Configuring a client using a configuration file

Configure your clients by using attributes in a text file. These attributes can be overridden by environment variables or in other platform-specific ways.

You can configure your IBM® MQ MQI clients by using a text file, the IBM MQ MQI client configuration file. This file is similar to the queue manager configuration file, qm.ini, that is used on UNIX and Linux® systems. The file contains a number of stanzas, each of which contains a number of lines of the format attribute-name = value.

The IBM MQ MQI client configuration file is generally named mqclient.ini, but you can choose to give it another name. The configuration information in this file applies to the following platforms:
  • [UNIX, Linux, Windows]UNIX, Linux, and Windows
  • [IBMi]IBM i
    Note: On IBM i, there is no default mqclient.ini file. However, you can create the file in the IBM i Integrated File System (IFS).
For more information, see Location of the client configuration file.
[z/OS]Note: The z/OS® platform cannot be used to run IBM MQ clients. Therefore, the mqclient.ini file does not exist on IBM MQ for z/OS.
The attributes in the IBM MQ MQI client configuration file apply to clients that use:
  • The MQI
  • IBM MQ classes for Java
  • IBM MQ classes for JMS
  • IBM MQ classes for .NET
  • XMS
Although the attributes in the IBM MQ MQI client configuration file apply to most IBM MQ clients, there are some attributes that are not read by managed .NET and XMS .NET clients, or by clients using either the IBM MQ classes for Java or the IBM MQ classes for JMS. For more information, see Which IBM MQ clients can read each attribute.

The configuration features apply to all connections a client application makes to any queue managers, rather than being specific to an individual connection to a queue manager. Attributes relating to a connection to an individual queue manager can be configured programmatically, for example by using an MQCD structure, or by using a Client Channel Definition Table (CCDT).

Environment variables that were supported in releases of IBM WebSphere® MQ earlier than Version 7.0 continue to be supported, and where such an environment variable matches an equivalent value in the client configuration file, the environment variable overrides the client configuration file value.

For a client application that uses IBM MQ classes for JMS, you can also override the client configuration file in the following ways:
  • By setting properties in the JMS configuration file
  • By setting Java system properties, which also overrides the JMS configuration file.

For the .NET client, you can also override the client configuration file and the equivalent environment variables by using the .NET application configuration file.

You cannot set up multiple channel connections by using the client configuration file.

Example client configuration file


#* Module Name: mqclient.ini                                       *#
#* Type       : IBM MQ MQI client configuration file               *#
#  Function   : Define the configuration of a client               *#
#*                                                                 *#
#*******************************************************************#
#* Notes      :                                                    *#
#* 1) This file defines the configuration of a client              *#
#*                                                                 *#
#*******************************************************************#

ClientExitPath:
   ExitsDefaultPath=/var/mqm/exits
   ExitsDefaultPath64=/var/mqm/exits64

TCP:
   Library1=DLLName1
   KeepAlive = Yes
   ClntSndBuffSize=32768
   ClntRcvBuffSize=32768
   Connect_Timeout=0 

MessageBuffer:
   MaximumSize=-1
   Updatepercentage=-1
   PurgeTime=0

LU62:
   TPName
   Library1=DLLName1
   Library2=DLLName2

PreConnect:
	Module=amqldapi
	Function=myFunc
	Data=ldap://myLDAPServer.com:389/cn=wmq,ou=ibm,ou=com
	Sequence=1

CHANNELS:
DefRecon=YES
ServerConnectionParms=SALES.SVRCONN/TCP/hostname.x.com(1414)