Connector configuration

Connectors have two types of configuration properties: standard configuration properties and connector-specific configuration properties. You must set the values of these properties before running the connector. Use one of the following tools to set a connector's configuration properties:

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.

Important:
Because this connector supports both the ICS and WebSphere MQ Integrator Broker, configuration properties for both brokers relevant to the connector.

Connector-specific properties

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

Note:
Always check the values WebSphere MQ provides because they may be incorrect or unknown. If the provided values are incorrect, specify them explicitly.

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

Table 10. Connector-specific configuration properties
Name Possible values Default value Required
ApplicationPassword Login password
No
ApplicationUserID Login user ID
No
ArchiveQueue Queue to which copies of successfully processed messages are sent queue://CrossWorlds. QueueManager/MQCONN. No
BOPref Business object preference HL7 Yes
Channel MQ server connector channel
Yes
ClassName Data handler class name com.ibm.adapters.datahandlers.hl7.HL7DataHandler No
ConfigurationMetaObject Name of configuration meta-object
Yes
Component delimiter User defined ^
DataHandlerConfigMO Data handler meta-object MO_DataHandler_Default Yes
DataHandlerMimeType MIME type of file HL7 No
DefaultVerb Any verb supported by the connector. Create
Dummy string User defined

ErrorQueue Queue for unprocessed messages queue://crossworlds. Queue.manager/
MQCONN.ERROR
No
Field delimiter Default field delimiter for all types. The default value is "|"
HostName WebSphere MQ server The default is "|". No
InDoubtEvents FailOnStartup Reprocess Ignore LogError Reprocess No
InputQueue Poll queues queue://CrossWorlds. QueueManager/MQCONN.IN Yes
InProgressQueue In-progress event queue queue://CrossWorlds. QueueManager/ MQCONN.IN_PROGRESS No
PollQuantity Number of messages to retrieve from each queue specified in the InputQueue property 1 No
Port Port established for the WebSphere MQ listener
No
ReplyToQueue Queue to which response messages are delivered when the connector issues requests queue://CrossWorlds. QueueManager/MQCONN.REPLYTO No
Representation Header or message object parsing. Can be one of the following:"Simplified" or "Native"
Simplified signifies the use of a parsing method which provides fine object represent only to message headers.
Native signifies the use of parsing method, which provides fine object represent to the whole message.

Repetition delimiter User defined The default value is "~"
Subcomponent delimiter User defined The default value is "&"
UnsubscribedQueue Queue to which unsubscribed messages are sent queue://CrossWorlds. QueueManager/MQCONN.UNSUBSCRIBE No
UseDefaults true or false false

ApplicationPassword

Password used with the ApplicationUserID to log in to WebSphere MQ.

Default = None.

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

ApplicationUserID

User ID used with the ApplicationPassword to log in to WebSphere MQ.

Default=None.

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

ArchiveQueue

Queue to which copies of successfully processed messages are sent.

Default = queue://crossworlds.Queue.manager/MQCONN.ARCHIVE

BOPref

Business object preferences prefix. The default is HL7.

Channel

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

Default=None.

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

ClassName

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

Default = com.ibm.adapters.DataHandlers.hl7.HL7DataHandler

Component delimiter

The default component delimiter for all flights. The default is "^".

ConfigurationMetaObject

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

Default = none.

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 = HL7

DefaultVerb

Specifies the verb to be set within an incoming business object, if it has not been set by the data handler during polling.

Default= Create

Dummy string

The dummy string.

ErrorQueue

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

Default = queue://crossworlds.Queue.manager/MQCONN.ERROR

FeedbackCodeMappingMO

Allows you to override and reassign the default feedback codes used to synchronously acknowledge receipt of messages to the integration broker. 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 the integration broker. For a listing of the default feedback codes, see Synchronous acknowledgment. The connector accepts the following attribute values representing WebSphere MQ-specific feedback codes:

The connector accepts the following WebSphere business integration system-specific status codes as attribute values in the meta-object:

Table 11 shows a sample meta-object.

Table 11. Sample 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.

Field delimiter

The default delimiter for all types. The default is "|" the pipe symbol.

HostName

The name of the server hosting WebSphere MQ.

Default=None.

If the HostName is left blank or removed, the connector allows WebSphere MQ to determine the host.

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

Specifies the message queues that the connector polls for new messages. See the MQSA documentation to configure the WebSphere MQ queues.

The connector accepts multiple semicolon-delimited queue names. For example, to poll the queues MyQueueA, MyQueueB, and MyQueueC, the value for connector configuration property InputQueue is: MyQueueA;MyQueueB;MyQueueC.

The connector polls the queues in a round-robin manner and retrieves up to pollQuantity number of messages from each queue. For example, pollQuantity equals 2, and MyQueueA contains 2 messages, MyQueueB contains 1 message and MyQueueC contains 5 messages.

With pollQuanity set to 2, the connector retrieves at most 2 messages from each queue per call to pollForEvents. For the first cycle (1 of 2), the connector retrieves the first message from each of MyQueueA, MyQueueB, and MyQueueC. That completes the first round of polling. The connector starts a second round of polling (2 of 2) and retrieves one message each from MyQueueA and MyQueueC--it skips MqQueueB because that queue is now empty. After polling all queues twice, the call to the method pollForEvents is complete. The sequence of message retrieval is:

  1. 1 message from MyQueueA
  2. 1 message from MyQueueB
  3. 1 message from MyQueueC
  4. 1 message from MyQueueA
  5. Skip MyQueueB because it is empty
  6. 1 message from MyQueueC

Default = queue://crossworlds.Queue.manager/MQCONN.IN

InProgressQueue

Message queue where messages are held during processing. You can configure the connector to operate without this queue by using System Manager to remove the default InProgressQueue name from the connector-specific properties. Doing so prompts a warning at startup that event delivery may be compromised if the connector is shut down while are events pending.

Default= queue://crossworlds.Queue.manager/MQCONN.IN_PROGRESS

I118N

Specifies the path name of the BIA_HL7I18N.cfg file ..\Healthcare\dependencies\hl7\BIA_HL7I18N.cfg

MTEventMap

This configuration contains a map of (Message X event type) -> Message structure. The file is located at ...\Healthcare\dependencies\hl7\HL7MTEventMap.cfg.

PollQuantity

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

Default =1

Port

Port established for the WebSphere MQ listener.

Default=None.

If the value of Port is left blank or the property is removed, the connector allows WebSphere MQ to determine the correct port.

Repetition delimiter

Default repetition delimiter for all types. The default is "~".

ReplyToQueue

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

Default = queue://crossworlds.Queue.manager/MQCONN.REPLYTO

Representation

Representation determines how the message is parsed, either "Simplified" or "Native." Simplified parses so that it represents only the message header. Native parses so that the entire message is represented. The default is "Simplified."

Subcomponent delimiter

Default subcomponent delimiter. The default is :&."

UnsubscribedQueue

Queue to which messages about business objects that are not subscribed to are sent.

Default =Default sub component delimiter for all types queue://crossworlds.Queue.manager/MQCONN.UNSUBSCRIBED

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, 2003