Role
This context gives access to manage a single Role.
Unique Actions
[?]
Configure Role
This action is used to edit the properties of a role.
 | Changing Name field during this operation will cause renaming of current context. This may lead to malfunctioning of other system components that use context name/path as a primary identifier. |
Action Type: |
Common Actions
[?]
Delete, Make Copy, Replicate, Edit Context Permissions, View Status
Advanced Information |
Context Information
Context Type: Role
Context Name: provided by user
Context Description: provided by user
Context Path: users.USER_NAME.roles.ROLE_NAME
Context Mask: users.*.roles.*
Context Permissions
[?]
Level | Description |
None | No access allowed. |
Observer | No access allowed. |
Operator | Configuration browsing. |
Manager | Role configuration and removal. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
[?]
Common Variables: groupMembership (Group Membership)
Role Properties
Defines the name and description of the segment. Used in conjunction with one or more Segments to define the Role Based Permissions for a user.
Variable Name: | childInfo |
Records: | 1 |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
name | String | 1-50 characters |
description | String | 1-50 characters |
Permissions
Table defining permissions for the indicated contexts types, entity types, and entities.
Variable Name: | permissions |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
contextType | String | Defines the context type that the permission will apply to. |
entityType | Integer | Indicates a entity type that the permission will apply to. |
entity | String | Indicates an entity name that the permission will apply to. |
exceptions | Data table | Nested Data Table to indicated which entities and entity types should be excluded from permissions. Fields are as follows:
|
permissions | String | Type of permission to apply to the indicated entities. Possible values are as follows:
|
Inherit Permissions from
List of roles from which to inherit permissions.
Variable Name: | roleInheritance |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
role | String | Context path of a role |
Public Functions
[?]
This context has no public functions.
Public Events
[?]
Common Events: Child Added, Child Removed, Evaluation, Evaluation Error, Visible Info Changed, Info.
Was this page helpful?