Skip to main content
Mitratech Success Center

Workflow System Variables

No page summary available.

All Workflow Users

image

Returns - This system variable returns a comma-separated list of all users involved in a workflow.

SysVar Tag -{WORKFLOW_ALL_USERS}

Optional Parameters

This system variable can be formatted according to the options available to a user system variable.

Num Workflow Attachments

image

Returns - The Num Workflow Attachments variable returns the number of objects attached to a workflow instance.

SysVar Tag:{WORKFLOW_ATTACHMENT_NUM, ObjectType=Document|Form CSStatus=Pending|NotPending|Failed|Done|PendingOrFailed, GroupName=group}

Optional Parameters

ObjectType: This system variable’s results can be restricted by object type using the ObjectType parameter. Acceptable values are DOCUMENT and FORM.

CSStatus: The CSStatus option is available with Concept Share integration. When a value is specified, the system variable will return only the number of documents matching that stated. If “Failed” is selected, this system variable will return the number of documents that failed to upload to Concept Share.

GroupName: The parameter limits this system variable such that it only returns the number of attachments in the specified group.

Priority

image

Returns - This system variable returns a workflow instance’s priority.

SysVar Tag -{WORKFLOW_PRIORITY}

Optional Parameters

This system variable does not have Optional Parameters.

Workflow Attachment Group

Returns - This system variable returns the groupname used for this workflow attachment.

SysVar Tag -{WORKFLOW_ATTACHMENT_GROUP}

Optional Parameters

This system variable has no optional parameters.

Workflow Attachment Size

Returns - The system variable returns the cumulative size of all documents attached to the workflow.

SysVar Tag -{WORKFLOW_ATTACHMENT_SIZE}

Optional Parameters

GroupName: Can be used to have this system variable return the cumulative size of documents only in the specified group.

Workflow Attachments

Returns - This system variable returns a comma-separated list of the names of objects currently attached to this workflow.

SysVar Tag -{WORKFLOW_ATTACHMENTS, GroupName=someGroup, ShowName = 1, ShowDesc = 0, ShowID = 0, GroupName=group}

Optional Parameters

GroupName: The results returned can be filtered by group using the Groupname= option. The GroupName parameter limits the system variable such that it only returns a list of attachments in the specified group.

ShowName: The option is set to 1 by default. When set to 1, it will display the name of the attachment.

ShowDesc: The option is set to 0 by default. If set to 1, it will display the attachment’s description.

ShowID: The option is set to 0 by default. If set t 1, it will display the object’s internal ID. If each is set to 1, each attachment will be returned in the format “name : description, name : description, name : description”…

Workflow Definition

image

Returns - This system variable returns the name of the current workflow definition.

SysVar Tag -{WORKFLOW_DEF_NAME}

Optional Parameters

This variable has no optional parameters.

Workflow Definition Name

Returns - This system variable returns the name of the definition that this workflow is an instance of.

SysVar Tag - {WORKFLOW_DEF_NAME}

Optional Parameters

This system variable does not have optional parameters.

Workflow Group Name

image

Returns - This system variable returns the groupname used for this workflow.

SysVar Tag -{WORKFLOW_GROUP_NAME}

Optional Parameters

This system variable has no optional parameters.

Workflow Initiator

image

Returns - This system variable returns information about the user who started the current workflow instance.

SysVar Tag -{WORKFLOW_INITIATOR}

Optional Parameters

The Workflow Initiator system variable can be formatted with any option available to a user system variable.

Workflow Instance Id

image

Returns - This system variable returns the ID of the current workflow instance.

SysVar Tag -{WORKFLOW_INSTANCE_ID}

Optional Parameters

This system variable has no optional parameters.

Workflow Instance Name

image

Returns - The Workflow Instance Name system variable returns the name of the current workflow instance.

SysVar Tag -{WORKFLOW_NAME}

Optional Parameters

This system variable does not have any Optional Parameters.

Workflow Result

image

Returns - This system variable returns the result of the last step of this workflow.

SysVar Tag -{WORKFLOW_RESULT}

Optional Parameters

This system variable has an optional parameter, result. When result is set to FIRST, it will return the result of the first instance of the workflow. If the result is LAST, it will return the result of the last instance of the workflow. If the result is ALL, it will return a sequentially sorted comma separated list of all workflow instances’ results. The default behavior is LAST.

Workflow Run Time

Returns - This system variable returns the time the current workflow instance has run.

SysVar Tag -{WORKFLOW_RUN_TIME}

Optional Parameters

This system variable can be formatted as a timespan.

Workflow Status

image

Returns - This system variable returns the status of the workflow instance. The string returned can be either “Pending”, “Completed”, or “Running”. The system variable will return “Pending” if a workflow is not available or has never been run.

SysVar Tag -{WORKFLOW_STATUS}

Optional Parameters

This system variable does not have Optional Parameters.

Workflow Start Date

image

Returns - This system variable returns a datetime representing the date the current workflow instance started.

SysVar Tag -{WORKFLOW_START_DATE}

Optional Parameters

The result of this system variable can be formatted using the Optional Parameters available to datetime system variables.

Workflow Stop Date

image

Returns - This system variable returns the date the current workflow instance stopped.

SysVar Tag -{WORKFLOW_STOP_DATE}

Optional Parameters

This system variable can be formatted using the Optional Parameters available to datetimes.

Workflow Termination Reason

image

Returns - This system variable returns the reason the current workflow instance terminated. The results of this system variable can be used to handle workflow errors. If the workflow is still running or no value has been returned, this system variable will return “Not Set.”

SysVar Tag -{WORKFLOW_TERM_REASON}

Optional Parameters

This system variable does not have Optional Parameters.

Workflow Users All Complete

Returns - This system variable returns all users that have completed their tasks with a "normal" completion code.

SysVar Tag -{WORKFLOW_USERS_ALL_COMPLETE}

Optional Parameters

There are no optional parameters for this system variable.

  • Was this article helpful?