How to use variables

All variables can be referenced to in forms and in customised message dialogs like external start confirmation message

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

EX. $instance.name$


If you want to access the variable return value for a specific data object just put the data object id and a dot as a prefix to the variable.

EX. $dataobjectID.fieldName$


Variable Description Type
instance.id

Returns the unique instance ID String

instance.name

Returns the instance name String

instance.description

Returns the instance description String

instance.links.show

Returns the instance url link String

instance.number

Returns the instance number Number
instance.created
Returns the date and time when the instance was created
Date/Time
instance.createddate
Returns the date the instance was created Date
instance.deadline
Returns the deadline date and time of the instance Date/Time
instance.deadlinedate
Returns the deadline date of the instance Date
instance.completed
Returns the date and time of when the instance was completed Date/Time
instance.completeddate
Returns the date the instance was completed Date
instance.initiator.id Returns Id (security id) of the initiator user for the instance String
instance.initiator.name Returns the name of the initiator user for the instance
String
instance.initiator.email Returns the email of the initiator user for the instance String
instance.initiator.username Returns the username of the initiator user for the instance String
instance.initiator.title
Returns the title of the initiator user for the instance String
instance.initiator.department
Returns the department of the initiator user for the instance String
instance.initiator.country
Returns the country of the initiator user for the instance String
instance.initiator.telephone
Returns the telephone of the initiator user for the instance String
instance.roles[roleName].assigned.name

Returns the name of all the assigned participant of a specific role in an instance

String, comma separated

instance.roles[roleName].assigned.email

Returns the email of all the assigned participant of a specific role in an instance 

String, comma separated

instance.roles[roleName].assigned.id Returns the id (security id) of all the assigned participant of a specific role in an instance String, comma separated

instance.roles[roleName].anyaccess.name

Returns the name of all participants of a specific role that has access to XX

String, comma separated

instance.roles[roleName].anyaccess.email

Returns the email of all participants of a specific role that has access to XX

String, comma separated

instance.roles[roleName].anyaccess.id Returns the id (security id) of all participants of a specific role that has access to XX String, comma separated
instance.roles[roleName].last.performer.name Returns the name of the last performer for the specific role String
instance.roles[roleName].last.performer.email Returns the email of the last performer for the specific role
String
instance.roles[roleName].last.performer.title Returns the title of the last performer for the specific role String
instance.roles[roleName].last.performer.department Returns the department of the last performer for the specific role String
instance.roles[roleName].last.performer.country Returns the country of the last performer for the specific role String
instance.roles[roleName].last.performer.telephone Returns the telephone of the last performer for the specific role
String
instance.roles[roleName].last.performer.id Returns the id (security id) of the last performer for the specific role  String

application.id

Returns the application ID String
application.name
Returns the application name String
application.description
Returns the application description String
space.id
Returns the space ID String
space.name
Returns the space name String
space.description
Returns the space description String
global.sessionData.account.name
Returns the name of the logged in user String
global.sessionData.account.userName
Returns the username of the logged in user  String
global.sessionData.account.firstName
Returns the first name of the logged in user String
global.sessionData.account.lastName
Returns the last name of the logged in user String

global.sessionData.account.fullName

Returns the first and last name of the logged in user

String

global.sessionData.account.email
Returns the email adress of the logged in user String
task.id Returns the task ID String
task.name Returns the task name String
task.description Returns the task description String
task.links.show Returns the link to the task URL link
tasks[ReferenceID].links.show Returns the URL for the task with the specified Reference ID (BPMN 1.0 only)
URL link
task.performer.id Returns id (security id) of the performer String
site.now
Returns current UTC date and time in format: "yyyy-MM-dd HH:mm:ss" Example: 2017-01-03 09:41:20
String
site.nowdate
Returns current UTC date in format "yyyy-MM-dd" Example: 2017-01-03
String
<DataID>.<FieldName> Returns the field name of the specified dataID String


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


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 customised message dialogs.