Widgets URL
Form Fields
-
X - The starting X coordinate for the widget.
-
Y - The starting Y coordinate for the widget.
-
Width - The overall width of the widget.
-
Height - The overall height of the widget.
-
Rotation - The rotation of the widget.
-
Type - The type of link that is being displayed. Internal links are links to other Unified Assurance interfaces, while external links should be used for external sites.
-
URL - The URL to be displayed in the widget.
-
Scrolling - Whether or not scroll bars should be displayed to the user.
-
Frame Border - Whether or not to show a border around the widget.
-
Refresh - Whether or not to automatically refresh the URL. The refresh time is configured in the User Group and/or the individual user's Properties.
-
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, 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/deviceswould 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 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 |
| <X> | X point of widget relative to the diagram canvas |
| <Y> | Y point of widget relative to the diagram canvas |
| <Width> | Widgth of widget in pixels |
| <Height> | Height of widget in pixes |
| <ScaleX> | Scaled X |
| <ScaleY> | Scaled Y |
| <Rotate> | Widget rotation in degrees |
| <URLType> | Type of URL |
| <URL> | URL to navigate |
| <Scrolling> | Scrolling |
| <FrameBorder> | Frame border |
| <Refresh> | Refresh time in seconds |
| <LinkType> | Drill-down link type: 'Diagram', 'DiagramBasic', 'DiagramDynamicDevice', 'ManualInternal', 'ManualExternal' |
| <LinkTarget> | Drill-down link target: 'SameTab', 'NewTab', 'NewWindow' |
| <LinkURL> | Drill-down URL to open. Only applicable for 'ManualInternal' and 'ManualExternal' link types |
| <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 |
| <MenuID> | Associated context menu ID. 0 if no menu |
Best Practices
-
External links cannot point to a page within Unified Assurance. Only internal links may point to a page within Unified Assurance.
-
Internal links should be the bare path with no leading slashes, e.g. "device/devices".