Configure the SOAP execution command

Use the input variables you created to configure the command that Orchestration executes on the SOAP endpoint.

Before you begin

Create the input variables you need in the Inputs form before you can advance to the Execution Command stage.

Role required: web_service_admin, activity_admin, activity_creator

Note: You can test the SOAP connection between the MID Server and the endpoint without having to run the acvitity in a workflow context. For details, see Test SOAP activity template inputs.

Procedure

  1. Drag variables from the list of inputs and drop them into command fields.
    The system formats the variable in the proper syntax for the command.
    Figure 1. SOAP execution command
    SOAP execution command
  2. Complete the fields shown in the table.
    Table 1. SOAP template execution command fields
    Field Description
    Input Input variable builder. Create variables to map to available fields.
    Web service message SOAP message to use for this activity. Users must have the web_service_admin role to configure this field.
    Web service message function SOAP message function to use for this activity. Users must have the web_service_admin role to configure this field.
    Endpoint Endpoint URL for the SOAP web service this activity uses. Enter an endpoint in this field to override the endpoint configured in the SOAP message. Click the lock icon to open the input field.
    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.
    Note:
    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.
  3. Click Save.
  4. Click Continue to advance to the Outputs stage.