The ReturnAccounts collaboration template is used to handles lists of data objects that represent records of financial items for individual customers, and to communicate with an account management system.
ReturnAccounts uses the Generic AccountSearchCriteria business object to contain an array of Generic Account business object. The Account business object represents a financial item relating to an individual customer. The first element of AccountSearchCriteria is used as search criteria. AccountSearchCriteria is sent to the destination application to find and retrieve full-valued Accounts by content. If the criteria is null, all Accounts are received.
ReturnAccounts does not involve any creation, updates or deletion of Accounts. If a Account needs to be created, updated or deleted, the TelcoCustomerAccountManager collaboration template supports these processes.
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.
The following diagram illustrates ReturnAccounts' 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.
Business object | Bound to | Function | Verbs used |
---|---|---|---|
AccountSearchCriteria | 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. | RetrieveByContent |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
AccountSearchCriteria | Account management system | Sends a reference-valued business object to retrieve the full-valued business object. | RetrieveByContent |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
AccountSearchCriteria | WebSphere MQ Workflow | Returns the result of the collaboration object's processing
to an application before the collaboration object ends its process. This is typically used
with a 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 |
To set up ReturnAccounts as a stand-alone collaboration object, complete the following steps:
This section illustrates the following business processes for this collaboration template:
This section illustrates this collaboration template's process logic for its supported verbs indicated below, as well as additional process logic that will be executed if the USE_RETURN or SYNC_FROM_SOURCE configuration property is set to true:
The following diagram shows the process logic for this collaboration template's RetrieveByContent verb.
The following diagram shows the additional process logic that is executed when the collaboration object's USE_RETURN configuration property is set to true.
This collaboration template uses the standard Email process for error handling business process.
IBM WebSphere InterChange Server provides the ability to roll back a transaction upon the failure of any step in the transaction. For example, when TelcoItemSync is a member of a collaboration object group, its process is one subtransactional step in a larger process. If any step fails in the collaboration object group's processes, IBM WebSphere Business InterChange Server allows you to roll back the processing of every collaboration object in the group.
When a TelcoItemSync collaboration object is used independently of other collaboration objects, its process comprises a single transactional step. In such a situation, it is not necessary to perform a rollback.
To cause a collaboration object or a collaboration object group to perform rollback requires modifying the collaboration template. To understand transaction processing by WebSphere Business Integration Server, see the Technical Introduction to IBM WebSphere InterChange Server. For information on adding transaction processing to the collaboration template, see the Collaboration Development Guide.
To extend the collaboration object to handle transaction processing, complete the following steps:
This section describes the following properties for this collaboration template:
This collaboration template uses the following standard configuration properties for collaboration templates:
The following properties are specific to this collaboration template:
This property specifies how to handle an exception raised by the destination application when no records are found that match the search criteria.
Possible values | Usage |
---|---|
true (default value) | Handles the exception as an error, and causes this collaboration object to fail and to raise an exception. |
false | Handles the exception as a zero result, and causes this collaboration object to finish successfully and to return an empty list. |
This property specifies whether to return the processed business object through the Return port.
This property is required to handle cases where the user expects the process to return an output that is of a different type than the input. For example, the result of an asynchronous process may return an output that is different from the input that triggered the asynchronous process.
Note: Exceptions from USE_RETURN process are not handled as INFORMATIONAL_EXCEPTIONS, because the result is not considered to be informational.
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. In this case, the Return port is typically bound to the same application as the one that is bound to the From port. |
false | Causes this collaboration object not to return through the Return port. In this case, the Return port is bound to the Port connector. |