Learn more about the system entity attributes systemattributes system.USER, system.CHANNEL, system.CURRENTPAGE, system.LANGUAGE, system.PAGEVALID, system.EVENT, system.ROLES, system.TODAY, system.TASKID and system.CASEID.
The Blueriq Runtime provides access to specific system properties via the system entity. This entity is created when the Runtime starts and contains attributes which may be used in expressions in your application. These attributes are owned by the runtime and should not be modified. The following attributes are available.
Index:
...
Overview
| System attribute | Description |
|---|
USER | Contains |
USER
| Code Block |
|---|
system.user (Instance) |
...
| a relation to the active user instance |
...
| Code Block |
|---|
system.user.id (String)
system.user.Roles (List)
system.user.teams (List)
system.user.userName (String)
system.user.tenant (String) |
These properties are extracted from the UserData object which is automatically filled from the Authentication from the SecurityContext.
Do not modify these properties, because in every newly created session these will be extracted again from the Authentication object in the Spring SecurityContext.
The proper way to get your user information copied to new AquimaSessions is to set the Spring Authentication object through the "org.springframework.security.authentication.AuthenticationProvider"
For implementing an AuthenticationProvider for the SecurityContext see Runtime Authentication.
...
CHANNEL
| Code Block |
|---|
system.channel (String) |
...
| the current device channel. |
...
...
CURRENTPAGE
| Code Block |
|---|
system.currentpage (String) |
...
| the name of the current page. |
...
LANGUAGE
| Code Block |
|---|
system.language (String) |
...
| the current language name. This attribute is updated after a language switch. |
...
| Code Block |
|---|
system.pagevalid (Boolean) |
The value of this boolean is:
- unknown if a page has never been validated
- false if the page has been validated and it contains errors (and/or warnings that are shown for the first time)
- true if the page has been validated and all validations are passed succesfully
The attribute value is recalculated with every refresh.
| Contains a value that represents the validity of the current page: unknown, true, false. |
EVENT | Contains |
...
EVENT
| Code Block |
|---|
system.event (List) |
...
| the current events, which can be set as parameters on an Event. This value is unknown if no event is triggered. |
ROLES | Contains a list of the roles of the current user. |
...
| Info |
|---|
Current events could be defined on buttons or as special events on specific container types. |
Furthermore, the type of button also sets these values:
...
Also:
| |
TODAY | Contains the current date (yyyy-MM-dd) from the runtime environment. |
TASKID | Contains the task id of the current started task. This value is unknown if there is no active task. This property will only be set if DCM 2.0 is active. |
CASEID | Contains the id of the the case where the started task belongs to. This value is unknown if there is no active task. This property will only be set if DCM 2.0 is active. |
System attribute details
| Include Page |
|---|
| System attribute USER, system.user |
|---|
| System attribute USER, system.user |
|---|
|
| Include Page |
|---|
| System attribute CHANNEL, system.channel |
|---|
| System attribute CHANNEL, system.channel |
|---|
|
| Include Page |
|---|
| System attribute CURRENTPAGE, system.currentpage |
|---|
| System attribute CURRENTPAGE, system.currentpage |
|---|
|
| Include Page |
|---|
| System attribute LANGUAGE, system.language |
|---|
| System attribute LANGUAGE, system.language |
|---|
|
| Include Page |
|---|
| System attribute PAGEVALID, system.pagevalid |
|---|
| System attribute PAGEVALID, system.pagevalid |
|---|
|
| Include Page |
|---|
| System attribute EVENT, system.event |
|---|
| System attribute EVENT, system.event |
|---|
|
| Include Page |
|---|
| System attribute ROLES, system.roles |
|---|
| System attribute ROLES, system.roles |
|---|
|
| Include Page |
|---|
| System attribute TODAY, system.today |
|---|
| System attribute TODAY, system.today |
|---|
|
| Include Page |
|---|
| System attribute TASKID, system.taskId |
|---|
| System attribute TASKID, system.taskId |
|---|
|
| Include Page |
|---|
| System attribute CASEID, system.CaseId |
|---|
| System attribute CASEID, system.CaseId |
|---|
|
...
ROLES
| Code Block |
|---|
system.roles (List) |
This attribute contains a list of the roles of the current user.
...
TODAY
| Code Block |
|---|
system.today (date) |
...