Thank you for your feedback.
Form temporarily unavailable. Please try again or contact docfeedback@servicenow.com to submit your comments.
Versions
  • London
  • Kingston
  • Jakarta
  • Istanbul
  • Helsinki
  • Geneva
  • Store
Close

Create a SOAP web service activity

Create a SOAP web service activity

Use this template to create a custom SOAP activity.

Before you begin

Role required: web_service_admin, activity_admin, activity_creator

About this task

For instructions on using the activity template process flow, see create custom activities.

Procedure

  1. Create a custom activity.
    This action creates a custom activity using a template.
  2. After setting up general properties and creating input variables, configure the SOAP web service Execution Command:
    OptionDescription
    Map the input variables Use the variables you created to configure the command that Orchestration executes on the SOAP web service.
    Web service message Specify the SOAP web service message to use for this activity. If you need information on SOAP web services messages, see SOAP message.
    Web service message function Specify the SOAP message function available in conjunction with the SOAP web service.
    Endpoint If you enter an endpoint in this field, it overrides the endpoint URL configured in the SOAP message web service. Click the lock icon to open the input field and add the endpoint.
    SOAP message parameters Name-value pairs to pass to the SOAP endpoint. You can create these parameters manually, or drag input variables into the parameter fields and then assign a value. Parameters defined in the SOAP message that use ${} can be assigned data from this activity template. Use the Additional attribute column to configure the system to not escape the text. By default, text sent to the SOAP message is escaped. The Name column is auto-populated if the users have provided variables using variable substitution in the SOAP message.
    Use MID Server Check box that determines if a MID Server must be used to invoke the SOAP web service. If the SOAP web service message function defines a MID Server, that MID Server is used instead of the one selected here.
    Required MID Server capabilities MID Server with the appropriate capabilities for connecting to the SOAP endpoint. By default, the system selects a MID Server with SOAP capabilities. This field is available when the Use MID Server check box is selected.
    Timeout Allowed duration of the SOAP web service request before it times out, in seconds. The default is 10.
    Authentication Determines what type of authentication is required for the endpoint. The options are:
    • Use existing credentials in SOAP message: Uses credential definitions from the SOAP message definition.
    • Override with Basic Authentication credentials: Uses |basic authentication credentials. Overrides the credentials in the SOAP message definition. Basic authentication credentials must be provisioned before they are available for selection.
    • Override with Certificate Authentication credentials: Overrides the credentials in the SOAP message definition with certificate authentication credentials.
    • Override with Both Basic and Certificate Authentication credentials: Overrides the credentials in the SOAP message definition with both basic authentication or certificate authentication credentials.
    • Override with WS-Security Username profile: Overrides the credentials in the SOAP message definition with credentials defined a WS Security Profile.
    Credentials Required REST endpoint basic authentication credentials. This field is available when Override with Basic Authentication credentials is selected in the Authentication field. Only basic authentication credentials appear in the selection list, which includes credentials stored on the instance and credential IDs from an external storage system. If you are using credentials stored in a CyberArk safe, you can override the default safe defined in the MID Server configuration file by adding the name of a different safe as a prefix to the credential ID, separated by a colon. For example, newsafe:orch-test-f5.
    Protocol Profile Protocol profile to use for authentication. This field is available when the authentication type is either Override with Certificate Authentication credentials or Override with Both Basic and Certificate Authentication credentials.
    Note: You can map parameter values in a test payload to variables in the Outputs tab automatically. See automap output variables.

What to do next