Workflow, Segment, and Step Status Descriptions

Variables
const	OMQ::StatComplete = "COMPLETE"
	This status indicates that the object it is attached to has successfully completed its processing.
const	OMQ::StatError = "ERROR"
	Indicates that the workflow order data instance has at least one step with an OMQ::StatError status.
const	OMQ::StatWaiting = "WAITING"
	Indicates that subworkflow steps are in progress and the system is waiting on the subworkflows to become OMQ::StatComplete.
const	OMQ::StatInProgress = "IN-PROGRESS"
	Indicates that the workflow order data instance is currently being processed.
const	OMQ::StatIncomplete = "INCOMPLETE"
	Indicates that processing for the workflow order data instance is not yet complete yet has no errors.
const	OMQ::StatAsyncWaiting = "ASYNC-WAITING"
	Indicates that asynchronous steps are in process and the system is waiting on data to become available in the queue assigned to the step.
const	OMQ::StatEventWaiting = "EVENT-WAITING"
	Indicates that one or more workflow event synchronization steps are in progress and the workflow is waiting for the event(s) to be posted.
const	OMQ::StatRetry = "RETRY"
	Indicates that workflow processing on the order data instance has generated an error and is now waiting for an automatic retry.
const	OMQ::StatCanceled = "CANCELED"
	Indicates that workflow order data instance processing has been canceled.
const	OMQ::StatReady = "READY"
	Indicates that a workflow order data instance has been created and is waiting for processing to start.
const	OMQ::StatScheduled = "SCHEDULED"
	Indicates that a workflow order data instance has been created and has not yet been processed because at the time the order was created, the scheduled date (the earliest possible processing date) was in the future.
const	OMQ::StatBlocked = "BLOCKED"
	Indicates that workflow order data instance processing has been temporarily blocked.

Detailed Description

These are the possible values for the descriptive status of a workflow order data instance; most of these can also be used for the status of a segment instance and a step instance.

Note

Descriptive status values are returned by almost all API functions even though abbreviated codes are actually stored in the database; this is mainly for backwards compatibility.

See also

• Workflow, Segment, and Step SQL Status Codes for the corresponding values stored in the database
• OMQ::StatMap for a hash that can be used to map from descriptive status codes to Workflow, Segment, and Step SQL Status Codes
• OMQ::SQLStatMap for a hash that can be used to map from SQL status codes to Workflow, Segment, and Step Status Descriptions

Variable Documentation

StatAsyncWaiting

const OMQ::StatAsyncWaiting = "ASYNC-WAITING"

Indicates that asynchronous steps are in process and the system is waiting on data to become available in the queue assigned to the step.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatAsyncWaiting

StatBlocked

const OMQ::StatBlocked = "BLOCKED"

Indicates that workflow order data instance processing has been temporarily blocked.

This status is similar to OMQ::StatCanceled but is considered only temporary.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatBlocked

StatCanceled

const OMQ::StatCanceled = "CANCELED"

Indicates that workflow order data instance processing has been canceled.

This status is similar to OMQ::StatBlocked but is considered a final status.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatCanceled

StatComplete

const OMQ::StatComplete = "COMPLETE"

This status indicates that the object it is attached to has successfully completed its processing.

This is a final status; once a workflow, segment, or step is COMPLETE, it will not be processed anymore.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatComplete

StatError

const OMQ::StatError = "ERROR"

Indicates that the workflow order data instance has at least one step with an OMQ::StatError status.

This status takes the highest priority; if any one step in a workflow has an OMQ::StatError status, then the entire workflow will also have an OMQ::StatError status. Workflow order data instances must be manually updated to OMQ::StatRetry when an OMQ::StatError status is reached.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatError

StatEventWaiting

const OMQ::StatEventWaiting = "EVENT-WAITING"

Indicates that one or more workflow event synchronization steps are in progress and the workflow is waiting for the event(s) to be posted.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatEventWaiting

StatIncomplete

const OMQ::StatIncomplete = "INCOMPLETE"

Indicates that processing for the workflow order data instance is not yet complete yet has no errors.

This status will be assigned after asynchronous segments have completed and dependent segments have not yet been started.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatIncomplete

StatInProgress

const OMQ::StatInProgress = "IN-PROGRESS"

Indicates that the workflow order data instance is currently being processed.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatInProgress

StatReady

const OMQ::StatReady = "READY"

Indicates that a workflow order data instance has been created and is waiting for processing to start.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatReady

StatRetry

const OMQ::StatRetry = "RETRY"

Indicates that workflow processing on the order data instance has generated an error and is now waiting for an automatic retry.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatRetry

StatScheduled

const OMQ::StatScheduled = "SCHEDULED"

Indicates that a workflow order data instance has been created and has not yet been processed because at the time the order was created, the scheduled date (the earliest possible processing date) was in the future.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatScheduled

StatWaiting

const OMQ::StatWaiting = "WAITING"

Indicates that subworkflow steps are in progress and the system is waiting on the subworkflows to become OMQ::StatComplete.

Note

The equivalent status code actually stored in the database is OMQ::SQLStatWaiting