After the future removal of the classic playbook editor, your existing classic playbooks will continue to run, However, you will no longer be able to visualize or modify existing classic playbooks.
For details, see:
View or edit the Python code in playbooks
Click the Python Playbook Editor tab to view the underlying Python code for your playbook. The code for the entire playbook is shown by default. Click any block in your playbook to view the code for the selected block only.
See the following documentation for more information about Python code in your playbooks:
- Python Playbook Tutorial for overview in the Python Playbook Tutorial for manual.
- About playbook automation APIs in the Python Playbook API Reference for manual.
Splunk does not support custom Python packages.
Manage your editing session
Use the icons in the Python Playbook Editor to manage your editing session.
How custom Python edits affect the visual playbook editor
When you see Playbook Code in the Python Playbook Editor, you are making changes affecting the whole playbook. When you begin to make edits, you are prompted to verify that you want to continue. If you continue, you will no longer be able to edit the playbook using the playbook editor. All changes to the playbook must be made by editing or adding Python code.
If you click a block in the playbook, your edits only disable the playbook editor for that block. The Python Playbook Editor changes from Playbook Code to the name of the Python function called in that block. You can continue to use the playbook editor to add, edit, or delete other blocks in the playbook. If you want to add another block downstream from the block you edited, you have to manually enter a Python function call for the next block, such as phantom.act()
. The playbook editor doesn't generate Python code for any block containing custom edits.
When editing the Python code for a Code block, make your edits in the editable area in order for callback functions to work.
- Create a Code block in the playbook editor. See Add custom code to your playbook with the code block.
- Click Python Playbook Editor.
- Click the Code block.
- Write your custom code in the area with the
# Write your custom code here...
text.################################################################################ ## Custom Code Start ################################################################################ # Write your custom code here... ################################################################################ ## Custom Code End ################################################################################
Debug playbooks in |
This documentation applies to the following versions of Splunk® SOAR (On-premises): 5.3.1, 5.3.2, 5.3.3, 5.3.4, 5.3.5, 5.3.6, 5.4.0, 5.5.0, 6.0.0, 6.0.1, 6.0.2, 6.1.0, 6.1.1, 6.2.0, 6.2.1, 6.2.2, 6.3.0
Feedback submitted, thanks!