Skip to content

Commit a30bb6d

Browse files
authored
DOCS-946 - Test nodes in playbooks (#5717)
* Add new section * Final updates * Minor updates * Add node examples * Updates from review by Shubham Chauhan * Update notes * Add release note
1 parent dd2561c commit a30bb6d

12 files changed

+54
-2
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: September 10, 2025 - Application Update
3+
hide_table_of_contents: true
4+
image: https://help.sumologic.com/img/reuse/rss-image.jpg
5+
keywords:
6+
- automation service
7+
- cloud soar
8+
- soar
9+
---
10+
11+
import useBaseUrl from '@docusaurus/useBaseUrl';
12+
13+
### New feature: Test nodes in playbooks
14+
15+
The new **Test Node** toggle on nodes allows you to test individual nodes in playbooks without having to run the entire playbook, offering greater control over node configuration and troubleshooting.
16+
17+
What's new:
18+
* Provide mock values for variables used in the node, and run the results to see the output and any errors.
19+
* Available on action, condition, user choice, and task nodes. (It is not available on filter or nested playbook nodes.)
20+
* Testing nodes counts against your [action limit](/docs/platform-services/automation-service/about-automation-service/#actions-limit) quota.
21+
22+
For more information, see [Test nodes in a playbook](/docs/platform-services/automation-service/automation-service-playbooks/#test-nodes-in-a-playbook).

docs/platform-services/automation-service/automation-service-playbooks.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
99
import ActionsLimit from '../../reuse/actions-limit.md';
1010
import CartesianProduct from '../../reuse/cartesian-product.md';
1111

12-
A playbook is a predefined set of actions and conditional statements that run in an automated workflow to respond to a certain event or incident type. Playbooks can allow your organization's teams to respond to an incident in a consistent, focused, and repeatable fashion.
1312

1413
Playbooks can be configured to execute automatically without user intervention, acting on information from the incident, or can be executed in interactive mode, where user input is required to authorize predefined actions.
1514

@@ -275,7 +274,38 @@ With the mechanism to import and export playbooks, you can move a playbook, alon
275274

276275
It is crucial that the file names inside the tar.gz adhere to the following format: `<unique_id>.<file_representing_name>.<file_type>.<file_extension>`, for example, `97ad7d6e.IP-Reputation.action.yaml`
277276

278-
## Test a playbook
277+
## Run tests on playbooks
278+
279+
### Test nodes in a playbook
280+
281+
The playbook **Test Node** toggle lets you test individual nodes of a playbook without needing to complete the entire flow. Testing individual nodes helps you improve your playbooks' reliability and shorten configuration time. You can provide mock values for variables used in the node, and run the results to see the output and any errors. The results provide informative messages to help you troubleshoot problems.
282+
283+
When you test nodes, keep in mind:
284+
* You can test action, condition, user choice, and task nodes. You cannot test filter or nested playbook nodes.
285+
* A single-node test does not execute downstream nodes. Only the selected node runs using the provided input. You cannot view the previous or past test node run executions.
286+
* Invalid JSON or missing required fields will block the test and show an error in the **Output** panel.
287+
* Before you can test a node, any node configuration changes need to be saved to the playbook draft. When you test a node, clicking **SAVE & RUN TEST** saves the node configuration to the same draft before executing.
288+
* Testing nodes counts against your [action limit](/docs/platform-services/automation-service/about-automation-service/#actions-limit) quota.
289+
290+
To test a node:
291+
1. Select a playbook.
292+
1. Click the **Edit** button at the bottom of the screen to make a draft of the playbook.
293+
1. Click the **Edit** button on a node.
294+
1. Click the **Test Node** toggle at the top of the **Edit Node** dialog. An **Input** panel appears to the left, and an **Output** panel appears to the right. <br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-toggle.png')} alt="Playbook Test Node toggle" style={{border:'1px solid gray'}} width="800"/>
295+
1. In the **Input** panel, enter variables to test the node. When you click **SAVE & RUN TEST**, results of the test appear in the **Output** panel.<br/>Ensure that you enter valid variables for the kind of inputs you need to test. Following are examples with different node types:
296+
* **Action**<br/>In the following example that uses input from insights, we provide an insight ID. The output shows the result of the action.<br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-variables.png')} alt="Action node test variables" style={{border:'1px solid gray'}} width="800"/>
297+
* **Condition**<br/>In the following example that uses input from reputation vendors, we provide reputation scores. The output shows the result of the condition.<br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-condition.png')} alt="Condition node test variables" style={{border:'1px solid gray'}} width="800"/>
298+
* **User choice**<br/>In the following example that uses user input data, we provide an email address. The output provides the resulting user choice. Click the user choice options to test whether they work as expected.<br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-user-choice.png')} alt="User choice node test variables" style={{border:'1px solid gray'}} width="800"/>
299+
* **Task**<br/>In the following example that uses incident input data, we provide a mock template name. The output provides the resulting task. Click the task options to test whether they work as expected.<br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-task.png')} alt="Task node test variables" style={{border:'1px solid gray'}} width="800"/>
300+
1. Examine the results in the **Output** panel and take any action needed to troubleshoot node operation:
301+
* Click the information button <img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-info-icon.png')} alt="Playbook Test Node JSON info button" style={{border:'1px solid gray'}} width="30"/> to see information on the test run:<br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-info-button.png')} alt="Playbook Test Node info" style={{border:'1px solid gray'}} width="300"/>
302+
* Click the **JSON details** button <img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-json-details-icon.png')} alt="Playbook Test Node JSON details button" style={{border:'1px solid gray'}} width="30"/> to see the JSON output:<br/><img src={useBaseUrl('img/platform-services/automation-service/playbook-test-node-json-details.png')} alt="Playbook Test Node JSON details" style={{border:'1px solid gray'}} width="300"/>
303+
1. Continue testing the node and making changes as needed in the node's configuration. When done, click **Save**.
304+
1. Test each node in your playbook that has the **Test Node** button (action, condition, user choice, and task). In each node, enter variables in the **Input** panel and examine the results in the **Output** panel to ensure the node works correctly.
305+
306+
After you're done testing individual nodes, test the entire playbook to ensure it runs end-to-end (see [Test a playbook](#test-a-playbook)).
307+
308+
### Test a playbook
279309

280310
You can test a playbook to verify that it works properly. The test results show the outcome as if the playbook actually ran.
281311

290 KB
Loading
64.7 KB
Loading
5.2 KB
Loading
5.58 KB
Loading
138 KB
Loading
4.3 KB
Loading
223 KB
Loading
226 KB
Loading

0 commit comments

Comments
 (0)