Enhanced Soap Tool

Introduction

The Enhanced SOAP Tool allows you to save the request and response payload of a call to a web service for integration purposes. It is an enhanced version of the existing SOAP Tool in Joget.

Plugin information

• Plugin Name: Enhanced SOAP Tool
• Compatibility: Joget DX 7 and onwards

Get started

Where to get the plugin

• You can download the plugin's source code from the GitHub repository.
• The latest release can be found in the Enhanced Soap Tool - Releases.

How to install

1. Download the plugin JAR file from the releases page.
2. Go to Settings > Manage Plugins > Upload Plugin.
3. Once uploaded, the plugin will be available in your Joget environment.

How to use it

1. Download the demo app from the link provided in the Download Demo App section.
2. Go to Joget Home or All Apps and click Import App to import the downloaded app. (For more details, see another KB, Import Joget App.)
   
3. Go to Search by SOAP Tool using Parameters in the demo app.
4. Enter "a" into the Name field for this demo.
5. The SOAP request will be made, and you can view the results.
   
6. Go to Manage SOAP Req / Res to view the saved request and response payload in another table.
   
   
7. You can review the data stored in the table via the form and see how the payload was saved.
   
   
   
   

Configure SOAP properties

The properties are mostly similar to SOAP Tool, the only added section is Store Request / Response.

Fields to configure:

• WSDL URL: The Webservice WSDL URL to be called.
• Operation Name: The name of the SOAP operation.
• Username: Credential Username for authentication.
• Password: Credential Password for authentication.
• Use WS-Security: If checked, WS-Security headers will be sent with the username and password.
• Parameters: Values in sequence order of the operation parameters.
• SOAP Body (XML): Enter the XML content for the <soap:Body> tag. The Parameters section is ignored when using the SOAP Body.
• SOAP Action: SOAP Action is required when SOAP Body is used, and SOAP version is 1.1.

Store request/response

Fields to configure:

• Form: The form used to store the request and response data.
• Field ID to store request: The field ID in the form for storing the request.
• Field ID to store response: The field ID in the form for storing the response.

Store to form

Fields to configure:

• Form: The target form where the data will be saved.
• Base XML Object Name for Multirow Data: Used for multi-row data to define the base path of the array.
• Field Mapping:
  • Field ID: The corresponding field in the form.
  • 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

Fields to configure:

• Workflow Variable Mapping:
  • Workflow Variable: The workflow variable name.
  • XML Object Name: The XML Object Name path.

Advanced

Field to configure:

• Debug Mode: When checked, debug messages will be printed 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 "}

Expected outcome

After configuring and running the Enhanced SOAP Tool, you can to save both the request and response payloads for further analysis and integration.

Download plugin

• Download Enhanced SOAP Tool

Download sample app