Common Process Attributes

This topic provides a list of common process attributes for AgilePoint.

Name Description
ActivityName

Name of the activity.

Specific to manual activities.

Common Usage: Can be used in an email template to specify the name of the activity that has been assigned to a participant.

ActivityParticipantFullNames

The full names of the activity's participants.

Specific to manual activities.

Common Usage: Can be used in the body of an email template to display the full names of the activity's participants.

ActivityParticipantUserNames

The user names of the activity's participants.

Specific to manual activities.

Common Usage: Can be used in the body of an email template to display 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.

CurrentDate

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.

HomeDirectory

The path for which AgilePoint Server is installed.

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

ParentProcessID

The unique ID of the parent process.

Common Usage: Can be used in an email template to notify the Admin user that there is an error in the parent process.

ProcessID

The unique ID of a process.

Common Usage:

ProcessInitiator

The user who initiated the process.

Common Usage: Can be used in the To field of an email template to send an Activity Exit Email 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 Manual Activity.

ProcessInitiatorLocation

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

Common Usage: Can be used in the body of an email template to specify the IP address of the Process Initiator.

ProcessInstanceID

The unique ID of a process instance.

Common Usage: Can be used in the body of an email template to provide the Administrator user with the identification code assigned to the process instance.

ProcessInstanceName

The name of the process instance.

Common Usage: Can be used in an email template to notify the Administrator user that there is an error in a specific instance of a process.

ProcessName

Name of the activity.

Common Usage:

ProcessParticipantFullNames

The full names of the process's participants.

Specific to manual activities.

Common Usage: Can be used in the body of an email template to display the full names of the process participants.

ProcessParticipantUserNames

The user names of the process's participants.

Specific to manual activities.

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

ProcessStartedDate

The start date of the process.

Common Usage: Can be used in the body of an email template to display the date for which the process started.

ProcessTemplateID

The unique ID of the process template.

Common Usage: Can be used in the body of an email template to specify the unique identification code of the process template.

ProcessTemplateName

The name of the process template.

Common Usage: Can be used in the body of an email template when referring to the name of the process template.

ProcessTemplateReportFile

The name of the report associated with a process template.

Common Usage: Can be used to attach the process template report file in an email template.

ProcessTemplateVersion

The version of the process template.

Common Usage: Can be used in the body of an email template to specify the version of the process template.

Session

The task session ID.

Can only be used in email templates associated with Activity Entry Email.

Common Usage: Can be used to refer to a specific session or occurrence of a task when a process is in a loop. The Session ID is updated each time the process loops. See TaskID.

SourceTaskParticipantFullName

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

Specific to manual activities.

Common Usage: Can be used in the body of an email template to display the full name(s) of the task's participants.

SourceTaskParticipantUserName

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

Specific to manual activities.

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

SystemUserEmailAddress

The email address of the system user.

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

SystemUserName

The name of the system user.

Common Usage: Can be used in the body of an email template to display the name of the system user.

TaskAssignedDate

The date the task was assigned.

Common Usage: Can be used in an incoming or Activity Exit Email template notifying a participant of the date for which a task has been assigned.

TaskDueDate

The due date of the task.

Common Usage: Can be used in an incoming or Activity Exit Email template notifying a participant of the date for which a task is due.

TaskID

The unique ID of the task.

Can only be used in email templates associated with Activity Entry Email.

Common Usage: Can be used in an email template associated with an Activity Entry Email to specify the unique ID of the task that has been assigned. See Session.

TaskName

The name of the task.

Can only be used in email templates associated with Activity Entry Email.

Common Usage: Can be used in an email template associated with an Activity Entry Email to specify the name of the task that has been assigned.

TaskParticipantFullName

The full name of the task's participant.

Common Usage: Can be used in the body of an email template to display the full name(s) of the task's participants.

TaskParticipantUserName

The user name of the task's participant.

Common Usage: Can be used in the To field of an email template to send a re-assigning email to the task's participants letting them know a task has been re-assigned. If you use the ${TaskParticipantUserName} process attribute 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.

WorkItemID

The unique ID of the work item.

Common Usage: Can be used in the body of an email template to display the unique ID of a work item.