Path-C1: Display Summary Alert Information

This logic path processes the information passed in by the external/third-party entity (via HTTP-Request Body) to:

C1: Get Current Alert Variables employs Functions: Transform node to convert Runbook runtime-variables into output properties of this node. These output properties get passed to subtending nodes.

C2: Display Alert employs Visualizations: Table node to display some of the supplied information in a table.

C1: Functions: Transform - Get Current Alert Variables

The Functions: Transform node formats the data needed by the Runbook automation into JSON, enabling the Runbook to provide native input to another node. The transformation is performed according to the Transform Template defined in the Functions: Transform node.

Placement of the Functions: Transform node on the Canvas in the Runbook Editor

There are two methods to place the Functions: Transform node in the canvas of the Runbook Editor.

  1. Find Functions: Transform in the palette on the left-side of the Runbook Editor and drag it onto the canvas to the right of the Variables: Set Primitive Variable node:

    1. The Variables: Set Primitive Variable node is a precursor for the Functions: Transform node. Connect the data flow from Triggering Entity: Webhook to Functions: Transform

  2. Alternatively, click on the plus sign on the Variables: Set Primitive Variable node to reveal a pop-up menu of relevant nodes. Then, find and select the Functions: Transform node.

NOTE: this method automatically connects the data flow from Variables: Set Primitive Variable to Functions: Transform.

Functions: Transform: Properties Blade

Configuration of the Node to format the desired Runbook-runtime variables into a JSON-format

NOTE: Prerequisite Runbook-runtime variables are assumed to have already been defined.

The Functions: Transform node, must be configured to format desired pre-defined Runbook-runtime variables into a JSON-format:

  1. In the Functions: Transform editor-card on the right, the “Transform Template” area must first be configured with a Liquid-template that defines creation of new OUTPUT DATA PROPERTIES and the mapping of associated runtime variables:

    NOTE: This area of the node configuration uses Liquid-templates to define data formats. Refer to Working With Liquid Templates.

    1. For this workflow, use the following Liquid-template to map the target Runbook-runtime variables into a JSON-format.

    Copy 
    {
    "data": [
    {
    "keys": {
    "Alert_Name": "{{variables["runtime.alert_name"]}}",
    "Date": "{{variables["runtime.alert_timestamp_epoch"] | date: '%Y-%m-%d--%H-%M-%S'}}",
    "Event_Details": "{{variables["runtime.last_event_details"]}}",
    "Category": "{{variables["runtime.category"]}}",
    },
    "data": {}
    }
    ],
    "info": {
    "keys": [
    {
    "id": "Alert_Name",
    "label": "Alert Name",
    "type": "string",
    "unit": ""
    },
    {
    "id": "Date",
    "label": "Date",
    "type": "string",
    "unit": ""
    },
    {
    "id": "Event_Details",
    "label": "Event Details",
    "type": "string",
    "unit": ""
    },
    {
    "id": "Category",
    "label": "Category",
    "type": "string",
    "unit": ""
    }
    ],
    "metrics": []
    }
    }

  1. Next, in the Functions: Transform editor card on the right, go to the OUTPUT DATA PROPERTIES area and add a Property for each of the target Runbook runtime-variables (i.e. enter the Name, Type, and Unit as appropriate for each):

  1. Click “Save & Close” to save this node configuration.

C2: Visualizations: Table - Display Alert Summary

Over the course of execution, there are points in an automation work-flow where it is useful to surface the information gathered or generated by the Runbook. The Runbook Visualization Nodes provide a means for a Runbook to surface information in a number of formats including the following:

  • Table

  • Pie Chart

  • Bar Chart

  • Timeseries Chart

  • Bubble Chart

  • Correlation Chart

  • Cards

  • Gauges

  • Connection Graph

  • Debug

  • Text

This Runbook uses the Visualizations: Table node to surface summary information about the SDA Alert that triggered this specific Runbook execution. The information collected includes the following:

  • Alert Name

  • Date

  • Event Details

  • Category

Placement of the Visualizations: Table node on the canvas in the Runbook Editor

There are two methods to place the Visualizations: Table node in the canvas of the Runbook Editor.

  1. Find Visualizations: Table in the palette on the left-side of the Runbook Editor and drag it onto the canvas to the right of the Functions: Transform node:

    1. The Functions: Transform node provides JSON formatted information as input for the Visualizations: Table node. Connect the data flow from Functions: Transform to Visualizations: Table.

  2. Alternatively, click the plus sign on the Functions: Transform node to reveal a pop-up menu of relevant nodes. Then, find and select the Visualizations: Table node.

NOTE: this method automatically connects the data flow from Functions: Transform to Visualizations: Table.

Visualizations: Table: Placement on the canvas

Configuration of the Node to surface the desired information

By default, the Visualizations: Table node surfaces all JSON parameters passed from the preceding node.

The Visualizations: Table node can also be configured to only surface certain JSON-parameters passed from the preceding node:

  1. In the Visualizations: Table editor card on the right:

    1. Go to the “Table Columns” area to review the available JSON parameters. Remove any that do not need to be surfaced.

    2. Go to the “Sort Column” area to set the desired sort column and the desired sort order.

    3. Make any other desired changes.

  2. Click “Save & Close” to save this node configuration.

The Visualizations: Table is configured to parse this JSON and surface as a table similar to:

Previous Step | Next Step