Skip to main content
Mitratech Success Center

Workflow Step System Variables

No page summary available.

Active Step Users

image

Returns - This system variable returns a comma-separated list of users actively involved in this step.

SysVar Tag -{STEP_USERS_ACTIVE:step name, Instance=InstNum}

Optional Parameters

Format: This system variable can be formatted using the format= parameter. It can be formatted to display either the number of users who are active in the specified step (using the format=count argument) or the percentage of users who care active in the step (using the format=percentage).

Instance: The step instance for iterative processes. The most recent instance will be "-1".

Branch Taken

image

Returns - This system variable returns a Boolean value based on whether the specified branch has been taken.

SysVar Tag -{BRANCH_TAKEN:branch name, instance=InstanceNum}

Optional Parameters

instance: This parameter takes an integer that corresponds to the number of times the step was, which is useful for iterated steps. Some possible values for the instance parameter might be:

Value

Result

-1

The last time the step was run

1

The first time the step was run

2

The second time the step was run

Completed Step Users

image

Returns - This system variable returns a comma-separated list of users who have completed the specified step.

SysVar Tag -{STEP_USERS_COMPLETE:someStepName, Result=branchName, ShowDelegator=false, ShowDelegatee = true, Instance=InstNum}

Optional Parameters

The result of this system variable can be formatted using the options available to user results. A step name must be specified for this system variable to return a list of users. Optionally, the Result parameter can be added such that this system variable only returns users who have completed the step going through the specified branch.

Format: This system variable can also be formatted using the format= parameter. It can be formatted to display either the number of users who completed the specified step (using the format=count argument) or the percentage of users who completed the step (using the format=percentage).

ShowDelegator/ShowDelegatee: Will respectively display who delegated a task and whom the task is delegated to. By default, the delegatee is shown and the delegator is not.

Instance: Will accept the instance number of iterations in an iterative process, with the most recent instance of the iteration identified at "-1".

Step Users

image

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

SysVar Tag -{STEP_USERS:step name, ShowDelegator = false, ShowDelegatee = true}

Optional Parameters

Format: This system variable can be formatted using the format= parameter. It can be formatted to display either the number of users in the specified step (using the format=count argument) or the percentage of users active in the step (using the format=percentage).

ShowDelegator/ShowDelegatee: Will respectively display who delegated a task and whom the task is delegated to. By default, the delegatee is shown and the delegator is not.

Is Step Past Due

image

Returns - This system variable returns a Boolean indicating whether the step is running past the due date.

SysVar Tag -{STEP_PAST_DUE:stepname}

Optional Parameters

Step name: If the step name is provided, Process Director will check to see if the specified step name is past due. If the step name is not provided, Process Director will check the currently running step to see if it is past due.

Num Times Step Run

image

Returns - This system variable returns the number of times a step has run. You can use this to break out of loops in a workflow.

SysVar Tag -{STEP_NUM_TIMES_RUN:step name}

Optional Parameters

This system variable does not have Optional Parameters.

Running Step

image

Returns - This system variable returns the name of the currently running step.

SysVar Tag -{STEP_RUNNING_NAME, Format=id}

Optional Parameters

Format: If the format parameter is set to id, this system variable will return the step’s ID rather than its name.

Step Description

image

Returns - This system variable returns a string containing the description of this workflow step.

SysVar Tag -{STEP_DESCRIPTION:step}

Optional Parameters

Step: You can use the step parameter to specify the name of the step whose description you want. If no step name is specified, this system variable will return the start date of the current step.

Step Due Date

image

Returns - This system variable returns the date the current step is due.

SysVar Tag -{STEP_DUE_DATE:step name, instance=InstanceNum}

Optional Parameters

This system variable can be formatted using options available to date system variables.

instance: This parameter takes an integer that corresponds to the number of times the step was, which is useful for iterated steps. Some possible values for the instance parameter might be:

Value

Result

-1

The last time the step was run

1

The first time the step was run

2

The second time the step was run

Step In Error

image

Returns - This system variable returns the name of the step currently in an error state.

SysVar Tag -{STEP_IN_ERROR}

Optional Parameters

This system variable does not have Optional Parameters.

Step Instance Id

Returns - This system variable returns the Instance ID of the running instance of a given workflow step.

SysVar Tag -{STEP_INSTANCE_ID:step name}

Optional Parameters

This system variable does not have Optional Parameters.

Step Message

Returns - This system variable returns the message for the specified step.

SysVar Tag -{STEP_MESSAGE:step}

Optional Parameters

You can specify which step you want the message of using the “step” parameter. If left unspecified, this system variable will return the start date for the current step.

Step Name

Returns - This system variable returns the name of the currently running Workflow Step in the context of the object that calls it. For instance, an email template that invokes the SysVar for a user activity notification will display the name of the Workflow Step that generated the notification.

SysVar Tag -{STEP_NAME}

Optional Parameters

This system variable has no optional parameters.

Step Reached

image

Returns - This system variable returns a Boolean value based on whether the specified step has been reached.

SysVar Tag -{STEP_REACHED}

Optional Parameters

This system variable does not have Optional Parameters.

Step Result

Returns - This system variable returns the result of a specified step instance.

SysVar Tag -{STEP_RESULT:step name, instance=instance id, SubTask=SubtaskName}

Parameters

This system variable must specify a particular step instance by using the instance= parameter.

Optional Parameters

SubTask: The subtask for which you'd like the result returned.

Step Result Count

Returns - This system variable returns the number of times the specified step has returned this result.

SysVar Tag -{STEP_RESULT_COUNT:step name, result=result to test for}

Optional Parameters

This system variable must specify the result being tested for using the result= parameter.

Step Run Time

Returns - This system variable returns the amount of time the specified step has run.

SysVar Tag -{STEP_RUN_TIME:step}

Optional Parameters

This system variable must specify a particular step using the “step” parameter, containing a workflow step or an instance of a workflow step. If no step is specified, this system variable returns the start date of the current step. This system variable can be formatted as a timespan system variable.

Step Start Date

image

Returns - This system variable returns the date that the specified step started.

SysVar Tag -{STEP_START_DATE:step name, instance=InstanceNum}

Optional Parameters

instance: This parameter takes an integer that corresponds to the number of times the step was, which is useful for iterated steps. Some possible values for the instance parameter might be:

Value

Result

-1

The last time the step was run

1

The first time the step was run

2

The second time the step was run

Step Status

Returns - This system variable returns a step’s status. It will return either “Running”, “Completed”, or “Pending.” The system variable will only return “Pending” if the specified step isn’t available or hasn’t been run.

SysVar Tag -{STEP_STATUS:stepname, instance=InstanceNum}

Optional Parameters

instance: This parameter takes an integer that corresponds to the number of times the step was, which is useful for iterated steps. Some possible values for the instance parameter might be:

Value

Result

-1

The last time the step was run

1

The first time the step was run

2

The second time the step was run

Step Stop Date

image

Returns - This system variable returns the date this step stopped.

SysVar Tag -{STEP_STOP_DATE:step name, instance=someInstance, SubTask=SubtaskName}

Optional Parameters

This system variable can be formatted using the options available to datetime system variables.

instance: This parameter takes an integer that corresponds to the number of times the step was, which is useful for iterated steps. Some possible values for the instance parameter might be:

Value

Result

-1

The last time the step was run

1

The first time the step was run

2

The second time the step was run

SubTask: The subtask for which you'd like the result returned.

Step Termination Reason

image

Returns - This system variable returns the reason the specified step terminated.

If the step has not terminated, this system variable will return “Not Set”.

  • Cancelled
  • Not Required
  • Error
  • Completed
  • Notified
  • Not Set
  • Reassigned
  • Stopped
  • Timeout
  • “Not Set” is returned if the step has yet to complete.

SysVar Tag -{STEP_TERM_REASON, Step=StepName, instance = InstanceNum}

Optional Parameters

Step: This system variable must specify a step name using the step parameter. Should this name not be specified, the system variable will return the start date of the current step.

instance: This parameter takes an integer that corresponds to the number of times the step was, which is useful for iterated steps. Some possible values for the instance parameter might be:

Value

Result

-1

The last time the step was run

1

The first time the step was run

2

The second time the step was run

Step Time Until Due

image

Returns - This system variable returns the amount of time until the current step is due.

SysVar Tag -{STEP_TIME_UNTIL_DUE}

Optional Parameters

This system variable is a timespan system variable and can be formatted according to standard timespan formatting options.

  • Was this article helpful?