diff --git a/docs/platform-services/automation-service/automation-service-integrations.md b/docs/platform-services/automation-service/automation-service-integrations.md index b26c906259..3b4bb09b7d 100644 --- a/docs/platform-services/automation-service/automation-service-integrations.md +++ b/docs/platform-services/automation-service/automation-service-integrations.md @@ -127,8 +127,31 @@ You can test an action on an integration to ensure that it is working correctly. :::tip 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.
Required fields for test action ::: -1. After you click **TEST ACTION**, results of the action are displayed:
Test action results +1. After you click **TEST ACTION**, results of the test are displayed:
Test action results +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:
Output JSON details button
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:
Output in JSON view +To change the data that is output from an action, see [Edit output of an action](#edit-output-of-an-action). + +## Edit output of an action + +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/). + +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: + +1. [Open an integration](/docs/platform-services/automation-service/automation-service-integrations/#view-integrations) and do the following: + 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. + 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. +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:
Example action +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**:
Test action +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.
Test action results +1. To edit the output of an action, first click the **Edit** button on the action:
Action edit button +1. On the resulting dialog, select the **Edit** toggle. The output code of the action is displayed:
Edit toggle +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:
Edit output + :::note + 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. + ::: +1. To ensure that the edited output works, [test the action](#test-action) like we did earlier.
For our example, after we test the action notice how the account type is now displayed in the **Show Details** dialog box:
New output displayed in test action results +1. But there is more output than what was configured to display. To see the complete output, click the **JSON details** button:
Output JSON details button
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:
Output in JSON view ## Cloud or Bridge execution diff --git a/docs/platform-services/automation-service/integration-framework/integration-framework-output.md b/docs/platform-services/automation-service/integration-framework/integration-framework-output.md index 749371c11b..3f63fbd2a4 100644 --- a/docs/platform-services/automation-service/integration-framework/integration-framework-output.md +++ b/docs/platform-services/automation-service/integration-framework/integration-framework-output.md @@ -7,6 +7,8 @@ description: Learn how to work with output from the integration framework. import useBaseUrl from '@docusaurus/useBaseUrl'; +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). + ## About integration output 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. diff --git a/static/img/platform-services/automation-service/action-output-edit-action.png b/static/img/platform-services/automation-service/action-output-edit-action.png new file mode 100644 index 0000000000..349fb214fe Binary files /dev/null and b/static/img/platform-services/automation-service/action-output-edit-action.png differ diff --git a/static/img/platform-services/automation-service/action-output-edit-button.png b/static/img/platform-services/automation-service/action-output-edit-button.png new file mode 100644 index 0000000000..e86e4ddbc0 Binary files /dev/null and b/static/img/platform-services/automation-service/action-output-edit-button.png differ diff --git a/static/img/platform-services/automation-service/action-output-edited-results.png b/static/img/platform-services/automation-service/action-output-edited-results.png new file mode 100644 index 0000000000..5366f88a7e Binary files /dev/null and b/static/img/platform-services/automation-service/action-output-edited-results.png differ diff --git a/static/img/platform-services/automation-service/action-output-edited.png b/static/img/platform-services/automation-service/action-output-edited.png new file mode 100644 index 0000000000..430ee89a7d Binary files /dev/null and b/static/img/platform-services/automation-service/action-output-edited.png differ diff --git a/static/img/platform-services/automation-service/action-output-example-action.png b/static/img/platform-services/automation-service/action-output-example-action.png new file mode 100644 index 0000000000..842fbc04d1 Binary files /dev/null and b/static/img/platform-services/automation-service/action-output-example-action.png differ diff --git a/static/img/platform-services/automation-service/action-output-json-details.png b/static/img/platform-services/automation-service/action-output-json-details.png new file mode 100644 index 0000000000..61d347868c Binary files /dev/null and b/static/img/platform-services/automation-service/action-output-json-details.png differ diff --git a/static/img/platform-services/automation-service/action-output-test-action-json-details.png b/static/img/platform-services/automation-service/action-output-test-action-json-details.png new file mode 100644 index 0000000000..53ac4d21a9 Binary files /dev/null and b/static/img/platform-services/automation-service/action-output-test-action-json-details.png differ diff --git a/static/img/platform-services/automation-service/action-output-test-action-results.png b/static/img/platform-services/automation-service/action-output-test-action-results.png new file mode 100644 index 0000000000..9a239faff7 Binary files /dev/null and b/static/img/platform-services/automation-service/action-output-test-action-results.png differ diff --git a/static/img/platform-services/automation-service/action-output-test-action.png b/static/img/platform-services/automation-service/action-output-test-action.png new file mode 100644 index 0000000000..b8991325ea Binary files /dev/null and b/static/img/platform-services/automation-service/action-output-test-action.png differ