Creating SOAP Provider

This section explains how to create SOAP Provider service in Adeptia Connect. Perform the following steps to create SOAP Provider service:

1. Click Configure > WEB SERVICES > SOAP Provider.

2. Click Create SOAP Provider. 
   
   
   
   

3. On the Create SOAP Provider window, type the name and description of the new Provider in the Name and Description text boxes respectively.

   In case, the Provider contains characters that fall in the character set encoding other than the default character set encoding, you can change this encoding in the Character Set Encoding field. By default, this field displays the character set encoding that you define at the application level.

4. Select either Process Flow or Template based on how you want to publish this SOAP Provider. 

   The SOAP providers that are published as Process Flows and set to be executed in Sync mode bypass the queue and get executed immediately.

5. Select Yes if you want to upload your own WSDL file, else select No in the Upload WSDL field.

   By default, the value of this field is No. If you change the value to Yes, a message appears prompting you to change the configuration values. 

   
   

    If you have selected 'Yes', expand this section and follow the steps therein...

   1. By default, the request service is located in the services/<folder name>. You can change this location in the Service Location field.

   2. Select Enable SSL check box if you want the SOAP Provider service to offer a SSL security.

      If you select Enable SSL, this SOAP provider will be published over SSL and use SSL configuration (KeyStore, TrustStore etc.) defined for the port that you select in the next step.

      
      

   3. In the Select Port field, select the port on which you want to publish the SOAP provider.
      

      All the ports that are available on API Gateway will be visible in this field. You can also define/edit/delete a custom port through an environment variable in values.yaml file. Click here to know how to configure the ports.

       
      

   4. If WSDL file is referring to another WSDL or XSD file, you can either select an existing file reference activity from the File References drop-down list, or click the  button to create a new file reference activity. You can click the  button if you want to update an existing file reference activity. For information on how to create a file reference activity, refer to Creating File Reference.

   5. Click Browse WSDL and upload the WSDL file that you want to use while creating your SOAP Provider service.
      After the file is uploaded successfully, a few new fields will add in the screen. 
      If there is only one service name in your WSDL file, Adeptia Connect will show that service name as selected. In case there are multiple service names in your WSDL file, Adeptia Connect will show you a list of all the services in the Service Name field. In such a case, you'd need to select the one that you want. 
      
      When you select a service name, the system will populate the Binding field automatically. This field displays only those bindings that correspond to the service name that you have selected in the Service Name field. If in the WSDL definition file there is only one binding for any service name, you will see only that binding in the Binding field. However, if there are multiple bindings for a service name, you'll see a list of all the bindings in the Binding field.

   6. Select a mode of configuration from the Configuration Mode field.
      
      
      • For All Operation: In case you want to select just one Process Flow to invoke any operation, select this option. However, you can execute the Process Flow only when you invoke an operation.
      • Per Operation: In case you want to select multiple Process Flows for invoking different operations, select this option. Here you can also leave any operation unbound. If you invoke any unbound operation, you will see a "Requested Operation is not implemented" error message.
        
        

   7. Select the way you want to process your payloads (request or response). The available options are In Memory and File. In Memory option is the default option.
      In Memory: Select this option if your payload size is small. In this case, the system processes web service payloads in the memory.

      File: Select this option if your payload size is relatively large. This helps while dealing with large volumes of payloads. When you select File, the system processes payload in a file – a physical space instead of memory, reducing the amount of memory needed for processing payloads.

   8. Enter the input and output variables in the Input Variable and Output Variable fields respectively. These names must match with the names defined in the Properties section of Process Designer. The names of these variables should be the same as defined in the respective Process Flows. 

   9. Select the security policy activity from the Security Policy field. For information on how to create a security policy, refer to Creating Security Policy for Web Services.

   10. To extract attachments from the request and send it with your response, select Enable Attachment check box.

       A message appears prompting to configure the Process Flow settings for the production environment. This message appears only if Optimize for Real-Time check box is not selected. For more information, refer to Creating Process Flow.
    If you have selected 'No', expand this section and follow the steps therein...

   1. In the Operation Name field, enter the name of the operation that you want the SOAP Provider to perform.

   2. In the Request Service Name text box, enter the request service name by which you want to publish the Web Service .

   3. By default, the request service is located in the services/<folder name>. You can change this location for accessing the web service.

   4. Select Enable SSL check box if you want the SOAP Provider service to offer a SSL security.

      If you select Enable SSL, this SOAP provider will be published over SSL and use SSL configuration (KeyStore, TrustStore etc.) defined for the port that you select in the next step.

      
      

   5. In the Select Port field, select the port on which you want to publish the SOAP provider.

      All the ports that are available on API Gateway will be visible in this field. You can also define/edit/delete a custom port through an environment variable in values.yaml file. Click here to know how to configure the ports.

      
      

   6. Select the SOAP version from the Soap Version field.

   7. In the Process Flow Name field, select a Process Flow to publish as a Web Service .

      While creating Process Flow for Web Services, you must keep the following things in mind:

      • Use Context source and target activities.
      • Input and Output variable names in the Process Flow properties must match with the ones that you entered while creating the provider activity.

   8. In the Input XML Schema field, select an input XML schema. 

   9. In the Output XML Schema field, select the output XML schema.

      In case an XML Schema has multiple roots, click Select Root button and select a root.

   10. Specify the way you want to process your payloads (request or response). The available options are In Memory and File. In Memory option is the default option.

       • In Memory
         Select this option if your payload  size is small. In this case, the system processes web service payloads in the memory.

       • File
         Select this option if your payload size is relatively large. This helps while dealing with large volumes of payloads. When you select File, the system processes payload in a file – a physical space instead of memory, reducing the amount of memory needed for processing payloads.

         While using File payload process type, the following additional changes must be made in the process designer:

         In the process designer, do the followings:

         1. Click Context Source, and set its Document Repository property to True.
         2. In the File Name(with full path) field, select $$WS_PROVIDER_PAYLOAD_SOURCE$$ variable.
         3. Click Context Target, and set its Document Repository property to True.
         4. In the File Name(with full path) field, choose $$WS_PROVIDER_PAYLOAD_TARGET$$ variable.

         It is recommended that you use different process flow whenever a payload process type is changed. For example, if a provider activity created with In Memory payload process type uses X process flow, this process flow can only be reused in a provider activity created using In Memory payload process type, and not with another payload process type, File.

   11. Enter the input and output variables in the Input Variable and Output Variable fields respectively. These names must match with the names defined in the Properties section of Process Designer.

       The names of these variables should be the same as defined in the respective Process Flow.

   12. Select the security policy activity from the Security Policy field. For information on how to create a security policy, refer to Creating Security Policy for Web Services.

   13. If you want to extract attachments from the request and send it with your response, select Enable Attachment check box.

6. To use WS-Addressing, expand WS-A Addressing Properties.

7. Select the Enable WS-A addressing check box, and define all the parameters.
   If you want to override WS-Addressing Parameters values dynamically then you need to select the check box. If you select that checkbox, then the SOAP Provider service will use the values or parameters in the corresponding context process flow and would ignore the parameters or values in the text boxes. However, if you do not select this check box then the SOAP Provider service will use the values or parameters of this section for the respective SOAP Provider service.

8. Expand Advanced Properties and select a project from the Project field.

9. Click Save.