DEQUEUE STUDY SIMULATIONS¶
Removes all queued simulations from a specified Study, effectively cancelling their pending execution. Use this worker when you need to clear a study’s simulation queue before re-submitting, modifying parameters, or aborting a batch run.
When to use¶
Tagged: cancel, dequeue, queue_management, simulation, study.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| Study | study_id | remote_lookup | — | ✓ | The unique identifier of the Study whose queued simulations should be dequeued; selected via remote lookup from the available studies list — required, no default. |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| Report | report | dataset | A dataset summarising the dequeue operation result, including which simulations were removed from the queue and any errors encountered. |
Disciplines¶
- platform.job_submission
- platform.workflow
Auto-generated from platform schema. Worker id: study_dequeue. Schema hash: 3204de6e8eca. Hand-curated docs in workerexamples/ override this page when present.