Client Tools (previously called URL Tools) use Situation and Alert data to carry out actions through a specified URL.
Client Tools can be set to return response data; providing a more detailed response in the UI that includes response status and data, which can yield useful and important information. Another example is for the tools to link to an external trouble ticket system (via its URL) which then opens a new ticket using data from the selected Situation.
There are two different types of Client Tools which can be run: Alert Client Tools and Situation Client Tools.
Go to System Settings > Tools and then either Alert Clients Tools or Situation Client Tools to open the configuration window (this is the same for both Alert and Situation Client Tools):
|This can be used to add a new Client Tool|
|This can be used to delete any selected Client Tool|
|This can be used to copy any selected Client Tool|
Creating a new Client Tool
1. Click theicon to create a new Client Tool.
2. Fill the available fields to define the tool. These are listed in the table below:
|Name||String (Mandatory)||The name for the Client Tool (up to 100 characters)|
|Description||String||The text description of the tool|
Click theicon to create a filter for specific criteria which the Alerts or Situations must match for this tool to be available
3. Next select one of the radio button options to choose one of the following options:
- URL Tool - If you want to create a tool that uses a URL.
- Merge Custom Info - If you want to created a tool that uses custom_info fields.
The different fields used to configure a URL Tool are described below:
|Show All Response Data||Boolean||If enabled, the tool will return more a more detailed response in the UI, including the response status and data|
Select GET if the tool needs to retrieve information or select POST if the tool needs to send information
Please note: Choose the method appropriate for the URL service you are interacting with
If enabled, this will open a new browser window when using the GET HTTP Method
Please note: This will disable the Show All Response Data
|URL||String||This is the URL of the Client Tool|
|URL Encoded Content||String|
This is the payload data that is to be posted when the tool is run when using the POST HTTP Method.
Please note: The payload data must be URL encoded and can include Situation and Alert attributes and prompt variables
Merge Custom Info
Select Merge Custom Info and in the Custom Info box, enter valid JSON for the custom_info you want the tool to add.
The example JSON blob below adds a set of custom_info called "TPS data" that contains a string "From MOOG", the Situation ID and the timestamp for when the Situation was created:
The JSON in the box can include Situation and Alert attributes and prompt variables.
When creating a client tool, entries in the URL, URL Encoded Content or Custom Info boxes can contain Situation or Alert attributes (for example,
$description for the contents of the Situation or Alert description field) and prompt variables.
Prompt variables open a message box when the tool is run, prompting the user to type text, a number, or select from a list.
In the URL, URL Encoded Content or Custom Info boxes, enter prompt variables in the following format:
The prompt name cannot be any of the existing Situation or Alert attribute names.
To add a new prompt:
- When entering text in the URL, URL Encoded Content or Custom Info box, type a prompt variable as described above. The prompt name appears in the Prompts table:
- To edit the prompt, double-click on it or select it and then click Edit Prompt:
Type a Display Name into the box. This is what will appear in the prompt message.
Next choose from one of the three prompt options: Text, Number and List.
• Text - this will prompt for string text. The optional text settings are described below:
Setting Input Description Default Value String This is the default prompt text Minimum Length String This is the minimum length of text which users can enter into the prompt Maximum Length String This is the maximum length of text which users can enter into the prompt
• Number - this will prompt users for a number. The optional number settings are described below:
Setting Input Description Default Value String This is the default number value Minimum Value String This is the minimum number which users can enter into the prompt Maximum Value String This is the maximum number which users can enter into the prompt
Please note: Numbers can be integers or floating point; in which case they are truncated to two decimal places
• List - this will prompt users to select from a list. The list settings are:
Setting Input Description Default Value String The default list value Available Options String These are the other available options
Click Add Option to add new options to the Available Options list. In the 'Display' column type what you want to appear for selection. In the 'Value' column, type what data you want to be added to the custom_info when the option is selected from the list. Click Update to add the option to the list.
- Finally click OK when you have finished. The new prompt will be added to the Prompts table.
When you have finished, click Save Changes. The new tool will appear in the list on the left.
Edit a Client Tool
1. Select the client tool you want to edit. Alternatively, type into the search bar to find the tool.
2. Edit fields as described above
Please note: You cannot edit the tool Name. If you need to do this, create a duplicate with the name you want. You can then delete the original
3. Click Save Changes.
4. If you want to discard your changes, click Revert Changes.
Running Client Tools
The Client Tools can be accessed from the following areas:
Client tools can also be configured to alter custom_info fields. For example, running a tool to raise a ticket on a third party system can be configured to prompt for entries of pre-defined (custom_info) values to provide more information in the ticket raised in the third party system.
Client Custom_info Tool with a Prompt Variable
To create a Client custom_info tool with a prompt variable, select the Merge Custom Info option:
In this example, the custom_info entered is:
The screenshot below shows how the prompt variable settings can be configured:
To run the tool, go to an Alert, right-click or click Tools > Tools > Set LEVEL data for TPS.
The prompt shown below will appear.
Click OK to continue.