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. Table 1 shows the common parameters for the Messaging API event handlers.
Any parameter not specified uses the default value shown in Table 1 or does not affect the operation of the event handler. All required parameters must be supplied in the
event XML unless:
- a parmFileName parameter tag specifying a parameter file is used
- a PARAMETERREF tag specifying 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 may be specified either in the Scheduler.xml file or in the file named here. |
| ABSvcPayload | No | Payload Data | N/A | Optional payload string data |
| sourceID | No | TxsServer001 | serverName or Transaction Server | A text string describing the source of the message. Since the Transaction Server is the source of any message 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 | Should be a unique name that identifies the receiver |
| jmsQmgrHostname | No | 127.0.0.1 or MYHOSTNAME | localhost | The host name or address of the server where the WebSphere® MQ queue manager resides |
| jmsQmgrChannel | Yes | SYSTEM.DEF.SVRCONN | N/A | The WebSphere MQ channel name |
| jmsQmgrPort | No | 1414 | 1414 | The port number on which the MQ manager is listening |
| jmsClient | No | false | Indicates the WebSphere MQ client component is being used to provide access to queueing services on a server. Set this parameter to false. | |
| jmsQmgrName | Yes | FTM.QMANAGER | N/A | The name of the MQ queue manager |
| 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. |
| jmsCipherSuite | No | SSL_RSA_WITH_3DES_EDE_CBCV_SHA | N/A | The name of the JSSE CipherSuite associated with the WebSphere CipherSpec specified for the user’s MQ queue manager. For more detailed information, refer to Table 2. If no CipherSuite is specified, this message is not encrypted. |
| jmsKeyStore | No | c:/keys/mqkey.jks | N/A | The fully qualified name of the file containing the key store |
| jmsKeyStorePassword | No | Password | N/A | The password used to access the key store |
| jmsTrustStore | No | c:/keys/mqkey.jks | N/A | The fully qualified name of the file containing the trust store |
| jmsUserId | No | mymqID | N/A | The user ID used to connect to the MQ queue manager |
| jmsPassword | No | mymqPW | N/A | The password used to connect to the 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. |
| jmsCCDT | No | MQCCDT.TAB | N/A | The file name for the MQ client channel definition table (CCDT) file to use. An example of using this parameter is shown in the scheduler reference XML file that is provided with Transaction Server. |