IDCServiceActivate collaboration template

The IDCServiceActivate collaboration template is used to activate an Internet Data Center (IDC) service on a  telecommunications network. The setup of the IDC service is processed by a network provisioning and activation system.

IDCServiceActivate uses the Generic ConfigRecordIDC business object to represent a configuration record for an IDC service.

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

IDCServiceActivate 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
ConfigRecordIDC 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. Activate

Port name: To
Business object Bound to Function Verbs used
ConfigRecordIDC Network provisioning and activation system Sends the triggering business object out of the collaboration object Activate

Port name: DestinationAppRetrieve
Business object Bound to Function Verbs used
ConfigRecordIDC Network provisioning and activation system Sends a reference-valued business object to retrieve the full-valued business object. The result determines which verb to use when synchronizing the ConfigRecordIDC. Retrieve

Port name: SourceApp
Business object Bound to Function Verbs used
ConfigRecordIDC Network provisioning and activation system Retrieves the source data from the master application. When the collaboration object is used in a sync mode, where it receives only the key information from the From port, it retrieves the source data from the master application, and synchronizes that data with other applications.

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

Port name: Return
Business object Bound to Function Verbs used
ConfigRecordIDC 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

Setting up the collaboration object

Since this collaboration object is assumed to handle a long-running process, a special setup for an asynchronous call model is required. In order to set up the collaboration object for an asynchronous call model, complete the following steps:

  1. Create an instance of IDCServiceActivate.
  2. Bind the ports as described in Port information.
  3. Set the configuration properties for IDCServiceActivate.

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 verb indicated below, as well as additional process logic that will be executed if the SYNC_FROM_SOURCE configuration property is set to true:

Activate

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

IDCServiceActivate Activate 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.

IDCServiceActivate SYNC_FROM_SOURCE  process logic

USE_RETURN

The following diagram shows the additional process logic that is executed when the collaboration object's USE_RETURN configuration property is set to true.

SalesOrderManager USE_RETURN process logic

Standard business processes

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

The following properties are specific to this collaboration template:

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.

USE_RETURN

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.

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

Copyright IBM Corp. 2002, 2003