Skip to main content
Mitratech Success Center

Timeline Activity System Variables

No page summary available.

Active Activity Users

image

Returns - This system variable returns a comma-separated list of the users currently actively involved in the specified activity.

SysVar Tag -{ACTIVITY_USERS_ACTIVE:activity name,Format=FormatType, 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 active users in this activity (using the format=count argument) or the percentage of users who are active in the activity (using the format=percentage).

Instance: The instance number of an iterating process. The most recent instance would be identified as "-1".

Activity Average Run Time

image

Returns - This system variable returns the average amount of time a specified activity usually takes to run.

SysVar Tag -{ACTIVITY_AVG_RUN_TIME:activity name}

Optional Parameters

This system variable can be formatted as a timespan system variable.

Activity Bottom Running Name

Returns - This system variable returns the specified activity’s lowest level activity. If two or more activities are running in different hierarchies, a comma-separated list of all lowest, unrelated, running activities will be returned.

SysVar Tag -{ACTIVITY_BOTTOM_RUNNING_NAME}

Optional Parameters

This system variable has no optional parameters.

Activity Description

Returns - This system variable returns the specified activity’s description.

SysVar Tag - {ACTIVITY_DESCRIPTION:activity}

Optional Parameters

This system variable must specify an activity name using the activity parameter. If no activity name is specified, this system variable will return the start date of the current activity.

Activity Due Date

image

Returns - This system variable returns the date the specified activity is due.

SysVar Tag -{ACTIVITY_DUE_DATE:activity name}

Optional Parameters

The result of this system variable can be formatted as a date.

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 paramater 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

Activity In Error

Returns - This system variable returns the name of an activity that is in error.

SysVar Tag -{ACTIVITY_IN_ERROR}

Optional Parameters

This system variable does not have Optional Parameters.

Activity Message

Returns - This system variable returns a message for a specified activity.

SysVar Tag -{ACTIVITY_MESSAGE:activity name}

Optional Parameters

This system variable does not have Optional Parameters.

Activity Name

Returns - This system variable returns the name of the Process Timeline Activity that is currently being evaluated in the context of the object that is evaluating it. An activity, therefore, can be evaluated in an administrative context, even though the activity is not currently running.

SysVar Tag -{ACTIVITY_CONTEXT}

Optional Parameters

This system variable has no optional parameters.

Activity Reached

image

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

SysVar Tag -{ACTIVITY REACHED:activity name}

Optional Parameters

This system variable does not have Optional Parameters.

Activity Result

image

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

SysVar Tag -{ACTIVITY_RESULT:activity name, instance=InstanceNum, SubTask=SubtaskName}

Parameters

This system variable must specify an activity name or instance. If none is specified, it will return the start date of the current activity. This system variable can be formatted as a timespan.

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

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

Activity Run Time

image

Returns - This system variable returns the amount of time this activity has been running.

SysVar Tag -{ACTIVITY_RUN_TIME:activity}

Optional Parameters

This system variable must specify an activity name or instance. If none is specified, it will return the start date of the current activity. This system variable can be formatted as a timespan.

Activity Start Date

image

Returns - This system variable returns the date the specified activity started.

SysVar Tag -{ACTIVITY_START_DATE:activity name, instance=InstanceNum}

Optional Parameters

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

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 paramater 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

Activity Start Date - Calculated

Returns - This system variable returns the date the specified activity is calculated to start, based on the current state of the process instance and the configuration of all the activities on which it is dependent.

SysVar Tag -{ACTIVITY_START_CALC:activity name, instance=InstanceNum}

Optional Parameters

This system variable’s results can be formatted as a date.

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

Activity Start Date - Configured

Returns - This system variable returns the date the specified activity is configured to start in the Timeline Definition.

SysVar Tag -{ACTIVITY_START_CONFIG:activity name, instance=InstanceNum}

Optional Parameters

This system variable’s results can be formatted as a date.

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

Activity Start Date – Predicted

image

Returns - This system variable returns the date the specified activity is predicted to start, based on the aggregate past performance of the process.

SysVar Tag -{ACTIVITY_START_PREDICTED:activity name}

Optional Parameters

The result of this system variable can be formatted as a date.

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

Activity Status

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

SysVar Tag -{ACTIVITY_STATUS:activity name, instance=InstanceNum}

Optional Parameters

This system variable is a timespan system variable, and the standard datetime formatting options apply.

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

Activity Stop Date

image

Returns - This system variable returns the date the specified activity stopped.

SysVar Tag -{ACTIVITY_STOP_DATE:activity name, instance=InstanceNum, SubTask=SubtaskName}

Optional Parameters

This system variable can be formatted according to the options available for date results.

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

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 paramater 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

Activity Stop Date - Calculated

Returns - This system variable returns the date the specified activity is calculated to stop, based on the current state of the process instance and the configuration of all the activities on which it is dependent.

SysVar Tag -{ACTIVITY_START_CALC:activity name, instance=InstanceNum}

Optional Parameters

This system variable’s results can be formatted as a date.

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

SysVar Tag -{ACTIVITY_STOP_CALC:activity name, instance=InstanceNum}

Optional Parameters

This system variable’s results can be formatted as a date.

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

Activity Stop Date - Configured

Returns - This system variable returns the date the specified activity is configured to stop in the Timeline Definition.

SysVar Tag -{ACTIVITY_STOP_CONFIG:activity name, instance=InstanceNum}

Optional Parameters

This system variable’s results can be formatted as a date.

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

Activity Stop Date - Predicted

image

Returns - This system variable returns the date the specified activity is predicted to stop, based on the aggregate past performance of the process.

SysVar Tag -{ACTIVITY_STOP_PREDICTED:activity name, instance=InstanceNum}

Optional Parameters

This system variable’s results can be formatted as a date.

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

Activity Termination Reason

Returns:

This system variable returns the reason the specified activity terminated.

  • Cancelled
  • Not Required
  • Error
  • Completed
  • Notified
  • Not Set
  • Reassigned
  • Stopped
  • Timeout

If the activity hasn’t yet terminated, the system variable will return “not set”.

SysVar Tag - {ACTIVITY_TERM_REASON:ActivityName, instance=InstanceNum}

Optional Parameters

This system variable must specify an activity using the activity parameter. Should one not be specified, this system variable will return the start date of the current activity.

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 paramater 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

Activity Time Until Due

Returns - This system variable returns the remaining amount of time until the activity is due for the current running activity.

SysVar Tag -{ACTIVITY_TIME_UNTIL_DUE}

Optional Parameters

This system variable can be formatted according to the standard timespan formatting options.

Activity Top Running Name

Returns - This system variable returns the specified activity’s highest level parent activity.

SysVar Tag -{ACTIVITY_TOP_RUNNING_NAME}

Optional Parameters

This system variable has no optional parameters.

Activity Users

image

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

SysVar Tag -{ACTIVITY_USERS:activity name, Format=FormatType, ShowDelegator=false, ShowDelegatee=true, Instance=InstanceNum}

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 this activity (using the format=count argument) or the percentage of users who are active in the activity (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: 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

Activity Users Complete

Returns - This system variable returns a list of users that have completed a specified activity.

SysVar Tag -{ACTIVITY_USERS_COMPLETE:ActivityName,Result=ResultName, Instance=InstNum, format=comments}

Parameters

ActivityName: The name of the activity from which the users need to be listed.

Optional Parameters

Result: The name of an activity result. If the Result parameter is included, the sysvar will return the list of users that selected the specified result.

Instance: The instance number of an iterating process. The most recent instance would be identified as "-1".

Format: using the "format=comments" modifier will to return only the comments placed by the users. If there were multiple users that completed this activity it will show them comma separated. If you want to limit the users to only those with a particular result, use the "result=" parameter.

All Children Activity Results

image

When a parent activity is configured to implement iteration, this sysvar is used to determine whether the results of all child activities in the iterative loop contain a user-specified value. The use of this SysVar is configured in the Condition Builder of the Process Director user interface.

SysVar Tag - Unlike most other System Variables, this sysvar is solely configured for use in the Process Director user interface, and there is no current use case for using the actual SysVar tag with this variable.

{ACTIVITY_RESULT_ALL_CHILDREN}

Optional Parameters

None

Any Child Activity Results

image

When a parent activity is configured to implement iteration, this sysvar is used to determine whether the result of any child activity in the iterative loop contains a user-specified value. The use of this SysVar is configured in the Condition Builder of the Process Director user interface.

SysVar Tag - Unlike most other System Variables, this sysvar is solely configured for use in the Process Director user interface, and there is no current use case for using the actual SysVar tag with this variable.

{ACTIVITY_RESULT_ANY_CHILD}

Optional Parameters

None

Completed Activity Users

image

Returns - This system variable returns a comma-separated list of the users involved in the specified activity who have completed their assigned task.

SysVar Tag -{ACTIVITY_USERS_COMPLETE:activity 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 who completed this activity (using the format=count argument) or the percentage of users who have completed the activity (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 Activity Past Due?

image

Returns - This system variable returns a Boolean value based on whether the specified activity has passed its due date.

SysVar Tag - {ACTIVITY_PAST_DUE}

Optional Parameters

This system variable has no available Optional Parameters.

Is Predicted To End Late?

image

Returns - This system variable returns a Boolean value based on whether the specified activity is predicted to end late.

SysVar Tag -{ACTIVITY_PREDICT_END_LATE:activity name}

Optional Parameters

This system variable cannot be formatted.

Is Predicted To Start Late?

image

Returns - This system variable returns a Boolean value based on whether the specified activity is predicted to start late.

SysVar Tag -{ACTIVITY_PREDICT_START_LATE:activity name}

Optional Parameters

This system variable does not have Optional Parameters.

Last Child Activity Result

image

Returns - When a parent activity is configured to implement iteration, this sysvar is used to determine whether the result of last completed child activity in the iterative loop contains a user-specified value. The use of this SysVar is configured in the Condition Builder of the Process Director user interface.

SysVar Tag - Unlike most other System Variables, this sysvar is solely configured for use in the Process Director user interface, and there is no current use case for using the actual SysVar tag with this variable.

{ACTIVITY_RESULT_LAST_CHILD}

Optional Parameters

None

Num Times Activity Run

image

Returns - This system variable returns the number of times a specified activity has been run in the current timeline instance. It will not count an activity that was skipped because of a rollback or a restart condition in an iteration parent.

SysVar Tag -{ACTIVITY_NUM_TIMES_RUN:activity name}

Optional Parameters

This system variable cannot be formatted.

Parent Activity

image

Returns - This system variable returns the parent activity of the current activity.

SysVar Tag -{PARENT_ACTIVITY}

Optional Parameters

There are no optional parameters for this system variable.

Parent Activity Iterated

image

Returns - When a parent activity is configured to implement iteration, this sysvar will return True if an iteration of the Parent activity has been completed, and False if the first iteration has not been completed. The use of this SysVar is configured in the Condition Builder of the Process Director user interface.

SysVar Tag - Unlike most other System Variables, this sysvar is solely configured for use in the Process Director user interface, and there is no current use case for using the actual SysVar tag with this variable.

{PARENT_ITERATED}

Optional Parameters

None

Parent Activity Restarted

Returns - When a parent activity is configured to implement iteration, this sysvar will return True if an iteration of the Parent activity has been restarted, and False if not. Parent Activities are usually restarted when a child activity result meets a specified condition. For instance, if a participant in an approval process rejects a request, the result may be configured restart the approval process.

SysVar Tag -{PARENT_RESTARTED}

Optional Parameters

None

Running Activity Name

image

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

SysVar Tag -{ACTIVITY_RUNNING_NAME}

Optional Parameters

This system variable cannot be formatted.

  • Was this article helpful?