Recall that a Workflow is a composed of one or more FireWorks. Both FireWorks and Workflows have a state (status).
You can get the states of FireWorks and Workflows using LaunchPad queries or through the web interface.
A FireWork state represents the status of a single job.
State | Meaning |
ARCHIVED | Similar to deleted. The FireWork will not run, and its launches are archived (won’t be used in duplicate checking). However, you can still query the FireWork. More information here. |
DEFUSED | The FireWork is canceled/paused. Child FireWorks won’t run (although siblings might). The FireWork can be resumed (reignited) later. More information here. |
WAITING | The FireWork is waiting for a parent FireWork to complete. The Rocket Launcher will not pull this FireWork until parent jobs complete. |
READY | This FireWork is ready to run, but hasn’t started running yet. The Rocket Launcher must pull this job and start running it. |
RESERVED | (Queue Launcher in reservation mode only). The FireWork is waiting in a queue to run. More information here. |
FIZZLED | The FireWork has failed; it was executed but threw an error during the process. It can be rerun if desired - more information here. |
RUNNING | The FireWork is currently running. Note that in catastrophic cases, a FireWork may display this state even though it has crashed; more information here. |
COMPLETED | The FireWork has successfully finished running. |
The state of a Workflow depends on the states of its component FireWorks.
State | Meaning |
ARCHIVED | Similar to deleted. All the individual FireWork states are ARCHIVED. |
COMPLETED | All the individual FireWork states are COMPLETED - the workflow is finished. |
DEFUSED | At least one FireWork in the workflow is DEFUSED. (If you have a branching workflow, other FireWorks might be running). |
FIZZLED | At least one FireWork in the workflow is FIZZLED and no FWs are DEFUSED. (If you have a branching workflow, other FireWorks might be running). |
RUNNING | At least one FireWork is RUNNING or COMPLETED. This state means that workflow has started but is not yet fully complete. |
RESERVED | No FireWorks are RUNNING or COMPLETED, but at least one FireWork has been submitted to the queue. |
READY | The workflow has not started running and no FireWorks are reserved to run. |
The FW spec has certain reserved keywords that indicate special instructions to the FireWorks software. They are listed below: