[Index]

Model: data/Role

User Roles

A User Role in the system combines the look and feel of the system interface with a number of default permissions and values. Refer to the diagram in the topic called Role based Access. A specific User Role is a combination of:

When a user is created or updated, a User Role can be selected for the user. This user will have the landing page, menu, theme and interface specified by the User Role. For example, the Configuration Template defaults and settings as well as Field Display Policy views of the menu associated with the role apply.

A User Role can be assigned to more than one user. The user hierarchy and role serve as components of role-based access control in the system.

A number of user roles are provided:

Each of these roles have a relevant landing page, menu layout and access profile. These elements as well as the theme can be customized.

Note

Users cannot modify their own User Role or the associated Access Profile, Menu Layout, Landing Page or any of the Configuration Templates or Field Display Policies associated with the Role.

Finally, user roles are subject to specific user role rules. This means that a particular user role may be tied to a specific Hierarchy type. For example, a Site Admin role may only be assigned to users who reside at a Site hierarchy level.

Create a User Role

  1. Choose the hierarchy.
  2. Choose Role Based Access > User Roles to open the User Roles list view.
  3. Click Add on the button bar to open the User Roles input form.
  4. On the Base tab, enter a Name for the role and optionally enter a Description.
  5. From the respective drop-down lists, choose the required Menu Layout, Theme, Access Profile, Interface and Landing Page for the User Role.
  6. On the Rules tab, add the Permitted Hierarchy Types at which this role will be available for selection when a user is created.
  7. Click Save on the button bar to create the User Role. The created instance is listed in the User Role list view.

When a user in the specified hierarchy is added or modified, the User Role from the hierarchy can be assigned to the user. The associated role, access profile, theme and menu layout then applies to the user.

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.

Model Details: data/Role

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
Dashboard The selected Dashboard that is associated with the Role.
  • Field Name: dashboard
  • Type: String
  • Target: data/Dashboard
  • 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
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]