Event parameters

This event handler uses the general Messaging API event handler parameters and parameters that are specific to the event. Event parameters are specified in the Scheduler.xml file.

The following table shows the additional event parameters for the end of day check event handler.
Table 1. EndOfDayCheckEventHandler parameters
Parameter name Trigger Type Value Description
categories No String User defined A comma delimited set of business day categories, any one of which is required for the Messaging API message to be sent.

This parameter is frequently used to prevent end of day messages being sent for specific categories. Use the not indicator to specify the categories that should not receive the messages.

For additional options available with this parameter, see Specifying Value Modifiers and Special Values.
asynchronous No Boolean
  • true
  • false
 When set to true, indicates that the event response processing for the execute end of day request is asynchronous. The reply queue specified must also be in the Transaction Server listener profile.

This parameter defaults to false (synchronous)

Response Processing provides more details about asynchronous and synchronous processing.

Note: This parameter does not affect response processing for the query end of day request because it is always synchronous.
target1 … targetN No String Name of a PARAMETERSET A Messaging API message is sent to all of the send queues in the parameter sets specified by these target parameters. If no target parameters are specified, only one Messaging API message is sent to the send queue defined in the event XML.
Note: For each target, all of the general Messaging API event handler parameters must be specified using some combination of the following:
  • the parameter set specified for the target
  • the parameters specified in the event XML
  • the parameter reference tags specified in the event XML
Example Handler XML provides an example of using target parameters.
Note: The following list describes what the value in the trigger column means:
Yes
When the value in this column in the database changes to one of the values that are allowed by the event stanza, the handler places a message on the specified queue.
No
When the value in this column in the database changes, it does not cause a message to be placed on a queue. This parameter can be added to provide more criteria that must be met to send a Messaging API message.
N/A
The parameter is not considered when it is being determined whether a message is sent.

Use the target parameters to send end of day messages to multiple applications simultaneously. When defining multiple target parameters for an event, they must be numbered sequentially. Any break in the numbering causes the targets defined after the break to be ignored.

When specifying the target parameters, use only the names of parameter sets that are defined in the scheduler and do not use the same parameter set twice. For each target parameter, the combination of destinationID and jmsSendQueue parameters specified in its PARAMETERSET tag must be unique from all of the other target parameters.