General Messaging API event handler parameters
Each Messaging API event handler requires a common set of parameters to establish the content and characteristics of the event message it sends. The following table shows the common parameters for the Messaging API event handlers.
Any parameter that is not specified uses the default value that is shown in the table or does not affect
the operation of the event handler. All required parameters must be supplied in the XML of the event unless
you use one of the following methods:
- A parmFileName parameter tag that specifies a parameter file is used.
- A PARAMETERREF tag that specifies a PARAMETERSET is used.
| Name | Required | Example | Default | Description |
|---|---|---|---|---|
| msgType | Yes | presStatesReached | N/A | A string value that is defined by the receiver (Distribution, in this case). Maximum size is 55. |
| parmFileName | No | c:/myprops/EventProps.properties | N/A | Fully qualified path name of the optional parameter file. The file must be in the Java™ properties format. All other parameters in this table can be specified either in the Scheduler.xml file or in the file that is named here. |
| ABSvcPayload | No | Payload Data | N/A | Optional payload string data. |
| sourceID | No | TxsServer001 | serverName or Transaction Server | A text string that describes the source of the message. Since the Transaction Server is the source of any message that is configured in this XML, this value can be left unspecified. When left unspecified, the Transaction Server configuration parameter, serverName, is used as the default. If serverName is not a specified configuration property, a default value of Transaction Server is used. |
| destinationID | Yes | Presentment | N/A | Needs to be a unique name that identifies the receiver. |
| jmsSendQueue | Yes | FXH.DISTRIBUTION.INPUT.QUEUE | N/A | The name of the queue to which to send the message. |
| jmsReplyQueue | Yes | FXH.TRANSSERVER.INPUT.QUEUE | N/A | The name of the queue for the receiver to post replies. Specify the queue named here in the receiveQueue element of the listener profile. |
| jmsKeyStore | No | c:/keys/mqkey.jks | N/A | The fully qualified name of the file that contains the keystore. |
| jmsKeyStorePassword | No | Password | N/A | The password used to access the keystore. |
| jmsTrustStore | No | c:/keys/mqkey.jks | N/A | The fully qualified name of the file that contains the truststore. |
| jmsUserId | No | mymqID | N/A | The user ID used to connect to the IBM® MQ queue manager. |
| jmsPassword | No | mymqPW | N/A | The password used to connect to the IBM MQ queue manager. |
| jmsPriority | No | 2 | 4 | A priority for the JMS message generated by the event handler. This setting must be an integer value between zero and nine. The greater the value the higher the priority (nine is the highest priority). Refer to the industry standard Java documentation for JMS for a complete description of this value. |
Configuring the client channel definition table (CCDT) file to connect to IBM MQ
All application pods connect to IBM MQ by using a JSON formatted CCDT file that is
called mq-ccdt.json. This JSON file contains the following parameters.
- 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.