SOAP Tool

The SOAP Tool facilitates integration by enabling users to call web services and retrieve essential data from external sources into the process instance.

Configure SOAP

To configure SOAP, drag and drop the Tool element onto the canvas in Process Builder,  click on it, and select Mapping.

When adding SOAP in field Tools, you will see the following fields available for configuration:

• WSDL URL: URL of the web service's WSDL file to be invoked.
• Operation Name: Name of the operation within the web service.
• Username: Credential - Username for authentication.
• Password: Credential - Password for authentication.
• Parameters: Values in sequence order of the operation parameters.
• SOAP Body (XML): XML content enclosed within the <soap:Body> tag of the SOAP request. The parameters setting is ignored when using SOAP Body.
• SOAP Action: Required when using SOAP Body, and the SOAP version is 1.1.

Store to form

Defines where the retrieved data from the SOAP response will be stored within a form in Joget. This ensures that the data fetched from the web service is properly captured and utilized in the workflow.

Fields to configure:

• Form: Form where retrieved data will be stored.
• Base XML Object Name for Multirow Data: If returned data is intended for an array / multirow data, define the base path of the array.
• Field Mapping: 
  • Field ID: Field ID corresponds to the target form field.
  • XML Object Name: 

    Path to child object defined in the Base XML Object Name for Multirow Data above.
    Else, just the XML Object Name itself.

     

Store to workflow variable

Allows mapping of the retrieved data from the SOAP response to specific workflow variables, facilitating data manipulation and usage within the Joget process.

Fields to configure:

• Workflow Variable Mapping:
  • Workflow Variable: Workflow Variable name.
  • XML Object Name: XML Object Name path.

Advanced

It provides an additional configuration option for the SOAP Tool, like debug mode for troubleshooting.

Field to configure:

• Debug Mode: When enabled, print debug messages in the server log for troubleshooting purposes. In the server log, you will observe returned formatted data as the following:
  

  INFO  20 Feb 2020 02:14:56 org.joget.plugin.enterprise.SoapTool 
  - {"NumberToWordsResult":"six hundred and seventy eight "}

Demo app to make a web service call to https://www.crcind.com/csp/samples/SOAP.Demo.CLS?wsdl, to call the method GetListByName.