Departments represent a specialized organizational unit and generally include static information. Departments can also be defined for a specific time period that is directly related to a project. When restructuring occurs, new department definitions need to be created and other definitions updated (for example: descriptions changed or made obsolete).
The DepartmentManager collaboration synchronizes the definition of a department across different applications. The collaboration ensures that all department information, such as the department number, department name and description, and the validity period are the same for the source and the destination. When synchronizing, the collaboration first checks whether the information from the source application exists in the destination application. If it does not, the collaboration creates it.
DepartmentManager does not support:
The DepartmentManager collaboration uses the generic Department business object, which represents department information in a human resources application.
This section includes information on port bindings and required steps for setting up collaboration objects based on DepartmentManager. For information on standard features, ports, and configuration properties for collaboration templates, see the Collaboration Development Guide. For general information on creating collaboration objects, see the System Implementation Guide.
Figure 1 illustrates DepartmentManager's ports as they are displayed in System Manager. The tables that follow the figure provide information about the ports.
Figure 1. DepartmentManager collaboration ports
Note: To prevent the collaboration object from using a port, bind that port to the Port connector. Binding the port indicates that the port is unused without causing the collaboration object to provide additional functionality.
Business object | Bound to | Function | Verbs used |
---|---|---|---|
Department | The destination application's connector | Sends a reference-valued business object to retrieve the full-valued business object. The result determines the verb to use when synchronizing the Department. |
Retrieve |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
Department | Source application's connector or calling collaboration. | 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 ends successfully. |
Create Retrieve Update Delete |
Business object | Bound to | Function | Verbs used |
---|---|---|---|
Department | The destination application's connector |
Sends the triggering business object out of the collaboration. |
Create Update Delete |
DepartmentManager is designed to be used as a stand-alone collaboration. To set up DepartmentManager as a stand-alone collaboration object, follow these steps:
This section illustrates the process logic for this collaboration template:
Figure 2 illustrates DepartmentManager's process logic.
Figure 2. DepartmentManager collaboration process logic
This collaboration template uses the following standard collaboration business processes:
For information about these processes, see the Collaboration Development Guide.
InterChange Server Express can roll back a transaction when any step in a transactional collaboration fails. For example, when DepartmentManager is a member of a collaboration-object group that participates in a transactional collaboration, its actions are one subtransactional step of a larger transaction. If any step in the collaboration-object group's business process fails, the transactional collaboration details how InterChange Server Express rolls back the processing of every collaboration in the group.
When a DepartmentManager collaboration object is used independently of other collaboration objects or the collaboration object's From port is bound to a source application rather than to another collaboration, its process comprises a single transactional step. In such a situation, it is not necessary to perform rollback.
To cause a collaboration object or a collaboration-object group to perform rollback requires modification of the collaboration template. To understand transaction processing in the IBM WebSphere Business Integration Server Express Plus system, see the System Implementation Guide. 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:
Note: DepartmentManager does not have unique configuration properties. All of its properties are standard.
This collaboration template uses the following standard configuration properties for collaboration templates:
For information on these configuration properties, see the Collaboration Development Guide.
To view an explanation of the messages of this collaboration template, launch the Log Viewer and open the collaboration template's message file. To launch the Log Viewer and open the collaboration template's message file:
To upgrade to a newer version of the collaboration template, perform the following steps: