Tools

Tools is a standard configuration interface for adding, editing, and removing the custom tools that are available to perform actions and processes in Vision.

See Standard Configuration Interface in Unified Assurance Concepts for information about interacting with the grid and form.

This user interface calls REST methods from the api/vision/tools endpoints. See REST API for Unified Assurance Core for details.

To open this interface, from the main navigation menu, select Configuration, then Vision, and then Tools.

Form Fields

• Name: The name of the tool.

• Icon: The icon used for the tool in menus.

• Path: The path to the web page to open or script to run depending on the value of Path Type.

  If the value starts with a string and ://, such as https://, the UI will treat this as an absolute path. Otherwise, the UI will treat the path as relative to the $A1BASEDIR/www/tools/diagram/ directory.

  You can use the selectedMarker token in the path. When the tool is run, it replaces the token with the actual value from the selected marker array. See About the selectedMarker Array for details about the keys used in selectedMarker.

• Path Type: The type of path.

  • Local: The Path value is a relative or absolute path to a tool on the Unified Assurance presentation server.

  • Internal: The Path value is a relative path to a Unified Assurance UI.

  • Hybrid: The Path value is a relative or absolute path to a tool on the Unified Assurance presentation server, expecting a JSON REST-type response to redirect to a Unified Assurance UI. The response contains the following properties:

    • success: A true or false value indicating whether the tool succeeded.

    • message: A string.

    • data: An object that contains the path key with the relative internal Unified Assurance UI path.

    • errors: An optional object containing any errors.

  • Remote: The Path value is a URL to a tool external to the Unified Assurance presentation server.

• Target: How the tool opens new pages: in a pop-up window, in the current browser tab, or in a new browser tab.

• Width: If Target is set to Pop Up, the width of the pop-up window.

  Any value between 10 and 90 is treated as a percentage of the overall browser width. Any value greater than 100 is treated as an absolute pixel value.

• Height: If Target is set to Pop Up, the height of the pop-up window.

  Any value between 10 and 90 is treated as a percentage of the overall browser height. Any value greater than 100 is treated as an absolute pixel value.

About the selectedMarker Array

The selectedMarker token represents a JSON array of markers with the following keys:

• id: The internal ID of the marker.

• entityName: The name of the marker.

• layer: The name of the layer that the marker appears on.

• sev: The severity of the marker.

• lat:: The latitude of the marker.

• lng: The longitude of the marker.

• image: The image used for the marker.

• ipAddress: The IP v4 address of the marker.

• ipV6Address: The IP v6 address of the marker.

• sources: The object containing the source of an event marker. Used only for event markers. Keys are:

  • key1: The description.

  • address: The physical address of the marker.

  • type: The type of marker, such as point, ddevice, or dlink.

  • layer_type: The type of layer that the marker appears on, such as custom or event.