IBM MQ for notification configuration properties
Notification messages can be sent by using notification with IBM® MQ. If the IBM MQ queue manager is configured for SSL connections, use the notifMqCipherSuite property to specify the SSL encryption algorithm that is being used. Use the notifMqKeyStore, notifMqKeyStorePassword, and notifMqTrustStore properties to provide the location of the keystore and truststore files. The configuration of IBM MQ connectivity for notification is controlled by the options that are described in Notification IBM MQ configuration properties. If the notify options are not set, the options in Table 1 are used.
The Gateway Server can also send private notification messages to Distribution. Distribution uses these messages to maintain the status for outbound work.
When the Transaction Server is used with Gateway, ensure that the mqTxsInputQueue and mqTxsEventQueue configuration properties are specified.
Setting up IBM MQ to use publish and subscribe messaging for notification message Version 2.0.0
For notification message Version 2.0.0, Gateway uses the publish and subscribe messaging model. To set up IBM MQ for publish and subscribe messaging, ensure that the queue manager is enabled for JMS and the broker is started.
runmqsc qmgrnamerunmqsc command needs to be run from the IBM MQ
java\bin folder. Substitute the name of the queue manager for
qmgrname. The command needs to be run one time for each queue manager. The strmqbrk command must be run each time the IBM MQ service is started
(when the physical server is rebooted). If this command is not run and Gateway tries to
establish a IBM MQ connection for publish and subscribe, Gateway returns a
failure.
Messages are published with a retention period as specified in the jmsPublishTime configuration property. The default is 24 hours (86400000 milliseconds). A message can be received by a server that is down if the server is brought back up within the jmsPublishTime interval.
The topic of the Version 2.0.0 notification messages is "IBMPayDir/Event".
Notification IBM MQ configuration properties
| Keywords | Values or example | Description |
|---|---|---|
| notifMqCCDT | MQCCDT.TAB | The file name for the IBM MQ client channel definition table (CCDT) file to
use. If a file name is specified in this property, the hostname, port, channel, and client properties in this
configuration are not used. For secure connections, the cipher suite property is ignored when a file name is specified in this property. The properties that relate to the keystore and truststore must still be provided. For more information about specifying the name of the CCDT file, see Configuring the client channel definition table (CCDT) file to connect to IBM MQ. |
| notifMqQmgrHostname | HOST1 | The hostname or address of the server where the IBM MQ queue manager for notification is located. |
| notifMqQmgrChannel | S_HOST1 | The IBM MQ channel name for notification. |
| notifMqQmgrName | FTM.QMANAGER2 | The name of the IBM MQ queue manager for notification. |
| notifMqQmgrPort | 1414 | The IBM MQ port number for notification. |
| notifMqUserId | userid | The user ID used to access the IBM MQ queue manager and queue for notification. The user ID is only required if the definition of the queue requires a user ID and password to access it. |
| notifMqPassword | Password | The password used to access the IBM MQ queue manager and queue for notification. The password is only required if the definition of the queue requires a user ID and password to access it. |
| notifMqSendQueue | BANK_TO_DEST | The name of the IBM MQ notification queue to which the transmittal messages are sent. This property is used only when Version 1.0.0 notification messages are sent. |
| notifMqCipherSuite | SSL_RSA_WITH_3DES_EDE_CBC_SHA | The name of the JSSE cipher suite associated with the cipher specifications that are specified for notification in the IBM MQ queue manager that is being used. For more information, see Table 2. |
| notifMqKeyStore | c:/keys/mqkey.jks | The fully qualified name of the file that contains the keystore. |
| notifMqKeyStorePassword | password | The password that is used to access the keystore. |
| notifMqTrustStore | c:/keys/mqkey.jks | The fully qualified name of the file that contains the truststore. |
| notifMqTrustStorePassword | password | The password that is used to access the truststore. |
| notifMqTrustStoreFormat | PKCS12 | Format of truststore file. The allowed values are JKS or PKCS12. The default value is PKCS12. |
| notifMqClient | true or false | Indicates whether the IBM MQ client is installed on this instance of Gateway Server and it is to connect to a remote IBM MQ server for notification. |
| jmsPublishTime | 86400000 | Allows a subscriber that is down to receive the message if it is brought back up within the set time interval. The default is 24 hours (86400000 milliseconds). |
| mqPresentmentQueue | FXH.DISTRIBUTION.FILE.QUEUE | The name of the transmission queue for Distribution. |
| mqTxsIdleTimeout | 300000 | Amount of time, in milliseconds, that an idle Transaction Server queue connection is left open before it is closed and discarded. |
| mqTxsInputQueue | Name of the IBM MQ queue on which the Transaction Server receives
command messages. Note: This parameter must be specified when the Transaction Server is used with
Gateway.
|
|
| mqTxsEventQueue | Name of the IBM MQ queue on which Transaction Server receives
events. Note: This parameter must be specified when the Transaction Server is used with Gateway.
|
Configuring the client channel definition table (CCDT) file to connect to IBM MQ
- The channel name.
- Client-connection-related parameters such as the host name, port number, and the queueManager name.
- Transmission security parameters such as the cipherSpecification.
Add your values for IBM MQ to the ftm-mq-<ftm-instance>-ccdt-config configmap in Red Hat®
OpenShift®. The FTM operator
uses the contents of this configmap to update the mq-ccdt.json file.