Widgets

 Top  Previous  Next

This context is a container, holding all widgets for a particular user.

Unique Actions [?]

CREATE NEW WIDGET (Default Action)

This Drag and Drop action is used to create a new widget. It is described here.

Action Type:

Drag and Drop

Action Icon:

cm_create

Action Name:

create

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at Manager permission level

Create Device Map

This action is used to create a Device Map widget.

Action Flow:

1. Specify map properties (name, description, background image, size of device images, etc.).
2. Select the Device to show on the map.
3. Edit the new map in GUI Builder.

Action Name:

createMap

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at Manager permission level

Common Actions [?]

Create From Template, Replicate To Children, Import, Export, Edit Context Permissions, Monitor Related Events, Search/Filter, various Grouped Actions according to child contexts.

Variable-Related Actions [?]

cm_chart Create CHART

This action creates a new widget with a chart component and several other components for controlling chart parameters on-the-fly. These components form a toolbar.

Chart is configured to show historical changes of variable's values.

At first step, the following parameters should be specified:

•Chart type (line, area, or bar)
•Toolbar (enabled/disabled)
•One of the two pre-defined validity expressions, that allow this chart to later used with the current context only or with all contexts of the same type.

At next step, one or more named chart trends should be created. Each trend is defined an expression that may refer one or more variable fields.

Action Name:

chartForVariable

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at Manager permission level

st_widget Create Widget

This action generates new widget that may be used to edited value variable. Newly created widget may be customized immediately after creation to form a good-looking custom editor for this type of variable.

Widget template produced by this action is best suit for editing values of complex variables those format defines multiple fields but single row. Template consist of main panel with two columns and and button panel in the bottom. Left column of main panel displays field names using widget labels. Right column contains different components used to view/edit field values. In the button there are two buttons: Submit button causing widget to commit changes and exit, and Close button that stops widget without saving changes. Here is how an auto-generated widget looks like for User Account Properties variable of User context:

ls_widgets_generated

Action Name:

widgetForVariable

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at Manager permission level

Event-Related Actions [?]

cm_chart Create CHART

This action creates a new widget with a chart component and several other components for controlling chart parameters on-the-fly. These components form a toolbar.

Chart is configured to show data value taken from history of current event.

At first step, the following parameters should be specified:

•Chart type (line, area, or bar)
•Toolbar (enabled/disabled)
•One of the two pre-defined validity expressions, that allow this chart to later used with the current context only or with all contexts of the same type.

At next step, one or more named chart trends should be created. Each trend is defined an expression that may refer one or more event fields.

Action Name:

chartForEvent

Non-Interactive Mode:

Not Supported

Permissions:

Accessible at Manager permission level

Context States and Icons

This context has no states. It is always represented by the st_widgets icon.

Advanced Information

Context Information

Context Type: widgets

Context Name: widgets

Context Description: Widgets

Context Path: users.USER_NAME.widgets

Context Mask: users.*.widgets

Context Permissions: Observer

Public Variables (Properties) [?]

This context has no public variables (properties).

Public Functions [?]

Common Functions: makeCopy (Make Copy), delete (Delete)

Create

Creates new widget.

Function Name:

create

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

Same as format of childInfo variable in Widget context.

Output Records:

0

Output Format:

none

Public Events [?]

Common Events: info (Information)