Using SOAP Webhook in a Template

SOAP Webhook can be used as a source in a template. The WSDL (Web Services Description Language) file bundled with Adeptia Connect is generally used to define a SOAP Webhook acting as a source in a template. However, there can be a situation when you may want to use your own WSDL file to create a SOAP Webhook and define the request and response parameters based on your requirement.

In Adeptia Connect, you have an option to create and use a SOAP Webhook according to your need. You can use your own WSDL file to create a SOAP Webhook before or during the creation of a template. If you have already created one using your WSDL file and published it as a Template, you will be able to select it from the designated drop-down box (Select Web Service Provider). You can also create a new one by uploading your WSDL file and use that as a source even when you are in the middle of creating a template.

Follow the steps below to create and use a SOAP Webhook as a source in a template. 

For steps previous to the step 1 being discussed below, refer to Creating a Template.

  1. Select SOAP WebHook as a source application.



  2. Select the Webhook type as Simple or Advanced.



  3. When Simple configuration is selected:
    1. Select Enable SSL check box if you want the SOAP Provider service to offer a SSL security. 
    2. Select a port in the Select Port field. 

      If you want to publish the SOAP Webhook to a custom port instead of the default port, refer to this document.
      These two fields are available only when you have selected the Simple as a Webhook type.
  4. Advanced Webhook type allows you to use a predefined Webhook or define a new one by using your own WSDL file. When Advanced configuration is selected:



    1. Select a pre-defined SOAP Provider in the Select Web Service Provider field. You can also create a new provider by clicking 

      When you create a new SOAP Provider from Template wizard:

      • The field Publish as will not be available and by default, the SOAP Provider will always be published as a Template
      • By default, the SOAP provider will be created in a published state.

      It is recommended that you create a different provider for each of the templates. It helps you ensure that only the allowed partners shall be able to execute the selected operation. If you have the same provider in multiple templates, the partner having access to one template can also execute the operations associated with the other templates.

    2. Select the SOAP operation corresponding to the selected provider in the Select the SOAP Operation field.

      The list displays all the available operations corresponding to the selected provider. 

      If you want all the SOAP operations of the selected web service provider to get associated with the current template, select All Operation in the Select the SOAP Operation field. This option is available only for Custom template (where mapping is not used in the process flow) and Pass through template.

      Once you have selected All Operation:

      • A request for any of the operations of the selected web service provider will execute the same template. 

      • An alert message will be thrown if any of the SOAP operations of the selected web service provider has been used in the other template. You can see in which other template, the SOAP operation has been used by clicking the text Click here in the alert message.

  5. Click Next.
  6. Select the Apply Security Policy check box.

    This screen appears only when you have selected Webhook type as Simple.
  7. Select a pre-defined security policy in the Select Security Policy to apply field.  You can also create a new security policy by clicking .
  8. Click Next to complete the steps that follow to create the template. 

  • To copy the access token, click Copy Token under the Action menu of a specific template.
  • To download the WSDL file, click Download WSDL under the Action menu of a specific template. 

These two options are available only when the template is in active state and Webhook type is Simple.


Below are the examples of a Webhook URL and the location of WSDL file associated with that Webhook.

  • URL (endpoint) of the Webhook in the below format:

    <selected Scheme in Webhook>://<Server>:<Selected Port>/rest/wsx/services/SOAPWebhook
  • Below is the location where WSDL file will be available:

    <selected Scheme in Webhook>://<Server>:<Selected Port>/rest/wsx/services/SOAPWebhook?wsdl

The table below explains the components of this URL for different cases:

Case

Endpoint





SchemeHostPortContext path
No PortGUI SchemeGUI HostGUI Port/rest/wsx/services/SOAPWebhook
Non SSL PorthttpGUI HostSelected Port/rest/wsx/services/SOAPWebhook
SSL PorthttpsGUI HostSelected Port/rest/wsx/services/SOAPWebhook