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 topology view.

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/topology/tools endpoints. See REST API for Unified Assurance Core for details.

To open this interface, from the main navigation menu, select Configuration, then Graph, then Topology, 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 or function 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/topology/ directory.

  You can use tokens in the path in the format <Property> to represent object properties. When the tool is run, tokens are replaced with actual values. For example, <DeviceID> is replaced with the value from the object's DeviceID property.

  Common tokens include:

  • <DeviceID>

  • <ObjectID>

  • <OwnerUserID>

  • <OwnerUserGroupID>

  See the specific objects for additional supported properties.

• Path Type: The type of path.

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

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

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

  • Function: The Path value is the name of a function implemented as a custom overrides in GraphsPanelViewController. This lets you use the tool to run custom functions on edges or vertices.

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

• Optional Context-Sensitive Controls: Use these to refine what elements the topology tool is available for. If you do not set any of these fields, the tool is available for all Universal Topology graph elements.

  • Element: Select either Edge or Vertex to make the tool available to all edges or vertices.

  • Edge Type: Select a specific edge type to make the tool available to all edges of that type.

  • Vertex Type: Select a specific vertex type to make the tool available to all vertices of that type.

  The most inclusive selection applies. This means that if you select Edge in Element, the tool is available for all edges, regardless of what you select in Edge Type.

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