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 diagram.

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

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

The UI path for this interface is Configuration -> Diagrams -> 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 proceeding value, the UI will try to open the tool in the $A1BASEDIR/www/tools/diagram/ directory.

• Path Type - The type of the path.

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

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

  • 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.

  • Remote treats the Path field as a link to an external website.

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

• Width - If Target is set to "Pop Up", the width of the pop up 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 pop up 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

• The following tokens will be replaced in Path field:

  • Any widget property in the format of <Property> (e.g. <DeviceID> is replaced with the value from the SVG element's DeviceID property). Refer to Diagrams for the complete list of supported properties for the different widget types.