PresentmentStatusCompleteEventHandler

This event handler determines whether a batch (ICL) finished processing and needs to be placed in the complete status before the start of end of day processing.

EXEC specification: com.ibm.paydir.ima.txsvr.event.handlers.PresentmentStatusCompleteEventHandler

When PresentmentStateChange, PresentmentColumnChange, and PresentmentGroupColumnChange events are processed, the event handler uses the states and column settings that are specified in the parameters for the event to determine whether a batch (ICL) finished its processing. If the criteria that are specified in the XML for the event are met, the event handler changes the batch (ICL) status to complete for the batch (ICL).

Event parameters

This event handler has parameters that are specific to the event. Event parameters are specified in the Scheduler.xml file.

The following table shows the event parameters that are available for the presentment status complete event handler.
Table 1. PresentmentStatusCompleteEventHandler parameters
Parameter name Trigger Type Value Description
presStates1 … presStatesN Yes String One or more of the batch (ICL) states that can be used for triggers. A comma-delimited list of batch (ICL) state column names. For more information about using this parameter, see Specifying Triggers.

If this parameter is used, also specify the PresentmentStateChange event type to ensure that the event is handled whenever the batch (ICL) state changes.

Note: The presStates1 parameter must be specified to process a PresentmentStateChange event.
condition Yes Integer
0
Accepted
1
Rejected
2
Suspended
3
Deleted
4
Canceled
 A comma-delimited set of condition settings, any one of which is required for the status of the batch (ICL) to be set to complete.

If this parameter is used, also specify the PresentmentColumnChange event type to ensure that the event is handled whenever the value of the condition column changes.

Note: This parameter defaults to accepted. To ignore the condition parameter, specify it as an empty value set.

For more options that are available to use with this parameter, see Specifying Value Modifiers and Special Values.
group.condition Yes Integer
0
Accepted
1
Rejected
2
Suspended
3
Deleted
4
Canceled
 A comma delimited set of condition settings for the inbound transmission that contains the batch (ICL) that is being processed. Any one of the values that are specified is required for the status of the batch (ICL) to be set to complete.

If this parameter is used, also specify the PresentmentGroupColumnChange event type to ensure that the event is handled whenever the value of the condition column changes.

For more options that are available to use with this parameter, see Specifying Value Modifiers and Special Values.
inbound.condition No Integer
0
Accepted
1
Rejected
2
Suspended
3
Deleted
4
Canceled
 A comma delimited set of condition settings for the inbound batch (ICL) that is associated with the batch (ICL) that is being processed. Any one of the values that are specified is required for the status of the processing batch (ICL) to be set to complete.

This parameter applies only to batches (ICLs) that are currently processing, which is batches (ICLs) that are at level P.

For more options that are available to use with this parameter, see Specifying Value Modifiers and Special Values.
overrideable Yes Boolean
  • FALSE
  • TRUE
 The overridable flag for the batch (ICL). If this parameter is specified, the value of the overrideable column must match this value for the batch (ICL) status to be set to complete.

If this parameter is used, also specify the PresentmentColumnChange event type to ensure that the event is handled whenever the value of the condition column changes.

For more options that are available to use with this parameter, see Specifying Value Modifiers and Special Values.
group.overrideable Yes Boolean
  • FALSE
  • TRUE
 The overridable flag for the inbound transmission. If this parameter is specified, the value of the overrideable column must match this value for the batch (ICL) status to be set to complete.

If this parameter is used, also specify the PresentmentGroupColumnChange event type to ensure that the event is handled whenever the value of the condition column of the inbound transmission changes.

For more options that are available to use with this parameter, see Specifying Value Modifiers and Special Values.
inbound.overrideable No Boolean
  • FALSE
  • TRUE
 The overridable flag for the inbound batch (ICL). If this parameter is specified, the value of the overrideable column must match this value for the batch (ICL) status to be set to complete.

This parameter applies only to batches (ICLs) that are currently processing, which is batches (ICLs) that are at level P.

For more options that are available to use with this parameter, see Specifying Value Modifiers and Special Values.
userField No String User defined A comma-delimited set of user field values, any one of which is required for the batch (ICL) status to be set to complete.
pending Yes Boolean
  • FALSE
  • TRUE
 The pending flag for the batch (ICL) that is being processed. If this parameter is specified, the value of the pending column must match this value for the batch (ICL) status to be set to complete.

If this parameter is used, also specify the PresentmentColumnChange event type to ensure that the event is handled whenever the value of the pending column changes.

For more options that are available to use with this parameter, see Specifying Value Modifiers and Special Values.
group.pending Yes Boolean
  • FALSE
  • TRUE
 The pending flag for the inbound transmission that is being processed. If this parameter is specified, the value of the pending column must match this value for the batch (ICL) status to be set to complete.

If this parameter is used, also specify the PresentmentGroupColumnChange event type to ensure that the event is handled whenever the value of the pending column changes.

For more options that are available to use with this parameter, see Specifying Value Modifiers and Special Values.
inbound.pending No Boolean
  • FALSE
  • TRUE
 The pending flag for the inbound batch (ICL) that is associated with the batch (ICL) that is being processed. If this parameter is specified, the value of the pending column must match this value for the batch (ICL) status to be set to complete.

This parameter applies only to batches (ICLs) that are currently processing, which is batches (ICLs) that are at level P.

For more options that are available to use with this parameter, see Specifying Value Modifiers and Special Values.
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.

Example handler XML

The example XML shows an event handler specification for setting batches (ICLs) to the complete status. It sets the status to complete for batches (ICLs) that meet all of the following criteria.
  • The batch (ICL) is not suspended.
  • The batch (ICL) is not pending.
  • The batch (ICL) is not archived.
  • The batch (ICL) was loaded, reviewed for duplicates, and reviewed by a Risk operator.
  • The batch (ICL) is in an inbound transmission that is not canceled and is not pending.
<EVENT>
   <NAME>Deposit Complete Determination</NAME>
   <TYPE>PresentmentStateChange</TYPE>
   <TYPE>PresentmentColumnChange</TYPE>
   <TYPE>PresentmentGroupColumnChange</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.handlers.PresentmentStatusCompleteEventHandler
   </EXEC>
   <PARAMETER name="presStates1">
      LOADED,!ARCHIVED,DUP_REVIEWED,RISK_REVIEWED,AUTH_REVIEWED
   </PARAMETER>
   <PARAMETER name="condition">!Suspended</PARAMETER>
   <PARAMETER name="group.condition">!Canceled</PARAMETER>
   <PARAMETER name="pending">FALSE</PARAMETER>
</EVENT>