System Variables Reference Guide
System Variables Reference Guide
ii
Contents ii
iii
Contents
SYSTEM VARIABLE PARAMETERS ..................................................................................................................................................... 2
USER SYSTEM VARIABLES ............................................................................................................................................................................. 2
FORM FIELD SYSTEM VARIABLES .................................................................................................................................................................... 2
DATETIME SYSTEM VARIABLES: ..................................................................................................................................................................... 3
ALL SYSTEM VARIABLES ............................................................................................................................................................................... 5
Group Parameter ............................................................................................................................................................................. 5
Encode Types.................................................................................................................................................................................... 5
Pre, Post, and Null ............................................................................................................................................................................ 6
FORM SYSTEM VARIABLES............................................................................................................................................................... 7
FORM FIELD .......................................................................................................................................................................................... 7
NEW FORM INSTANCE .......................................................................................................................................................................... 8
FORM SUBMITTER ................................................................................................................................................................................ 9
SUBMIT DATE...................................................................................................................................................................................... 10
NUM FORM ATTACHMENTS ............................................................................................................................................................... 11
FORM PRINTING ................................................................................................................................................................................. 12
CONVERTING TO PDF .......................................................................................................................................................................... 13
FORM EVENT TYPE .............................................................................................................................................................................. 14
FORM EVENT NAME............................................................................................................................................................................ 15
IS ON MOBILE DEVICE? ....................................................................................................................................................................... 16
FORM ATTACHMENTS ........................................................................................................................................................................ 16
FORM INSTANCE ID ............................................................................................................................................................................. 16
FORM ATTACHMENT GROUP.............................................................................................................................................................. 17
META DATA SYSTEM VARIABLES ................................................................................................................................................... 19
CATEGORY .......................................................................................................................................................................................... 19
ATTRIBUTE .......................................................................................................................................................................................... 20
OBJECT INFORMATION SYSTEM VARIABLES................................................................................................................................... 21
NAME ................................................................................................................................................................................................. 21
DESCRIPTION ...................................................................................................................................................................................... 22
SIZE ..................................................................................................................................................................................................... 23
CREATE USER ...................................................................................................................................................................................... 24
UPDATE USER ..................................................................................................................................................................................... 25
CREATE DATE ...................................................................................................................................................................................... 26
UPDATE DATE ..................................................................................................................................................................................... 27
VERSION ............................................................................................................................................................................................. 28
DOCUMENT TEXT................................................................................................................................................................................ 29
FOLDER PATH...................................................................................................................................................................................... 29
OBJECT ID ........................................................................................................................................................................................... 29
OBJECT TYPE ....................................................................................................................................................................................... 30
WORKFLOW SYSTEM VARIABLES ................................................................................................................................................... 31
PRIORITY ............................................................................................................................................................................................. 31
NUM WORKFLOW ATTACHMENTS ..................................................................................................................................................... 32
WORKFLOW INITIATOR....................................................................................................................................................................... 33
WORKFLOW INSTANCE NAME ............................................................................................................................................................ 34
WORKFLOW STATUS ........................................................................................................................................................................... 35
WORKFLOW START DATE.................................................................................................................................................................... 36
Contents iii
iv
Contents iv
Contents v
vi
Contents vi
Contents 1
Guid: the system variable will return the global unique ID of an object
Custom_String: returns the custom string stored in the Users table entry
Custom_Number: returns the custom number stored in the Users table entry
Custom_Date: returns the custom date stored in the Users table entry
The following example demonstrates how a user system variable tag can be formatted to return the User ID:
{CURR_USER, format=Userid}
Contents 2
FORMAT:
{FORM:someFieldName, format=Currency}
Currency: formats the system variable into a format representing currency (e.g. $22.99)
ROW_NUM:
{FORM:someFieldName, ROW_NUM=2}
If this form control is part of an array, returns the value specified by the ROW_NUM parameter
SEPARATOR:
{FORM:someColumnFieldName, SEPARATOR=|}
If this form control is part of an array, this option specifies which character will be used to separate the
different values in the different elements of the array. By default, the separator is a comma.
YEARS:
MONTHS:
DAYS:
HOURS:
Contents 3
MINUTES:
SECONDS:
Datetime system variables can be formatted using any combination of the following parameters:
FORMAT:
{CURR_DATE, format=[option]}
dd: displays the current day of the month as a number, padding to two digits with a zero if necessary (01 31)
h: displays the hour as 1-12. Without specifying AM or PM, 1:00pm is indistinguishable from 1:00am (and so
on) with this formatting option.
hh: displays the hour as 01-12. Padding using a zero is applied to ensure that the value returned is two
characters long. Without specifying AM or PM, 1:00pm is indistinguishable from 1:00am (and so on) with this
formatting option.
HH: displays the hour as 00-23. Padding using a zero is applied to ensure that the value returned is always two
characters long.
mm: displays the current minute as a number 00 59. Left padding using a zero is added to ensure the return
value is two characters long
MM: displays the month as a number 01 12. Left padding using a zero is added to ensure the return value is
two characters long.
MMM: returns the abbreviated name for the month (Jan. Dec.)
MMMM: returns the full name for the month (January December)
Contents 4
ss: displays the seconds as a number 00 59. Padding using a zero is added to the left of the return value to
ensure it is two characters long.
tt: displays A.M. if the time is before noon. Otherwise displays P.M.
y: displays the year as a one or two digit number. The first two numbers of the year are always omitted. The
third digit of the year is omitted if the year is between 00 and 09 (e.g. 1, 17, 93)
yy: displays the last two digits of the year. (e.g. 48, 67, 73)
yyyy: displays all four digits of the year. If the year is less than four digits long, zeros are added to pad the year
value to four digits (e.g. 1982, 2009)
separators (/ : ): quotation marks, apostrophes, colons, and slashes can be added to the datetime
formatting. They will displayed literally, and can be used to separate different elements of the datetime string.
Encode Types
Encoding types are special characters put inside system variable tags to force the tag to return a certain type. These are often used
to prevent improperly encoded values from breaking a query. The format used to specify an encode type is as follows:
{[encode-type]SysVar}
Where [encode-type] can be any one of the following symbols:
* -- converts the result into a valid SQL list of strings (e.g. string one, string two, string three)
@ -- ensures the result is valid for a calculation control or system variable tag
Contents 5
To specify the Pre, Post, and Null values in a SysVar tag, use the following format:
{VARNAME pre=[pre_text], post=[post_text], null=[null_text]}
Contents 6
Returns:
A Form Field system variable will return the value of a specified form field. The data will be drawn from the active instance of the
eForm.
SysVar Tag:
{FORM:[form_field_name]}
Optional Parameters:
The Optional Parameters available depend on what kind of data the form field contains. If the form field contains arbitrary data,
then the form field system variable Optional Parameters apply. If the form field contains data about a user, then the user system
variable Optional Parameters apply. No Optional Parameters are available when the form field contains information about an object.
Contents 7
Returns:
This system variable returns a Boolean value (e.g. yes/no, true/false) reflecting whether or not the eForm instance has just been
created.
SysVar Tag:
{NEW_FORM_INSTANCE}
Optional Parameters:
No Optional Parameters apply to this system variable: it will always return a Boolean value.
Contents 8
FORM SUBMITTER
Returns:
This system variable returns information about the user that submitted the eForm, thus creating the eForm instance.
SysVar Tag:
{FORM_SUBMITTER}
Optional Parameters:
The Optional Parameters for a User system variable apply to this SysVar.
Contents 9
10
SUBMIT DATE
Returns:
The Submit Date system variable returns the date a form instance was submitted on.
SysVar Tag:
{SUBMIT_DATE}
Optional Parameters:
This system variable can be formatted according to options available to datetime system variables.
Contents 10
11
Returns:
This system variable returns the number of attachments to an eForm instance.
SysVar Tag:
{FORM_ATTACHMENT_NUM}
Optional Parameters:
This system variables results can be restricted by object type using the ObjectType parameter. Acceptable values are DOCUMENT
and FORM.
Contents 11
12
FORM PRINTING
Returns:
This system variable returns a Boolean value reflecting whether or not the eForm is being printed. Use this to change what is
displayed on printed versions of the eForm.
SysVar Tag:
{FORM_PRINTING}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 12
13
CONVERTING TO PDF
Returns:
This system variable returns a Boolean value reflecting whether or not the eForm is being converted to a PDF. Use this system
variable to change is displayed on PDF versions of an eForm.
SysVar Tag:
{FORM_TO_PDF}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 13
14
Returns:
This system variable returns a string reflecting the type of the most recent form event. The returned string can be any of the
following values:
User
Complete
Cancel
Save
SaveAndClose
CancelClose
DocumentAttached
ClipboardAttached
RefreshEvent
SysVar Tag:
{FORM_EVENT_TYPE}
Optional Parameters:
Contents 14
15
Returns:
This system variable returns a string containing the name of the most recent form event.
SysVar Tag:
{FORM_EVENT_NAME}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 15
16
IS ON MOBILE DEVICE?
Returns:
This system variable returns a Boolean value reflecting whether or not the eForm is being displayed on a mobile device. Use this to
change what an eForm displays depending on what device is displaying an eForm. Tablets count as mobile devices.
SysVar Tag:
{FORM_IS_MOBILE}
Optional Parameters:
This system variable does not have Optional Parameters.
FORM ATTACHMENTS
Returns:
This system variable returns a comma-separated list of object names attached to this form instance.
SysVar Tag:
{FORM_ATTACHMENTS}
Optional Parameters:
The results returned can be filtered by group using the Groupname= option.
FORM INSTANCE ID
Returns:
This system variable returns the ID of the current form instance.
Contents 16
17
SysVar Tag:
{FORM_INSTANCE_ID}
Optional Parameters:
This system variable cannot be formatted.
Contents 17
19
Returns:
The Category system variable returns the name of a specified category or list of categories so long as the object containing this
system variable is assigned to that category. If the object is not assigned to a listed category, the system variable returns a null string
for that category.
SysVar Tag:
{CATEGORY:[category_name_1].[category_name_2]}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 19
20
ATTRIBUTE
Returns:
This system variable returns the name of an attribute if the object containing this system variable is assigned to that attribute. If the
object is not assigned to the attribute, the system variable will return a null string.
SysVar Tag:
{ATTRIBUTE:[category_name].[attribute_name], format=[currency|value|string]}
Optional Parameters:
This system variable can be formatted as a currency, a numeric value, or a string using the format= option.
Contents 20
21
Returns:
This system variable returns a string containing the name of this object.
SysVar Tag:
{OBJ_NAME}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 21
22
DESCRIPTION
Returns:
This system variable returns a string containing the description of the relevant object.
SysVar Tag:
{OBJ_DESC}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 22
23
SIZE
Returns:
This system variable returns the size of the object.
SysVar Tag:
{OBJ_SIZE}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 23
24
CREATE USER
Returns:
This system variable returns information about the user that created the object.
SysVar Tag:
{CREATE_USER}
Optional Parameters:
The result of this system variable can be formatted using the user Optional Parameters.
Contents 24
25
UPDATE USER
Returns:
This system variable returns information about the last user to update the object.
SysVar Tag:
{UPDATE_USER}
Optional Parameters:
This system variable can be formatted using the Optional Parameters available to user system variables.
Contents 25
26
CREATE DATE
Returns:
This system variable returns the date on which the object was created.
SysVar Tag:
{CREATE_DATE}
Optional Parameters:
The result of this system variable can be formatted according to options available to format dates.
Contents 26
27
UPDATE DATE
Returns:
This system variable returns the date upon which the object was last updated.
SysVar Tag:
{UPDATE_DATE}
Optional Parameters:
This system variable can be formatted using the date Optional Parameters.
Contents 27
28
VERSION
Returns:
This system variable returns the objects version number
SysVar Tag:
{OBJ_VERSION}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 28
29
DOCUMENT TEXT
Returns:
This option allows for a full-text search of a document object.
SysVar Tag:
N/A
FOLDER PATH
Returns:
This system variable returns the content list folder path of an object.
SysVar Tag:
{FOLDER_PATH}
Optional Parameters:
This system variable does not have Optional Parameters.
OBJECT ID
Returns:
This system variable returns the ID of an object.
SysVar Tag:
{OBJ_ID}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 29
30
OBJECT TYPE
Returns:
This system variable returns this objects type. This system variable can return the following:
Document
Folder
Rule
Knowledge View
Workflow
Workflow Instance
TaskList
User
Group
Partition
Form
Form Instance
Category
Dropdown
Profile
DataSource Connection
Report
SysVar Tag:
{OBJ_TYPE}
Optional Parameters:
This system variable has no optional parameters.
Contents 30
31
Returns:
This system variable returns a workflow instances priority.
SysVar Tag:
{WORKFLOW_PRIORITY}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 31
32
Returns:
The Num Workflow Attachments variable returns the number of objects attached to a workflow instance.
SysVar Tag:
{WORKFLOW_ATTACHMENT_NUM}
Optional Parameters:
A group name can be specified, making the variable return only the number of attached objects in the specified groups.
Contents 32
33
WORKFLOW INITIATOR
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.
Contents 33
34
Returns:
The Workflow Instance Name system variable returns the name of the current workflow instance.
SysVar Tag:
{WORKFLOW_INSTANCE_NAME}
Optional Parameters:
This system variable does not have any Optional Parameters.
Contents 34
35
WORKFLOW STATUS
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.
Contents 35
36
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.
Contents 36
37
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.
Contents 37
38
TERMINATION REASON
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.
Contents 38
39
ALL USERS
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.
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}
Optional Parameters:
This system variables results can be filtered by group using the GroupName=someGroup parameter.
Contents 39
40
SysVar Tag:
{WORKFLOW_ATTACHMENT_GROUP}
Optional Parameters:
This system variable has no optional parameters.
WORKFLOW NAME
Returns:
This system variable returns the name of the current workflow instance.
SysVar Tag:
{WORKFLOW_NAME}
Optional Parameters:
This system variable has no optional parameters.
Contents 40
41
Returns:
The Task Name system variable returns the name of the task that the process is currently on. A user might use this system variable
to configure an eForm specifically to what task is running.
SysVar Tag:
{TASK_NAME}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 41
42
Returns:
This system variable returns the date the current task was assigned.
SysVar Tag:
{TASK_ASSIGN_DATE}
Optional Parameters:
This system variable can be formatted according to date Optional Parameters.
Contents 42
43
TASK INSTRUCTIONS
Returns:
This system variable returns a string containing the instructions for the current task. The results of this system variable can be
displayed on an eForm to instruct the end user.
SysVar Tag:
{TASK_INSTRUCTIONS}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 43
44
Returns:
This system variable returns the date the current task is due.
SysVar Tag:
{TASK_DUE_DATE}
Optional Parameters:
This system variable can be formatted using Optional Parameters available to dates.
Contents 44
45
TASK PRIORITY
Returns:
This system variable returns the priority of the current task.
SysVar Tag:
{TASK_PRIORITY}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 45
46
TASK ON BEHALF OF
Returns:
This system variable returns information about the user who delegated this task to another user. This system variable only returns a
value when the task has been delegated.
SysVar Tag:
{TASK_ON_BEHALF_OF}
Optional Parameters:
This system variable can be formatted according to options available to user results.
Contents 46
47
Returns:
This system variable returns the name of the sub task automatically created when a user is assigned a task in a sequence.
SysVar Tag:
{SUB_TASK_NAME}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 47
48
IN RUNNING TASK?
Returns:
This system variable returns a Boolean value reflecting whether or not the currently logged in user is opening the eForm in the
context of a running task.
SysVar Tag:
{IN_RUNNING_TASK}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 48
49
STEP USERS
Returns:
This system variable returns a comma-separated list of all users involved in a workflow step.
SysVar Tag:
{STEP_USERS:[step name]}
Optional Parameters:
This system variable can be formatted with Optional Parameters available to user results.
Contents 49
50
Returns:
This system variable returns the date the current step is due.
SysVar Tag:
{STEP_DUE_DATE:[step name]}
Optional Parameters:
This system variable can be formatted using options available to date system variables.
Contents 50
51
RUNNING STEP
Returns:
This system variable returns the name of the currently running step.
SysVar Tag:
{STEP_RUNNING_NAME}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 51
52
Returns:
This system variable returns a comma-separated list of users actively involved in this step.
SysVar Tag:
{STEP_USERS_ACTIVE:[step name]}
Optional Parameters:
This system variable can be formatted with options available to user system variables.
Contents 52
53
Returns:
This system variable returns the date that the specified step started.
SysVar Tag:
{STEP_START_DATE:[step name], instance=someInstance}
Optional Parameters:
Datetime Optional Parameters can be used to format this system variable. There is also an optional instance parameter that allows
the user to specify a specific instance of a workflow step to get the start date of.
Contents 53
54
Returns:
This system variable returns the date this step stopped.
SysVar Tag:
{STEP_STOP_DATE:[step name], instance=someInstance}
Optional Parameters:
This system variable can be formatted using the options available to datetime system variables. There is also an optional instance
parameter that allows the user to specify a specific instance of a workflow step to get the start date of.
Contents 54
55
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.
Contents 55
56
Returns:
This system variable returns a Boolean value based on whether the specified step is past its due date. You can use this to
conditionally change the process flow if the step is late.
SysVar Tag:
{STEP_PAST_DUE:[step name]}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 56
57
BRANCH TAKEN
Returns:
This system variable returns a Boolean value based on whether the specified branch has been taken.
SysVar Tag:
{BRANCH_TAKEN:[branch name], instance=[workflow instance]}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 57
58
STEP REACHED
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.
Contents 58
59
Returns:
This system variable returns a comma-separated list of users who have completed the specified step.
SysVar Tag:
{STEP_USERS_COMPLETE}
Optional Parameters:
The result of this system variable can be formatted using the options available to user results.
STEP DESCRIPTION
Returns:
This system variable returns a string containing the description of this workflow step.
SysVar Tag:
{STEP_DESCRIPTION:step}
Optional Parameters:
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.
Contents 59
60
STEP IN ERROR
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 RESULT
Returns:
This system variable returns the result of a specified step instance.
SysVar Tag:
{STEP_RESULT:[step name], instance=[instance id]}
Optional Parameters:
This system variable must specify a particular step instance by using the instance= parameter.
Contents 60
61
STEP STATUS
Returns:
This system variable returns a steps status. It will return either Running, Completed, or Pending. The system variable will only
return Pending if the specified step isnt available or hasnt been run.
SysVar Tag:
{STEP_STATUS:[step name]}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 61
63
Returns:
This system variable returns information about the user currently viewing the eForm.
SysVar Tag:
{CURR_USER}
Optional Parameters:
The result of this system variable can be formatted using the user Optional Parameters.
USER
Contents 63
64
Returns:
This option allows the user to specify a user to be used for comparisons. This is technically not a system variable, but information
about a user can be gathered via SysVar tags by referencing a user picker.
SysVar Tag:
{FORM:someUserPicker}
Optional Parameters:
The result of this SysVar tag can be formatted according to what options are available to form field system variables.
GROUP
Returns:
This system variable allows the user to specify a group to be used in comparisons. Information about a group can be gathered via
SysVar tags by referencing a group picker form field.
SysVar Tag:
{FORM:someGroupPicker}
Optional Parameters:
The result of a group picker reference can be formatted according to the options available to form field system variables.
Contents 64
65
Returns:
This system variable returns the result of a selected Business Rule.
SysVar Tag:
{RULE:[business rule name]}
Optional Parameters:
The result of this system variable can be formatted according to the options available to the type of data the business rule returns.
Contents 65
67
Returns:
This system variable returns information about the user that initiated the running timeline.
SysVar Tag:
{TIMELINE_INITIATOR}
Optional Parameters:
This system variable can be formatted according to the options available to user system variables.
Contents 67
68
TIMELINE STATUS
Returns:
This system variable returns a string representing the status of the current timeline. The result of this system variable will be either
Completed, Running or Pending. This system variable will return Pending when the timeline is unavailable or has never been
run.
SysVar Tag:
{TIMELINE_STATUS}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 68
69
Returns:
This system variable returns the number of items attached to a timeline. You can tell the system variable only to count items within
a certain group.
SysVar Tag:
{TIMELINE_ATTACHMENT_NUM, GroupName=[group name]}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 69
70
Returns:
This system variable returns the name of the running timeline instance.
SysVar Tag:
{TIMELINE_NAME}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 70
71
PRIORITY
Returns:
This system variable returns the priority of the running timeline.
SysVar Tag:
{TIMELINE_PRIORITY}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 71
72
Returns:
This system variable returns the date this timeline instance started.
SysVar Tag:
{TIMELINE_START_DATE}
Optional Parameters:
This system variable can be formatted using the date Optional Parameters.
Contents 72
73
Returns:
This system variable returns the date this timeline instance stopped.
SysVar Tag:
{TIMELINE_STOP_DATE}
Optional Parameters:
This system variable can be formatted using the options available to date system variables.
Contents 73
74
TERMINATION REASON
Returns:
This system variable returns a string containing the reason this timeline instance terminated. If a timeline is not running or has not
been completed, this system variable returns Not Set.
SysVar Tag:
{TIMELINE_TERM_REASON}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 74
75
Returns:
This system variable returns the predicted date that the running timeline instance will complete.
SysVar Tag:
{TIMELINE_STOP_PREDICTED}
Optional Parameters:
This system variable can be formatted using Optional Parameters available to date results.
TIMELINE ATTACHMENTS
Returns:
This system variable returns a comma-separated list of object names attached to this timeline instance.
SysVar Tag:
{TIMELINE_ATTACHMENTS}
Optional Parameters:
The results returned can be filtered by group using the Groupname= option.
Contents 75
76
Contents 76
77
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]}
Optional Parameters:
Contents 77
78
ACTIVITY USERS
Returns:
This system variable returns a comma-separated list of all users involved in the specified activity.
SysVar Tag:
{ACTIVITY_USERS:[activity name]}
Optional Parameters:
This system variable can be formatted according to Optional Parameters available to user system variables.
Contents 78
79
Returns:
This system variable returns the date the specified activity started.
SysVar Tag:
{ACTIVITY_START_DATE:[activity name], instance=someInstance}
Optional Parameters:
This system variable can be formatted using the options available to a date system variable. There is also an optional instance
parameter that allows the user to specify a specific instance of a timeline activity to get the start date of.
Contents 79
80
Returns:
This system variable returns the date the specified activity stopped.
SysVar Tag:
{ACTIVITY_STOP_DATE:[activity name], instance=someInstance}
Optional Parameters:
This system variable can be formatted according to the options available for date results. There is also an optional instance
parameter that allows the user to specify a specific instance of a timeline activity to get the stop date of.
Contents 80
81
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.
Contents 81
82
Returns:
This system variable returns a Boolean value based on whether the specified activity has passed its due date.
SysVar Tag:
{ACIVITY_PAST_DUE}
Optional Parameters:
This system variable has no available Optional Parameters.
Contents 82
83
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.
Contents 83
84
ACTIVITY REACHED
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.
Contents 84
85
Returns:
This system variable returns the date the specified activity is predicted to start.
SysVar Tag:
{ACTIVITY_START_PREDICTED:[activity name]}
Optional Parameters:
The result of this system variable can be formatted as a date.
Contents 85
86
Returns:
This system variable returns the date the specified activity is predicted to stop.
SysVar Tag:
{ACTIVITY_STOP_PREDICTED:[activity name]}
Optional Parameters:
This system variables results can be formatted as a date.
Contents 86
87
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.
Contents 87
88
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.
Contents 88
89
Returns:
This system variable returns the number of times a specified activity has been run in the current timeline instance.
SysVar Tag:
{ACTIVITY_NUM_TIMES_RUN:[activity name]}
Optional Parameters:
This system variable cannot be formatted.
Contents 89
90
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]}
Optional Parameters:
This system variable can be formatted according to the user Optional Parameters.
Contents 90
91
This system variable returns the average amount of time a specified activity usually takes to run.
SysVar Tag:
{ACTIVITY_AVG_RUN_TIME:[activity name], format=[Days|Hours|Minutes|Seconds]}
Optional Parameters:
This system variable can be formatted to return its result in days, hours, minutes, or seconds. By default, this system variable returns
its result in days.
ACTIVITY DESCRIPTION
Returns:
This system variable returns the specified activitys 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 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 RESULT
Returns:
This system variable returns the result of a specified activity instance.
SysVar Tag:
{STEP_RESULT:[activity name], instance=[instance id]}
Optional Parameters:
Contents 91
92
This system variable must specify a particular activity instance by using the instance= parameter.
ACTIVITY STATUS
Returns:
This system variable returns an activitys status. It will return either Running, Completed, or Pending. The system variable will
only return Pending if the activity isnt available or hasnt been run.
SysVar Tag:
{ACTIVITY_STATUS:[activity name]}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 92
93
Contents 93
95
Returns:
This system variable returns the name of the current process instance.
SysVar Tag:
{PROCESS_NAME}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 95
96
PROCESS INITIATOR
Returns:
This system variable returns information about the user that initiated this instance of a process.
SysVar Tag:
{PROCESS_INITIATOR}
Optional Parameters:
This system variable can be formatted according to Optional Parameters available to user results.
Contents 96
97
PROCESS STATUS
Returns:
This system variable returns the status of the current process. This system variable can return Completed, Running, or
Pending. This system variable will return Pending when the process is unavailable or has never been run.
SysVar Tag:
{PROCESS_STATUS}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 97
98
PROCESS PRIORITY
Returns:
This system variable returns the priority of the current process.
SysVar Tag:
{PROCESS_PRIORITY}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 98
99
Returns:
This system variable returns the date this process instance started.
SysVar Tag:
{PROCESS_START_DATE}
Optional Parameters:
This system variables result can be formatted as a date.
Contents 99
100
Returns:
This system variable returns the date the process instance ended.
SysVar Tag:
{PROCESS_STOP_DATE}
Optional Parameters:
This system variables results can be formatted as a date.
Contents 100
101
TERMINATION REASON
Returns:
This system variable returns the reason a process instance terminated. You can use this system variable to handle unexpected
process errors.
SysVar Tag:
{PROCESS_TERM_REASON}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 101
102
RUNNING USERS
Returns:
This system variable returns a comma-separated list of all users actively involved in the current process instance.
SysVar Tag:
{PROCESS_TASK_USERS_ACTIVE}
Optional Parameters:
This system variable can be formatted using Optional Parameters available to user results.
IS SUB-PROCESS?
Returns:
This system variable returns a Boolean (yes/no) value reflecting whether this process is a sub-process of another process.
SysVar Tag:
{IS_SUBPROCESS}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 102
103
PROCESS IN ERROR
Returns:
This system variable returns the name of a process task thats in an error state.
SysVar Tag:
{PROCESS_IN_ERROR}
Optional Parameters:
This system variable cannot be formatted.
PROCESS INSTANCE ID
Returns:
This system variable returns the ID of the current process.
SysVar Tag:
{PROCESS_INSTANCE_ID}
Optional Parameters:
This system variable has no optional parameters.
PROCESS MESSAGE
Returns:
This system variable returns a process tasks message. If there is none, it returns the date the process started.
SysVar Tag:
Contents 103
104
{PROCESS_MESSAGE}
Optional Parameters:
This system variable cannot be formatted.
Contents 104
105
Returns:
This option allows the user to specify a datetime from a datetime picker. While not technically a system variable, information about
a date can be gathered via SysVar tags by referencing a date picker.
SysVar Tag:
{FORM:someDateTimePicker}
Optional Parameters:
The result of this form field SysVar tag can be formatted according to the options available for form field SysVar tags.
CURRENT DATE
Returns:
This system variable returns the date at the moment this system variable is being referenced.
SysVar Tag:
{CURR_DATE}
{CURR_DATETIME} (for the time as well)
Contents 105
106
DAYS AGO
Returns:
This system variable returns a date a specific number of days before the date that this system variable is referenced.
SysVar Tag:
{CURR_DATE, days=-[number of days ago]}
Optional Parameters:
This system variable can be formatted according to the options available to datetime system variables.
Returns:
This system variable returns a date a specific number of days after the date that this system variable is referenced.
SysVar Tag:
{CURR_DATE, days=-[number of days from now]}
Optional Parameters:
This system variable can be formatted as a datetime system variable.
Contents 106
107
Contents 107
109
EMAIL USER
Returns:
This system variable returns the user the task is assigned to.
SysVar Tag:
{EMAIL_USER}
Optional Parameters:
This system variable can be formatted as a user system variable.
Contents 109
110
Optional Parameters:
CompletePage: the full URL of the page to navigate to after the task is completed.
CompletePagePrompt: set to 0 to prevent a confirmation prompt from displaying
CompleteText: text to display after the task is completed
NoHome: set to 1 to prevent the home page from displaying when the task link is clicked.
EMAIL TASK ID
Returns:
Replaced with a tag indicating the task list used to send this email.
SysVar Tag:
{EMAIL_TASK_ID}
Optional Parameters:
There are no optional parameters for this system variable.
Contents 110
111
This variable returns a list of the potential branches or activity results from this task.
SysVar Tag:
{EMAIL_RESULT_LIST}
Optional Parameters:
The user can specify a character to separate each result in the list.
Contents 111
113
CUSTOM VARIABLE
Returns:
This system variable returns the value of a specified variable defined in the vars.cs.ascx file.
SysVar Tag:
{CustomVar:someVariableName}
Optional Parameters:
This system variable does not have optional parameters.
DATE DIFFERENCE
Returns:
This system variable returns the difference between two datetimes.
SysVar Tag:
{DATEDIFF DATE1=[first date] DATE2=[second date]
TYPE=[YEARS|MONTHS|DAYS|MINUTES|SECONDS|BUSINESS_DAYS|BUSINESS_HOURS}
Optional Parameters:
Contents 113
114
Using the Type= parameter, this system variable can return the difference in years, months, days, minutes, seconds business days, or
business hours.
DEBUG_MODE
Returns:
This system variable returns a Boolean (yes/no) value reflecting whether debug mode is current on or off.
SysVar Tag:
{DEBUG_MODE}
Optional Parameters:
This system variable does not have Optional Parameters.
INTERFACE URL
Returns:
This system variable returns the URL of the interface of the system configurations.
SysVar Tag:
{INTERFACE_URL}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 114
115
LOGO URL
Returns:
This system variable returns the URL of the system logo image.
SysVar Tag:
{LOGO_URL}
Optional Parameters:
There are no Optional Parameters for this system variable.
ROW NEXT
Returns:
The Row Next system variable returns the number of the next row in an array.
SysVar Tag:
{ROW_NEXT}
Optional Parameters:
This system variable does not have Optional Parameters
ROW NUM
Returns:
The Row Num system variable returns the number of the array row containing this system variable.
SysVar Tag:
{ROW_NUM}
Optional Parameters:
This system variable does not have Optional Parameters.
ROW PREV
Returns:
The Row Prev system variable returns the number of the previous row in an array.
Contents 115
116
SysVar Tag:
{ROW_PREV}
Optional Parameters:
This system variable does not have Optional Parameters.
SERVER CULTURE
Returns:
This system variable returns the servers configured culture.
SysVar Tag:
{SERVER_CULTURE, format=[name]}
Optional Parameters:
If the format=name option is used, this system variable returns the culture name. Otherwise, it returns the culture code.
SERVER NAME
Returns:
This system variable returns the name of the server.
SysVar Tag:
{SERVER_NAME}
Optional Parameters:
This system variable does not have optional parameters.
SERVER VERSION
This system variable returns the servers version.
SysVar Tag:
{SERVER_VERSION, format=[string]}
Optional Parameters:
Using the format=String Optional Parameters returns a string containing the servers version. Otherwise, this system variable returns
the version number.
SESSION
Returns:
The session system variable returns the session variable for the current user.
SysVar Tag:
{SESSION}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 116
117
SEQUEL PERMISSION
Returns:
This system variable returns information about a permission. It can be used to verify that a user has a certain permission for a
certain object. The ID of the relevant object is passed via the ID parameter, the User ID of the user is passed through the UserID
parameter, and the type of permission being queried is passed through the PermType parameter.
SysVar Tag:
{SQL_PERM, ID=[object ID], UserID=[Users User ID], PermType=[VIEW|MODIFY|DELETE|RUN]}
Optional Parameters:
This system variable does not have Optional Parameters.
SEQUENCE NUMBER
Returns:
This system variable returns a value that increments every time the system variable is referenced.
SysVar Tag:
{SEQ_NUM}
Optional Parameters:
This system variable can be formatted using the Digits= parameter. You can specify the number of digits that this number should
display with.
STRING
Returns:
The String system variable returns the value of a localized string in the relevant resource file. The localized string is referenced by its
name in the resource file.
SysVar Tag:
{STRING:string_name, type=[Internal|Custom]}
Optional Parameters:
This system variable has a formatting option called type. This can be set either to internal or custom. If set to internal, the
string will reference a Process Director-defined string, whereas when type is set to custom, it will reference a string defined by the
user in a resource file.
Contents 117
118
Returns:
This option will allow the user to specify a string to be used in a comparison. It is not technically a system variable.
SUM
Returns:
This system variable returns the numerical sum of all the fields in a column of an array.
SysVar Tag:
{SUM, Columns=[name of field in an array]}
Optional Parameters:
This system variable does not have Optional Parameters.
Contents 118
119
Contents 119
INDEX
121
E
A
ACTIVE ACTIVITY USERS 77
ACTIVE STEP USERS 52
ACTIVITY AVERAGE RUN TIME 90
ACTIVITY DESCRIPTION 91
ACTIVITY DUE DATE 81
ACTIVITY IN ERROR 91
ACTIVITY MESSAGE 91
ACTIVITY REACHED 84
ACTIVITY RESULT 91
ACTIVITY RUN TIME 92
ACTIVITY START DATE 79
ACTIVITY START DATE PREDICTED 85
ACTIVITY STATUS 92
ACTIVITY STOP DATE 80
ACTIVITY STOP DATE - PREDICTED 86
ACTIVITY TERMINATION REASON 92
ACTIVITY TOP RUNNING NAME 92
ACTIVITY USERS 78
ACTIVITY USERS COMPLETE 93
All System Variables 5
ALL USERS 39
ATTRIBUTE 20
F
FOLDER PATH 29
FORM ATTACHMENT GROUP 17
FORM ATTACHMENTS 16
FORM EVENT NAME 15
FORM EVENT TYPE 14
FORM FIELD 7
Form Field System Variables 2
FORM INSTANCE ID 16
FORM PRINTING 12
FORM SUBMITTER 9
Form System Variables 7
BRANCH TAKEN 57
Business Rule System Variables 65
BUSINESS RULES 65
GROUP 64
Group Parameter 5
CALC 113
CATEGORY 19
COMPLETED ACTIVITY USERS 90
COMPLETED STEP USERS 59
CONVERTING TO PDF 13
CREATE DATE 26
CREATE USER 24
CURRENT DATE 105
CURRENT USER 63
CURRENT USER GROUPS 113
CUSTOM VARIABLE 113
IN RUNNING TASK? 48
INTERFACE URL 114
IS ACTIVITY PAST DUE? 82
IS ON MOBILE DEVICE? 16
IS PREDICTED TO END LATE? 88
IS PREDICTED TO START LATE? 87
IS STEP PAST DUE? 56
IS SUB-PROCESS? 102
D
DATE 105
DATE DIFFERENCE 113
DateTime System Variables 105
Datetime System Variables: 3
K
KNOWLEDGE VIEW DEFINITION NAME 114
KNOWLEDGE VIEW FILTER DATA 115
KNOWLEDGE VIEW NUMBER OF ROWS 114
L
LOGO URL 115
Contents 121
M
Meta Data System Variables 19
N
NAME 21
NEW FORM INSTANCE 8
NUM FORM ATTACHMENTS 11
NUM TIMELINE ATTACHMENTS 69
NUM TIMES ACTIVITY RUN 89
NUM TIMES STEP RUN 55
NUM WORKFLOW ATTACHMENTS 32
O
OBJECT ID 29
Object Information System Variables 21
OBJECT TYPE 30
Other System Variables 113
122
SIZE 23
STEP DESCRIPTION 59
STEP DUE DATE 50
STEP IN ERROR 60
STEP INSTANCE ID 60
STEP MESSAGE 60
STEP REACHED 58
STEP RESULT 60
STEP RESULT COUNT 60
STEP RUN TIME 61
STEP START DATE 53
STEP STATUS 61
STEP STOP DATE 54
STEP TERMINATION REASON 61
STEP USERS 49
STRING 117
STRING (Right-Hand Side Menu) 118
SUB TASK NAME 47, 104
SUBMIT DATE 10
SUM 118
System Variable Parameters 2
P
Pre, Post, and Null 6
PRIORITY 31, 71
PROCESS ATTACHMENT GROUP 103
PROCESS DEFINITION NAME 103
PROCESS IN ERROR 103
PROCESS INITIATOR 96
PROCESS INSTANCE ID 103
PROCESS INSTANCE NAME 95
PROCESS MESSAGE 103
PROCESS PRIORITY 98
PROCESS START DATE 99
PROCESS STATUS 97
PROCESS STOP DATE 100
Process System Variables 95
PROCESS TASK DUE DATE 104
PROCESS TASK RUNNING 104
PROCESS TASK START DATE Returns: 104
R
ROW NEXT 115
ROW NUM 115
ROW PREV 115
RUNNING ACTIVITY NAME 83
RUNNING STEP 51
RUNNING USERS 102
S
SEQUEL PERMISSION 117
SEQUENCE NUMBER 117
SERVER CULTURE 116
SERVER NAME 116
SERVER VERSION 116
SESSION 116
T
TASK ASSIGN DATE 42
TASK DUE DATE 44
TASK INSTRUCTIONS 43
TASK NAME 41
TASK ON BEHALF OF 46
TASK PRIORITY 45
Task System Variables 41
TERMINATION REASON 38, 74, 101
Timeline Activity System Variables 77
TIMELINE ATTACHMENT GROUP 76
TIMELINE ATTACHMENTS 75
TIMELINE AVERAGE RUN TIME 74
TIMELINE CONFIGURED STOP DATE 76
TIMELINE DEFINITION NAME 76
TIMELINE INITIATOR 67
TIMELINE INSTANCE NAME 70
TIMELINE START DATE 72
TIMELINE STATUS 68
TIMELINE STOP DATE 73
TIMELINE STOP DATE PREDICTED 75
Timeline System Variables 67
U
UPDATE DATE 27
UPDATE USER 25
USER 63
User System Variables 2, 63
V
VERSION 28
Contents 122
123
W
WORKFLOW ATTACHMENT GROUP 39
WORKFLOW ATTACHMENTS 39
WORKFLOW DEFINITION NAME 40
WORKFLOW INITIATOR 33
WORKFLOW INSTANCE NAME 34
WORKFLOW NAME 40
WORKFLOW RUN TIME 40
WORKFLOW START DATE 36
WORKFLOW STATUS 35
Workflow Step System Variables 49
WORKFLOW STOP DATE 37
Workflow System Variables 31
Contents 123