The BillableItemManager collaboration template is used to synchronize data objects that represent records of billable items related to a service, and to communicate with an account management system.
BillableItemManager uses the Generic BillableItem business object to represent a billable item record.
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 BillableItemManager'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 |
---|---|---|---|
BillableItem | 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. | Create Update Retrieve Delete |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
BillableItem | Account management system | Sends the triggering business object out of the collaboration object | Create Update Delete |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
BillableItem | Account 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 BillableItem. | Retrieve |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
BillableItem | Account management system | 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. Note: Since this port is closely related to SYNC_FROM_SOURCE property, see the SYNC_FROM_SOURCE property. |
Retrieve |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
BillableItem | 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 BillableItemManager 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 Create, Delete, and Update verbs.
The following diagram shows the process logic for this collaboration template's Retrieve 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.
The following diagram shows the additional process logic that is executed when the collaboration object's SYNC_FROM_SOURCE configuration property is set to true.
This collaboration template uses the following standard business processes:
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 retrieve the source data from the master application through the SourceApp port before sending the data to another application. When the triggering business object has only the key information, this property should be set to true.
Possible values | Usage |
---|---|
true | Causes this collaboration object to retrieve the full-value business object and use it as triggering business object. |
false (default value) | Causes this collaboration object to use the triggering business object directly. In this case, the SourceApp port is bound to the Port connector. |
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. |