What Process Data Variables Can I Use in an Application?

When you configure a process activity or an form control, the Process Data > System Data tab gives System data variables are the variables that come out of the box (OOTB) for you to use in your apps.

You can also create new process data variables. For more information, refer to Add Variable screen.


Process Data Syatem Data tab

How to Start

  1. Do one of these:
  2. On the configuration screen, click the App Data tab.
  3. On the App Data tab, click System Data.

Fields

Field NameDefinition

Activity Display Name
Description:
The name of the activity that shows in your process.
Syntax:
${ActivityDisplayName}
Common Usage:
In an activity reminder email to specify the name of the activity that has been assigned to a participant.
Limitations:

Activity Name
Description:
The name of the activity shown in your process model.
Syntax:
${ActivityName}
Common Usage:
In an activity reminder email to specify the name of the activity that has been assigned to a participant.
Limitations:

Activity Participant Full Names
Description:
The full names of the activity's participants.
Syntax:
${ActivityParticipantFullNames}
Common Usage:
In the body of an email template to show the full names of the activity's participants.
Limitations:

Activity Participant User Names
Description:
The user names of the activity's participants.
Syntax:
${ActivityParticipantUserNames}
Common Usage:
In the body of an email template to show the system names of the activity's participants. The ActivityParticipantUserNames attribute uses a comma as the string's delimiter. Since the To and CC fields of an email template only recognize semicolon as the delimiter for specifying multiple recipients, the ActivityParticipantUserNames macro cannot currently be used in the To or CC field of an email template when there are multiple participants for the activity.
Limitations:

App Display Name
Description:
The name of an app that shows in AgilePoint NX.
Syntax:
${ApplicationDisplayName}
Common Usage:
In an eForm to show the display name of the app.

Current Date
Description:
The date and time at runtime.
  • If this variable is used to display data on an eForm, it will show the date and time when the eForm opens on the device of the runtime app user.
  • If this variable is used to submit data in a process activity or form control, the value represents the date and time the form or process activity executes.
Syntax:
${CurrentDate}
Common Usage:
  • Update date fields in an InfoPath form or to set date fields in a database.
  • Show a date anywhere in an app.
Example:
Refer to:

Delegated User Full Name
Description:
The full name of the runtime app user to whom the task is delegated.
Syntax:
${DelegatedUserFullName}
Common Usage:
In the body of an activity reassignment email to show the full names of the users to whom the task is delegated.

Delegated User Name
Description:
The user names to whom the task is delegated.
Syntax:
${DelegatedUserName}
Common Usage:
In the body of an activity reassignment email to show the system names of the users to whom the task is delegated.

Home Directory
Description:
The path for which AgilePoint Server is installed.
Syntax:
${HomeDirectory}
Common Usage:
In the Attachments field of an email template to construct a path to files on the AgilePoint Server.

Is Business Hour
Description:
Returns true if a time is within the organization's business hours, and false if the time is not within business hours, as specified in the work calendar.
Syntax:
${IsBusinessHour}
Common Usage:
In a hidden form field to make sure that the form is submitted during business hours.

Parent Process ID
Description:
The unique ID of the parent process.
Syntax:
${ParentProcessID}
Common Usage:
In an email template to notify the administrator user that there is an error in the parent process.

Process Model Display Name
Description:
The name of the process model that shows in AgilePoint NX.
Syntax:
${ProcessModelDisplayName}
Common Usage:
In an eForm to show the display name of the process model.

Process ID
Description:
The unique ID of a process.
Syntax:
${ProcessID}
Common Usage:
In the body of an email template to provide the administrator user with the identification code assigned to the process instance.

Process Initiator
Description:
The runtime app user who initiated the process.
Syntax:
${ProcessInitiator}
Common Usage:
Example:
Refer to:

Process Initiator Location
Description:
The location (IP address) of the runtime app user who initiated the process.
Syntax:
${ProcessInitiatorLocation}
Common Usage:
In the body of an email template to specify the IP address of the process initiator.

Process Name
Description:
Name of the activity.
Syntax:
${ProcessName}
Common Usage:

An email template to show the name of the process model.

Process Participant Full Names
Description:
The full names of the participants for the process.
Syntax:
${ProcessParticipantFullNames}
Common Usage:
In the body of an email template to show the full names of the process participants.

Process Participant User Names
Description:
The user names of the participants for the process.
Syntax:
${ProcessParticipantUserNames}
Common Usage:
In the To field of an email template to send an email notification to the participants of the process letting them know there has been a change in the process.
Limitations:

Process Started Date
Description:
The start date of the process.
Syntax:
${ProcessStartedDate}
Common Usage:
In the body of an email template to show the date for which the process started.

Process Model Name
Description:

The name of the process model

.
Syntax:
${ProcessModelName}
Common Usage:
In the body of an email template when referring to the name of the process model.

Process Model Report File
Description:

The name of the report associated with a process model

.
Syntax:
${ProcessModelReportFile}
Common Usage:
Attach the process model report file in an email template.

Process Model Version
Description:

The version of the process model

.
Syntax:
${ProcessModelVersion}
Common Usage:
In the body of an email template to specify the version of the process model.

Source Task Participant Full Name
Description:
The full name of the task's participant associated with the original task (i.e. reassigned).
Syntax:
${SourceTaskParticipantFullName}
Common Usage:
Update date fields in an InfoPath form or to set date fields in a database.
Limitations:
  • Specific to human task activities.
  • This variable is not supported in the To, CC, BCC, or From fields of an email template.

Source Task Participant User Name
Description:
The user name of the task's participant for the original task (i.e. reassigned).
Syntax:
${SourceTaskParticipantUserName}
Common Usage:
In the To field of an email template to send an activity reassignment email to the activity's participants letting them know an activity has been assigned to them.
Limitations:

System User Email Address
Description:
The email address of the AgilePoint Service Account.
Syntax:
${SystemUserEmailAddress}
Common Usage:
In the From, To, and CC fields of an email template.

System User Name
Description:
The name of the AgilePoint Service Account.
Syntax:
${SystemUserName}
Common Usage:
In the body of an email template to show the name of the AgilePoint Service Account.

Task Assigned Date
Description:
The date the task was assigned.
Syntax:
${TaskAssignedDate}
Common Usage:
In an incoming or activity completion email notifying a participant of the date for which a task has been assigned.

Task Due Date
Description:
The due date of the task.
Syntax:
${TaskDueDate}
Common Usage:
In an incoming or activity overdue email notifying a participant of the date for which a task is due.

Task ID
Description:
The unique task ID.
Syntax:
${TaskID}
Common Usage:
In an email template associated with an activity initiation email to specify the unique ID of the task that has been assigned. See Session.
Limitations:

Task Name
Description:
The name of the task.
Syntax:
${TaskName}
Common Usage:
In an email template associated with an activity initiation email to specify the name of the task that has been assigned.
Limitations:

Task Participant Full Name
Description:
The full name of the task's participant.
Syntax:
${TaskParticipantFullName}
Common Usage:
In the body of an email template to show the full names of the task's participants.

Task Participant User Name
Description:
The user name of the participant of the task.
Syntax:
${TaskParticipantUserName}
Common Usage:
In the To field of an email template to send a activity reassignment email to the task's participants letting them know a task has been re-assigned. If you use the ${TaskParticipantUserName} process data variable in the To field instead of specifying the entire list of participants in the To field, then for each participant, a separate email will be sent, and none of the participants will receive duplicate copies of the email.

User Manager Email ID
Description:
The email address of the user's manager.
Syntax:
${UserManagerEmailID}
Common Usage:
In the From, To, and CC fields of an email template.

Doc Lib Path (SharePoint Only)
Description:
The relative path of the document library (e.g. Testemail).
Syntax:
${DocLibPath}
Common Usage:
In an email template when specifying the path to a document library in your SharePoint Portal Server.

Doc Name (SharePoint Only)
Description:
The name of the document (e.g. Testemail-2005-0036.xml).
Syntax:
${DocName}
Common Usage:
In an email template when specifying the name of an InfoPath form.

Doc URL (SharePoint Only)
Description:
The full document path (e.g. http://pearl:8084/sites/AgilePointFinancialSite/Testemail/Testemail-2005-0036.xml).
Syntax:
${DocURL}
Common Usage:
In an email template when specifying the path to a document on your SharePoint server.

Folder Path (SharePoint Only)
Description:
The relative path to a folder on your SharePoint site.
Syntax:
${FolderPath}
Common Usage:
In an email template to specify the path to a folder in your SharePoint server.

Folder URL (SharePoint Only)
Description:
The relative path of the folder (e.g. /sites/AgilePointFinancialsFolder).
Syntax:
${FolderURL}
Common Usage:
In an email template to specify the URL of a folder on your SharePoint Portal server machine.

List ID (SharePoint Only)
Description:
The unique ID of the list in SharePoint.
Syntax:
${ListID}
Common Usage:
In an email template to specify the list in your SharePoint site.

List Item ID (SharePoint Only)
Description:
The unique ID of the list item in SharePoint.
Syntax:
${ListItemID}
Common Usage:
In an email template to specify a list item to change.

Site ID (SharePoint Only)
Description:
The unique ID of the site in SharePoint.
Syntax:
${SiteID}
Common Usage:
In an email template to specify the site in SharePoint.

Site Path (SharePoint Only)
Description:
The relative path of the site (e.g. /sites/AgilePointFinancialSite).
Syntax:
${SitePath}
Common Usage:
In an email template when specifying the path to a document library in SharePoint.

Subsite Path (SharePoint Only)
Description:

The relative path of the SharePoint subsite — for example, /sites/subsite/AgilePointFinancialSite.

Syntax:
${SubSitePath}
Common Usage:
In an email template when specifying the path to a document library in SharePoint.

SharePoint Server (SharePoint Only)
Description:
The SharePoint URL (e.g. http://pearl:8084).
Syntax:
${SPServer}
Common Usage:
In body of an email template to build a link to an item on your SharePoint server.

Web ID (SharePoint Only)
Description:
The unique ID of a SharePoint web address.
Syntax:
${WebID}
Common Usage:
In an email template to specify the SharePoint web address.

Unique 32 Bit ID
Description:
A unique, 32-bit alphanumeric string in GUID format. Under certain conditions, a GUID can be created when a process runs.
Syntax:
${Unique32BitID}
Common Usage:
You can use a GUID in a form control that accepts text input.