Related Topics
Active Activity Users
Returns
This system variable returns a comma-separated list of the users currently actively involved in the specified activity.
SysVar Tag
{ACTIVITY_USERS_ACTIVE:ActivityName,Format=FormatType, Instance=InstNum}
Parameters
ActivityName (Required): The name of the activity for whom the users should be returned.
Modifiers
Format: This optional modifiers 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 format=percentage).
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
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, format=id}
Modifiers
format=id: This optional modifier can be used to return the Activity Instance ID, instead of the activity name.
Activity Description
Activity Due Date
Returns
This system variable returns the date the specified activity is due.
SysVar Tag
{ACTIVITY_DUE_DATE:ActivityName, Instance=N, UserTask=1}
Parameters
ActivityName: If no activity name is specified, this system variable will return the due date of the currently running activity.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
UserTask=1: This optional modifier, when included in the variable, will return only user activities.
This system variable’s result can be formatted using the Modifiers that are generally available for DateTime system variables.
Activity In Error
Returns
This system variable returns true or false based on whether an activity is in error. For users of v5.07 and higher, using the optional format parameter changes the behavior to return the name(s) of activities that are in error, either singly, or in a comma-separated list (for multiple activities in error).
SysVar Tag
{ACTIVITY_IN_ERROR, format=ActivityName}
Modifier
format: You may use this parameter to return the error instances of a specified activity.
Activity Loop Count
When a parent activity is configured to implement iteration, this SysVar is used to determine the number of iterations that have occurred in the loop.
SysVar Tag
{ACTIVITY_LOOP_COUNT:ActivityName}
Parameters
ActivityName (Required): The name of the activity whose loop count you wish to return.
Alternate Syntax
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 isn't currently running.
SysVar Tag
Modifiers
format=id: This optional formatter can be set to "id" to return the Activity Instance ID, instead of the activity name.
Alternate Syntax
Activity Result
Returns
This system variable returns the result of a specified activity instance.
SysVar Tag
{ACTIVITY_RESULT:ActivityName, instance=InstanceNum, SubTask=SubtaskName, separator="TextOrHTML", KeepEmptyRows=0
|1}
Parameters
ActivityName: The name of the activity whose result you wish to return. If none is specified, it will return the start date of the current activity. This system variable can be formatted as a timespan.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information. Additionally, this variable supports the syntax instance=all to return a list of all results for an activity that has iterated.
SubTask: The subtask for which you'd like the result to be returned.
Separator: Enables you to define a separator to use for the results when multiple results are returned.
KeepEmptyRows: The list will return an empty space for rows that have no results when multiple results are returned.
Activity Run Time
Returns
This system variable returns the amount of time this activity has been running.
SysVar Tag
{ACTIVITY_RUN_TIME:ActivityName}
Parameters
ActivityName: The name of the activity whose run time you wish to return. 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
Returns
This system variable returns the date the specified activity started.
SysVar Tag
{ACTIVITY_START_DATE:ActivityName, Instance=InstanceNum, Days=NumDays}
Parameters
ActivityName (Required): The name of the activity whose start date you wish to return.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
Days: This modifier is used to calculate the due date of an activity via System Variable. The Days parameter is an integer value that specifies the number of days after the Activity Start Date to set the due date. For example, a Days value of "3" would set the due date to three days after the Activity Start Date.
This system variable can be formatted using the options available to a DateTime system variable.
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:ActivityName, instance=InstanceNum}
Parameters
ActivityName (Required): The name of the activity whose calculated start date you wish to return.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
This system variable’s results can be formatted as a DateTime system variable.
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:ActivityName, instance=InstanceNum}
Parameters
ActivityName (Required): The name of the activity whose configured start date you wish to return.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
This system variable’s results can be formatted as a DateTime system variable.
Activity Start Date – Predicted
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:ActivityName}
Parameters
ActivityName (Required): The name of the activity whose predicted start date you wish to return.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
The result of this system variable can be formatted as a DateTime system variable.
Activity Status
Returns
This system variable returns an activity’s status. It will return either “Active”, “Complete”, or “Pending.” The system variable will only return “Pending” if the activity isn’t available or hasn’t been run.
SysVar Tag
{ACTIVITY_STATUS:ActivityName, instance=InstanceNum}
Parameters
ActivityName (Required): The name of the activity whose status you wish to return.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
Activity Stop Date
Returns
This system variable returns the date the specified activity stopped.
SysVar Tag
{ACTIVITY_STOP_DATE:ActivityName, instance=InstanceNum, SubTask=SubtaskName}
Parameters
ActivityName (Required): The name of the activity whose stop date you wish to return.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
SubTask: The subtask for which you'd like the result to be returned.
This system variable can be formatted according to the options available for date results.
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_STOP_CALC:ActivityName, instance=InstanceNum}
Parameters
ActivityName (Required): The name of the activity whose calculated stop date you wish to return.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
The result of this system variable can be formatted as a DateTime system variable.
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:ActivityName, instance=InstanceNum}
Parameters
ActivityName (Required): The name of the activity whose configured stop date you wish to return.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
The result of this system variable can be formatted as a DateTime system variable.
Activity Stop Date - Predicted
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:ActivityName, instance=InstanceNum}
Parameters
ActivityName (Required): The name of the activity whose predicted stop date you wish to return.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
The result of this system variable can be formatted as a DateTime system variable.
Activity Termination Reason
Returns
This system variable returns the reason the specified activity terminated.
- Canceled
- Not Required
- Error
- Completed
- Notified
- Not Set
- Reassigned
- Stopped
- Timeout
If the activity hasn’t yet terminated, the system variable will return “not set”. The system variable won't return a value if the activity was rolled back, or is in an iteration segment that has looped.
SysVar Tag
{ACTIVITY_TERM_REASON:ActivityName, instance=InstanceNum}
Parameters
ActivityName: The name of the activity whose termination reason you wish to return. Should one not be specified, this system variable will return the start date of the current activity.
Modifiers
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
Activity Users
Returns
This system variable returns a comma-separated list of all users involved in the specified activity. For Process Director v5.34 and higher, this system variable will return the email address of anonymous users who are assigned to an activity.
SysVar Tag
{ACTIVITY_USERS:ActivityName, Format=count
|percentage, ShowDelegator=false, ShowDelegatee=true, Instance=InstanceNum}
Parameters
ActivityName (Required): The name of the activity whose users you wish to return.
Modifiers
Format: This system variable 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 argument).
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 optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
Activity Users Complete
Returns
This system variable returns a list of users that have completed a specified activity. For Process Director v5.34 and higher, this system variable will return the email address of anonymous users who are assigned to an activity.
SysVar Tag
{ACTIVITY_USERS_COMPLETE:ActivityName,Result=ResultName, Instance=InstNum, format=comments, termreason=N}
Parameters
ActivityName (Required): The name of the activity from which the completed users need to be listed.
Modifiers
Result: The name of an activity result. If the Result modifier is included, the SysVar will return the list of users that selected the specified result.
Instance: This optional modifier takes an integer that corresponds to the number of times the step was run, which is useful for iterated steps. See the Instance Modifier section of the Parameters topic for more information.
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 Modifier.
Termreason: This optional numeric parameter enables you to specify the termination reason for the activity users. When you do so, the variable will return only the users whose activity was terminated for the reason specified. The following values are acceptable.
| VALUE | DESCRIPTION |
|---|---|
1
|
Normal termination |
2
|
Timeout |
3
|
Did not finish |
4
|
Canceled |
5
|
Reassigned |
6
|
Not Needed |
9
|
Break |
10
|
Restart |
All Children Activity Results
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}
Alternate Syntax
Any Child Activity Result
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.
Alternate Syntax
Last Child Activity Result
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, format=name}
Modifiers
format=name: This optional modifier will return the activity Name, instead of the activity Result.
Num Times Activity Run
Returns
This system variable returns the number of times a specified activity has been run in the current timeline instance. It won't count an activity that was skipped because of a rollback or a restart condition in an iteration parent.
SysVar Tag
{ACTIVITY_NUM_TIMES_RUN:ActivityName}
Parameters
ActivityName (Required): The name of the activity you wish to check.
Parent Activity Iterated
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 hasn't been completed. The use of this SysVar is configured in the Condition Builder of the Process Director user interface.
SysVar Tag
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
Running Activity Name
Returns
This system variable returns the name of the currently running activity.
SysVar Tag
{ACTIVITY_RUNNING_NAME
, format=id}
Modifiers
format=id: This optional formatter can be set to "id" to return the Activity Instance ID, instead of the activity name. Setting this formatter to "child" will return the names of running child activities.
Optional Tags
The variable will also be correctly returned using the alternate syntax options below:
Documentation Feedback and Questions
If you notice some way that this document can be improved, we're happy to hear your suggestions. Similarly, if you can't find an answer you're looking for, ask it via feedback. Simply click on the button below to provide us with your feedback or ask a question. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical issue with Process Director, please open a support ticket.
