Message Broker component variables

As with all environment variables, the broker-specific variables are stored in the services.ini file.

Each variable description provides the variable format for Microsoft Windows, Linux, or UNIX operating systems. The description also identifies the broker component that uses the variable.

Acknowledgment queue creation flag variable
The acknowledgment queue creation variable sets a Boolean flag if the queue is to be created.
Acknowledgment queue directory variable
The acknowledgment queue directory variable identifies the directory path for all Ack queues.
Acknowledgment queue name variable
The Acknowledgment queue name variable indicates the name of the Ack queue. These messages are used to send acknowledgments back to the client systems.
Acknowledgment code variable
This variable contains a comma delimited list of acknowledgment codes (ACK) that are accepted by the message sender.
Acknowledgment XPath variable
This variable contains the XPath to the location of the ACK code within an XML message. This variable is only used for the XML and HL7v3 message sender.
Aggregate mode variable
This variable enables aggregate mode. Aggregate mode is used to turn off message validation by the message reader and for the message reader to have a configurable response. This mode is suggested to be turned off unless there is no need for message validation and no need for a configurable response. This mode is initially set during inbound instance creation by responding to the Should the Inbound Reader Interface run in aggregate mode(n is recommended)? prompt.
Application name variable
The application name variable is used to override the default behavior of MemPuts for ADD, CHANGE, and MERGE event type categories. The MemPut behaviors are overridden at an event level.
Attribute update filter variable
A filter can be defined to manage attribute updates only on specific attributes. This attribute update filter variable is a comma-separated string. For example, if you would like to filter on LGLNAME and SSN the filter would be ‘LGLNAME,SSN'. If you would like to filter on all attributes the filter would be ‘all'.
Manage attribute update variable
The manage attribute update variable (also known as attribute update manager) is set when you respond y to the Attribute change messagesprompt during creation of an Inbound Broker instance. This variable indicates whether the Inbound Interface is going to manage attribute change messages. Most implementations elect not to manage attribute changes because of the potential performance impact. If you opt to manage attribute changes, a member get (MemGet) interaction is processed first to check for attribute changes.
Attribute update queue name variable
The attribute update queue name variable is used by the Inbound Message Manager. When an inbound message causes an attribute to change in the MDM database, an attribute update message is placed in the attribute update queue (similar to the process of other message queues). These messages can be received by downstream systems.
Configuration file name variable
The configuration file name variable identifies a valid file name where the broker configuration information is defined.
Connection string variable
The connection string variable defines the connection to the MDM operational server.
Default queue directory variable
This identifies a default queue directory for all queues. The value must point to a valid directory path that can be written to by the broker service.
Delimited message token variable
The delimited message token variable identifies the token used in messages. The default token is ‘|'.
Destination host variable
The destination host variable identifies the host where messages are sent.
Destination port variable
The destination port variable identifies the port where messages are sent.
Document handler variable
The document handler variable optimizes the parsing of XML messages. When the document handler is not set, the data section of the configuration file must exist with XPath definitions. By default the document handler is not set.
DTD directory path variable
The DTD directory path variable specifies a valid directory path where the DTD resides. If the DTD file directory is not defined, the current working directory is used. This variable does not need to be defined for an HL7 Inbound Message Manager, but must be defined for XML.
Duplicate attribute management variable
The duplicate attribute management variable is used to filter out matching attributes from the inbound row list. The default value is to process duplicate attributes (Y).
Dynamic dll variable
Setting the dynamic dll variable loads the dll that identifies which message type is being sent. For example, this variable must be set to msgsender_hl7.dll for HL7 messages.
Dynamic iterator variable
Dynamic iterators can be used in an inbound message configuration. Dynamic iterators stop their execution when there is no more data to be gathered from the inbound message for the elements within the iterator. This variable is initially set when you respond ’y’ to this prompt during inbound instance creation:Is the Inbound Interface using dynamic iterators (n is recommended)?
EIA Pend Criteria variable
The EIA pend criteria variable is a comma-delimited list of eiaTypeno;eaiStatno combinations that indicate the records that must be set to a pending status and not sent.
EIA Send Criteria variable
The EIA send criteria variable is a comma-delimited list of eiaTypeno;eaiStatno combinations that indicate the entXeia records that must be sent to the receiving source through outbound processing. Member adds require an eiaTypeno of 13. Use of the wildcard character * can be used to denote “all.”
EIA Trigger Filter variable
The Outbound Broker populates messages with all member data available at time of message creation. Multiple events can occur for a single member during a polling interval. This scenario can result in a message that contains information that might not have been available at the time of the trigger event. Use the EIA trigger filter variable to determine whether you want your downstream system to receive only the data that was available at the time of the trigger event.
EID Update Configuration File Name variable
The EID update configuration file name variable identifies the configuration file to be used for EID add and update processing.
EID linkage rule variable
The EID linkage rule variable determines which LINKEDMEMHEAD to select. By default the EID linkage rule is ENTITY:MEMRECNO.
Encoding type variable
The encoding type variable indicates the encoding type of the messages that are being processed or generated. Use this option if you are processing a file rather than a queue.
Encoding type (input) variable
The encoding type input variable indicates the encoding type of the messages being processed. Use this option if you are processing a file rather than a queue.
Entity type variable
The entity type variable indicates the entity type used in the task search.
Fixed message filler character variable
The fixed message filler character variable identifies the filler character for fixed-length messages. The default filler character is a space.
Fixed message length variable
The fixed message length variable specifies the length of all fixed messages.
Generator dll variable
The generator dll variable defines the custom Outbound Broker libraries to satisfy custom requirements that the broker framework does not support. The dynamic dll determines how different message types are processed. The specific generatorDll must point to an existing generator dll.
HasShadow task configuration file variable
The HasShadow task configuration file variable identifies the name of the configuration file that manages the processing of this task type.
HL7 standard escape variable
HL7 defines character sequences to represent special characters not otherwise permitted in messages. These sequences begin and end with the escape character of the message (usually \), and contain an identifying character, followed by 0 or more characters. The most common use of these escape sequences is to escape the HL7 defined delimiter characters. This variable determines how escapes are managed in the HL7 message.
HL7 message version variable
This variable identifies the inbound HL7 message version number. This variable is initially set during inbound instance creation.
Idle Socket Expiration variable
The idle socket expiration variable identifies the number of seconds in which an idle Inbound Message Reader socket connection will expire. An entry of 0 means that idle socket connections do not expire.
Input data file name variable
Use the input data file name variable to identify the name of the input file. Input data is read from this specified input file when the read from input queue variable is set to false.
Input data flag variable
The input data flag variable is a Boolean flag that determines if the input data is being read from the inbound queue. By default this flag is set to true.
Input queue name variable
The input queue name variable is the name used by the inbound queue (when set for Inbound Message Manager) or the outbound queue (when set for Outbound Message Sender). The setting is used as a prefix for the data files in the .toc file and the *-proc.pos file.
Input queue directory variable
The input queue directory variable identifies a queue directory for all input queues. This queue must point to a valid directory path that can be written to by the Broker service.
Input put queue name variable
The input put queue name variable is the queue type that the Routing Message Manager uses for tracking processed messages. The default value is “proc.” The Routing Message Manager uses the InputQueueName-InputPutName.toc and InputQueueName-InputPutName.pos to track the messages that it finished processing.
Input get name queue type variable
The input get name parameter is the queue type from which the Routing Message Manager reads. The default value is “read.” The Routing Message Manager uses the InputQueueName-InputGetName.toc and InputQueueName-InputGetName.pos files to determine the messages that must be processed.
Mapping dll variable
The mapping dll variable loads the dll that determines how different message types are processed. The specific mappingDll must point to an existing dll.
Member type variable
The member type variable indicates the member type used in the EID history search.
Message type variable
The message type variable identifies whether the broker component is processing HL7, XML, fixed-length, or delimited messages.
Minimal Lower Layer Protocol (MLLP)
Minimal Lower Layer Protocol (MLLP) defines the leading and trailing delimiters for an HL7 message.
ODBC connection string variable
The ODBC connection string is used when processing Enterprise ID adds
Optimize EID Add variable
The Optimize EID Add variable, if set to true, prevents the Outbound Message Broker from sending a member add if it has a pending EID update. This variable is used to minimize the number of messages that are being sent. Optimize EID Add is set to true by default.
Parser dll variable
The parserdll variable defines a custom parser library to satisfy customer needs that the general framework does not support. The parser dll is a dynamically loaded dll that is associated with the message type that is being processed.
Password Scheme variable
The password scheme variable is a string value used to determine whether the password is plain text or encrypted through the madpwd2 utility. This variable replaces the MIPasswordEncrypted variable and defaults to plain text.
Polling time variable
The polling time variable indicates how many seconds the Outbound Message Sender waits before trying to send more outbound messages. The default time is 3 minutes (180 seconds).
PreMerge task configuration file variable
The premerge task configuration file variable identifies the name of the configuration file used to manage premerge messages.
Public identifier variable
The public identifier variable indicates a public identifier such as a DTD.
Query dll variable
In previous releases, a query dll was dynamically loaded to determine the message type that is being processed. To specify the dll, the query dll variable had to be specified. This functionality (the calling of the message-associated library) is now handled by a common library loaded by default. However, if you have a custom library that you want to override the common library, you can use the query dll variable.
Reader dll variable
The Reader dll variable defines a library to support custom code that the general broker framework does not support. The argument loads the dynamic dll that identifies which message type is being read off the socket.
Reconnect attempts variable
The reconnect attempts variable indicates the number of times the Message Sender attempts to reconnect to the receiving host system.
Reject message threshold variable
The reject threshold causes the broker service (for example, msgbroker, msgsender, or other broker services) to shut down if this number of consecutive reject messages is met. The reject message threshold variable default setting is 20. Setting the threshold to 0 allows unlimited rejects.
Reject queue name variable
The reject queue name variable identifies the name used by the “reject” queue. The messages in this queue are messages that failed to process successfully.
Reject queue directory variable
The reject queue variable identifies a queue directory for all “reject” queues. The queue must point to a valid directory path that can be written to by this service.
Reprocess message time indicator variable
The reprocess messages time indicator variable checks the message event time against the last event time for the given member in the MDM database. If the message event time is more current than the last event time found in the database, the message is sent to the MDM operational server. Set this variable when reprocessing rejected messages.
Reprocess rejected messages flag variable
The reprocess rejected message flag variable indicates whether rejected messages are being reprocessed.
Reprocess rejected mapped messages flag variable
The reprocess rejected mapped messages flag variable is used by the Mapping Broker. If this variable is set to true, the Mapping Message Manager shuts down when all messages are processed.
Security library value variable
The security library variable indicates that the socket protocol is SSL.
Service listening port variable
The service listening port variable identifies the port on which the Inbound Message Reader or Query Broker is listening.
Shutdown on complete indicator variable
The shutdown on complete indicator variable, if set to on (Y), causes the Message Broker (MsgBroker) to shut down when all messages are processed.
Socket protocol value variable
The socket protocol value variable defines the protocol between the Message Reader or Message Sender and external clients.
Socket timeout variable
The socket timeout variable is used to close the socket after the specified amount of time passes with no processing.
SSL CA Cert File variable
The SSL CA cert file variable defines the root file of the SSL certificates. This SSL variable is used to define SSL settings between the broker component and a client.
SSL Cert File variable
This SSL cert file variable defines the name of the certificate file used to establish SSL. This SSL variable is used to define SSL settings between the broker component and a client.
SSL Crypto library variable
The SSL Crypto library variable defines the SSL encryption library. This SSL variable is used to define SSL settings between the broker component and a client.
SSL library variable
The SSL library variable defines the socket protocol library. This setting is the physical library name. This SSL variable is used to define SSL settings between the broker component and a client.
SSL Private Key File variable
The SSL Private Key File variable defines the private key file used by the broker. This SSL variable is used to define SSL settings between the broker component and a client.
SSL timeout variable
The SSL timeout variable defines the socket timeout. A timeout of 0 is indefinite. This SSL variable is used to define SSL settings between the broker component and a client.
SSL Version Depth variable
The SSL version depth variable defines the version depth. This SSL variable is used to define SSL settings between the broker component and a client.
SSL Version variable
The SSL version variable defines the SSL version type. This SSL variable is used to define SSL settings between the broker component and a client.
Success queue creation flag variable
The success queue creation variable is a boolean that determines whether the “good” or “OK” queue is created. By default this flag is set to true (Y).
Success queue directory variable
The success queue directory variable identifies a queue directory for all “good” or “OK” queues. The queue must point to a valid directory path that can be written to by this service.
Success queue name variable
The success queue name variable identifies the name used by the “good” or “OK” queue. The messages in this queue are messages that processed successfully.
Sync and Async communication protocol variable
The sync and async communication protocol variable defines the communication protocol as synchronous or asynchronous. The protocol is synchronous by default. A synchronous communication protocol sends an acknowledgment back to the client.
System identifier variable
The system identifier variable indicates a system identifier such as a DTD.
Total connections variable
The total connections variable indicates the number of connections that the Inbound Message Reader accepts on the listening port. In implementations with multiple sources, this variable can be set at the number of sources. The default is 1. Setting the total connections to 0 allows unlimited connections.
User login ID variable
The user login ID variable identifies a valid user in LDAP Directory Server.
User password variable
The user password variable identifies the password associated with the user login ID. The password can be clear text or encrypted.
Web Service Action variable
The web service action variable identifies the action or value that represents the SOAP action during the request.
Web service action prefix variable
The web service action prefix variable is used when running the broker as a web service. If you do not specify a web service action, you must specify a web service action prefix. When a web service action is not specified, the SOAP action used is the concatenation of the web service action prefix and the name of the first node in the web service payload (that is, the web service message).
Web service enabled variable
The web service enabled variable indicates whether the Outbound Broker is operating as a web service. This setting is a y (yes) or n (no) value.
Web service to URL variable
The web service to URL variable identifies the web service that is being called by the Outbound Message Sender. This URL is a fully qualified web address to the web service called by the Outbound Broker.
Web service from URL variable
If you are using SOAP 1.2, the web service from URL variable contains the value of the ReplyTo node.
Web service SOAP version variable
Valid options for the web service SOAP version variable are SOAP 1.1 or 1.2.
XML document type variable
The XML document type variable indicates the message type that is being generated.

Last updated: 23 October 2014