Tools View

To open this subform, select or create an event tool with the View type from the Tools UI.

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.

  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/event/ directory.

  You can use tokens in the path. When the tool is run, tokens are replaced with actual values. For example, <Node> is replaced with the value from the event's Node field.

  You can use the following tokens:

  • Any Event column name in the format <Field>

  • <EventID>: The first selected EventID.

  • <Events>: A comma-delimited list of all selected EventIDs.

  • <ShardID>: The first selected event ShardID.

  • <Shards>: A comma-delimited list of all selected event ShardIDs.

• 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. Does not pass EventID request parameters unless you use tokens. To pass the EventID, append &EventID=<EventID> to the path. See Best Practices)

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

• Refresh: Select this to unpause and refresh the event list when the tool finishes.

  When Target is New Tab, the list refreshes when the tab opens.

  When Target is a Pop Up, the list refreshes when the pop-up window is closed.

  When Target is Current Tab, this setting does not apply.

• Augment Data: Select this to obtain event information for the first selected event and make it available to the tool through a request parameter. This data comes from the Event database for real-time tools and the Historical database for historical tools. Historical event data is pulled from the record with the most recent reported time.

• Journal: Select this to add a journal entry to the event when the tool is used.

  • Entry: The journal entry to add when the tool is used.

    You can use the following tokens, which are replaced with actual values when the journal is written:

    • $USERID: The UserID of the user running the tool.

    • $USERNAME: The username of the user running the tool.

    • $USERFULLNAME: The full name of the user running the tool.

    • $USERGROUPID: The user group ID of the user running the tool.

  • Actor: The actor value to be used when the tool is run. It will default to the UserID of the user running the tool if it is left blank.

  • Action: The action value to be used when the tool is run. It will default to the name of the tool if it is left blank.

header('Location: /');