Add a system variable to a process
System variables are simple non-editable process variables that give you information, such as who created the job and the job ID which you typically do not know at design time.
Each System variable holds a value for a specific TotalAgility task. For example, SPP_RES_JOB_Creator holds the User ID of the creator of a job, or AWF_JOBID holds the ID of the job. This information is only gathered upon job creation.
- Open the process map in which to create the variable.
-
On the process modeling bar, click
Variables and click
New.
The New variable dialog box is displayed.
-
Enter a unique
Name for the variable.
By default, the name of the variable becomes the ID of the variable; however, you can change the ID if needed.
- On the Type list, select System. (Default: String)
- On the Value list, select a System variable, for example, AWF_USABLE_RESOURCE.
- Click Add and close.
- Save the process.
System variables available in TotalAgility
Variable |
Description |
---|---|
AWF_JOBID |
Holds the value for the Job ID of the current job. |
AWF_RES_JOB_CREATOR |
Holds the value for the User ID of the job creator. |
AWF_RES_JOB_CREATOR_SUP |
Holds the value for the User ID of the supervisor of the job creator. |
AWF_RES_PREVIOUS_ACT |
Holds the value for the User ID of the resource of the previous activity. |
AWF_USABLE_RESOURCE |
Holds the value for the current usable resource. |
JOB_SCORE |
Holds the value for the job score of the process. |
SKIN_ID |
Holds the value for the ID of the skin process map. When a job is created on a template that invokes a skin, the SKIN_ID variable will hold the ID of the skin process. |
SPP_BUDGET |
Holds the budget value as defined by the user at design time. |
SPP_CASE_ID |
Holds the value for the case job ID. If the business process map is not associated with any case, this system variable holds the job ID (AWF_JOBID). |
SPP_CASE_REFERENCE |
Holds the case reference value as given by the user when creating a case reference. |
SPP_EPC |
Holds the value for the embedded process count. |
SPP_ID |
When used in a parent job, this is set to the parent job ID, and when used in a subjob, this is set to the subjob ID. Therefore, this variable can be used for updating or retrieving any job data, whether in a job or subjob. |
SPP_JOB_CREATOR_EMAIL |
Holds the email of the resource who created the job. |
SPP_JOB_CREATOR_SUP_EMAIL |
Holds the email of the supervisor of the resource who created the job. |
SPP_JOB_STATE |
Holds the value of the current state of a job. |
SPP_JOB_STATE_PERCENTAGE |
Holds the value of the percentage complete of a job state. |
SPP_PREV_RES_EMAIL |
Holds the email of the resource who completed the previous activity. |
SPP_PREV_RES_SUP_EMAIL |
Holds the email of the supervisor resource who completed the previous activity. |
SPP_PROCESS_ID |
Holds the value for the ID (GUID) of the process. |
SPP_PROCESS_NAME |
Holds the value for the name of the process. |
SPP_RES_JOB_OWNER |
Holds the value for the user ID of the job owner. |