Use the Web Service task to call a Rest API or Soap Service. It is represented as rectangular shape box as shown below:



Purpose

Web Service task is used to call external web services using Rest API or Soap API Service. It helps business processes to gather and retrieve information from an external web server.


Web Service Node Configuration Properties:

Web Service Configuration panel has 4 tabs to define properties.

  1. General

General Tab contains general information such as title, task id etc.

  1. Business Object

Used to configure and map the Business Object for input and output for the node.

  1. WebService Parameter



All Settings in WebService ParameterTab are shown below:


Property

Mandatory

Default

Description

Web Service Type

Yes

SOAP

To choose the type of web service. There are 2 types as following: SOAP and REST.


The values for Settings are as follows.

SOAP

When SOAP is selected as Web Service Type, user must enter the information about calling the Soap Service in the SOAP panel.




Property

Mandatory

Default

Description

WSDL File

Y, SOAP using WSDL File


WSDL File for WebService to needs to be called

XSD File

N


Subject of WSDL file.

WSDL URL

Y, when SOAP needs to be called using url.


WSDL URL is the url to the WSDL File location.

Operation

Y


The operation is method to be called of that service.

End Point

Y


The endpoint is the URL where that service can be accessed by a client application.

Authentication

N


Authentication credentials for HTTP authentication.

Username

N


Username for Authentication.

Password

N


Password for Authentication.


SOAP panel has a "Choose WSDL" button to upload WSDL file or a "Choose XSD" button to upload XSD file. Once the user chooses a WSDL or XSD, user can click the Get Operation button to get all possible operations from the SOAP service. Get Endpoint button is to get End Point from SOAP Service.

REST

When REST is selected as the Web Service Type, user must enter information about calling the Rest API on REST panel.




Property

Mandatory

Default

Description

REST URL

Yes


URL for calling Rest API.

Http Type

Yes


Operations to HTTP requests.

Accept Header

Yes


Type of text that the Rest API accepts.

Content Type

Yes


A Content Type is a set of text response when calling Rest API.

Authentication

No


Authentication credentials for HTTP authentication.

Username

No


Username for Authentication.

Password

No


Password for Authentication.


Both SOAP and REST tabs contain a "Open Mapping Parameter" button. Click on "Open Mapping parameter" button redirects user to Mapping Parameter panel screen where user can click on Mapping Parameter Input line or Mapping Parameter Output line to map parameters for this Web Service task.


Note: User must click "Save Panel" to save all configuration changes.