Widgets collection¶
The "Cockpit" includes preset widget types. Each widget type provides different parameters to configure and different data to be displayed.
The following section describes, in alphabetical order, each available widget type and its configuration properties.
Widget "Alarm list"¶
The "Alarm list" widget shows a list of alarms, filtered by objects, alarm severity and alarm status. For details on the information provided for each alarm, refer to Working with alarms in Device Management.
Create a widget¶
To create a new widget, select "Add widget" from the "Home" tab.
Parameters to configure
| Field | Description |
|---|---|
| Title | By default, the widget type is simply used as title. |
| Target assets or devices | Select groups or devices, optional HTML expressions which should be evaluated. |
| Status | Only show devices with alarms of the selected alarm status. |
| Type | Only show alarms of the specified type(s). Details can be seen when clicking once on an alarm. |
| Severities | Only show alarms of the selected alarm severity. |
| Order | Alarms may be ordered by the active status (followed by severity and time, the default) or the severity (followed by time). |
Widget "All critical alarms"¶
The "All critical alarms" widget shows all objects with a critical alarm. There are no additional parameters to be configured.
For details on alarms, refer to Device Management.
Widget "Applications"¶
The "Applications" widget shows a list of links to all available applications. There are no additional parameters to be configured.
For details on applications, refer to Managing Applications in Administration.
Widget "Asset notes"¶
The "Asset notes" widget displays messages provided by the administrative user to all owners of the current widget.
Only users with the permission to edit the home dashboard will be able to provide this message.
Widget "Asset properties"¶
The "Asset properties" widget displays a user-defined list of attributes of the current object. The current object can be a device or a group.
Parameters to configure
| Field | Description |
|---|---|
| Title | By default, the widget type is simply used as title. |
| Target assets or devices | Select groups or devices. |
| Properties | List of properties, see Widget "Asset table". |
Note
In the view mode, this widget only displays the properties which are not empty.
Widget "Asset table"¶
The "Asset table" widget shows details of all child devices in a table. This is a very powerful widget, allowing to arrange selected properties of objects in a table.
Parameters to configure
| Field | Description |
|---|---|
| Title | By default, the widget type is simply used as title. |
| Target assets or devices | Select for which object all child devices should be shown. This is typically a group object. |
| Properties | Select properties or actions of an object to visualize them as columns in the table. |
Example
In the following screenshot, three columns are configured:
The resulting table is visualized as follows:
Adding properties
To add a property, click "+Add Properties" and select one or more properties to be added.
Note
The property "Active alarm status" shows active alarms as icons in the table. If you select this property, you also need to configure the renderer "Active Alarm Status" in the list of columns.
Adding actions
To add an action, click "+Add Action". Select Toggle maintenance mode to add the predefined action to toggle the maintenance mode. Or select "Create operation" to create a button that will execute a shell command. In the following dialog you can then enter the label for the button and the shell command to be executed.
Note
The dialog shows the predefined shell commands of the first device that supports shell commands. The list is empty if there is no such device. You can also enter the JSON format for the operation that will be sent to the device. For details, contact the device vendor for supported operations.
Modifying the table
To edit the header of a column, click on its value in the "Label" column and edit the label.
You can rearrange the columns by clicking the icon at the very left of a row and dragging and dropping the entry.
To remove a property or an action, hover over the respective row and click "Delete" at the right.
Widget "Cockpit welcome"¶
The "Cockpit welcome" widget lets you display a welcome message to the "Welcome" screen. There are no additional parameters to be configured.
Widget "Data point graph"¶
The "Data point graph" widget shows a data point (measurement) in a graph. The visualization is the same as in the data explorer.
The easiest way to create a "Data point graph" widget is to navigate to the data explorer, click the "More..." button in the top menu bar and select "Send as widget to dashboard".
Refer to Visualizing data using the data explorer for further details on the parameters to be configured.
Widget "Data point list"¶
The "Data point list" widget shows data points (measurements), one in each row, with current values and data point properties.
Parameters to configure
| Field | Description |
|---|---|
| Title | Widget title. By default, the widget type is simply used as title. |
| Data point | Shows a list of available data points. You must enable at least one data point. Click "Add data point" to add a data point to the list. |
| Column visibility | Select which columns should be visible: Label: Label of the data point. See Visualizing data using the data explorer for details. Target: Target value. Can be configured in the data explorer or Data Point Library. Current: Current value. Diff: Absolute difference between current value and target value. Diff %: Percentage of difference between current value and target value. Asset: Name of the device or group of the data point. |
Widget "Data point table"¶
The "Data point table" widget configuration is similar to the "Data point graph" widget, but instead of visualizing the data as a line-chart, data is visualized as a table.
The "Data point table" widget displays data based on selected data points, time interval and aggregation.
Out of range values, based on configured yellow and red ranges, are highlighted in the table.
Widget "Event list"¶
The "Event list" widget lets you monitor events for a selected device.
Additionally, a specific date range can be set and the events can be monitored in realtime.
Widget "Fieldbus device"¶
The "Fieldbus device" widget lets you see the status of a modbus device and operate it.
For details on the "Fieldbus device" widget, refer to Cloud Fieldbus in Device Management.
Widget "Help and service"¶
The "Help and service" widget displays links to help and service resources. There are no additional parameters to be configured.
Widget "Image"¶
The "Image" widget lets you display a single image to be selected from your computer by browsing. There are no additional parameters to be configured.
Widget "Info Gauge"¶
The "Info gauge" widget visualizes one data point in form of a radial gauge and multiple data points as labels.
You can select one data point for the gauge, and multiple data points shown with labels on the left side.
You must enable at least one data point in each section to create the "Info gauge" widget.
Widget "HTML"¶
The "HTML" widget shows user-defined content. The content can be formatted using HTML.
Parameters to configure
- Target assets or devices: Select the objects for which optional HTML expressions are evaluated.
- HTML code
The following variables can be used inside the HTML content:
- {{devicesCount}}: Total number of devices.
- {{usersCount}}: Total number of users.
- {{deviceGroupsCount}}: Total number of groups.
- {{deviceName}}: The name of the device.
- {{deviceProperty}}: More general form of the above. You can address any property of the device.
- {{deviceC8y_HardwareModel}}: The model of the device.
- {{deviceFragmentProperty}}: More general form of the above. You can address any property of any fragment of the device.
Note
"Device" refers to the target device, as selected in the widget configuration parameter. fragment.property refers to the properties of the respective device. To see the available property names, you can use the "Asset property" or “Asset table” widget and click "+Add property" in the widget configuration. This will show a table of supported properties. You can copy and paste the values from the column “Property”. Generated properties of these widgets are not available in the HTML widgets.
Widget "Linear Gauge"¶
The "Linear gauge" widget visualizes data points in form of a linear gauge. Min and max target values are shown on the gauge as well.
Note
If a label is not properly readable, you can help yourself by increasing the min and max value of the data point to move the label into the readable range.
You must enable at least one data point to create the "Linear gauge" widget.
Widget "Map"¶
The "Map" widget shows the location of a device or all devices of a group.
You can drag the map and move its content, and you can zoom in and out by using the "Plus and Minus" buttons.
The icons representing the devices are color-coded. The color used follows these rules:
- Red = At least one critical alarm
- Orange = At least one major alarm
- Yellow = At least one minor alarm
- Blue = At least one warning
- Green = No alarm
Click a device icon, to open popup with the following information:
- The device name. When clicked, the application navigates to the device.
- The date at which the device last reported its location, if available.
- A slider to show/hide the device tracks for the previous and current days.
Parameters to configure
Target assets or devices: Select which devices are shown on the map. If a group is selected, all devices in that group (but not in any subgroups) are visible.
Note
If none of the target device(s) has a known location, then the widget shows a world map without icons.
Widget "Message sending"¶
The "Message sending" widget sends a message to a device. The behavior of the device itself is device-dependent. Only available for devices that support this type of operation.
Widget "Pie chart"¶
The "Pie chart" widget displays data points (measurements) with current values in a pie chart presentation.
Parameters to configure
| Field | Description |
|---|---|
| Title | Widget title. By default, the widget type is simply used as title. |
| Pie chart options | Select from the options to show tooltips, percentages, legends in the pie chart. |
| Data point | Shows a list of available data points. You must enable at least one data point. Click "Add data point" to add a data point to the list. |
Widget "Quick links"¶
The "Quick links" widget displays several quick links to relevant operations. There are no additional parameters to be configured.
Widget "Radial Gauge"¶
The "Radial gauge" widget visualizes data points in form of a radial gauge.
You must enable at least one data point to create the "Radial gauge" widget.
Widget "Recent alarms"¶
The "Recent alarms" widget shows all alarms of all severity sorted by time. There are no additional parameters to be configured.
For details on alarms, refer to Device Management.
Widget "Relay array control"¶
The "Relay array control" widget lets you switch relays on or off independently in an array of relays. Only available for devices that support this type of operation.
Widget "Relay control"¶
The "Relay control" widget allows you to switch a device relay on or off. Only available for devices that support this type of operation.
Widget "Rotation"¶
The "Rotation" widget lets you render an object model of a device.
Parameters to configure
| Field | Description |
|---|---|
| Title | By default, the widget type is simply used as title. |
| Target assets or devices | Select group or device to be displayed. |
| Object model for rendering | Select an object model type for rendering. May be one of "Box model" or "Phone model". |
| Wireframe | Turn "Wireframe" on or off (default = on). The "wireframe" mode displays the object in a skeletal representation. |
| Camera type | Select the type of camera to be used. May be one of "Orthographic camera" or "Perspective camera". |
In the "Rotation" widget you can rotate the object by dragging and moving it around. Zoom in and out by using the mouse.
Widget "SCADA"¶
The "SCADA" widget provides a graphic representation of the status of a device.
For details on the "SCADA" widget, refer to "Optional Services" > "Cloud Fieldbus" > "Monitoring status using the SCADA widget".
Widget "Silo"¶
The "Silo" widget displays data points (measurements) with current values in a silo presentation.
Parameters to configure
| Field | Description |
|---|---|
| Title | Widget title. By default, the widget type is simply used as title |
| Data point | Shows a list of available data points. You must enable at least one data point. Click "Add data point" to add a data point to the list. |
Widget "Traffic light"¶
The "Traffic light" widget visualizes the states of a device as traffic light.
Parameters to configure
| Field | Description |
|---|---|
| Title | Widget title. By default, the widget type is simply used as title. |
| Target assets or devices | Select group or device to be displayed. |
| States mapping | Select a property for each light. The value of the property has to be one of the following to have the respective light on: true, 1, any non-empty string, any non-null number. |
Widget "Twitter News"¶
The "Twitter news" widget displays tweets from Twitter's embedded timeline widget.
Parameters to configure
| Field | Description |
|---|---|
| Title | By default, the widget type is simply used as title. |
| Twitters's username | User name for the Twitter account being displayed. |
| Twitter's widget ID | ID for the Twitter widget. You can obtain the ID from widgets settings. |
| Options | Select if you want to display a header, footer, borders or transparency. |