SOAP step
Enable action designers to send outbound SOAP web service requests to external systems.
Note: SOAP step is not available in the base system and requires the ServiceNow® Integration Hub subscription. After the required plugin is activated, the step is visible under Integrations.
Roles and availability
- Available as an Workflow Studio action step. Users with the action_designer role can create a custom action with one or more action steps.
- Action designers need the web_service_admin role to perform these web services tasks.
- Select WSDL
- Load new WSDL
- Select a WS-Security policy
Fields
| Field | Description |
|---|---|
| Connection Details | |
| Connection | The type of connection to use. - Define Connection Inline: Define connection information within the action step. - Use Connection Alias: Define connection information using the Connection Alias table. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using an action in multiple environments. Likewise, if the connection information changes, you don't need to update your custom action. To learn more about connections and credentials, see Introduction to credentials, connections, and aliases. |
| Connection Alias | Connection & Credential alias record that the system uses to run the action step. Users with the flow_designer or admin role can create or select an associated Connection record. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using an action in multiple environments. Likewise, if the connection information changes, you don't need to update your custom action. To learn more about connections and credentials, see credentials, connections, and aliases. The credential value is displayed as a Password (2 Way Encrypted) data pill on the data panel. Note: This field is available when Use Connection Alias is selected from the Connection list. |
| Credential Alias | Credential alias that the system uses to run the action step. Users with the flow_designer or admin role can create or select an associated Connection record. Using an alias eliminates the need to configure multiple credentials when using an action in multiple environments. Likewise, if the credential information changes, you don't need to update your custom action. To learn more about connections and credentials, see credentials, connections, and aliases. The credential value is displayed as a Password (2 Way Encrypted) data pill on the data panel. Note: This field is available when Define Connection Inline is selected from the Connection list. |
| Use MID | Option to use a MID Server to run the SOAP step. Select this check box to display the MID Selection,MID Application, and Capabilities fields.Note: This field is available when Use Connection Alias is selected from the Connection list. |
| Endpoint | The URL endpoint for the SOAP request. If Use Connection Alias is selected, this field is read-only and displays the endpoint URL associated with alias. If Define Connection Inline is selected, enter an endpoint URL for the connection. |
| Test SOAP Step | Button to test the SOAP step. To test, select the Test SOAP Step button. Enter any required input values and select the Run Test button. After the test runs, any step outputs or error messages are displayed in the Test Results section of the test window. |
| Connection Timeout | Number of milliseconds the system waits for a successful host connection. If the step does not make a successful connection during this time, the connection request times out. If Define Connection Inline is selected, enter a timeout value for the connection. Leave this field empty to use the system default connection timeout value. Note: Avoid setting the Connection Timeout value to zero, as this may cause a stale connection. |
| MID Selection | Option to select a specific MID Server or MID Cluster. Choose any one of the following options. - Auto-Select MID Server: Your ServiceNow instance selects the MID Server without manual input. - Specific MID Server: Your ServiceNow instance uses MID Server that you specify. - Specific MID Cluster: Your ServiceNow instance uses the MID Cluster that you specify. A MID Cluster is a group of MID Servers that enables your ServiceNow instance to handle multiple integrations, and improve integration speed. For more information, see Configure a MID Server cluster. This field is available when Define Connection Inline is selected from the Connection list, and Use MID is checked. |
| MID Cluster | Data pill for the MID Cluster you want to use. This field is available when Define Connection Inline is selected from the Connection list, Use MID is checked, and Specific MID Cluster is selected from the MID Selection list. |
| Request Details | |
| Build Envelope | The method to use when building the SOAP envelope. - From WSDL: Select this option to display the Select a WSDL and Operation fields. - Manually: Select this option to manually enter or paste WSDL text. |
| Select a WSDL | The WSDL to use to build the SOAP envelope. Select an existing WSDL record or click Load New WSDL to download or manually enter a WSDL file. The selected WSDL populates the values of the Operation, SOAP action, and SOAP Envelope fields.Note: This field is available when you select From WSDL from the Build Envelope list. |
| Load New WSDL | Option to download or manually enter a WSDL file. |
| Operation | The operation to run from the selected WSDL. Each WSDL has its own list of available operations. |
| SOAP Action | The URL to run the SOAP action. If Build Envelope is set to From WSDL, this field is read-only and displays the URL to run SOAP action. If Build Envelope is set to Manually, enter a URL to run the SOAP action. |
| Request Type | Format of the request. Options include.- Text: A request in JSON, XML, or other text format. - Binary: A request in a binary file format. |
| SOAP Envelope | The XML text sent to the endpoint. If Build Envelope is set to From WSDL, the system adds the necessary XML for the Operation that you select. If Build Envelope is set to Manually, enter the XML text that you want to use. Enter record values in the appropriate SOAP envelope elements. For example, enter an incident short description in the <short_description> element.Note: This field is available when the Request Type is Text. |
| Attachment | Attachment record that contains the request. You can look up or create this record in a prior step and define it as an input variable. Create it by using the JSONStreamingBuilder and XMLStreamingBuilder APIs in the Script step. Note: This field is available when the Request Type is Binary. |
| Reset Envelope | Option to discard all manual changes that you made to the SOAP envelope. Select this check box to revert the SOAP envelope to its original state.Note: This field is available when you select From WSDL from the Build Envelope list. |
| New WSDL | |
| Name | The name of the WSDL record you want to create. |
| Import Method | The method to enter WSDL.- Download from URL: Select to display the WSDL URL, User name, and Password fields to retrieve the WSDL from an external source, typically the web service provider. - Manually Populate WSDL Content: Select to display the WSDL Content field to manually enter or paste WSDL text. |
| WSDL URL | The URL to the SOAP web service.Note: This field is available when you select Download from URL from the Import Method list. |
| User name | The user name to authenticate with the SOAP web service.Note: This field is available when you select Download from URL from the Import Method list. |
| Password | The password to authenticate with the SOAP web service. The system always masks passwords in the user interface and prevents exporting them as plain text.Note: This field is available when you select Download from URL from the Import Method list. |
| WSDL Content | The XML document describing the SOAP web service and its operations.Note: This field is available when you select Manually Populate WSDL Content from the Import Method list. |
| Import | Option to add the SOAP web service WSDL to the instance. |
| WS-Security | |
| Enable WS-Security Policy | Option to restrict the SOAP web service to a security policy. Select this check box to display the Policy field. |
| Policy | The policy record that you want to use to restrict web service connections. Select an existing policy record. |
| Retry Policy | |
| Enable Retry Policy | Option to enable the retry policy. For more information, see Retry policy. |
| Override Default Policy for Alias | Option to override the default retry policy. This check box is not applicable when Define Connection Inline is selected from the Connection list. |
| Retry Policy | Default retry policy associated with Connection Alias. If Override Default Policy for Alias is selected, you can override the default retry policy and select another existing retry policy based on your requirement. |
| Advanced Options | |
| Headers | The name-value pairs to include in the SOAP message as HTTP headers. Use the plus icon to add headers. Add a Name and Value for each HTTP header. |
| Headers > Omit if empty | Option to exclude a header if the value is empty or null.Note: This check box is available after clicking the down arrow to display the advanced options. |
Action error evaluation
If this step fails
Data type: Choice
Option to continue running the next step or go to error evaluation. To use the step status code or message for a custom action error condition, see .
SOAP response size limit
The system limits the size of SOAP responses to 5 MB. Direct SOAP responses that exceed this limit generate an error. To support larger response sizes, increase the response size limit with the glide.pf.soap.response_payload_max_size system property. This system property supports a maximum value of 10 MB.