Variables

It is possible to present information from the instance by using Variables. Variables present information from forms, tasks, and other data that exist in the instance. For example, you can present text from a form field on the page to allow external users. It could be a comment, a decision or other relevant information that allows the external user to understand the status of their instance.

When to use variables

Variables are used when you need to share information between generated data from the session, data specified in form fields, and data presented in customized message dialogs.

How to use variables

All variables can be referenced in forms and in customized message dialogs like external start confirmation message. 

When you want to refer to a variable, use $-sign before and after the variable.

Example: $instance.name$ 

Form variables

To refer to a form field with a variable you just type $dataID.formfield$.

Example: You can set a value from a formfield in another formfield by using the attribute "value" in the field you want to populate.   

Adding variables

Variables are added by clicking on the button Variables in the top right of the editor. This will present a list of available variables that you can add. Click on a variable and it will be added where you have your cursor. A variable always starts and ends with a dollar sign $. The variable will be replaced with its content when you open the External Instance Overview Page via the link. If there is no data in the variable it will not show any information at all.

Instance variables

To access the variable return value for a specific data object, put the data object id and a dot as a prefix to the variable.

Example: $dataobjectID.fieldName$

Application and Space variables

Site variables 

Task variables

Task variables are mainly used on tasks, for example when you send a notification mail. 

You can use tasks[ID].links.show when you want to send the URL address to the task via mail from a different part of the process. The task must have been created before the mail is sent out.

Global variables

Global variables works a bit differently from the rest of the variables.  They are used to post information about the logged-in user in forms, when the form is created. 

How it works

The global variable collects information from a user who is logged in, opens the form for the first time, and posts that information in the form.

Global variables will not work on forms used by external users.

How to set up Global variables

To use a global variable, you need to have form field with a default value were you enter the variable. 

Global variables are not called by $ but instead by = in front of the string.
Example: =global.sessionData.account.fullName

Claims variables

Claims variables can only be used if a contract is using SAML. 

When a user logs on to Process Automation the IdP (Identity Provider) can also send specific data about the user that can be populated by variables. 

The values in claims are customer-specific and can vary depending on what the IdP sends to Process Automation.