Working with Playbooks and Playbook Collections

Playbook collections can be viewed, imported, and created here. In the left Playbook Collections pane, select a Playbook Collection, and all its playbooks are displayed in the main pane to the right of the Playbook Collections pane. Select a playbook from the main pane to go into Playbook Designer to view its triggers and steps. From here, you can edit the playbook, and make additional changes, such as saving a draft, publishing it, or running the playbook. If you wish to perform one of the following main actions on a playbook, select the checkbox next to the playbook(s) , then click the appropriate icon. Actions are: Activate Playbook, Deactivate Playbook, Clone Playbook, Delete Playbook, Move Playbook (to another Playbook Collection), Export Playbook, Change Logging Level.

Creating a Playbook Collection

To create a Playbook Collection, in the left pane, click the + (Create Collection) icon, then take the following steps.

1. In the Name field, enter a name for the Playbook Collection.

2. In the Description field, enter an information about the Playbook Collection, such as its purpose.

3. Enter a tag name in the Tag field. Tags are objects that can be used to reference specific playbooks and playbook collections when searching or filtering results. To add an additional tag, press the Tab key.
   

4. Note: The following special characters cannot be used in tags: ', , , ", #, ?, /

5. When done, click Save.

Importing a Playbook Collection

To import a Playbook, take the following steps.

1. Go to Resources > Automation > Playbooks.

2. From the left pane, click the Import Collection icon.

3. Choose the JSON file in the side bar pop up.

4. Click Import.

5. Enable the playbook by checking the checkbox.

Adding a Playbook

From Resources > Automation > Playbooks > Playbooks, to create a playbook, at the main Playbook Collection pane, where playbooks are displayed take the following steps.

1. To create a new Playbook, in the main pane, click + (Add a new Playbook).
   

   Note: The Add a new Playbook icon will not appear if you have an existing playbook checkbox checked.
   

2. In the Name field, enter a name for the playbook.

3. In the Description field, enter a description that allows you to identify the playbook.

4. Enter any Tags you wish to include. Tags are objects that can be used to reference specific playbooks and playbook collections when searching or filtering results.
   

   Note: The following special characters cannot be used in tags: ', , , ", #, ?, /
   

5. Select the playbook state, Active or Inactive. By default, playbooks are created in the Active state.

6. If the playbook involves a Connector, select the Target as the Agent where the Connector is going to run.

7. When done, click Save. The playbook will automatically open up in Playbook Designer. The Playbook Designer is a visual canvas that allows you to design and edit your playbooks. For details on Playbook Designer features, see here. For information about creating a playbook, see General Concepts.

Actions Available when Playbook(s) Checkboxes are Selected

• Activate Playbook: Set Playbook Status as Active.

• Deactivate Playbook: Set Playbook Status as Inactive.

• Clone Playbook:Clone selected playbooks. The selected playbook(s) are saved with the name %Playbook Name%(1). Cloning the playbook clones every step within the playbook.
  

  Note: If you have cloned a playbook that contains a reference to other playbooks, either within the same collection or in different collections, then the references do not get automatically updated. However, if you simultaneously clone playbooks in the same collection where either one references the other or they both reference each other, then the references get automatically updated. For example, consider a playbook named 'Extract and Enrich Indicators' playbook that references the 'Enrich Indicators' playbook. Now, if you simultaneously clone both the 'Extract and Enrich Indicators' and 'Enrich Indicators' playbooks to create the 'Extract and Enrich Indicators (1)' and 'Enrich Indicators (1)' playbooks, all references in the 'Extract and Enrich Indicators (1)' playbook are updated to 'Enrich Indicators (1)' playbook.

• Delete Playbook:Delete the selected playbooks.

• Move Playbook:Move playbooks to another collection. From the Move to Collection drop-down, select the Playbook Collection to move the playbook(s) to, then click Submit.
  

• Export Playbook:Export playbooks in JSON format, including any associated tags. You will be prompted as to whether you wish to include all versions or just the current playbook.

• Change Logging Level: Change the logging level for playbooks. From the Select Execution Log Level drop-down, select VERBOSE or MINIMAL as the logging levels for the playbooks, then click Apply.

  Note: It is recommended to set the playbook logging level to MINIMAL for production instances and in scenarios where you want to use storage space efficiently; whereas set the logging level to VERBOSE while designing or debugging playbooks since this option can quickly fill up the storage space.