Connector configuration

Connectors have two types of configuration properties: standard configuration properties and adapter-specific configuration properties. You must set the values of these properties before running the adapter.

To use Connector Configurator to configure connector properties:

  1. Start Connector Configurator.
  2. From the File menu, select New, then select Connector Configuration.
  3. From the template list, select WebSphereMQWorkflowTemplate.

The configuration file is created. If you need further assistance with using Connector Configurator to configure connector properties, see the following references:

Standard connector properties

Standard configuration properties provide information that all connectors use. See Appendix A. Standard configuration properties for connectors for documentation of these properties. When you set configuration properties in Connector Configurator, you specify your broker using the BrokerType property. Once this is set the properties relevant to the broker appear in the Connector Configurator window. For more information, see Appendix B. Connector Configurator.

Connector-specific properties

Connector-specific configuration properties provide information needed by the connector for WebSphere MQ Workflow. They also provide a way of changing static information or logic within the connector agent without having to recode and rebuild the agent.

Table 4 lists the connector-specific configuration properties for the connector. See the sections that follow for explanations of the properties.

Table 4. Connector-specific configuration properties
Name Possible values Default value Required
ApplicationPassword Login password Password. No
ApplicationUserID Login user ID ADMIN. No
ArchiveQueue Queue to which copies of successfully processed messages are sent MQWFCONN.ARCHIVE No
AuditQueue Works as ReplyToQue in the condition where ResponseTimeout=-1 MQWFCONN.AUDIT No
MQSeriesCCSID Character set for queue manager connection null No
MQSeriesChannel MQ server connector channel FMCQM.CL.TCP Yes
DataHandlerClassName Data handler class name com.crossworlds .DataHandlers. text.xml No
DataHandlerConfigMO Data handler meta-object MO_DataHandler _Default Yes
DataHandlerMimeType MIME type of file text/xml No
ErrorQueue Queue for messages containing errors MQWFCONN.ERROR No
MQSeriesHostName Name of machine containing WebSphere MQ Workflow queue manager blank Yes
InDoubtEvents FailOnStartup Reprocess IgnoreLogError Reprocess No
InputQueue Queue to poll for WebSphere MQ Workflow requests CWLDINPUTQ Yes
InProgressQueue In-progress event queue MQWFCONN.IN_ PROGRESS Yes
JavaCorbaApi Enables Java CORBA API when its value is set to true false No
OutputQueue Queue to issue requests to WebSphere MQ Workflow FMC.FMCGRP.EXE.
XML
Yes
PollQuantity Number of messages to retrieve from the input queue 1 No
MQSeriesPort Port established for the WebSphere MQ (MQSeries) listener 14000 Yes
ReplyToQueue Queue to which response messages are delivered when the connector issues requests MQWFCONN.REPLYTO No
UnsubscribedQueue Queue to which unsubscribed messages are sent MQWFCONN. UNSUBSCRIBE No
MQSeriesQueueManager Queue manager for Workflow FMC (if left blank, the
default queue manager is used)
No
BOPrefix For subscription deliveries, the name of the data structure is appended to this prefix to determine the name of the top-level business object. MQWF_ No
WorkflowSystemName The name of the WebSphere MQ Workflow system to which the connector binds for direct control of a workflow process. FMCSYS No
WorkflowSystemGroup The name of the WebSphere MQ Workflow system group to which a connection is established for direct control of a workflow process. FMCGRP No
WorkflowAgentLocatorPolicy Specifies local or remote connection to the WebSphere MQ Workflow server. LOC The connector connects to the server running on the local machine.OSA The connector connects remotely to the WebSphere MQ Workflow server LOC No
WorkflowAgentName The name of the WebSphere MQ Workflow CORBA agent. No

ApplicationPassword

Password used with UserID to log in to WebSphere MQ.

Default = password.

If the ApplicationPassword is left blank or removed, the connector uses the default password provided by WebSphere MQ Workflow.

ApplicationUserID

Passed by the connector to the WebSphere MQ Workflow server to authorize a connection (for the Java direct-binding API). This property is also used:

If ApplicationUserID is left blank or removed, the connector uses the default user ID provided by WebSphere MQ Workflow.

You can specify the user ID in this property or in the meta-object attribute UserID. In either case, ApplicationUserID must be:

Note:
ApplicationUserID is not specified in the MCA properties for the WebSphere MQ server connection channel used by WebSphere MQ Workflow. By default WebSphere MQ Workflow specifies user fmc for this property, which causes all messages exchanged between the adapter and the WebSphere MQ Workflow application to be sent under the authority of user fmc. Clear this value in your WebSphere MQ server connection channel properties so that messages can be sent by the ApplicationUserID that you specify in this connector-specific property.

Default=ADMIN.

ArchiveQueue

Queue to which copies of successfully processed messages are sent.

Default = MQWFCONN.ARCHIVE

AuditQueue

The queue to which responses are sent in the case of a Timeout=-1 (default). When sending messages to the WebSphere MQ Workflow application, the connector populates the ReplyToQueue as the connector property value of AuditQueue in the header of the outbound message. This is used to track errors, even when the connector is not waiting for a response.

MQSeriesChannel

WebSphere MQ Workflow server connector channel through which the connector communicates with WebSphere MQ.

Default=FMCQM.CL.TCP

If the Channel is left blank or removed, the connector uses the default server channel provided by WebSphere MQ Workflow.

DataHandlerClassName

Data handler class to use when converting messages to and from business objects.

Default = com.crossworlds.DataHandlers.text.xml

DataHandlerConfigMO

Meta-object passed to data handler to provide configuration information.

Default = MO_DataHandler_Default

DataHandlerMimeType

Allows you to request a data handler based on a particular MIME type.

Default = text/xml

ErrorQueue

Queue to which messages that could not be processed are sent.

Default = MQWFCONN.ERROR

MQSeriesHostName

The name of the server hosting WebSphere MQ Workflow.

Default = blank

InDoubtEvents

Specifies how to handle in-progress events that are not fully processed due to unexpected connector shutdown. Choose one of four actions to take if events are found in the in-progress queue during initialization:

Default = Reprocess

InputQueue

Message queue that is polled by the connector for new messages.

Default = CWLDINPUTQ

InProgressQueue

In-progress event queue.

Default = MQWFCONN.IN_PROGRESS

JavaCorbaApi

Enabling the Java CORBA APIs is required for use with WebSphere MQ Workflow 3.2.2. If false, the connector supports the XML APIs for use with WebSphere MQ Workflow 3.3.2 and higher. If you are using WebSphere MQ Workflow 3.4 or later, then this property must be false.

Default = false

MQSeriesCCSID

The CCSID used to connect to the queue manager for WebSphere MQ Workflow. This value should match the CCSID property of the queue manager for WebSphere MQ Workflow.

Default = blank (if left blank, it is regarded as 819)

You may need to change the CCSID to support selected characters. When you do, you must change the CCSID connector specific property as well as the CCSID of the WebSphere MQ Workflow queue.

Changing the MQSeries CCSID connector property
  1. Double-click MQWF connector in System Manager. The Connector Designer -- MQWorkflowConnector opens.
  2. Click the Application Config Properties tab.
  3. Enter a new value (such as "943") in the MQSeriesCCSID property.
  4. Restart the connector.
  5. Restart ICS (recommended).
CCSIDChanging the MQSeries CCSID queue property
  1. Run RUMMQSC FMCQM at a command prompt.
  2. Enter ALTER QMGR CCSID (new_value) and press Enter.
  3. Enter END and press Enter.

OutputQueue

Queue to issue requests to MQSeries Workflow.

Default = FMC.FMCGRP.EXE.XML

PollQuantity

Number of messages to retrieve from the input queue.

Default =1

MQSeriesPort

Port established for the MQSeries (WebSphere MQ) listener.

Default = 14000

ReplyToQueue

Queue to which response messages are delivered when the connector issues requests.

Note:
When sending messages to the WebSphere MQ Workflow application, the connector populates the ReplyToQueue field in the header of the outbound message regardless of whether the connector expects a response. This helps identify issues when invalid business data is sent to the MQ Workflow application.

Default = MQWFCONN.REPLYTO

UnsubscribedQueue

Queue to which messages that are not subscribed are sent. The connector delivers a message to this queue property if:

Default = MQWFCONN.UNSUBSCRIBE

MQSeriesQueueManager

The queue manager for WebSphere MQ Workflow.

Default = FMC (if left blank, the default queue manager is used)

BOPrefix

The name of the data structure is appended to this prefix for subscription deliveries. The data structure determines the name of the top-level business object for the transaction.

Default = MQWF_

WorkflowSystemName

The name of the WebSphere MQ Workflow system to which a connection will be established when direct control of a workflow process is required by the connector.

Default = FMCSYS

WorkflowSystemGroup

The name of the WebSphere MQ Workflow system group to which a connection will be established when direct control of a workflow process is required by the connector.

Default = FMCGRP

WorkflowAgentLocatorPolicy

Specifies how the connector establishes a connection to the WebSphere MQ Workflow server identified by properties WorkflowSystemName and WorkflowSystemGroup. Possible values are as follows:

Default = LOC

Note:
In order to support client connections with IBM Java ORB, the start_MQWorkflow.bat (Windows) or start_MQWorkflow.sh (UNIX) files need to be modified. Open the appropriate start_MQWorkflow file and scroll down until you see a comment beginning with Step 3... all of the lines that follow and adjust paths as indicated in the directions provided. This ensures that the correct IBM Java ORB libraries are loaded and used by the WebSphere MQ Workflow client libraries during initialization. This modification does not affect your communication with InterChange Server.

WorkflowAgentName

The name of the WebSphere MQ Workflow CORBA agent.

Default = none

Copyright IBM Corporation 2003, 2005. All Rights Reserved.