Environment variables

Environment variables are used in UI customizations. Depending on the context there are more or less variables available.

Variables can be used in conjunction with other text values, as they are replaced before the text is used or displayed on the UI.

The syntax for variables is:

${variableName}

For example:

Hello ${user.name}

Variables can be used in the following contexts:

In the Search View:
1. Filter Title
2. Filter Default value
3. Columns Display name
In the Calendar View:
1. Filter Title (since 1.5.1)
2. Filter Default value (since 1.5.1)
In the Frame View
1. Filter Title (since 1.5.2)
2. Filter Default value (since 1.5.2)
In the Edit View:
1. Title edit
2. Input fields of type Link (since 1.5.1)
3. Default value of input fields (since 1.6.2)

Global variables

Global variables are available throughout the entire system.

Variable name	Type	Description
user.key	int	The key of the current logged user.
user.name	string	The name of the current logged user.
user.bu.key	int	The business unit key of the current logged user.
user.o.key	int	The organization key of the current logged user.
date.today	date	The current date
date.now	datetime	The current date and time
date.firstDayOfYear	date	The first day of this year.
date.lastDayOfYear	date	The last day of this year.
date.firstDayOfMonth	date	The first day of this month.
date.lastDayOfMonth	date	The last day of this month.
date.firstDayOfLastMonth	date	The first day of last month.
date.lastDayOfLastMonth	date	The last day of last month.
date.firstDayOfWeek	date	The first day of this week.
date.lastDayOfWeek	date	The last day of this week.
date.lastWorkingDayOfWeek	date	The last working day of this week.

Entity variables are available only in the Edit View and are filled with values from the currently edited entity.

Variable name	Type	Description
key	int	The key of the current entity.
date_created	datetime	The date and time the current entity was created.
date_updated	datetime	The date and time the current entity was updated.
id_user	int	The key of the user that owns the current entity.
id_business_unit	int	The key of the business unit of the current entity.
id_organization	int	The key of the organization of the current entity.
propertyName	-	All other entity properties. The variable name is actually the property name.

Calendar variables are available only in the Calendar View for each layer.

Variable name	Type	Description
view.startDate	datetime	The start date of the selection.
view.endDate	datetime	The end date of the selection.