AgilePoint Knowledge Base

Home Search Tags Glossary Members

Welcome Guest ( Login | Register )

Latest Additions Most Popular

Home » Knowledgebase » AgilePoint BPMS Suite » AgilePoint Envision » List of pre-defined process attributes that can be used when...

List of pre-defined process attributes that can be used when...

List of pre-defined process attributes that can be used when building process models

The information in this article applies to:

AgilePoint Envision

TOPIC(S)

This article provides a list of pre-defined process attributes that can be used when building AgilePoint process models.

When writing code, a different approach is necessary for accessing process attributes. For the case of writing code, most of the Predefined Process Attributes mentioned below are actually the properties of classes. For example, you may get the process instance information such as process instance name, due date, etc from the properties of the WFProcessInstance class. The available classes and properties are listed in our Web Service API and AgilePoint SDK (APSDK) documentation.

SUMMARY

AgilePoint process models typically contain many process attributes. These process attributes can be very useful when working with certain AgileShapes. Instead of creating your own mechanism to manage or access these process attributes, AgilePoint has built-in functionality giving you direct access to this information without having to use code. For example, you can use the process attribute data for such purposes as controlling the process flow and building email templates. Keep in mind that some of the predefined attributes below can only be used in specific ways or situations. When using process attributes, different syntax may need to be used. Outside of an email template, you may use $AttributeName, whereas inside an email template, you may use ${AttributeName}.

NOTE: More information about process attributes can be found in the AgilePoint User's Guide in Appendix A.

DETAILS

The following is a list of process attributes that can be used throughout AgilePoint:

ActivityName - The name of the current activity.
CurrentDate - The current date.
HomeDirectory - The path for which AgilePoint Server is installed.
ParentProcessID - The unique ID of the parent process.
ProcessID - Same as ProcessInstanceID.
ProcessInitiator - The user who iniated the process.
ProcessInitiatorLocation - The location (IP address) of the user who initiated the process.
ProcessInstanceID - The unique ID of the process instance.
ProcessInstanceName - The name of the process instance.
ProcessName - Same as ProcessInstanceName.
ProcessParticipantFullNames - The full names of the process's participants.
ProcessParticipantUserNames - The user names of the process's participants.
ProcessStartedDate - The start date of the process.
ProcessTemplateID - The unique ID of the process.
ProcessTemplateName - The name of the process template.
ProcessTemplateReportFile - The name of the report associated with a process template.
ProcessTemplateVersion - The version of the process template.
SystemUserEmailAddress - The email address of the system user.
SystemUserName - The name of the system user.

The following is a list of process attributes that can be used only within the context of a Manual activity or other AgileWork-based activity. This includes email templates used as notifications within Manual activities. You should not use these attributes in email messages sent outside the context of Manual activities or other AgileWorks.

ActivityParticipantFullNames - The full name of the of the activity's participants.
ActivityParticipantUserNames - The user names of the activity's participants.
TaskAssignedDate - The date the task was assigned.
TaskDueDate - The due date of the task.
TaskID - The unique ID of the task.
TaskName - The name of the task.
TaskParticipantFullName - The full name of the task's participant.
TaskParticipantUserName - The user name of the task's participant.
Session - The task session ID.
SourceTaskParticipantFullName - The full name of the task's participant associated with the original task (i.e. reassigned).
SourceTaskParticipantUserName - The user name of the task's participant for the original task.
WorkItemID - The unique ID of the work item.

The following is a list of process attributes specific to SharePoint processes. These are used only for processes based on the Microsoft SPDoc and Microsoft InfoPath templates:

AllParticipantCommentsHtml - The entire history of the information entered by the Participant in the "Comment" field of the SharePoint task page.
LastParticipantCommentHtml - The most recent comment entered by the Participant in the "Comment" field of the SharePoint task page.
DocLibPath - The relative path of the document library (e.g. Testemail).
DocName - The name of the document (e.g. Testemail-2005-0036.xml).
DocUrl - The full document path (e.g. http://pearl:8084/sites/AscentnFinancialSite/Testemail/Testemail-2005-0036.xml).
SPServer - The SharePoint Url (e.g. http://pearl:8084).
SitePath - The relative path of the site (e.g. /sites/AscentnFinancialSite).

The following is a list of process attributes used internally by AgilePoint. You should not create process attributes with these names.

AssemblyName - The name of the custom assembly associated with the process
BaseDefID - Unique identifier of the first version of the process template
CheckedOutBy - User that has the process template checked out
CheckedOutDate - Date the process template was checked out
ClassName - The name of the custom class (AgileStub) associated with the process including namespace and class name. Ex. MyNamespace.MyClassName.
CreatedBy - The user that created the process template
CreatedDate - The date the process template was created
DefID - The unique identifier of the process definition
DefName - The process definition name
Description - Description of the process template
Diagnostic - The relative path
DocRef - Document reference of the process template
ExpectedTime - Expected time duration of the process
Owner - Owner of the process template
PreVersion - The previous version of the process template
Status - The status of the running process instance
Version - The current version of the process template