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 to 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.

EX. $instance.name$ 


Form variables

If you want 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 attribut "value" in the field you want to populate.   


Instance variables


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$


Instance VariablesDescriptionType
instance.id

Returns the unique instance IDString

instance.name

Returns the instance nameString

instance.description

Returns the instance descriptionString

instance.links.show

Returns the instance URL linkString

instance.number

Returns the instance numberNumber
instance.created
Returns the date and time when the instance was created
Date/Time
instance.createddate
Returns the date the instance was createdDate
instance.deadline
Returns the deadline date of the instanceDate
instance.deadlinetime
Returns the deadline time of the instanceTime
instance.completed
Returns the date and time of when the instance was completedDate/Time
instance.completeddate
Returns the date the instance was completedDate
instance.initiator.idReturns Id (security id) of the initiator user for the main instanceString
instance.initiator.nameReturns the name of the initiator user for the main instance (or the name of the application if external start is initiated)
String
instance.initiator.emailReturns the email of the initiator user for the main instanceString
instance.initiator.usernameReturns the username of the initiator user for the main instanceString
instance.initiator.title
Returns the title of the initiator user for the main instanceString
instance.initiator.department
Returns the department of the initiator user for the main instanceString
instance.initiator.country
Returns the country of the initiator user for the main instanceString
instance.initiator.telephone
Returns the telephone of the initiator user for the main instanceString
instance.initiator.originkeyReturns the Origin Key for the user if the user has been automatically replicated into Barium LiveString
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.idReturns the id (security id) of all the assigned participant of a specific role in an instanceString, 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.idReturns the id (security id) of all participants of a specific role that has access to XXString, comma separated
instance.roles[roleName].last.performer.nameReturns the name of the last performer for the specific roleString
instance.roles[roleName].last.performer.emailReturns the email of the last performer for the specific role
String
instance.roles[roleName].last.performer.titleReturns the title of the last performer for the specific roleString
instance.roles[roleName].last.performer.departmentReturns the department of the last performer for the specific roleString
instance.roles[roleName].last.performer.countryReturns the country of the last performer for the specific roleString
instance.roles[roleName].last.performer.telephoneReturns the telephone of the last performer for the specific role
String
instance.roles[roleName].last.performer.idReturns the id (security id) of the last performer for the specific roleString
instance.roles[roleName].next.performers.*Returns the name or email or title or other (see above variables) of who will be assigned to the specified role. Replace the * with name, email or other.String
instance.roles[roleName].hastasks.*Returns the name or email or title or other (see above variables) of who has active tasks in the specified role. Replace the * with name, email or other.
String


Application and Space variabels


Application and Space 

application.id

Returns the application IDString
application.name
Returns the application nameString
application.description
Returns the application descriptionString
space.id
Returns the space IDString
space.name
Returns the space nameString
space.description
Returns the space descriptionString



Site variables 


Site Variables

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 dataIDString


Task variables

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


Task Variables

task.idReturns the task IDString
task.nameReturns the task nameString
task.descriptionReturns the task descriptionString
task.links.showReturns the link to the taskURL link
tasks.deadlineReturns the date of the deadline in UTC-timeString
task.performer.idReturns id (security id) of the performerString






Global variables

Global variables works a bit different from the rest of the variables.  The 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 Barium Live and who opens the form for the first time and post that information in the form.


Note: 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 variabel. 



NOTE: Global variables are not called by "$" but instead by "=" in front of the string.

Example: "=global.sessionData.account.fullName"


Global Variables

global.sessionData.account.name
Returns the name of the logged in userString
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 userString
global.sessionData.account.lastName
Returns the last name of the logged in userString
global.sessionData.account.fullName
Returns the first and last name of the logged in userString
global.sessionData.account.email
Returns the email adress of the logged in userString
global.sessionData.account.department
Returns the department of the logged in user. String
global.sessionData.account.telephone
Returns the telephone number of the logged in user.
String