CompleteDesign collaboration template

The CompleteDesign collaboration template is used to handle work orders that track installation and configuration. CompleteDesign receives confirmation notification events that signal the creation of design layer records (DLRs) from a provisioning system.

CompleteDesign uses the Generic ConfigRecord business object to represent a work order that tracks installation and configuration.

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

Diagram showing CompleteDesign 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.

Port name: From
Business object Bound to Function Verbs used
ConfigRecord WebSphere MQ Workflow Receives the triggering business object Update

Port name: To
Business object Bound to Function Verbs used
ConfigRecord Provisioning system Sends the triggering business object out of the collaboration object Update

Port name: DestinationAppRetrieve
Business object Bound to Function Verbs used
ConfigRecord Provisioning system Sends a reference-valued business object to retrieve the full-valued business object. The result determines whether the triggering business object is sent to the destination application. Retrieve

Port name: SourceApp
Business object Bound to Function Verbs used
ConfigRecord WebSphere MQ Workflow Retrieves the source data from the master application. When the collaboration object receives only the key information from the From port, it retrieves the source data from the master application, and sends the full-valued business object to the destination application.

Note:
Since this port is closely related to SYNC_FROM_SOURCE property, see the SYNC_FROM_SOURCE property.
Retrieve

Setting up the collaboration object

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

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

Collaboration template processes

This section illustrates the following business processes for this collaboration template:

Overall process logic

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 SYNC_FROM_SOURCE configuration property is set to true:

Create

The following diagram shows the process logic for this collaboration template's Create verb.

ReturnTestResult Validate process logic

SYNC_FROM_SOURCE

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.

ServiceRequestInitiator SYNC_FROM_SOURCE  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: SYNC_FROM_SOURCE. 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".

SYNC_FROM_SOURCE configuration property
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.

Copyright IBM Corp. 2002, 2003