What Process Data Variables Can I Use in an Application?

Activity Display Name

Function:

The name of the activity that shows in your process.

Common Usage:

In an activity reminder email to specify the name of the activity that has been assigned to a participant.

Limitations:

• Specific to human task activities.

Activity Name

Function:

The name of the activity shown in your process model.

Common Usage:

In an activity reminder email to specify the name of the activity that has been assigned to a participant.

Limitations:

• Specific to human task activities.

Activity Participant Full Names

Function:

The full names of the activity's participants.

Common Usage:

In the body of an email template to show the full names of the activity's participants.

Limitations:

• Specific to human task activities.

Activity Participant User Names

Function:

The user names of the activity's participants.

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

Limitations:

• Specific to human task activities.

App Display Name

Function:

The name of an app that shows in AgilePoint NX.

Common Usage:

In an eForm to show the display name of the app.

Current Date

Function:

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 runtime app user's device.
• 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.

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:

• (Example) Create Zoom Meeting

Delegated User Full Name

Function:

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

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

Function:

The user names to whom the task is delegated.

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

Function:

The path for which AgilePoint Server is installed.

Common Usage:

In the Attachments field of an email 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 calendar.

Common Usage:

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:

In an email 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:

In an eForm to show the display name of the process model.

Process ID

Function:

The unique ID of a process.

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

Function:

The user who initiated the process.

Common Usage:

• In the To field of an email template to send an activity completion email notification to the person who initiated the process, letting them know that the process is complete.
• In the participant property of a human task activity.

Example:

Refer to:

• (Example) Configure an Email Activity (Notify Requester If Requested Hours Not Available)
• (Example) Configure an Email Activity (Notify Requester - On Manager Approval)
• (Example) Configure an Email Activity (Notify Requester - On Manager Rejection)
• (Example) Configure the Update Process Data Activity

Process Initiator Location

Function:

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

Common Usage:

In the body of an email template to specify the IP address of the process initiator.

Process Name

Function:

Name of the activity.

Common Usage:

In an email 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:

In the body of an email template to show the full names of the process participants.

Process Participant User Names

Function:

The user names of the process's participants.

Common Usage:

In the To field of an email template to send an e-mail notification to the process's participants letting them know there has been a change in the process.

Limitations:

• Specific to human task activities.

Process Started Date

Function:

The start date of the process.

Common Usage:

In the body of an email template to show the date for which the process started.

Process Model Name

Function:

The name of the process model.

Common Usage:

In the body of an email 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:

Attach the process model report file in an email template.

Process Model Version

Function:

The version of the process.

Common Usage:

In the body of an email 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).

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 e-mail template.

Source Task Participant User Name

Function:

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

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:

• Specific to human task activities.

System User Email Address

Function:

The e-mail address of the system user.

Common Usage:

In the From, To, and CC fields of an email template.

System User Name

Function:

The name of the system user.

Common Usage:

In the body of an email template to show the name of the system user.

Task Assigned Date

Function:

The date the task was assigned.

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

Function:

The due date of the task.

Common Usage:

In an incoming or activity overdue email notifying a participant of the date for which a task is due.

Task ID

Function:

The unique task ID.

Common Usage:

In an e-mail template associated with an activity initiation email to specify the unique ID of the task that has been assigned. See Session.

Limitations:

• In email templates associated with an activity initiation email.

Task Name

Function:

The name of the task.

Common Usage:

In an e-mail template associated with an activity initiation e-mail to specify the name of the task that has been assigned.

Limitations:

• In email templates associated with an activity initiation email.

Task Participant Full Name

Function:

The full name of the task's participant.

Common Usage:

In the body of an email 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:

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 e-mail will be sent, and none of the participants will receive duplicate copies of the e-mail.

User Manager Email ID

Function:

The e-mail address of the user's manager.

Common Usage:

In the From, To, and CC fields of an email template.

Doc Lib Path (SharePoint Only)

Function:

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

Common Usage:

In an email template when specifying the path to a document library in your SharePoint Portal Server.

Doc Name (SharePoint Only)

Function:

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

Common Usage:

In an email template when specifying the name of an InfoPath form.

Doc URL (SharePoint Only)

Function:

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

Common Usage:

In an email 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:

In an email 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:

In an email template to specify the URL of a folder on your SharePoint Portal server machine.

List ID (SharePoint Only)

Function:

The unique ID of the list in SharePoint.

Common Usage:

In an email 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:

In an email template to specify a list item to change.

Site ID (SharePoint Only)

Function:

The unique ID of the site in SharePoint.

Common Usage:

In an email template to specify the site in SharePoint.

Site Path (SharePoint Only)

Function:

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

Common Usage:

In an email 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:

In an email template when specifying the path to a document library in SharePoint.

SharePoint Server (SharePoint Only)

Function:

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

Common Usage:

In body of an email 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:

In an email 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.