Web Service Consumer objects

The Web Service Consumer objects are used to request and process information or activity from a provider through the use of request messages. How this request message should be structured should be made available to you by the provider.

Clarify supports Web Services for both SOAP or REST protocols. A fundamental difference between a consumer object using the SOAP protocol versus REST is that the SOAP version exposes all services made available by the provider, while the REST version references a single Service. Another difference is the use of a WSDL for SOAP.

Web Service Consumer objects using SOAP/WSDL

When creating a Web Consumer (SOAP/WSDL) object, you must select the provider-supplied WSDL (via URL or filesystem). The WSDL identifies the IP address and Port used for the Web Service, lists the operations that can be executed when using the service, and identifies the XML Schema describing the incoming and outgoing message formats. WS-Security, if used, is also defined in the WSDL. The consumer of the service uses these Schemas to form their request message and understand the provider's response message.

When finished in the Web Service Consumer wizard, Clarify automatically generates XML Schemas contained in newly generated Packages.

Web Service Consumer objects using REST

When creating a Web Consumer (REST) object, you define different options and settings. This includes the URL location of the service, as well as the HTTP methods to be used. Once saved the Web Service Consumer object can be called as a Business Process task.