Segment
This context gives access to manage a single Segment.
Unique Actions
[?]
Configure Segment
This action is used to edit the properties of a Segment.
 | 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: Segment
Context Name: provided by user
Context Description: provided by user
Context Path: users.USER_NAME.Segments.SEGMENT_NAME
Context Mask: users.*.segments.*
Context Permissions
[?]
Level | Description |
None | No access allowed. |
Observer | No access allowed. |
Operator | Configuration browsing. |
Manager | Segment configuration and removal. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
[?]
Common Variables: groupMembership (Group Membership)
Segment Properties
Defines the name and description of the segment. Used in conjunction with one or more Roles 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 |
Context Mask
Table defining Context Paths and Context Masks to be used with Roles when defining Roll-Based Permissions.
Variable Name: | masks |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level. |
Record Format:
Field Name | Field Type | Notes |
mask | String | String which can be evaluated as a Context Paths or Context Masks. |
Segment Inheritance
List of Segments from which to inherit context paths and context masks.
Variable Name: | segmentInheritance |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
segment | String | Context path of a segment. |
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?