Widgets
All Dashboards are constructed using OCS360 widgets, defined in the Widget Library.
A widget is an element that displays a specific type of information or functionality on a dashboard. Widgets are used to display or control data and visualize information obtained from devices connected to the OCS360platform.
Widget Types
According to the provided features, each widget definition represents a specific widget type. There are five widget types:
Each widget type has its own specific data source configuration to visualize data. The types of available data sources depend on the widget type:
-
Alarm Source - this data source type, used primarily in Alarm widgets, requires a source entity to display related alarms and their corresponding fields
-
Alarm Count - this data source type is used in the latest values widgets. The user needs to specify the target entity
-
Device - this data source type is used in both the time-series and latest values widgets. The user needs to specify the target device, and the time series key, or the attribute name, or entity field
-
Entities Count - this data source type is used in the latest values widgets. The user needs to specify the target entity
-
Entity - this data source type is used in both the time-series and latest values widgets. The user needs to select the target entity by specifying an entity alias, and the time series key, or the attribute name
-
Function - this data source type is used in both the time series and latest values widgets for debugging. The user can specify a JavaScript function that will simulate data from a device in order to set up visualization.
The Latest values widget type is used to showcase the latest values of a specific device time series data point e.g., any Gauge Widget. This type of widget uses values of time series as a data source. Digital Gauge in the example is displays the current temperature value.
The Time Series widget type displays historical values for the selected period of time, or the latest values in a certain time window (e.g., Timeseries Line Chart or Timeseries Bar Chart). This widget type uses only the values of Device Time Series as a data source. In order to specify the time frame of displayed values, TimeWindow settings are used. The Time Window can be specified on the dashboard page or via widget details. It can be either Realtime (the dynamically changed time frame for a certain latest interval), or History (a fixed historical time frame). All of these settings are part of the Timeseries widget configuration. For example, the “Timeseries Line Chart” displays the speed value of the device in real-time.
The Control widget allows the user to send RPC commands to devices; it handles and visualizes replies from the device. The RPC widgets are configured by specifying the target device as the target endpoint for RPC commands. For example, the “Knob Control” widget is used to send set temperature value to the device.
-
Select the Knob Control widget from the Control Widget bundle
-
In the Target device “entity alias” field select the entity alias created in the name of device.
-
In the appearance tab “Device subscribed tags” field will list all the tags that are subscribed from the selected OCS device. Select the tag as required and click on “Add”
-
To list device subscribes tags in control widgets, program downloaded in the OSC device must be configured with variables under “Subscribe” groups and device state must be ACTIVE in OCS360 platform.
See Subscribe Topics Example:in Cscape Configuration for instructions on creating groups.
The Control widget is now created. Use the knob to change the tag values
By default, the knob control widget updates data as real values in the OCS.To configure the widget as an Integer data type, select the option, “Disable decimal values” that is available in the appearance section.
Data Update Widget (Numeric Entry Widget):
This widget can be used to send numeric value in Integer or Real format to OCS device. The widget has value field click on that to enter the value for the configured variable.
On clicking “Send” button the entered value will be send to the OCS device.
LED Indicator Widget
-
Select the led indicator from the Control Widget bundle
-
In the Target device “entity alias” field select the entity alias created in the name of device.
-
In the appearance tab under value settings select the variable from the list that drop down in the led status value field.
The Alarm Widget type displays alarms related to the specified device in a certain time window (e.g., the Alarms table). To configure the Alarm widget, the user configures the device as the alarm source and defines the corresponding alarm fields.
As for the Timeseries widgets, the Alarm widgets have the Time Window configuration to specify the time frame of the displayed alarms. Additionally, the configuration includes parameters such as “Alarm status”, “Alarm severity”, and “Alarm type”. The “Alarm status” parameter shows the status of the alarms being sent. The “Alarm severity” parameter shows the frequency of alarm sends (in seconds). The “Alarm Type” parameter helps identify the primary source of the alarm. For instance, “HighTemperature” and “LowHumidity” represent two different alarms. In this context, the “Alarms table” widget displays the latest alarm for the device in real-time
The Static Widget type displays static customizable HTML content (e.g., HTML card). Static widgets do not use any data sources and are usually configured by specifying static HTML content and, optionally, CSS styles. An example of a Static widget is the “HTML card” that displays the specified HTML content.
Label Card
The label card widget is useful to create custom labels. This widget will display only static information.
SCADA widgets are used to visualize or control data published from an OCS in SCADA layout. Using these widgets dashboards can be designed to have same look and feel as a SCADA system.
There are five different SCADA widgets bundles are available,
| SCADA Widget Bundles | |
|---|---|
| General high-performance SCADA | Contains high performance SCADA symbol widgets. |
| High-performance SCADA Energy Systems | Contains SCADA widgets for energy applications |
| High-performance SCADA Fluid Systems | Contains SCADA widgets for fluid applications |
| High-performance SCADA Oil and Gas | Contains SCADA widgets for oil and gas applications. |
| Traditional SCADA Fluid Systems | Contains traditional SCADA widgets for fluid applications |
Widgets are grouped into widget bundles according to their purposes. Some widgets can be found in multiple packages simultaneously. For example, the Alarm Count widget can be both found in the Alarm widgets bundle and the Count widgets bundle.
User can use search function to find the widgets in the widget’s bundles.
Alarm Widgets Bundle
The Alarm Widgets bundle is useful for visualization of alarms for specific Devices, both in real-time and history modes.
Analog Gauges Widgets Bundle
The Analog Gauges Widgets bundle is useful for visualization of temperature, humidity, speed, and other integer or float values.
Cards Widgets Bundle
The Cards Widgets bundle is useful for visualization of time series data or attributes in table or card widgets.
Charts Widgets Bundle
The Charts Widgets bundle is useful for visualization of historical or real-time data with a time window.
Control Widgets Bundle
The Control Widgets bundle is useful for visualization of the current state and sending RPC commands to target devices.
Count Widgets Bundle
The Count Widgets bundle is useful for counting and visualizing the current number of alarms and devices.
Date Widgets Bundle
The Date Widgets bundle is useful for changing the date range for other widgets on the dashboard.
Digital Gauges Widgets Bundle
The Digital Gauges bundle is useful for visualization of temperature, humidity, speed and other integer or float values.
Home Page Widgets Bundle
The Home Page Widgets bundle is useful for customizing and displaying quick links to the platform’s UI components, documentation, or any other resources on the home page, displaying statistics about the number of devices and API usage, etc.
HTML Widgets Bundle
The HTML Widgets bundle is useful for injecting custom HTML code, or for displaying configurable HTML with the ability to inject values from the selected data source.
Input Widgets Bundle
The Input widgets bundle is useful for modifying the attributes of an devices.
Liquid Level Widgets Bundle
The Liquid Level Widgets bundle includes widgets for visualizing the level of liquid inside the tank.
Maps Widgets Bundle
The Map Widgets bundle is useful for visualizing the geographic location of devices and tracking device routes in both real-time and history modes.
Navigation Widgets Bundle
The Navigation Widgets bundle is useful for defining the home dashboard of the user.
Table Widgets Bundle
The Tables Widgets bundle is useful when the user needs to display a list of alarm signals, and time series data. Additionally, this widget bundle showcases persistent RPC requests, which are based on entity alias. It can also be filtered optionally and supports pagination for enhanced usability.
Exporting Widgets
Users can export a specific type of widget from a widget bundle in JSON format and import it in the same or different OCS360 instance.
In order to export a widget type, click the Export button on the particular widget card. The widget configuration file will be saved in JSON format.
Importing Widgets
Follow these steps to import a widget:
-
Click the “Add widget” button in the upper right corner of the "Widgets" page. Select "Import widget"
-
In the pop-up, user will be prompted to upload the JSON file. Drag and drop a exported widget Json file, then click the "Import" to add a widget to the widget bundle
The widget is imported.
Deleting Widgets
To delete a widget click on the “ X” icon that removes the widgets from the dashboard.