View or edit the Python code in Splunk Phantom 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.
The on_start
function is similar to the main
or begin
functions in other programming languages. Splunk Phantom executes the Python code in your playbooks by calling the on_start
function with the container context.
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 Full 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, which disables the visual playbook editor (VPE) for the playbook. Now, you can only edit the Python code.
If you click a block in the playbook, your edits only disable the VPE for that block. The Python Playbook Editor changes from Full Code to the name of the Python function called in that block. You can continue to use the VPE to add, edit, or delete other blocks. 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 VPE doesn't generate Python code for any block containing custom edits.
When editing the Python code for a Custom Function block, make your edits in the editable area in order for callback functions to work.
- Create a Custom Function block in the VPE. See Add custom code with the custom function block.
- Click Python Playbook Editor.
- Click the Custom Function 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 ################################################################################
View or edit playbook settings | Overview of cases |
This documentation applies to the following versions of Splunk® Phantom (Legacy): 4.8
Feedback submitted, thanks!