AddressValidation collaboration template

The AddressValidation collaboration template is used to validate location information by comparison with information registered in a database, such as street addresses and location codes. AddressValidation communicates with an supplier/partner order handling system.

AddressValidation uses the Generic ServiceLocationData business object to represent location information.

This collaboration template uses the ProcessContext attribute of generic business objects to maintain process information between two or more collaboration objects. In order to maintain this information, the collaboration object performs the following actions, starting from when it receives a triggering business object:

Collaboration object setup

This section includes information on port bindings and required steps for setting up collaboration objects based on this collaboration template. For information on standard features, ports, and configuration properties for collaboration templates, and for general information on creating collaboration objects refer to the documents listed in Required documents for creating collaboration objects.

Port information

The following diagram illustrates AddressValidation's ports:

AddressValidation collaboration's ports

Note: To keep the collaboration object from using a port, bind that port to the Port connector. Doing so indicates that the port is unused without causing the collaboration object to provide additional functionality.

The following tables describe bindings for the ports of this collaboration object.

Port name: From
Business object Bound to Function Verbs used
ServiceLocationData WebSphere MQ Workflow Receives the triggering business object. At the end of a synchronous call, this port also returns the triggering business object to the source application when the collaboration object ends successfully. Validate
 
Port name: To
Business object Bound to Function Verbs used
ServiceLocationData Supplier/partner order handling system Sends the triggering business object out of the collaboration object for location validation Validate

Port name: Return
Business object Bound to Function Verbs used
ServiceLocationData WebSphere MQ Workflow Returns the result of the process to an application before the collaboration object ends its process. This is typically used with WebSphere MQ Workflow connector to return the result of the business process to the WebSphere MQ Workflow activity.

Note:
Since this port is closely related to USE_RETURN property, see the USE_RETURN property.
Update

Setting up the collaboration object

To set up an AddressValidation collaboration object, complete the following steps:

  1. Create the AddressValidation collaboration object.
  2. Bind the ports as described in Port information.
  3. Set the configuration properties for AddressValidation.

Collaboration template processes

This section illustrates the following business processes for this collaboration template:

Overall process logic

The following diagram shows the process logic for this collaboration template's Validate verb.

AddressValidation collaboration Prequalify process logic

The following diagram shows the additional process logic that is implemented when the collaboration object's USE_RETURN configuration property is set to true.

USE_RETURN process logic

Standard business process logic

This collaboration template uses the following standard business processes:

Configuration properties

This section describes the following properties for this collaboration template:

Standard properties

This collaboration template uses the following standard configuration properties:

Properties specific to this collaboration template

This collaboration has the USE_RETURN configuration property.

This property specifies whether to return the processed business object through the Return port.

Note: Exceptions from USE_RETURN process are not handled as INFORMATIONAL_EXCEPTIONS, because of the nature of the process.

USE_RETURN configuration property
Possible values Usage
true (default value) Causes this collaboration object to return the processed business object through the Return port after the completion of  processing. This is typically used when this collaboration object is called to return the result from the preceding asynchronous request.
false Causes this collaboration object not to return through the Return port. In this case, the Return port is bound to the Port connector.

Copyright IBM Corp. 2002, 2003