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> or, for fields using display conversions, <FieldRaw>.
For example, if you have a display conversion for ZoneID, use <ZoneIDRaw> for the token. If you later disable the conversion, you do not have to update the tool path again. The path will still work with the Raw field name, even when the conversion is disabled. If you delete the conversion, you must update the path to remove Raw. See Display Conversions for information about the UI for creating display conversions.
-
<EventID>: The first selected event's EventID.
-
<Events>: A comma-delimited list of all selected events' EventIDs.
-
<ShardID>: The first selected event's ShardID.
-
<Shards>: A comma-delimited list of all selected events' ShardIDs.
-
-
Path Type: The type of path.
-
Internal: The Path value is a relative path to a Unified Assurance UI. See the default Device Info tool for an example.
-
Local: The Path value is a relative or absolute path to backend tool on the Unified Assurance presentation server (located in the $A1BASEDIR/www/tools/event directory.) See the default By Event Type tool for an example, and About Knowledgebase.php for information about the backend Knowledgebase tool.
-
Hybrid: The Path value is a relative or absolute path to a backend tool on the Unified Assurance presentation server that uses a JSON REST-type response to redirect to a Unified Assurance UI. See the default View Topology tool for an example; this tool looks up the vertex ID of the node for the selected event, then redirects to the topology graph starting with that vertex ID.
The JSON 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. See the default Analytics Search by Device tool for an example.
Does not pass EventID request parameters unless you use tokens. To pass the EventID, append &EventID=<EventID> to the path.
-
-
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.
-
Note:
A custom URL does not have direct access to the Unified Assurance session. To verify that a user is authenticated in order to use a script, verify that the CGISESSID cookie exists. If it does not, then include the following in the script:
header('Location: /');
About Knowledgebase.php
The Knowledgebase.php file is a backend tool located in the $A1BASEDIR/www/tools/event/ directory of the primary presentation server. This file provides access to relevant articles in the internal wiki. The following default tools use this file:
-
Article Device
-
Article Event Text
-
Article Event Type
-
Article Location
-
By Device
-
By Event Type
-
By Summary
You can optionally create custom view tools that use Knowledgebase.php in the Path when Path Type is set to Internal.
Knowledgebase.php Options
When using Knowledgebase.php in a tool, you can include the following options in the path:
-
Action: The action to do in the wiki. Valid values are Search and Open.
-
Type: The field from the Event database, or aggregation of fields, to use with the action. Valid values are:
-
Device: Search for or open the wiki article for the value from the Node field of the selected event.
-
EventType: Only valid when Action is set to Open. Open the wiki article for values from the Method, SubMethod, and EventType fields of the selected event.
-
EventText: Only valid when Action is set to Open. Open the wiki article for the value from the Summary field of the selected event.
-
Any other field in the Event database: Search or open the wiki article that matches the field.
-
-
EventID: Optional. Checks if the selected event still exists and returns an error if not.
For example, the default Article Device tool opens the wiki article for the value of the Node from the selected event, if the event still exists, by using the following path:
Knowledgebase.php?Action=Open;Type=Device;EventID=<EventID>