Run Playbook

The Run Playbook step allows the package flowing through a playbook to be (optionally) diverted to another specific playbook (called a "sub-playbook") that uses a top step of type Playbook. The output of the sub-playbook will be sent back to the sending playbook. In programming lingo, this allows you to make a function that accepts information, does something to it, then sends information back to you.

Place this step wherever you would like the steps in the sub-playbook to run. The sub-playbook steps will run as if they were inline right where the Run Playbook step is.

  • Choose Playbook: The dropdown menu lists any playbook that starts with an input type of Playbook. This means you will need to create the sub-playbook before you can select it in this configuration.
  • Open Selected Playbook: This button is a shortcut to open the selected sub-playbook for editing. It will open as a new tab with your other open playbook editors.
  • Skip this step if the sub-playbook is not enabled (checkbox): If this box is checked, the parent playbook will only send the package through this sub-playbook if the sub-playbook is in the Enabled (checked) state in the Playbook Manager. If the package is not sent through the sub-playbook, it will continue out the positive (+) side of the Run Playbook step. This feature allows you to manage which sub-playbooks are active at any time by toggling their checkboxes in the Playbook Manager instead of having to edit the playbook(s) each time you want to change.

The Sub-Playbook Rule


The step that determines if the sub-playbook returns TRUE or FALSE cannot have any children.

The playbook with the Run Playbook step in it needs to know which side the package that comes back from the sub-playbook should go down when it returns and exits to the next step. If the package exits a step in the sub-playbook that has no children (no steps connected to either + or -) it will be sent back to the Run Playbook step using the same output path. These steps are colored light yellow.

If a step only has one output (positive or negative) and the package exits on a side that has no additional steps attached, any changes to the package in the sub-playbook are removed and the package returns to the parent unaltered. The package will exit from the false side of the parent playbook.

  • step/run-playbook
  • Last modified: 2019/08/12 20:42