Skip to end of metadata
Go to start of metadata

The Web Services modules supports SOAP Web Services. When using a SOAP Web Service, we access the WSDL file to return a list of valid operations that can be called.

Watch the Video




Creating a new SOAP Configuration

In the Project Browser of the designer, right­-click the SOAP Configuration to create a new SOAP Web Service Configuration. 



General Settings

WSDL URL

This is the full URL that is required to access the Web Service WSDL.

Example: https://www.w3schools.com/xml/tempconvert.asmx

After entering in the URL, press the  button to connect and process the WSDL file to return a listing of valid operations and ports. After a valid WSDL has been configured, the Web Services module internally processes the WSDL and presents the possible selections. 

Port

This is the available address or connection point for the web service. It is normally a simple string. Select an available port to allow the available Operations to be populated.

Schema

This will allow you to view the schema used for the selected port. It is a readable version of the settings contained in the WSDL and allows you to cycle through the ports, operations and body contents of the input and output for the operation.

Operation

These are the available actions this web service and port supports. The operation is similar to a method or function call in a traditional programming language.

Encoding

The available encoding types are UTF_8, UTF_16, ISO_8859_1, Windows_1252, and ASCII.

Timeout

This is the time the module will wait until a response is received from the URL. If no response is received then an error is generated.

Calls that take more than < Gateway Read Timeout Setting> seconds will time out in the Client.

Bypass SSL server authentication

The consumer (client) will bypass SSL server authentication if the checkbox is selected.

Enable error reporting for failure HTTP response codes 

An exception will be thrown when the web service call results in a code like 404 or other error codes, if the checkbox is selected.



HTTP Authentication

Type

The options are HTTP Basic, HTTP Digest, and HTTP NTLM.

Username

The user name to set for the new SOAP configuration.

Password

The password to set for the new SOAP configuration.



WS-Security

Enable WS-Security

The system will enable WS-Security if the checkbox is enabled. 

Username

The user name to set for the WS-Security.

Password

The password to set for the WS-Security.

Password type

The available password types are PasswordText or PasswordDigest.

Time to live (s)

Amount of time (in seconds) that the message is valid.



Parameters

A web service operation will most likely require parameters to be set before the web service can be called. The parameter section allows you to see those parameters, their data type and optionally set the parameters to a constant value or bind them to a tag.

Some parameters have limited values that can be used and these may be supplied by the operation. These values will appear as a drop down box. You may need to use these parameter names in scripting calls when running this web service.


No Inputs

For provider operations with no inputs, the Request Message Schema will have an empty body. Example:

  • No labels