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 event. Default tools include actions such as viewing event history (if the historical database has been initialized), acknowledging or un-acknowledging an event, opening a wiki page, and more.
Refer to the Standard Configuration Interface guide for details on interacting with the grid and form.
This user interface calls REST methods from api/event/tools.
The UI path for this interface is Configuration -> Events -> Tools.
Subforms
Meta
Knowledgebase.php
The Knowledgebase.php file is used by a few default tools so users can access relevant pages in the internal wiki. This file is called by some of the default tools, but can also be used in custom tools, if desired.
Options
| Inputs | Values | Description |
|---|---|---|
| Action | Search, Open | What type of action to do in the wiki. |
| Type | Device, EventType, EventText, (Any field in the real-time event database) | Event Field or Aggregate to use. |
| EventID | Optional |
Note:
Some of the values that can be set for Type have special processing that will be done in the file and can not be changed.
-
For either Action value, if Type is set to "Device", the value from the "Node" event list field will be used.
-
The "EventType" and "EventText" types are only valid when Action is set to "Open".
-
When Action is set to "Open", if Type is set to "EventType", the values from the "Method", "SubMethod" and "EventType" event list fields will be used.
-
When Action is set to "Open", if Type is set to "EventText", the values from the "Summary" event list field will be used.
-
Example Path
An example path that can be used in a tool is:
Knowledgebase.php?Action=Open&Type=Device
Note:
Tools marked with an asterisk (*) use the Knowledgebase.php file.
-
Article Device *
-
Article Event Text *
-
Article Event Type *
-
Article Location *
-
By Device *
-
By Event Type *
-
By Summary *