Edit a runbook

Edit online

The runbook editor provides editing capabilities as well as runbook elements that help to document operational procedures. Runbook elements are designed to avoid mistakes.

Open the runbook editor and click Library > New runbook to create a new runbook or scroll through the list of runbooks and click the menu overflow icon Open menu and select Edit runbook to open an existing runbook in the editor.

The editor consists of the following areas:

Figure 1. Working areas of the runbook editor
Working areas of the runbook editor
  1. Runbook details: Enter descriptive data about the runbook.
    Name
    The name identifies the runbook. Try to be as precise as possible and describe the problem that this runbook solves.
    Description
    Describe the problems that this runbook solves in more detail and sketch out the solution.
    Tags
    Provide tags to filter runbooks. You can select any existing tags from the drop-down list and click the plus icon + to add them. To create a new tag, type the text into the field, select the text string displayed, and click the plus icon +.
    Runbook ID
    This field is generated by Runbook Automation. The Runbook ID can be used to identify the runbook using the Runbook Automation HTTP REST Interface. Use the copy button to copy the ID to the clipboard.
  2. Editor: Provides text edit actions and runbook elements to describe operational tasks. Each step has its own section with an optional title. Manual steps cannot contain automation elements. Automated steps must be added for automations.
  3. Parameters: Create parameters that are used in this runbook.
  4. Automations: Add pre-defined automations to the runbook. Automated steps only contain an automation, no text.
  5. Save and Publish the runbook.
You can edit a runbook if you are an RBA Author or RBA Approver.
Note: A warning message might be displayed in the runbook editor for Runbooks that have been converted from an older data model. Before you save the runbook, review the steps and remove any manual steps that may have been added during the conversion. This is important for runbooks that are run in a fully automated context.