Tools

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

Refer to the Standard Configuration Interface guide for details on interacting with the grid and form.

This user interface calls REST methods from api/vision/tools.

The UI path for this interface is Configuration -> Vision -> Tools.

Form Fields

• Name - The name for the tool.

• Icon - The icon used when viewing the list of available tools.

• Path - The URL to the web page or script to run depending on Path Type.

  Note:

  If the "Path" value starts with a "((Word))" + "://", e.g. https://, the UI will treat this as an absolute path.

  If the "Path" value does not start with the preceding value, the UI will try to open the tool in the $A1BASEDIR/www/tools/vision/ directory.

• Path Type - The type of the path.

  • Internal treats the Path field as a relative path to an Unified Assurance UI interface.

  • Local treats the Path field as a relative or absolute path to a tool on the Unified Assurance presentation server.

  • Hybrid treats the Path field as a relative or absolute path to a tool on the Unified Assurance presentation server and expects a JSON REST-type response to redirect to an Unified Assurance UI interface. Response format:

    • success: true/false.

    • message: string.

    • data: object; must contain path key with the relative internal Unified Assurance UI interface path.

    • errors: object (optional).

  • Remote treats the Path field as an URL to a tool external to the Unified Assurance presentation server.

• Target - How to open the page. Options include opening to a new pop up window, opening to the current browser tab, or a new browser window.

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

  Note:

  If a value between 10 and 90 is used, the pop up window will be this percentage of the overall browser area wide. If a value greater than 100 is used, the pop up window will be this number of pixels wide.

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

  Note:

  If a value between 10 and 90 is used, the pop up window will be this percentage of the overall browser area high. If a value greater than 100 is used, the pop up window will be this number of pixels high.

Best Practices

• When the Vision Tool is run, an array of the selected markers, called selectedMarker is available to be passed into the tool using token replacement.

  • selectedMarker is a JSON array of markers where each marker has the following keys:

    • id Internal ID of the marker

    • entityName Name of the marker

    • layer Name of the layer of the marker

    • sev Severity of the marker

    • lat Latitude of the marker

    • lng Longitude of the marker

    • image Image used for the marker

    • ipAddress IP v4 address of the marker

    • ipV6Address IP v6 address of the marker

    • sources Object containing source of the source of the marker, only for event markers. Keys are:

    • key1 description

    • address Physical address of the marker

    • type type of the marker i.e. point, ddevice or dlink

    • layer_type type of layer, i.e. custom or event