Runbook Editor

The Runbook Editor enables you to create and edit runbooks. It shows each runbook as an assembly of runbook nodes arranged in a sequence that defines the runbook's execution. The runbook nodes enable you to define the runbook as a set of discrete logical blocks, each of which performs some action relative to the initial trigger and subsequent queries to Alluvio IQ's data ocean.

The Runbook Editor can be launched from the Runbooks Page, either by choosing Edit from the ... pop-up menu at the right of a runbook's name, or, if the runbook's definition is shown, by clicking Edit above the preview.

This topic describes the components and controls that make up the Runbook Editor. Creating Custom Runbooks Using the Runbook Editor describes the process of how to create a new runbook and edit an existing one.

Tool Bar

The tool bar resides at the top of the Runbook Editor, providing controls for working with the current runbook definition.

  • New Runbook – Begin defining a new runbook on a blank canvas.

  • Save – Keep the latest changes to the current runbook definition. The Save Runbook dialog will appear, prompting you to type or change a name and description for the runbook. The name and description will be visible in the list of runbooks on the Runbooks Page.

  • ExportOutput the runbook definition to a JSON file that can be imported subsequently to create a new runbook.

  • Reset – Discard all unsaved changes and revert to the last saved definition. For a new, unsaved runbook, this discards everything.

  • Undo – Roll back the previous unsaved change to the runbook. You can click this repeatedly to roll back multiple unsaved changes sequentially.

  • Redo – Re-implement the previous undone unsaved change to the runbook. ("Undo the last undo.") You can click this repeatedly to re-implement multiple undone changes sequentially.

  • Zoom In – Look at the canvas more closely to see an area in more detail, focusing on any nodes that are selected.

  • Zoom Out – Back away from the canvas to see more of it at one time.

  • Fit to Screen – Adjust the view of the canvas to see the entire runbook definition filling the pane.

  • Multi-Select – Enable multi-select for your next action with the cursor, so you can drag a box around multiple objects on the runbook canvas to select them all at once. This is not sticky; you'll need to click this each time you want to select multiple objects.

  • Beautify – Make the arrangement of nodes on the canvas neat and orderly. This will align nodes on the canvas horizontally and vertically to make the definition easier to read.

  • Auto-Connect – Create connections between nodes automatically as they are dragged onto the canvas and arranged in sequence with other nodes. If this is disabled, you'll need to connect nodes manually.

  • Preview Output With Mock Data – Display the tables and charts that will result when this runbook executes, but with artificial data.

  • Execute a Test RunCause the runbook to execute immediately and generate output based on currently available data, and display the results.

Runbook Node Palette

The palette lists all the possible runbook nodes. Select a node and drag it to the canvas, arranging it in sequence relative to other nodes that are on the canvas already. Type text in the palette's Search panel to filter the nodes by name, or to find a specific node.

Canvas

This is the main pane of the Runbook Editor, where you place and connect runbook nodes to define the runbook.

Properties Blade

Select a runbook node on the canvas to display its properties at the right side of the canvas. You can modify the node's properties as necessary to configure the runbook's behavior.