The ReturnParties collaboration template is used to find data objects representing customers or suppliers by specified content search criteria from an order management system in the telecommunications industry.
ReturnParties uses the Generic PartySearchCriteria business object to contain an array of Generic Party business object. A Party represents a person, a company or a household who is a customer or supplier. The first element of PartySearchCriteria is used as search criteria. PartySearchCriteria is sent to the destination application to find and retrieve full-valued Parties by content. If the criteria is null, all Parties are received.
The ReturnParties collaboration template does not involve any creation, updates or deletion of Parties. If a Party needs to be created, updated or deleted, the PartyManager collaboration template supports these processes.
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:
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 ReturnParties'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.
Business object | Bound to | Function | Verbs used |
---|---|---|---|
PartySearchCriteria | 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 |
---|---|---|---|
PartySearchCriteria | Sales order management system |
Sends a reference-valued business object to retrieve the full-valued business object. The result determines which verb to use when synchronizing the PartySearchCriteria | RetrieveByContent |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
PartySearchCriteria | 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 ReturnParties as a stand-alone collaboration object, complete the following steps:
This section illustrates the following business processes for this collaboration template:
The following diagram illustrates ReturnParties' RetrieveByContent process logic.
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 inherits the Email process for error handling business process from the CollaborationFoundation template.
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 | Handles the exception as an error, and causes this collaboration object to fail and to raise an exception. |
false (default value) | 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.
Note: Exceptions from USE_RETURN process are not handled as INFORMATIONAL_EXCEPTIONS, because of the nature of the process.
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. |