A User Role is a combination of Configuration Templates and Field Display Policies that apply to all the Data-, Device- and Domain Models available in the system. When a User Role is created, a Configuration Template and Field Display Policy can be selected as defaults that apply to each available model. The User Role can also be associated with a Menu Layout, Theme and an Access Profile that specifies create, read, update and delete permissions on each model. When a user is created or updated, a User Role can be selected for the user. This means that the user will by default have the menu, relevant permissions, Configuration Template defaults and settings as well as Field Display Policy views applied when using the relevant model. More than one user can have the same User Role assigned. User Roles provide a means to manage users that are logged in on the system.

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

Name *

The name that is given to the Role.

Field Name: name
Type: String

Description

A description for the Role.

Field Name: description
Type: String

Menu Layout

The selected Menu Layout that is associated with the Role.

Field Name: menu_layout
Type: String
Target: data/MenuLayout
Target attr: name
Format: uri

Theme

The selected Theme that is associated with the Role.

Field Name: theme
Type: String
Target: data/Theme
Target attr: name
Format: uri

Access Profile *

The selected Access Profile that is associated with the Role.

Field Name: access_profile
Type: String
Target: data/AccessProfile
Target attr: name
Format: uri

Interface *

The selected interface that is associated with the Role. The interface can be an Administration or Self Service.

Field Name: interface
Type: String
Choices: ["Administration", "Self Service", "None"]

Landing Page

Landing page for user

Field Name: landing_page
Type: String
Target: data/LandingPage
Target attr: name
Format: uri

Self Service Links

Provide useful links to Self Service end users

Field Name: selfservice_links
Type: String
Target: data/SelfServiceLinks
Target attr: name
Format: uri

Self Service Feature Display Policy

Field Name: ss_display_policy
Type: String
Target: data/SelfServiceFeatureDisplayPolicy
Target attr: name
Format: uri

Custom Interfaces

The list of interfaces that are associated with the role.

Field Name: interfaces.[n]
Type: Array

Interface Type *

The selected interface type that is associated with the role.

Field Name: interfaces.[n].interface_type
Type: String
Target: data/InterfaceType
Target attr: name
Format: uri

Name *

The selected interface that is associated with the role.

Field Name: interfaces.[n].name
Type: String
Format: uri

Rules

Field Name: rules
Type: Object

Permitted Hierarchy Types

Hierarchy Types that this Role can be added under.

Field Name: hierarchy_types.[n]
Type: Array
Cardinality: [1..n]

Model: data/Role

Model Details