SOAP services

A SOAP Service integration connects a web service that speaks XML over HTTP. Many ERP and back-office systems work this way. You describe each operation once with an envelope template, and agents call it with the right values.

Create the integration

1. 1Go to Studio → Integrations, click Add Integration and choose SOAP Service.
2. 2Enter an Integration Name, for example "Order Service", and a Description.
3. 3Enter the Endpoint URL, where requests are sent. Optionally add the WSDL URL; it is used as a reference and for the connection test.
4. 4Choose the SOAP Version, 1.1 or 1.2.
5. 5Choose the Authentication Type and fill in its fields.
6. 6Optionally add Default Headers, In-Body Credentials and Service Documentation.
7. 7Click Create Integration.

Some older services expect a username and password inside the SOAP body. Put those in In-Body Credentials. Harmona adds them to every call on the server. Agents never see them and cannot change them.

Add operations

1. 1Open the integration and click Add Operation.
2. 2Enter a Name, for example `get_order_status`, and a Description of what it does.
3. 3Enter the SOAPAction if the service needs one.
4. 4Paste a full sample request as the Envelope Template, and replace each concrete value with a placeholder such as `{{order_id}}`.
5. 5Under Template Parameters, describe each placeholder and mark whether it is Required.
6. 6Click Add Operation.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ord="http://example.com/orders">
  <soapenv:Body>
    <ord:GetOrderStatus>
      <ord:OrderId>{{order_id}}</ord:OrderId>
    </ord:GetOrderStatus>
  </soapenv:Body>
</soapenv:Envelope>

Placeholders use letters, digits and underscores. Values are escaped automatically when the call is made. A sample request from SoapUI or the service documentation is a good starting point.

To check an operation, click Test operation next to it, fill in the values and click Run Test. This calls the live service. The result shows the Parsed response or the Raw XML, and any SOAP Fault. To check the service itself, click Edit SOAP and then Test Connection.

SAP and other ERP systems

If your SAP system exposes a SOAP web service, connect it like any other SOAP service: its endpoint, its WSDL and one operation per call you want agents to make. To answer from SAP HANA data directly, use a database connection instead.