Skip to content

Commit 0c87e81

Browse files
authored
DOCS-954 - Edit output of an action (#5541)
* Add images * Add text * Add links
1 parent aa424b0 commit 0c87e81

11 files changed

+26
-1
lines changed

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

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,31 @@ You can test an action on an integration to ensure that it is working correctly.
127127
:::tip
128128
In some cases, you'll need to provide data for required fields before **TEST ACTION** is enabled. This is data that normally would be provided by the output of other actions running earlier in a playbook sequence, and so must be provided here to test if the action runs correctly. In the example below, note that you need to provide information for the **Issue (ID or Key)** field in order to test the action. Also note that under the **Issue Type** field there is helpful text telling you that you can get the issue type ID and key from the **List Issue Types** action.<br/><img src={useBaseUrl('img/platform-services/automation-service/test-action-required-fields.png')} alt="Required fields for test action" style={{border: '1px solid gray'}} width="400" />
129129
:::
130-
1. After you click **TEST ACTION**, results of the action are displayed:<br/><img src={useBaseUrl('img/platform-services/automation-service/test-action-results.png')} alt="Test action results" style={{border: '1px solid gray'}} width="600" />
130+
1. After you click **TEST ACTION**, results of the test are displayed:<br/><img src={useBaseUrl('img/platform-services/automation-service/test-action-results.png')} alt="Test action results" style={{border: '1px solid gray'}} width="600" />
131+
1. The table in the **Show Details** dialog only shows data that is configured to display. To see the complete output in JSON format, including data not configured to display, click the **JSON details** button:<br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-test-action-json-details.png')} alt="Output JSON details button" style={{border: '1px solid gray'}} width="500" /><br/>In this dialog you can click expand arrows to examine the output in JSON format. Click buttons at the top of the dialog to return to the display view, download the JSON, or copy the output:<br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-json-details.png')} alt="Output in JSON view" style={{border: '1px solid gray'}} width="500" />
131132

133+
To change the data that is output from an action, see [Edit output of an action](#edit-output-of-an-action).
134+
135+
## Edit output of an action
136+
137+
When an integration's action runs, it typically generates output that is passed on to the next step in a playbook. For information about the format of this output, see [Integration Framework Output](/docs/platform-services/automation-service/integration-framework/integration-framework-output/).
138+
139+
You may want to change the output of an action to allow playbooks to execute different activities downstream from the action. Perform the following steps to edit the output of an action:
140+
141+
1. [Open an integration](/docs/platform-services/automation-service/automation-service-integrations/#view-integrations) and do the following:
142+
1. [Ensure that it is a certified integration](/docs/platform-services/automation-service/automation-service-integrations/#certified-integrations). Only certified integrations allow you to edit the output of their actions.
143+
1. [Ensure that authentication is configured for the integration](/docs/platform-services/automation-service/configure-authentication-for-integrations/). Testing actions on the integration will fail unless the integration's authentication settings are correctly configured so that the product you're integrating with can communicate with Sumo Logic.
144+
1. Select an action on the integration. For our example, we'll edit the output for the **List Users** action on the Atlassian Jira V2 integration:<br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-example-action.png')} alt="Example action" style={{border: '1px solid gray'}} width="700" />
145+
1. First, let's [test the action](#test-action) to see the output it generates. Enter any values needed for the action to run and click **TEST ACTION**:<br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-test-action.png')} alt="Test action" style={{border: '1px solid gray'}} width="400" />
146+
1. Output of the action is displayed in the **Show Details** dialog. Although this dialog shows the user IDs and names, there is much more output that is generated by the action. We'll see that when we edit the action next.<br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-test-action-results.png')} alt="Test action results" style={{border: '1px solid gray'}} width="500" />
147+
1. To edit the output of an action, first click the **Edit** button on the action:<br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-edit-button.png')} alt="Action edit button" style={{border: '1px solid gray'}} width="700" />
148+
1. On the resulting dialog, select the **Edit** toggle. The output code of the action is displayed:<br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-edit-action.png')} alt="Edit toggle" style={{border: '1px solid gray'}} width="700" />
149+
1. Edit the output code as desired and click **Save**. In the example below, we'll add the ability for the output to display account type information:<br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-edited.png')} alt="Edit output" style={{border: '1px solid gray'}} width="700" />
150+
:::note
151+
When you click **Save**, the edited code is validated. In order for the edited output to successfully run, it must be formatted correctly and be output that the integration can provide.
152+
:::
153+
1. To ensure that the edited output works, [test the action](#test-action) like we did earlier.<br/>For our example, after we test the action notice how the account type is now displayed in the **Show Details** dialog box: <br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-edited-results.png')} alt="New output displayed in test action results" style={{border: '1px solid gray'}} width="500" />
154+
1. But there is more output than what was configured to display. To see the complete output, click the **JSON details** button:<br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-test-action-json-details.png')} alt="Output JSON details button" style={{border: '1px solid gray'}} width="500" /><br/>Here you can click expand arrows to examine the output in JSON format. Click buttons at the top of the dialog to return to the display view, download the JSON, or copy the output:<br/><img src={useBaseUrl('img/platform-services/automation-service/action-output-json-details.png')} alt="Output in JSON view" style={{border: '1px solid gray'}} width="500" />
132155

133156
## Cloud or Bridge execution
134157

docs/platform-services/automation-service/integration-framework/integration-framework-output.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ description: Learn how to work with output from the integration framework.
77

88
import useBaseUrl from '@docusaurus/useBaseUrl';
99

10+
This article describes the format of integration output. To edit the output of an integration, see [Edit output of an action](/docs/platform-services/automation-service/automation-service-integrations/#edit-output-of-an-action).
11+
1012
## About integration output
1113

1214
Integrations primarily use JSON to pass data between actions and other internal components. There is no requirement that integrations return JSON results; integrations will execute regardless of the data or data type they return. However, in order to pass data returned from an action to a future action in a runbook or to other internal components, the output from an integration action must be returned in JSON, and the JSON fields must be defined in the output:path attributes of the action definition file. In other words, if the action output is not returned in JSON, it will not be able to be used in any other areas.
352 KB
Loading
506 KB
Loading
133 KB
Loading
358 KB
Loading
494 KB
Loading
68.1 KB
Loading
137 KB
Loading
124 KB
Loading

0 commit comments

Comments
 (0)