You are viewing the documentation for Blueriq 16. Documentation for other versions is available in our documentation directory.
Learn more about the system entity attributes 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.
Overview
| System attribute | Description |
|---|---|
USER | Contains a relation to the active user instance. |
CHANNEL | Contains the current device channel. |
CURRENTPAGE | Contains the name of the current page. |
LANGUAGE | Contains the current language name. This attribute is updated after a language switch. |
PAGEVALID | Contains a value that represents the validity of the current page: unknown, true, false. |
EVENT | Contains 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. |
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
USER
This attribute contains a relation to the active user instance (@User@).
system.user (Instance)
The active user contains the following attributes:
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
This system attribute contains the current device channel. This value is optional.
system.channel (String)
CURRENTPAGE
This system attribute contains the name of the current page.
system.currentpage (String)
LANGUAGE
This system attribute contains the current language name. This attribute is updated after a language switch.
system.language (String)
PAGEVALID
This system attribute contains a value that represents the validity of the current page: unknown, true, false.
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 successfully
The attribute value is recalculated with every refresh.
EVENT
This system attribute contains the current events, which can be set as parameters on an Event. This value is unknown if no event is triggered.
system.event (List)
Current events could be defined on buttons or as special events on specific container types.
| System.event value | Behaviour |
|---|---|
| _previous | System flows back to the last visited page. Use this when no 'return' flow is modelled in the flow. |
| _draft | System continues it's flow without validating the current page. |
| _void | System flows without submitting the current page. Use this on 'return' flows to allow a user to return to a previous step. Can be combined with the _previous event. |
| _refresh | System refreshes the page without flowing. Use this to allow a user to manually refresh the page. |
Some elements automatically set a value in the system.event attribute.
| Button Event Type | system.event value |
|---|---|
| Validate and Continue | no value |
| Continue | _draft |
| Cancel | _void |
Also:
| Button Refreshes | system.event value |
|---|---|
| True | _refresh |
| False | no value |
ROLES
This system attribute contains a list of the roles of the current user.
system.roles (List)
TODAY
This system attribute contains the current date (yyyy-MM-dd) from the runtime environment.
system.today (date)
TASKID
This system attribute 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.
system.taskId (Integer)
CASEID
This system attribute contains the ID of the case where the current 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.caseId(String)
Overview
Content Tools