Splunk® Phantom

Build Playbooks with the Visual Editor

Acrobat logo Download manual as PDF


This documentation does not apply to the most recent version of Phantom. Click here for the latest version.
Acrobat logo Download topic as PDF

Create a new playbook in Splunk Phantom using the visual playbook editor

Perform the following tasks to open the visual playbook editor (VPE) and create a new playbook in Splunk Phantom:

  1. From the Main Menu, select Playbooks.
  2. Click + Playbook. The VPE opens in a new tab in your browser. The Start and End blocks are populated on the editor. All playbooks must start with the Start block and end with the End block.
  3. Specify a name for the playbook.

Playbooks in the same folder cannot have the same name. Playbooks in different folders can have the same name. Click the plus and minus icons to zoom in or zoom out.

Go to Add a new block to your Splunk Phantom playbook to learn how to add a new block and begin building your playbook.

Organize your playbook library in Splunk Phantom

Organizing your playbooks can help you quickly assess the purpose of each playbook. The following is a list of recommendations on how to name and organize your playbooks.

  • Create concise names for your playbooks. In certain views, there is a limited width for displaying the playbook execution history.
  • Use the category field in the playbook to specify the most important attribute of the playbook for organizational purposes. For example, the team that owns the playbook, the environment the playbook runs in, or the use case of the playbook. Using this field helps you quickly assess the purpose of each playbook.
  • Use the name of the playbook as a high-level description of what the playbook does. You can use the description field of the playbook to add more detailed information.
  • Use tags to track other attributes of the playbook such as the team member who is responsible for it, the stability level, or the priority.

The playbook listing page provides information on the apps, actions, assets, and playbooks used, so there is no need to include this type of information in your playbook name. Attempting to include this information in the playbook name can cause issues as the metadata will change over time and you will have to update your playbook names and calls to sub playbooks.

Last modified on 22 July, 2020
PREVIOUS
Use playbooks to automate analyst workflows in Splunk Phantom
  NEXT
Add a new block to your Splunk Phantom playbook

This documentation applies to the following versions of Splunk® Phantom: 4.10, 4.10.1, 4.10.2, 4.10.3, 4.10.4, 4.10.6, 4.10.7


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters