View Tool¶

Form Fields¶

Tool Name - The name of the tool.
Icon - The icon used when viewing the list of available tools.
Path - The URL to the web page that will be opened when this tool is used.

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 above, the UI will try to open the tool in the $A1BASEDIR/www/tools/event/ directory.
Path Type - The type of the path.
- Internal treats the Path field as a relative path to an Assure1 UI interface.
- Local treats the Path field as a relative or absolute path to a tool on the Assure1 presentation server.
- Hybrid treats the Path field as a relative or absolute path to a tool on the Assure1 presentation server and expects a JSON REST-type response to redirect to an Assure1 UI interface. Response format:
  - success: true/false
  - message: string
  - data: object; must contain path key with the relative internal Assure1 UI interface path
  - errors: object (optional)
- Remote treats the Path field as an URL to a tool external to the Assure1 presentation server. Does not pass EventID request parameters unless using tokens. (e.g. To pass the EventID, append to the path &EventID=<EventID>. See Best Practices)
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.
Refresh - The event list will be unpaused and refreshed when the tool finishes if the box is checked. This only applies if the Target is not the current Assure1 Tab. If the Target is a new tab, the list refreshes when the tab opens. If the Target is a pop up, the list refreshes when the pop up window is closed.
Augment Data - Obtains Event information for the first selected Event and makes it available to the tool via a Request parameter. This data will come from the Events database for Realtime tools and Historical for historical tools. Historical event data is pulled from the record with the most recent Reported time.
Journal - A checkbox to control whether or not a journal entry is added to the event when the tool is used.
Entry - The journal entry that will be added when the tool is used.

Best Practices¶

When the View Tool is executed, event values can be provided to the tool through token replacement. The following tokens if seen will be replaced in Path field:
- Any Event column name in the format of <Field> (e.g. <Node> is replaced with the value from the Node field).
- <EventID> - Replaced with the first selected Event ID.
- <Events> - Replaced with a comma-delimited list of all selected Event IDs.
- <ShardID> - Replaced with the first selected Event Shard ID.
- <Shards> - Replaced with a comma-delimited list of all selected Event Shard IDs.
When the journal is written, the following tokens will be replaced in the Entry field:
- $USERID - UserID of the user executing tool.
- $USERNAME - User name of the user executing tool.
- $USERFULLNAME - Full name of the user executing tool.
- $USERGROUPID - User Group ID of the user executing tool.
A custom URL does not have direct access to the Assure1 session. If you wish to verify that a user is logged in in order to use a script, the following must be done:
- Verify that the CGISESSID cookie exists.
- If it does not, then do the following in the script:
```
header('Location: /');
```

Back