Web Service objects configure the resources needed to consume a local or remote service, expose a service to remote clients, and manage the flow and transformation of message data. Clarify supports both SOAP and REST, and an integration can act as a provider, a consumer, or both.
A web service is an interface that lets software systems exchange data over a network regardless of platform or language. Communication typically uses HTTP with an XML payload, though XML is not required (REST services commonly use other formats).
Clarify provides two object types:
| Object | Role | Function |
|---|---|---|
| Web Service Provider | Exposes a service | Generates the companion resources (such as the WSDL or a service URL) that clients need to send requests. Once activated, it listens for inbound requests and routes them for processing. |
| Web Service Consumer | Calls a service | Sends requests to a local or remote provider endpoint and processes the responses. |
Both objects integrate with Clarify Business Processes. Request and response data can be mapped, transformed, and passed to Business Processes, Schemas, and other objects as part of the integration flow. Providers can also include attachments in response messages.
Provider Configuration
A provider can publish its service contract in one of two ways:
- WSDL (SOAP): Clarify generates a WSDL document. Hosted on a server, it describes the operations, message formats, and endpoint so consumers can build compliant requests.
- Endpoint URL (REST): Clarify exposes a URL that consumers call directly.
Use Cases
1. Consuming a third-party service (shipping rate lookup)
Goal: Calculate shipping cost at order time using a carrier's web service (UPS, in this example) without custom code.
Flow:
- Capture the destination zip code from the website order form.
- Use a Web Service Consumer object to send the request to the carrier's endpoint.
- Receive the rate response and map it into the order data.
- Return the total shipping cost to the customer.
The same pattern applies to other carrier operations, such as address validation, tracking lookup, currency conversion, and SMS notification. These use an HTTP connection to the external service and require no custom integration code.
2. Integrating systems with no native web service support
Goal: Transfer invoice data from a legacy Order Management System (OMS) to a commercial accounting application when neither exposes a web service interface.
Approach: Instead of running an internal web server and writing custom applications to extract, transform, and load the data, use Clarify to:
- Define Web Service objects as the communication layer between the two systems.
- Build Business Processes to handle the transformation and transfer of invoice data.
- Optionally use Clarify adapter objects to simplify connectivity to each system.
This replaces custom code with configuration and is non-intrusive to both applications.
3. Other patterns
- Processing inbound purchase orders delivered as SOAP attachments.
- Handling order status queries from any internet-connected client, such as a website or mobile device.
Summary
Define and configure the Web Service Provider or Consumer object, link it to the Business Processes and Schemas that handle your data, and activate it. Once active, it can consume services, expose services to remote clients, or both.
Comments
0 comments
Please sign in to leave a comment.