Dashboard
This context lets you access and manage a single dashboard.
Unique Actions
Open Dashboard
This action opens a dashboard.
Action Name: | open |
Permissions: | Accessible at Observer permission level |
Execution Parameters: |
|
Configure
This action is used to edit Dashboard properties.
 | 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, Monitor Related Events, View Status
Context States and Icons
Icon | Code | State |
| 0 | This dashboard is relative. |
| 1 | This dashboard is absolute. |
| 2 | This dashboard is a class instance dashboard. |
Advanced Information |
Context Information
Context Type: dashboard
Context Name: provided by user
Context Description: provided by user
Context Path: users.USER_NAME.dashboards.DASHBOARD_NAME
Context Mask: users.*.dashboards.*
Context Permissions
Level | Description |
None | No access allowed. |
Observer | Opening the dashboard. Basic event monitoring. Status browsing. |
Operator | Configuration browsing. |
Manager | Dashboard configuration and removal. |
Engineer | Same as Manager. |
Administrator | Same as Manager. |
Public Variables (Properties)
Common Variables: groupMembership (Group Membership), validity (Validity), activeAlerts (Active Alerts)
Properties
See description of the variable and its fields here.
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 |
title | String | Nullable |
type | Integer | |
validityExpression | String | |
validityListeners | Data Table |
Elements
See description of the variable and its fields here.
Variable Name: | elements |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Manager permission level |
Record Format for Desktop dashboards:
Field Name | Field Type | Notes |
title | String | |
type | Integer | |
location | Data Table | |
parameters | Data Table | |
validityExpression | String |
Record Format for Web dashboards:
Field Name | Field Type | Notes |
name | String | |
type | Integer | |
parameters | Data Table |
Public Functions
This context has no public functions.
Public Events
Common Events: info (Information)
Was this page helpful?