SOAP

Simple Object Access Protocol (SOAP) is a protocol using XML and HTTP to interchange data between applications using different programming languages. The SOAP action An instruction within a botflow. executes a call to a SOAP web service from within a botflow Automated steps that you can design for each bot that will run..

Using the SOAP action, you can:

  • Query information from a SOAP server.
  • Initiate a process using a SOAP request.

Some examples of using the SOAP action are:

  • Query for information to update a database.
  • Initiate a process performed on the SOAP server.

Add a SOAP action to a botflow

These are the steps required to add a SOAP action to a botflow. The Action Builder field and button descriptions table given below the procedure fully describe required and optional configuration fields.

To add a SOAP action to a botflow:

  1. On the Actions List, click Advanced and then click SOAP from the Programming list.
  2. The Action Builder window for SOAP displays.

  3. Set the SOAP settings.
  4. General

    • Url: Specify the URL, starting with https://, and enter the remainder of the web address.
    • Headers: Add any required headers by clicking the plus sign () and completing the fields in the Header window.
    • Request: Specify the request that will be sent to the web service.
    • Encoding: Select the required encoding from the drop-down list.

    Authentication

    • Authentication: If required, select the Authentication check box and then select the required authentication type from the drop-down list.

    Response

    • Save content: Select the required option to save the content of the SOAP action from the drop-down list:
      • File: Enter the file name with file path in the field.
      • Variable: Enter the variable name in the field.
    • Save status code: If required, select the Save status code check box to enter a code in the Save status code field.

  5. If needed, adjust the Run Error Task settings to fine tune how the action runs.
  6. If needed, adjust the Run Switch setting to create the action without running it.
  7. Optionally, add an action note.
  8. Click OK to add the SOAP action to the botflow.