Widgets Line

Form Fields

X1 - The starting X coordinate for the widget.
Y1 - The starting Y coordinate for the widget.
X2 - The ending X coordinate for the widget.
Y2 - The ending Y coordinate for the widget.
Stroke Width - The width of the widget.
Color Theme - Whether the coloring of the widget is solid or will use a gradient.
Start Point Type - The starting point type of the widget.
Start Point Size - If an "Start Point Type" is selected, this will be the size of the start point type.
End Point Type - The ending point type of the widget.
End Point Size - If an "End Point Type" is selected, this will be the size of the end point type.
Device - The device that has the metric to be displayed.
Metric Type - After selecting a device, a list of available metric types will be displayed.
Metric Instance - After selecting a device and metric type, a list of available metric instances will be displayed.
Time Range - The time range to retrieve and display the metric data.
Threshold Type - Used to determine which threshold type comparison should be done. Options include:
- Availability which checks to see if the metric data is available in the selected period.
- Performance Utilization which does the following calculation, which is then used in the threshold comparison: (Metric Data/Metric Maximum) * 100.
- Performance Value which selects the raw metric value and is used in the threshold comparison.
Warning Threshold - The threshold settings used to check if the metric is in violation.
- If set to None, no thresholding will be done for the widget.
- If set to [Manual], a customized threshold value can be used to change the widget color, and can also play a sound when the metric is in violation.
- If set to a pre-configured threshold, the widget can change color, and can also play a sound when the metric is in violation.
- Operator - If Warning Threshold is set to "[Manual]", the operator that will be used to check for metric violation. Used in conjunction with Value field.
- Value - If Warning Threshold is set to "[Manual]", the value used to check for metric violation. Used in conjunction with Operator field.
- Audible Alert - If a metric is in violation, the selected sound will be played.
Critical Threshold - The threshold settings used to check if the metric is in violation.
- If set to None, no thresholding will be done for the widget.
- If set to [Manual], a customized threshold value can be used to change the widget color, and can also play a sound when the metric is in violation.
- If set to a pre-configured threshold, the widget can change color, and can also play a sound when the metric is in violation.
- Operator - If Critical Threshold is set to "[Manual]", the operator that will be used to check for metric violation. Used in conjunction with Value field.
- Value - If Critical Threshold is set to "[Manual]", the value used to check for metric violation. Used in conjunction with Operator field.
- Audible Alert - If a metric is in violation, the selected sound will be played.
Link Type - The various actions that can occur when the widget is clicked on. Options include doing nothing, going back one page, linking to internal or external web sites, linking to a metric graph, linking to the metric details, or linking to another diagram.
- Manual (internal) - the Link URL should be a link to any OCUA UI page (this would use a virtual path, e.g. /#device/devices would open the Configuration -> Device Catalog -> Devices page).
- Manual (external) - the Link URL is a valid physical path on the presentation server (e.g. /tools/myScript.php), or to an external site (e.g. https://www.example.com).
Link Target - If Link Type is set to link to web sites, the metric graph, the metric details, or another diagram, the new page can be opened in the current tab, a new browser tab, or a new browser window.
Link URL - If Link Type is set to link to web sites, this will be the URL of the site.
Diagram - If Link Type is set to link to a diagram, this will be the diagram to be opened.
Device - If Link Type is set to link to a Dynamic Device diagram, this will be the device that will be used within the diagram.
Context Menu - This will be the diagram menu available when context-clicking on the widget.

Token	Description
<WidgetID>	SVG Widget identifier
<X>	Starting X point of widget relative to the diagram canvas
<Y>	Starting Y point of widget relative to the diagram canvas
<X2>	Ending X point of widget relative to the diagram canvas
<Y2>	Ending Y point of widget relative to the diagram canvas
<ScaleX>	Scaled X
<ScaleY>	Scaled Y
<StrokeWidth>	Stroke width
<Theme>	Color theme
<StartPointType>	Start point type: 'Triangle', Arrow', 'Circle', or 'None'
<StartPointSize>	Start point size: 'Small', 'Medium', 'Large'
<EndPointType>	End point type: 'Triangle', Arrow', 'Circle', or 'None'
<EndPointSize>	Start point size: 'Small', 'Medium', 'Large'
<DeviceID>	Device ID
<MetricTypeID>	Metric Type ID
<MetricID>	Metric ID
<Period>	Metric Period: Daily, Weekly, Monthly, Yearly
<ThresholdTypeID>	Threshold Type ID
<WarningThresholdID>	Warning Threshold ID. 0 if manual
<WarningManualThresholdOperator>	Warning manual threshold operator
<WarningManualThresholdValue>	Warning manual threshold value
<CriticalThresholdID>	Critical Threshold ID. 0 if manual
<CriticalManualThresholdOperator>	Critical manual threshold operator
<CriticalManualThresholdValue>	Critical manual threshold operator
<LinkType>	Drill-down link type: 'Diagram', 'DiagramBasic', 'DiagramDynamicDevice', 'ManualInternal', 'ManualExternal'
<LinkTarget>	Drill-down link target: 'SameTab', 'NewTab', 'NewWindow'
<LinkDiagramID>	Drill-down diagram to open. Only applicable for 'Diagram', 'DiagramBasic', and 'DiagramDynamicDevice' link types
<LinkDeviceID>	Drill-down dynamic device diagram to open. Only applicable for 'DiagramDynamicDevice' link type
<LinkURL>	Drill-down URL to open. Only applicable for 'ManualInternal' and 'ManualExternal' link types
<MenuID>	Associated context menu ID. 0 if no menu

Title and Copyright Information

User’s Guide

F88949-01

Widgets Line

Form Fields

Widget Properties