Configuring the adapter

Connectors have two types of configuration properties; standard configuration properties and connector-specific configuration properties. Some of these properties have default values that you do not need to change. For others, you must set the values of these properties before you can run the adapter. To configure connector properties with InterChange Server as your integration broker, use Connector Configurator. For more information, refer to Appendix B, "Connector specific properties".

A connector obtains its configuration values at startup. During a runtime session, you may want to change the values of one or more connector properties. Changes to some connector configuration properties, such as AgentTraceLevel , take effect immediately. Changes to other connector properties require component restart or system restart after a change. To determine whether a property is dynamic (taking effect immediately) or static (requiring either connector component restart or system restart), refer to Appendix B, "Connector specific properties".

When you configure connector properties for the Adapter for FRONT ARENA, make sure that the following criteria are met:

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.

Because this adapter supports only InterChange Server as the integration broker, the only configuration properties relevant to it are for InterChange Server.

Connector-specific properties

Connector-specific configuration properties provide information needed by the connector at runtime. They also provide a way of changing static information or logic within the adapter without having to re-code and rebuild the agent.

The following table lists the connector-specific configuration properties for the adapter. See the sections that follow for explanations of the properties.

Note:
These properties include default queue name values. You will need to change these values to match the queue names you are actually using in your set up.


Table 38.

Connector-specific configuration properties
Name Possible values Default value Required

ApplicationPassword

Login password


No

ApplicationUserName

Login user ID


No

ArchiveQueue

Queue to which copies of successfully processed messages are sent

queue://<queue_manager_name>/
WC_MQCONN.ARCHIVE

No

Channel

MQ server connector channel


Yes

ConfigurationMetaObject

Name of configuration meta-object


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 unprocessed messages

queue://<queue_manager_name>/ WC_MQCONN.ERROR

No

FeedbackCodeMappingMO

Feedback code meta-object


No

HostName

WebSphere MQ server


Yes

InDoubtEvents

FailOnStartup Reprocess Ignore LogError

Reprocess

No

InputQueue

Poll queues

queue://<queue_manager_name>/ WC_MQCONN.IN

No

InProgressQueue

In-progress event queue

queue://<queue_manager_name>/ WC_MQCONN.IN_PROGRESS

Yes

PollQuantity

Number of messages to retrieve from each queue specified in the InputQueue property

1

No

Port

Port established for the WebSphere MQ listener


Yes

ReplyToQueue

Queue to which response messages are delivered when the adapter issues requests

queue://<queue_manager_name>/ WC_MQCONN.REPLYTO

No

UnsubscribedQueue

Queue to which unsubscribed messages are sent

queue://<queue_manager_name>/ WC_MQCONN.UNSUBSCRIBE

No

UseDefaults true or false false

ApplicationPassword

The password used with UserID to log in to WebSphere MQ.

Default = None.

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

ApplicationUserName

The user ID used with a Password to log in to WebSphere MQ.

Default=None.

If the ApplicationUserName is left blank or removed, the adapter uses the default user ID provided by WebSphere MQ.

ArchiveQueue

The queue to which copies of successfully processed messages are sent.

Default = queue://<queue_manager_name>/WC_MQCONN.ARCHIVE

Channel

The MQ server adapter channel through which the adapter communicates with WebSphere MQ.

Default=none.

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

ConfigurationMetaObject

The name of the static meta-object containing configuration information for the connector.

Default = none.

DataHandlerClassName

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

Default = com.crossworlds.DataHandlers.text.xml

DataHandlerConfigMO

The meta-object passed to the data handler to provide configuration information.

Default = MO_DataHandler_Default

DataHandlerMimeType

This allows you to request a data handler based on a particular MIME type. The XML data handler is required for use with FRONT ARENA.

Default = text/xml

ErrorQueue

The queue to which messages that could not be processed are sent.

Default = queue://<queue_manager_name>/WC_MQCONN.ERROR

FeedbackCodeMappingMO

This property allows you to override and reassign the default feedback codes used to synchronously acknowledge receipt of messages to InterChange Server. This property enables you to specify a meta-object in which each attribute name is understood to represent a feedback code. The corresponding value of the feedback code is the return status that is passed to InterChange Server. For a listing of the default feedback codes, see "Synchronous message delivery". The adapter accepts the following attribute values representing WebSphere MQ-specific feedback codes:

The adapter accepts the following InterChange Server-specific status codes as attribute values in the meta-object:

The following table shows an example meta-object.

Table 39. Example feedback code meta-object attributes

Attribute name Default value
MQFB_APPL_FIRST

SUCCESS

MQFB_APPL_FIRST + 1

FAIL

MQFB_APPL_FIRST + 2

UNABLE_TO_LOGIN

Default = none.

HostName

The name of the server hosting WebSphere MQ.

Default=none.

InDoubtEvents

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

Default = Reprocess.

InputQueue

The message queues that will be polled by the adapter for new messages. This parameter should be set to the same value as the EventHandler/WMQQueue parameter in the Bridge for FRONT ARENA configuration file.

If the InputQueue property is not supplied, the connector starts up properly but prints a warning message, and performs request processing only. It will not perform any event processing.

Default= queue://<queue_manager_name>/WC_MQCONN.IN

InProgressQueue

Message queue where messages are held during processing.

Default= queue://<queue_manager_name>/WC_MQCONN.IN_PROGRESS

PollQuantity

The number of messages to retrieve from each queue specified in the InputQueue property during a pollForEvents scan.

Default =1

Port

The port established for the WebSphere MQ listener.

Default=None.

ReplyToQueue

The queue to which response messages are delivered when the adapter issues requests. This parameter should be set to the same value as the RequestHandler/WMQReplyQueue parameter in the Bridge for FRONT ARENA configuration file.

Default = queue://<queue_manager_name>/WC_MQCONN.REPLY

UnsubscribedQueue

The queue to which messages that are not subscribed are sent.

Default = queue://<queue_manager_name>/WC_MQCONN.UNSUBSCRIBED

Note:
*Always check the values WebSphere MQ provides since they may be incorrect or unknown. If so, please implicitly specify values.

UseDefaults

On a Create operation, if UseDefaults is set to true, the connector checks whether a valid value or a default value is provided for each isRequired business object attribute. If a value is provided, the Create operation succeeds. If the parameter is set to false, the connector checks only for a valid value and causes the Create operation to fail if it is not provided. The default is false.

Copyright IBM Corp. 1997, 2004