Location of the client configuration file

An IBM MQ MQI client configuration file can be held in a number of locations.

A client application uses the following search path to locate the IBM MQ MQI client configuration file:
  1. The location specified by the environment variable MQCLNTCF.

    The format of this environment variable is a full URL. This means the file name might not necessarily be mqclient.ini and facilitates placing the file on a network attached file-system.

    Note the following:

    • C, .NET and XMS clients support only the file: protocol; the file: protocol is assumed if the URL string does not begin with protocol:
    • To allow for Java 1.4.2 JREs, which do not support reading environment variables, the MQCLNTCF environment variable can be overridden with an MQCLNTCF Java System Property.

  2. A file called mqclient.ini in the present working directory of the application.
  3. A file called mqclient.ini in the IBM MQ data directory for Windows, UNIX and Linux systems. Note the following:

    • The IBM MQ data directory does not exist on certain platforms, for example, IBM i and z/OS, or in cases where the client has been supplied with another product.
    • On UNIX and Linux systems, the directory is /var/mqm
    • On Windows platforms you configure the environment variable MQ_FILE_PATH during installation, to point at the data directory. It is normally C:\ProgramData\IBM\MQ
    • To allow for Java 1.4.2 JREs that do not support reading environment variables we can manually override the MQ_FILE_PATH environment variable with an MQ_FILE_PATH Java System Property.

  4. A file called mqclient.ini in a standard directory appropriate to the platform, and accessible to users:

    • For all Java clients this is the value of the user.home Java System Property.
    • For C clients on UNIX and Linux platforms this is the value of the HOME environment variable.
    • For C clients on Windows this is the concatenated values of the HOMEDRIVE and HOMEPATH environment variables.

Note: For the IBM MQ client for HP Integrity NonStop Server, the mqclient.ini file must be located in the OSS file system. Guardian applications must either place the mqclient.ini file in the IBM MQ data directory or set the MQCLNTCF environment variable to a location in the OSS file system. Parent topic: Configure a client using a configuration file