InvokeProcessWithServiceOrder collaboration template

This collaboration template is used to invoke a process in the destination application. As a result of this invocation, the destination application (such as WebSphere MQ Workflow) starts a scenario based on the order.

TelcoWFInvokeWithServiceOrder uses the Generic ProcessInvokeWithServiceOrder business object to represent a request to invoke a process. This business object contains a Generic TelcoServiceOrder business object.

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

InvokeProcessWithServiceOrder 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
ProcessInvoke
WithServiceOrder
Provisioning system Receives the triggering business object. Invoke

Port name: To
Business object Bound to Function Verbs used
ProcessInvoke
WithServiceOrder
WebSphere MQ Workflow Sends the triggering business object out of the collaboration object Invoke

Port name: SourceApp
Business object Bound to Function Verbs used
TelcoServiceOrder Provisioning 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, this port 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

Setting up the collaboration object

To set up InvokeProcessWithServiceOrder as a stand-alone collaboration object, complete the following steps:

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

Collaboration template processes

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

Overall process logic

The following diagram illustrates InvokeProcessWithServiceOrder's process logic.

InvokeProcessWithServiceOrder collaboration 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.

PROCESS_NAME

This property is used to specify the name of the process to invoke. The value specified for this property is set to triggering business object's ProcessName attribute whose type is String if the business object has that attribute.

PROCESS_NAME configuration property
Possible values Usage
any value (default is CustomerBillingManagement ) Specifies the process to invoke
none Set this property to none to cause this collaboration to not set any value to a business object's "ProcessName" attribute.

EXECUTION_MODE

This property is used to specify whether to start the process in a synchronous mode or asynchronous mode. The value specified for this property is copied to the triggering business object's ExecutionMode attribute whose type is String if the business object has that attribute.

EXECUTION_MODE configuration property
Possible values Usage
synchronize Causes the process to start in synchronous mode.
asynchronize (default value) Causes the process to start in asynchronous mode.
none Prevents this collaboration from specifying any value for a business object's ExecutionMode attribute.

RESPONSE_TIMEOUT

This property is used to specify the timeout value of the process invocation. The value specified for this property is copied to the triggering business object's ResponseTimeout attribute whose type is String if the business object has that attribute.

RESPONSE_TIMEOUT configuration property
Possible values Usage
any value (default value is 10000 ) Specifies a value for the triggering business object's ResponseTimeout attribute
none Prevents this collaboration from setting any value to a business object's ResponseTimeout attribute

Copyright IBM Corp. 2002, 2003