Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents

...

Introduction

English
green
borderWidth1
titleBGColor#ddffcc
borderStylesolid
titleDefinition
The SOAP Tool allows one to invoke call to webservice for integration purpose to return useful information from external sources into the process instance.

SOAP Tool Properties

Configure SOAP Tool

Image AddedImage Removed

Figure 1: SOAP Tool Properties

NameDescription
WSDL URLWebservice WSDL URL to be called.
Operation NameOperation Name
UsernameCredential - Username
Password Credential - Password
ParametersValues in sequence order of the operation parameters.
SOAP Body (XML)

The XML content of <soap:Body> tag.

Parameters setting is ignored when SOAP Body is used.

SOAP Action
SOAP Action is required when SOAP Body is used and SOAP version is 1.1

...



Store To Form

Image RemovedImage Added

Figure 2: SOAP Tool Properties - Store to To Form Properties

NameDescription
 FormTarget form to store data.
 Base XML Object Name for Multirow DataIf returned data is intended to an array / multirow data, define the base path
to
of the array.
 Field Mapping
NameDescription
Field IDField ID correspondent 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

Image AddedImage Removed

Figure 3: SOAP Tool Properties - Store to To Workflow Variable Properties

NameDescription
 Workflow Variable Mapping
NameDescription
Workflow VariableWorkflow Variable name.
XML Object NameXML Object Name path.

...




Advanced

Image RemovedImage Added

Figure 4: SOAP Tool Advanced Properties - Advanced

NameDescription
 Debug Mode

When checked, debug messages will be printed out in the server log for troubleshooting purpose.

...

In the server

...

log,

...

you will

...

observe returned formatted data as the following

...

:

Code Block

...

INFO  

...

20 

...

Feb 

...

2020 

...

02:

...

14:

...

56 org.joget.plugin.enterprise.SoapTool  
- {"

...

NumberToWordsResult":

...

"six hundred and seventy eight "}




Download Demo App

Demo app to make a web service call to https

 

Example 1

In the example above, we are making a webservice call to  http://www.webservicex.net/geoipservice.asmx , calling the method GetGeoIP.

Below is a sample app to make a webservice call to http://www.webservicexcrcind.net/airport.asmx?op=GetAirportInformationByCountry.

APP_soapToolSample-2-20131126170202.zip

Example 2

The sample app below contains a SOAP call to the operation name GetStockQuote from http://www.restfulwebservices.net/wcf/StockQuoteService.svc?wsdl

APP_webservice1-1-20161123115423.jwa

When Debug Mode is enabled, the output will be similar to the following:

Code Block
INFO 23 Nov 2016 18:51:47 SoapTool - <ns1:GetStockQuoteResult xmlns:a="http://www.restfulwebservices.net/DataContracts/2008/01" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://www.restfulwebservices.net/ServiceContracts/2008/01"><a:Symbol>IBM</a:Symbol><a:Last>162.67</a:Last><a:Date>11/22/2016</a:Date><a:Time>4:01pm</a:Time><a:Change>-0.10</a:Change><a:Open>163.00</a:Open><a:High>163.00</a:High><a:Low>161.95</a:Low><a:Volume>2770899</a:Volume><a:MktCap>154.68B</a:MktCap><a:PreviousClose>162.77</a:PreviousClose><a:PercentageChange>-0.06%</a:PercentageChange><a:AnnRange>116.90 - 165.00</a:AnnRange><a:Earns>12.27</a:Earns><a:PE>13.25</a:PE><a:Name>International Business Machines</a:Name></ns1:GetStockQuoteResult>
INFO 23 Nov 2016 18:51:47 org.joget.plugin.enterprise.SoapTool - {"GetStockQuoteResult":{"High":"163.00","Earns":"12.27","MktCap":"154.68B","Symbol":"IBM","Time":"4:01pm","Change":"-0.10","Date":"11/22/2016","PreviousClose":"162.77","Open":"163.00","Name":"International Business Machines","Last":"162.67","Low":"161.95","Volume":"2770899","PE":"13.25","PercentageChange":"-0.06%","AnnRange":"116.90 - 165.00"}}
INFO 23 Nov 2016 18:51:47 org.joget.workflow.shark.WorkflowAssignmentManager - [processId=134992_webservice1_process1, processDefId=webservice1#6#process1, participantId=requester, next user=[admin]]

 

 

 com/csp/samples/SOAP.Demo.CLS?wsdl, to call the method GetListByName.