AcknowledgmentReceiver collaboration template

The AcknowledgmentReceiver collaboration template is used to receive acknowledgement from an independent service vendor (ISV) application that the application has received data. If the collaboration object receives a positive acknowledgement, it does nothing. If it receives a negative acknowledgement (indicating that the application failed to receive the data) the collaboration object issues an error.

AcknowledgmentReceiver uses the Generic Acknowledgment Business Object to represent an ISV application acknowledgement of receipt of data.

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 AcknowledgmentReceiver's ports:

AcknowledgmentReceiver 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
Acknowledgment Supplier/partner order handling system Receives the triggering business object Create
 
Port name: To
Business object Bound to Function Verbs used
Acknowledgment WebSphere MQ Workflow Sends the triggering business object out of the collaboration object Create

Setting up the collaboration object

To set up a AcknowledgmentReceiver collaboration object, complete the following steps:

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

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 Create verb.

AcknowledgmentReceiver collaboration Prequalify 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

In addition to its standard configuration properties, this collaboration template has a single configuration property specific to itself: RETURN_NACK. This property specifies whether to raise an exception or send an error information to the caller when a collaboration object receives a negative acknowledgement.

RETURN_NACK configuration property
Possible values Usage
all
Causes this collaboration object to send error information to the caller whenever a negative acknowledgement is received.
none (default value) Causes this collaboration object to raise an exception whenever a negative acknowledgement is received.
Comma-delimited list of values for the RequestName attribute of the Acknowledgement business object Causes this collaboration object to send error information to the caller whenever the RequestName value of a negative acknowlegement is one of the listed values, and to raise exception if the value is not listed.

Copyright IBM Corp. 2002, 2003