Moogsoft Docs

Implement Client Tools

You can create Client Tools in Moogsoft AIOps to use Situation and alert data to execute 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.

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

  • Click the + icon to create a new Client Tool.

  • Fill the available fields to define the tool. These are listed in the table below:

    Field

    Input

    Description

    Name

    String (Mandatory)

    The name for the Client Tool (up to 100 characters)

    Description

    String

    The text description of the tool

    Context

    Filter (Optional)

    Click the pencil icon to create a filter for specific criteria which the Alerts or Situations must match for this tool to be available

  • 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 create a tool that uses custom info fields.

URL Tool

The different fields used to configure a URL Tool are described below:

Field

Input

Description

Show All Response Data

Boolean

If enabled, the tool returns a more detailed response in the UI, including the response status and data.

HTTP Method

GET

POST

Select GET if the tool needs to retrieve information or select POST if the tool needs to send information.

Note: Choose the method appropriate for the URL service you are interacting with.

Open Window

Boolean

If enabled, this opens a new browser window when using the GET HTTP Method.

Note: This disables 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.

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:

{"TPS data": ["From MOOG", "$sig_id", "$created_at"]}

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

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:

$<prompt_name>

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.

  • Enter a Display Name. This is what appears in the prompt message.

Next choose from one of the three prompt options: Text, Number and List.

  • Text - this prompts users for string text. The optional text settings are:

    Setting

    Input

    Description

    Default Value

    String

    The default prompt text.

    Minimum Length

    String

    The minimum length of text which users can enter into the prompt.

    Maximum Length

    String

    The maximum length of text which users can enter into the prompt.

  • Number - this prompts users for a number. The optional number settings are:

    Setting

    Input

    Description

    Default Value

    String

    The default number value.

    Minimum Value

    String

    The minimum number which users can enter into the prompt.

    Maximum Value

    String

    The maximum number which users can enter into the prompt.

    Note

    Numbers can be integers or floating point; in which case they are truncated to two decimal places.

  • List - this prompts users to select from a list. The list settings are:

    Setting

    Input

    Description

    Available Options

    String

    The other available options.

    Default Value

    String

    The default list value.

    Click Add Option to add new options to the Available Options list. In the 'Display' column enter 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.

    ClientTools1.JPG

Finally click OK when you have finished. The new prompt is added to the Prompts table.

When you have finished, click Save Changes. The new tool appears in the list on the left.

Edit a Client Tool
  • Select the client tool you want to edit. Alternatively, type into the search bar to find the tool.

  • Edit fields as described above.

    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.

  • Click Save Changes.

  • If you want to discard your changes, click Revert Changes.

Running Client Tools

The Client Tools can be accessed from the following areas:

Alert Client Tools: On the Alert Tools Menu, see Alerts Overview (Right-Click menu). Or via "Situation Alerts" in a Situation Room.

Situation Client Tools: The Situation Tools Menu, from Tools menu on the Situation Room or via ChatOps in the Collaborate tab.

round-info-button (1).png

If you want to run Client Tools using Safari, go to Safari > Preferences > Security and uncheck 'Block pop-up windows' as this is checked by default.

Examples

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:

Newscreenshot.png

In this example, the custom info entered is:

{"LEVEL": $prompt1}

The screenshot below shows how the prompt variable settings can be configured:

ClientTools3.JPG
Run the Tool

To run the tool:

  • Go to an alert, right-click or click Tools > Tools > Set LEVEL data for TPS.

  • The prompt shown below appears:

    ClientTools4.JPG
  • Click OK to continue.