References Steps

References represent steps that help create a chain of playbooks.

Reference a Playbook

Use the Reference a Playbook step to trigger another playbook within the current playbook, creating a chain of multiple playbooks. This step allows you to call any playbook in the system, whether Active or Inactive, by name.

To add a Reference a Playbook step:

1. In the Playbook Designer, from the Select Step pane, choose Reference a Playbook.

2. In the Step Name field, type the name of the step.

3. (Optional) Click Add Description to add a description for the step.

4. From the Playbook Reference field, choose the playbook you want to reference from the list of available playbooks across all playbook collections in the system.

5. From the Parent Data Reference field, choose what data the parent playbook will pass to the referenced playbook:

   • Full ENV: Pass the complete environment data from the parent playbook to the reference playbook. This allows the referenced playbook to access any dynamic variable from the parent playbook and use it just as it is being used in the parent playbook.

   • Pass Input Record Only: Pass only the record inputs available under vars.input.records from the parent playbook to the reference playbook.

   • Not Required (default): Prevents any data of the parent playbook from being passed to the reference playbook. This is useful when you want to avoid unnecessary data passing, such as when the referenced step loops on lot of items or when the playbook is run in the debug mode, consuming memory and database space.

6. (Optional) Add playbook actions, such as Variables, Loops, etc., to this step by clicking Variables in the playbook step footer. For more information on playbook actions that extend playbook steps, see Playbook Steps.

7. Click Save to save the step.