Linked runbooks allow you to control a multi-runbook event from a parent runbook with one or more linked runbooks. In this article, we’ll cover how you can add and edit parent and linked runbooks, and how to execute an event from a parent runbook.

Overview

Note: To create linked runbooks, ensure you have the ability to create runbooks and templates in your workspace.

A linked task type allows you to link runbooks to a parent runbook. A linked task is illustrated by two dashes on the rounded square task icon.

A linked runbook is a runbook that is linked to a parent runbook. These runbooks cannot begin until given the command to start from the parent runbook. When a linked runbook is in execution mode, the linked task within the parent runbook will appear in progress:

In the below screenshot, the linked runbook is depicted with its own set of tasks ready for execution.

Parent runbook overview

A parent runbook is a runbook that has one or more linked runbooks attached to it. There is no limit to the amount of linked runbooks attached to a parent runbook.

From the parent runbook, you have the ability to execute other runbooks in your workspace. A parent runbook has full control over the execution of an event and all linked runbooks. When the linked runbook completes, the linked task in the parent runbook will complete automatically. From there, the parent runbook will move on to subsequent tasks. Once all tasks have been executed successfully, the parent runbook will complete.

Manage linked and parent runbooks

Edit and access linked runbooks by either clicking the title of the linked task in the parent runbook (as depicted in the screenshot below) or by selecting the linked runbook in your workspace via the Runbooks list.

During the execution of an event, within a linked runbook you can:

Start the linked runbook once the linked task in the parent has become startable
Pause, cancel, or complete a linked runbook during a live run

These actions will update the link task status in the parent runbook. During the execution of an event, within a parent runbook, you can:

Create and start an auto start or default linked task
Skip a linked task
Abandon a linked task (from Branching Task and Branching Headers)
Pause, cancel, and resume a parent runbook

Make changes to your parent runbook at any time by navigating to your Runbooks list in your workspace and editing as you would any runbook. For example, you can add or remove tasks and access the Runbook Details panel as needed.

To duplicate a parent runbook, click the cog icon next to the runbook title > Duplicate runbook. All linked tasks will be duplicated; templates used in the original runbook will also be duplicated into the linked tasks of the duplicated runbook.

Linked runbooks can be archived at any time, except when their associated parent runbook is in live or rehearsal run, or if the linked runbook is in a run itself. To archive a parent runbook, click the cog icon next to the runbook title > Archive. When a parent runbook is archived, it will be unlinked from its associated linked runbooks but archived. To note, associated linked runbooks will need to be archived separately.

Attach a linked runbook via template

When a linked task type is added to a runbook, it is linked to a template that is then converted to a linked runbook. To add a linked runbook to a parent runbook, a Linked task type will need to be added to the parent runbook first. Linked runbooks can only be linked to parent runbooks if they are templates. Follow the steps below on how to do this.

Create a task or select an existing task.
Click on the task to open the Task Details panel. In the Task Type drop-down menu, click the Linked task type.

Alternatively, insert a linked task below an existing task by clicking the More options icon.

3. Click on the Template Name field to select a template for the linked task. You have the ability to select any template you have access to within your workspace.

4. Click the + LINK button in the modal window to save and create your linked task/runbook. If you wish to change the template, you can use the edit icon next to the template name.

5. Make any further details required in the Task Details panel and click Save on the top right-hand corner of the panel.

Once the task is created, the template linked will create a child runbook that is a linked task within the parent runbook.

After you have saved your changes to the new linked runbook task, a new task will be added to the bottom of the task listing.

Execute an event

Once your parent and linked runbooks are set up, following the steps above, you can now execute an event.

Before executing an event with parent and linked runbooks, it's important to note that the parent runbook has control over the execution of the event. As a result, all linked runbooks are locked from starting until they have received the command to unlock from the parent runbook.

To execute an event with linked runbooks, follow the steps below:

Navigate to your parent runbook.
Click Play in the upper right-hand corner.
Start tasks and linked tasks as needed.

While the linked runbook is in execution mode, the linked task associated with it in the parent runbook will appear as "in progress." When the linked runbook completes, the linked task associated with it in the parent runbook will automatically complete, allowing the parent runbook to move on to subsequent tasks.

After all tasks have been completed, the parent runbook will complete.

If needed, make changes to your parent runbook at any time by navigating to your Runbooks list within your workspace and editing as you would any runbook.

For example, you can add or remove tasks and access the Runbook Details panel as needed.

To duplicate a parent runbook, click the cog icon next to the runbook title > Duplicate runbook. All linked tasks will be duplicated; templates used in the original runbook will be carried over into the linked tasks of the duplicated runbook.