Configuring the samples, template, adapter, and maps
This sections describes the samples as well as how to configure them and
the adapter.
About the sample content
The samples are as follows:
- MQWF_DataStructure_SampleItemOrder This is a business object
representing the data structure named SampleItemOrder in WebSphere
MQ Workflow.
- MQWF_DataStructure_SampleItemOrder_Item This is a business
object representing the child data structure Item contained in data
structure SampleItemOrder in WebSphere MQ Workflow.
- MQWF_DataStructure_SampleItem This is a business object
representing the data structure SampleItem in WebSphere MQ
Workflow.
- MQWF_SampleItemOrder This is a container object for
MQWF_DataStructure_SampleItemOrder. It holds an input and
output data structure along with the various meta-objects used by the
adapter. This is the object passed between the adapter and a
collaboration when dealing with data structure
SampleItemOrder.
- MQWF_SampleItem This is a container object for
MQWF_DataStructure_SampleItem. It holds an input and output
data structure along with the various meta-objects used by the adapter.
This is the object passed between the adapter and a collaboration when dealing
with data structure SampleItem.
- MO_MQWorkflow_ProcessInstance This object is used to track and
control WebSphere MQ Workflow processes.
- MQWF_SampleItemRequest This is a container object for
MQWF_DataStructure_SampleItemRequest and is used when WebSphere MQ
Workflow sends a request to InterChange Server. It holds an input data
structure along with various meta-objects used by the adapter. This is
the object passed from the adapter to a collaboration when dealing with data
structure SampleItemRequest.
- MQWF_SampleItemResponse This is a container object for
MQWF_DataStructure_SampleItemRequest and is used when InterChange
Server returns a response to WebSphere MQ Workflow. It holds an output
data structure along with the various meta-objects used by the adapter.
This is the object passed from a collaboration to the adapter when dealing
with data structure SampleItemRequest.
- MQWF_GBO_SampleItem This is a container object for
MQWF_DataStructure_SampleItem. It holds an input and output
data structure and represents a fictitious generic business object in a
collaboration.
- SampleItemOrderSync_MQWF_to_Port and
SampleItemOrderSync_Port_to_MQWF These are collaboration objects
used for exchanging business object MQWF_SampleItemOrder between
the adapter and a Port Connector.
- SampleItemSync_MQWF_to_Port and
SampleItemSync_Port_to_MQWFThese are collaboration objects used for
exchanging business object MQWF_SampleItem between the adapter and
a Port Connector.
- SampleWorkflowProcessControl_Port_to_MQWF This is a
collaboration object used for retrieving and controlling business object
MO_MQWorkflow_ProcessInstance
- SampleItemActivity_MQWF_to_MQWFThis is a collaboration object
and is used for receiving MQWF_GBO_SampleItem from the adapter,
passing it to a Port connector agent, and sending it back to the
adapter.
- MQWF_Sample_RequesttoGBO This is a map that transfers data from
a request business object MQWF_SampleItemRequest to a fictitious
generic business object MQWF_GBO_SampleItem.
- MQWF_Sample_GBOtoResponse This is a map that transfers data
from a fictitious generic business object MQWF_GBO_SampleItem to a
response business object. MQWF_SampleItemResponse.
Copying the template class file
For the collaboration template to work, you must include the associate
class file:
- Copy the files contained in sample_folder/classes to
WBI_folder/collaborations/classes/UserCollaborations/classes
- Note:
- Because the sample collaboration is based upon the
CollaborationFoundation template (available separately), IBM does
not provide the .CLM or .java components
necessary for modifying the collaboration.
Configuring the connector
Configure connector properties as follows:
- AgentTraceLevel=3
- ApplicationPassword=(password for username)
- ApplicationUserName=username
- ArchiveQueue=MQWFCONN.ARCHIVE
- BOPrefix=MQWF_
- DeliveryTransport=IDL (optional)
- ErrorQueue=MQWFCONN.ERROR
- InputQueue=CWLDINPUTQ
- MQSeriesCCSID=CCSID
- MQSeriesChannel=CHANNEL
- MQSeriesHostname=HOST
- MQSeriesPort=PORT
- MQSeriesQueueManager=queue manager
- OutputQueue=FMC.FMCGRP.EXE.XML
- ReplyToQueue=MQWFCONN.REPLYTO
- UnsubscribedQueue=MQWFCONN.UNSUBSCRIBED
Supporting the sample business objects
To work with the sample business objects, you must make sure that the
adapter supports them:
- In System Manager, open the WBI Adapter for the WebSphere MQ Workflow and
Port connector definitions
- Click the Supported Business Objects tab, and add the following business
objects:
- MO_MQWorkflow_ProcessInstance
- MO_MQWorkflow_ProcessTemplateConfig
- MO_MQWorkflow_ContainerInfo
- MO_MQWorkflow_ProcessInfo
- MO_MQWorkflow_ActivityInfo
- MO_MQWorkflow_ActivityRequest
- MO_MQWorkflow_ActivityResponse
- MO_DataHandler_Default
- MO_DataHandler_DefaultXMLConfig
- MQWF_SampleItem
- MQWF_Structure_SampleItem
- MQWF_SampleItemOrder
- MQWF_Structure_SampleItemOrder
- MQWF_Structure_SampleItemOrder_Item
- MQWF_SampleItemRequest
- MQWF_SampleItemResponse
- MQWF_Structure_SampleItemRequest
Binding maps
To enable maps to transfer data, you must associate them with the
adapter.
- In System Manager, open the adapter definitions.
- Click the Associated Maps tab.
- Check Explicit Bindings for the following maps:
- MQWF_Sample_RequesttoGBO
- MQWF_Sample_GBOtoResponse
Final configuration steps
- Reboot InterChange Server to ensure that all changes take effect.
- Import
sample_folder/WebSphereMQWorkflow_Samples.fdl to
your IBM WebSphere MQ Workflow Runtime Server.
- Note:
- For information about importing the FDL file to Runtime, see IBM
WebSphere MQ Workflow: Getting Started with Buildtime. If
you are not concerned about overwriting existing runtime data, you can quickly
load the sample workflows by opening a command line window and typing the
following (WARNING: This will overwrite all runtime data):
fmcibie /i=WebSphereMQWorkflow_Samples.fdl /u=ADMIN /y= /t
/o (password: password)
