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 Name - 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 can be set to change the widget color and play a sound when the metric is in violation.
-
If set to a pre-configured threshold, the widget can change color and play a sound when the metric is in violation.
-
-
Warning Threshold Operator - If Warning Threshold is set to "[Manual]", the operator that will be used to check for metric violation. Used in conjunction with Warning Threshold Value field.
-
Warning Threshold Value - If Warning Threshold is set to "[Manual]", the value used to check for metric violation. Used in conjunction with Warning Threshold Operator field.
-
Warning 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 can be set to change the widget color and play a sound when the metric is in violation.
-
If set to a pre-configured threshold, the widget can change color and play a sound when the metric is in violation.
-
-
Critical Threshold Operator - If Critical Threshold is set to "[Manual]", the operator that will be used to check for metric violation. Used in conjunction with Critical Threshold Value field.
-
Critical Threshold Value - If Critical Threshold is set to "[Manual]", the value used to check for metric violation. Used in conjunction with Critical Threshold Operator field.
-
Critical 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.
-
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.
Widget Properties
Token | Description |
---|---|
<WidgetID> | SVG Widget identifier |
<LinkType> | Drill-down link type: 'Diagram', 'DiagramBasic', 'DiagramDynamicDevice', 'ManualInternal', 'ManualExternal' |
<LinkTarget> | Drill-down link target: 'SameTab', 'NewTab', 'NewWindow' |
<LinkDiagramID> | Optional Drill-down diagram to open. Only applicable for 'Diagram', 'DiagramBasic', and 'DiagramDynamicDevice' link types |
<LinkDeviceID> | Optional Drill-down dynamic device diagram to open. Only applicable for 'DiagramDynamicDevice' link type |
<LinkURL> | Optional Drill-down URL to open. Only applicable for 'ManualInternal' and 'ManualExternal' link types |
<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 |
<MenuID> | Associated context menu ID. 0 if no menu |
<StrokeType> | Stroke type: 'Empty', Gradient', 'Color' |
<StrokeGradient> | Optional stroke gradient clor in hex notation. Only present for 'Gradient' stroke type |
<StrokeColor> | Optional stroke color in hex notation. Only present for 'Color' stroke type |
<StartPointType> | Start point type: 'Triangle', Arrow', 'Circle', or 'None' |
<EndPointType> | End point type: 'Triangle', Arrow', 'Circle', or 'None' |
<StartPointSize> | Start point size: 'Small', 'Medium', 'Large' |
<EndPointSize> | Start point size: 'Small', 'Medium', 'Large' |
<Theme> | Color theme |
<DeviceID> | Device ID |
<MetricTypeID> | Metric Type ID |
<MetricID> | Metric ID |
<Period> | Metric Period: Daily, Weekly, Monthly, Yearly |
<ManualPollCycles> | Poll Cycles Ago |
<ThresholdTypeID> | Threshold Type ID |
<WarningThresholdID> | Warning Threshold ID. 0 if manual |
<WarningManualThresholdOperator> | Optional Warning manual threshold operator |
<WarningManualThresholdValue> | Optional Warning manual threshold value |
<CriticalThresholdID> | Critical Threshold ID. 0 if manual |
<CriticalManualThresholdOperator> | Optional Critical manual threshold operator |
<CriticalManualThresholdValue> | Optional Critical manual threshold operator |