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 the process data variables that come out of the box (OOTB) for you to use in your application.

You can also create new process data variables. For more information, refer to Create a Shared Variable.



How to Start

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

Fields

Field Name Definition

Activity Display Name

Function:
The name of the activity that shows in your process.

Specific to human task activities.

Common Usage: Can be used in an activity reminder e-mail to specify the name of the activity that has been assigned to a participant.

Activity Name

Function:
The name of the activity shown in your process model.

Specific to human task activities.

Common Usage: Can be used in an activity reminder e-mail to specify the name of the activity that has been assigned to a participant.

Activity Participant Full Names

Function:
The full names of the activity's participants.

Specific to human task activities.

Common Usage: Can be used in the body of an e-mail template to show the full names of the activity's participants.

Activity Participant User Names

Function:
The user names of the activity's participants.

Specific to human task activities.

Common Usage: Can be used in the body of an e-mail 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 e-mail 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 e-mail template when there are multiple participants for the activity.

Application Display Name

Function:
The name of an application that shows in AgilePoint NX.

Common Usage: Can be used in an eForm to show the display name of the application.

Current Date

Function:
The current date.

Common Usage: Can be used to update date fields in an InfoPath form or to set date fields in a database. It can also be used anywhere that you want the date to be shown.

Delegated User Full Name

Function:
The full name of the user to whom the task is delegated.

Common Usage: Can be used in the body of an activity reassignment e-mail to show the full names of the users to whom the task is delegated to.

Delegated UserName

Function:
The user names to whom the task is delegated.

Common Usage: Can be used in the body of an activity reassignment e-mail to show the system names of the users to whom the task is delegated.

Home Directory

Function:
The path for which AgilePoint Server is installed.

Common Usage: Can be used in the Attachments field of an e-mail template to construct a path to files on the AgilePoint Server.

Is Business Hour

Function:
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 calender.

Common Usage: Can be used in a hidden form field to make sure that the form is submitted during business hours..

Parent Process ID

Function:
The unique ID of the parent process.

Common Usage: Can be used in an e-mail template to notify the administrator user that there is an error in the parent process.

Process Model Display Name

Function:
The name of the process model that shows in AgilePoint NX.

Common Usage: Can be used in an eForm to show the display name of the process model.

Process ID

Function:
The unique ID of a process.

Common Usage: Can be used in the body of an e-mail template to provide the administrator user with the identification code assigned to the process instance.

Process Initiator

Function:
The user who initiated the process.

Common Usage: Can be used in the To field of an e-mail template to send an activity completion e-mail notification to the person who initiated the process, letting them know that the process is complete. It can also be used in the participant property of a human task activity.

Process Initiator Location

Function:
The location (IP address) of the user who initiated the process.

Common Usage: Can be used in the body of an e-mail template to specify the IP address of the process initiator.

Process Name

Function:
Name of the activity.

Common Usage: Can be used in an e-mail template to notify the administrator user that there is an error in a specific instance of a process.

Process Participant Full Names

Function:
The full names of the process's participants.

Common Usage: Can be used in the body of an e-mail template to show the full names of the process participants.

Process Participant User Names

Function:
The user names of the process's participants.

Specific to human task activities.

Common Usage: Can be used in the To field of an e-mail template to send an e-mail notification to the process's participants letting them know there has been a change in the process.

Process Started Date

Function:
The start date of the process.

Common Usage: Can be used in the body of an e-mail template to show the date for which the process started.

Process Model Name

Function:
The name of the process model.

Common Usage: Can be used in the body of an e-mail template when referring to the name of the process model.

Process Model Report File

Function:
The name of the report associated with a process.

Common Usage: Can be used to attach the process model report file in an e-mail template.

Process Model Version

Function:
The version of the process.

Common Usage: Can be used in the body of an e-mail template to specify the version of the process model.

Source Task Participant Full Name

Function:
The full name of the task's participant associated with the original task (i.e. reassigned).

Specific to human task activities.

Common Usage: Can be used in the body of an e-mail template to show the full names of the task's participants. This variable is not supported in the To, CC, BCC, or From fields of an e-mail template.

Source Task Participant User Name

Function:
The user name of the task's participant for the original task (i.e. reassigned).

Specific to human task activities.

Common Usage: Can be used in the To field of an e-mail template to send an activity reassignment e-mail to the activity's participants letting them know an activity has been assigned to them.

System User E-mail Address

Function:
The e-mail address of the system user.

Common Usage: Can be used in the From, To, and CC fields of an e-mail template.

System User Name

Function:
The name of the system user.

Common Usage: Can be used in the body of an e-mail template to show the name of the system user.

Task Assigned Date

Function:
The date the task was assigned.

Common Usage: Can be used in an incoming or activity completion e-mail notifying a participant of the date for which a task has been assigned.

Task Due Date

Function:
The due date of the task.

Common Usage: Can be used in an incoming or activity overdue e-mail notifying a participant of the date for which a task is due.

Task ID

Function:
The unique task ID.

Can only be used in e-mail templates associated with activity initiation e-mail.

Common Usage: Can be used in an e-mail template associated with an activity initiation e-mail to specify the unique ID of the task that has been assigned. See Session.

Task Name

Function:
The name of the task.

Can only be used in e-mail templates associated with activity initiation e-mail.

Common Usage: Can be used in an e-mail template associated with an activity initiation e-mail to specify the name of the task that has been assigned.

Task Participant Full Name

Function:
The full name of the task's participant.

Common Usage: Can be used in the body of an e-mail template to show the full names of the task's participants.

Task Participant User Name

Function:
The user name of the task's participant.

Common Usage: Can be used in the To field of an e-mail template to send a activity reassignment e-mail 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 e-mail will be sent, and none of the participants will receive duplicate copies of the e-mail.

User Manager E-mail ID

Function:
The e-mail address of the process initiator's manager.

Common Usage: Can be used in the From, To, and CC fields of an e-mail template.

DocLibPath (SharePoint Only)

Function:
The relative path of the document library (e.g. Testemail).

Common Usage: Can be used in an e-mail template when specifying the path to a document library in your SharePoint Portal Server.

DocName (SharePoint Only)

Function:
The name of the document (e.g. Testemail-2005-0036.xml).

Common Usage: Can be used in an e-mail template when specifying the name of an InfoPath form.

DocUrl (SharePoint Only)

Function:
The full document path (e.g. http://pearl:8084/sites/AgilePointFinancialSite/Testemail/Testemail-2005-0036.xml).

Common Usage: Can be used in an e-mail template when specifying the path to a document on your SharePoint server.

Folder Path (SharePoint Only)

Function:
The relative path to a folder on your SharePoint site.

Common Usage: Can be used in an e-mail template to specify the path to a folder in your SharePoint server.

Folder URL (SharePoint Only)

Function:
The relative path of the folder (e.g. /sites/AgilePointFinancialsFolder).

Common Usage: Can be used in an e-mail template to specify the URL of a folder in your SharePoint Portal Server.

List ID (SharePoint Only)

Function:
The unique ID of the list in SharePoint.

Common Usage: Can be used in an e-mail template to specify the list in your SharePoint site.

List Item ID (SharePoint Only)

Function:
The unique ID of the list item in SharePoint.

Common Usage: Can be used in an e-mail template to specify a list item to change.

Site ID (SharePoint Only)

Function:
The unique ID of the site in SharePoint.

Common Usage: Can be used in an e-mail template to specify the site in SharePoint.

Site Path (SharePoint Only)

Function:
The relative path of the site (e.g. /sites/AgilePointFinancialSite).

Common Usage: Can be used in an e-mail template when specifying the path to a document library in SharePoint.

Subsite Path (SharePoint Only)

Function:

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

Common Usage: Can be used in an e-mail template when specifying the path to a document library in SharePoint.

SPServer (SharePoint Only)

Function:
The SharePoint URL (e.g. http://pearl:8084).

Common Usage: Can be used in body of an e-mail template to build a link to an item on your SharePoint server.

Web ID (SharePoint Only)

Function:
The unique ID of a SharePoint web address.

Common Usage: Can be used in an e-mail template to specify the SharePoint web address.

Unique 32 Bit ID

Function:
A unique, 32-bit alphanumeric string in GUID format. Under certain conditions, a GUID can be created when a process runs.

Common Usage: You can use a GUID in a form control that accepts text input.

Related Topics