The MFT coordination.properties file

The coordination.properties file specifies the connection details to the coordination queue manager. Because several Managed File Transfer installations might share the same coordination queue manager, you can use a symbolic link to a common coordination.properties file on a shared drive.

The coordination.properties file is created by the installer or by the fteSetupCoordination command. You can use the fteSetupCoordination command with the -f flag to change the basic coordination queue manager properties in this file. To change or add advanced coordination queue manager properties you must edit the file in a text editor.

The coordination.properties file is located in the MQ_DATA_PATH/mqft/config/coordination_qmgr_name directory.

The MFT coordination.properties file contains the following values:
Table 1. Basic coordination queue manager properties
Property name Description Default value
[MQ 9.2.0 Jul 2020]coordinationCredentialsKeyFile Name of the file containing the credential key used while encrypting credentials. A string property having no default value.
coordinationQMgr The name of the coordination queue manager. No default
coordinationQMgrHost The host name or IP address of the coordination queue manager. No default
coordinationQMgrPort The port number used for client connections to the coordination queue manager. 1414
coordinationQMgrChannel The SVRCONN channel name used to connect to the coordination queue manager. SYSTEM.DEF.SVRCONN

If you do not specify a value for the coordinationQMgrHost property, bindings mode is used by default.

If you specify a value for the coordinationQMgrHost property but do not specify values for the coordinationQMgrPort and coordinationQMgrChannel properties, a port number of 1414 and a channel of SYSTEM.DEF.SVRCONN are used by default.

Here is an example of the contents of a coordination.properties file:
coordinationQMgr=ERIS
coordinationQMgrHost=kuiper.example.com
coordinationQMgrPort=2005
coordinationQMgrChannel=SYSTEM.DEF.SVRCONN
In this example, ERIS is the name of an IBM® MQ queue manager that is located on the system kuiper.example.com. The queue manager ERIS is the queue manager that Managed File Transfer sends log information to.

Advanced coordination properties

Managed File Transfer also provides more advanced coordination properties. If you want to use any of the following properties, manually edit the coordination.properties file to add the required advanced properties. When you specify file paths on Windows, ensure the separator character backslash (\) is entered as double backslashes (\\), that is, escaped backslash (\). Alternatively, you can use a single forward slash (/) character as a separator. For more information about character escaping in Java properties files, see the Oracle documentation Javadoc for the Properties class.

Table 2. Advanced coordination properties: Agent
Property name Description Default value
agentStatusJitterTolerance

The maximum amount of time an agent status message publication can be delayed by before the message is considered as overdue. This value is measured in milliseconds.

The age of a status message is based on the time at which it was published at the coordination queue manager. However, the message is emitted by the agent some time before it is received at the coordination queue manager to allow for the time required to travel across the IBM MQ network. If this transit always takes the same amount of time, messages created 60 seconds apart are published 60 seconds apart, regardless of the actual time in transit. However, if the transit time varies between messages, they might be created at 60-second intervals but published at intervals of, for example, 61, 59, 58, and 62 seconds. The maximum deviation from 60, 2 seconds in this example, is the jitter. This property determines the maximum delay due to jitter before the message is treated as overdue.

 3000
Table 3. Advanced coordination properties: Code page
Property name Description Default value
coordinationCcsid The code page the commands connect to the coordination queue manager with. Also any publications to the coordination queue manager made by the agent are performed with this code page. If you specify a value for coordinationCcsid you must also specify a value for coordinationCcsidName. 1208
coordinationCcsidName The Java representation of the coordinationCcsid. If you specify a value for coordinationCcsidName you must also specify a value for coordinationCcsid. UTF8
Table 4. Advanced coordination properties: Connection
Property name Description Default value
javaLibraryPath When connecting to a queue manager in bindings mode Managed File Transfer must have access to the IBM MQ Java bindings libraries. By default Managed File Transfer looks for the bindings libraries in the default location defined by IBM MQ. If the bindings libraries are in a different location use this property to specify the location of the bindings libraries. MQ_INSTALLATION_PATH/java/lib
Table 5. Advanced coordination properties: Multi-instance queue manager
Property name Description Default value
coordinationQMgrStandby The host name and the port number used for client connections, in IBM MQ CONNAME format, for the standby instance of a multi-instance coordination queue manager defined by the coordinationQMgr property. For example, host_name(port_number) No default
Table 6. Advanced coordination properties: Queue
Property name Description Default value
dynamicQueuePrefix This property defines the IBM MQ prefix to use for generating a temporary queue name.

The format of the dynamicQueuePrefix property follows the format of the DynamicQName field of the IBM MQ MQOD structure. For more information, see Creating dynamic queues.

You can also define this property in the command.properties file if you want to use a specific IBM MQ prefix for temporary reply queues that are generated by commands that require a response from the agent.

 WMQFTE.*
modelQueueName This property defines the IBM MQ model queue to use for generating a temporary queue.

You can also define this property in the command.properties file if you want to use a specific IBM MQ model queue for temporary reply queues that are generated by commands that require a response from the agent. For more information, see The MFT command.properties file.

 SYSTEM.DEFAULT.MODEL.QUEUE
Table 7. Advanced coordination properties: Security
Property name Description Default value
userIdForClientConnect The user ID that gets flowed through the client connections to IBM MQ. If java is specified the user name reported by the JVM is flowed as part of the IBM MQ connection request. The value of this property can be None or java. None
coordinationQMgrAuthenticationCredentialsFile The path to the file that contains the MQ connection credentials for connection to the coordination queue manager.

[z/OS]For details on creating the Authentication Credentials File see Configuring MQMFTCredentials.xml on z/OS®.

[AIX, Linux, Windows]See Configuring MQMFTCredentials.xml for information on the location and permissions of this file.

[AIX, Linux, Windows]Further details on creating the Authentication Credentials File are in MFT and IBM MQ connection authentication

Table 8. Advanced coordination properties: SSL/TLS
Property name Description Default value
coordinationSslCipherSpec Specifies the protocol, hash algorithm, and encryption algorithm that is used, and how many bits are used in the encryption key, when data is exchanged between the commands and the coordination queue manager.

The value of coordinationSslCipherSpec is a CipherSpec name. This CipherSpec name is the same as the CipherSpec name used on the coordination queue manager channel. A list of valid CipherSpec names is included in SSL/TLS CipherSpecs and CipherSuites in IBM MQ classes for Java and SSL/TLS CipherSpecs and CipherSuites in IBM MQ classes for JMS.

coordinationSslCipherSpec is similar to coordinationSslCipherSuite. If both coordinationSslCipherSuite and coordinationSslCipherSpec are specified, the value of coordinationSslCipherSpec is used.

 None
coordinationSslCipherSuite Specifies SSL aspects of how the commands and the coordination queue manager exchange data.

The value of coordinationSslCipherSuite is a CipherSuite name. The CipherSuite name maps to the CipherSpec name used on the agent queue manager channel. For more information, see CipherSuite and CipherSpec name mappings.

coordinationSslCipherSuite is similar to coordinationSslCipherSpec. If both coordinationSslCipherSuite and coordinationSslCipherSpec are specified, the value of coordinationSslCipherSpec is used.

 None
coordinationSslPeerName Specifies a distinguished name skeleton that must match the name that is provided by the coordination queue manager. The distinguished name is used to check the identifying certificate that is presented by the coordination queue manager on connection. None
coordinationSslTrustStore Specifies the location of the certificates that the commands trust. The value of coordinationSslTrustStore is a file path. If it is a Windows file path, the backslash character (\) must be escaped (\\).

From IBM WebSphere® MQ 7.5 or later, the value of this property can contain environment variables.

 None
coordinationSslTrustStoreType The type of SSL keystore you want to use. JKS and PKCS#12 keystores are supported. The value of this property can be either jks or pkcs12. jks
coordinationSslTrustStoreCredentialsFile The path to the file that contains the coordinationSslTrustStore credentials.

From IBM WebSphere MQ 7.5, the value of this property can contain environment variables.

 The default value for this property is %USERPROFILE%\MQMFTCredentials.xml on Windows and $HOME/MQMFTCredentials.xml on other platforms.
coordinationSslKeyStore Specifies the location of the private key of the commands. The value of coordinationSslKeyStore is a file path. If it is a Windows file path, the backslash character (\) must be escaped (\\). This property is only required if the coordination queue manager requires client authentication.

From IBM WebSphere MQ 7.5, the value of this property can contain environment variables.

 None
coordinationSslKeyStoreType The type of SSL keystore you want to use. JKS and PKCS#12 keystores are supported. The value of this property can be either jks or pkcs12. jks
coordinationSslKeyStoreCredentialsFile The path to the file that contains the coordinationSslKeyStore credentials.

From IBM WebSphere MQ 7.5, the value of this property can contain environment variables.

 The default value for this property is %USERPROFILE%\MQMFTCredentials.xml on Windows and $HOME/MQMFTCredentials.xml on other platforms.
coordinationSslFipsRequired Specifies that you want to enable FIPS support at the level of the coordination queue manager. The value of this property can be true or false. For more information, see FIPS support in MFT. false
Table 9. Advanced coordination properties: Subscription
Property name Description Default value
coordinationSubscriptionTopic Use this property to specify a topic other than SYSTEM.FTE to subscribe to in order to obtain publications about the status of the IBM MQ network. All tooling still publishes to the SYSTEM.FTE topic, but you can change your IBM MQ topology to distribute these publications to different topics based on their content. You can then use this function to force the tooling to subscribe to one of these other topics.

For IBM WebSphere MQ 7.5 and later fix packs, you require an interim fix for APAR IC96850 for the property to be recognized by IBM MQ Explorer and the fteListMonitors command.

 SYSTEM.FTE