Configuring batch (ICL) progress indicators

The progress of batches (ICLs) through the processing flow can be tracked by using progress-indicator status icons. These icons can be displayed on the batch (ICL) pages for many of the batch (ICL) states.

To configure how the batch (ICL) progress indicators are displayed, add extra parameters to the stanzas in the Transaction Server Scheduler.xml file. For each stanza where you want to monitor the progress of a state, you must specify the name of the state that is being monitored in a progressState parameter. To include a visual notification when the progress for a monitored state is taking longer than expected, also specify an expiration time interval in the corresponding progressExpiry parameter. Stanzas that use the PresentmentStatesEventHandler, or its subclasses, to cause a batch (ICL) to transition to another state can include these parameters to indicate which state is expected upon completion and how long the processing can run before it is running too long.

When an event occurs, the appropriate handlers for the type of event that occurred are called. The PresentmentStatesEventHandler first determines whether the event that occurred is defined as a trigger in the stanza. Then, it determines whether the other criteria that are specified in this event stanza matches the current state of the batches (ICLs) and transmission. If the handler determines that this event is to be handled and a message is to be placed on a queue, any states that are specified in the progressState and corresponding progressExpiry parameters are updated before to the message is placed on the queue. If an error occurs sending the message, the progress indicator is updated to show that the state is in error.

The batch (ICL) progress indicator parameters to be used in the Scheduler.xml file are described in the following list.

progressState: Specify the name of the state to be monitored. For events that can set more than one state, use multiple progressState parameters to monitor the different states. The progressState parameter can be used as a sequenced parameter. Use the explicit numbering method when expiration intervals are needed for the progress state parameters. For more information, see Using sequenced parameters.
progressExpiry: To display a visual notification when the progress is taking longer than expected, specify an expiration time interval for the state. The expiration interval must be specified by using the same values and formats that are used to specify the intervals for scheduler tasks. To match the expiration interval parameter to the progress state parameter for the state, use the explicit numbering method for sequenced parameters. For more information about the interval specification, see Recurring Tasks.

For balancing applications, more than one state can be set in an event stanza. To monitor both states, specify a progressState1 and a progressState2 parameter and optionally, their associated progressExpiry1 and progressExpiry2 parameters.

The following example is an event stanza for Risk Management. The progressState1 parameter indicates that the performRiskCheck message type sets the ACTIVITY_MONITORED state. The progressExpiry1 parameter indicates that it is expected to complete within 1500 milliseconds after it starts. If it does not complete within that time frame, the batches / ICLs page shows the warning icon, which indicates that the activity monitoring is taking longer than expected.

<EVENT>
   <NAME>Risk Profile - File and Presentment States Reached</NAME>
   <TYPE>PresentmentStateChange</TYPE>
   <TYPE>PresentmentColumnChange</TYPE>
   <TYPE>PresentmentGroupColumnChange</TYPE>
   <TYPE>PresentmentGroupStateChange</TYPE>
   <EXEC>com.ibm.paydir.ima.txsvr.event.appbridge.PresentmentStatesEventHandler</EXEC>
   <PARAMETER name="msgType">performRiskCheck</PARAMETER>
   <PARAMETER name="presStates#">!LOCKED,LOADED,!ACTIVITY_MONITORED</PARAMETER>
   <PARAMETER name="condition">accepted</PARAMETER>
   <PARAMETER name="group.condition">accepted</PARAMETER>
   <PARAMETER name="group.states1">EXP_LIMIT_REVIEWED</PARAMETER>
   <PARAMETER name="pending">N</PARAMETER>
   <PARAMETER name="group.pending">N</PARAMETER>
   <PARAMETER name="forwardReturn">F,D</PARAMETER>
   <PARAMETER name="group.sourceId">!2</PARAMETER>
   <PARAMETER name="presLevel">INB</PARAMETER>
   <PARAMETER name="progressState1">ACTIVITY_MONITORED</PARAMETER>
   <PARAMETER name=”progressExpiry1”>1500 msecs</PARAMETER>
   <PARAMETERREF>schedulerReferenceProperties</PARAMETERREF>
   <PARAMETERREF>sendToRiskManagement</PARAMETERREF>
</EVENT>

The state names to use in the Scheduler.xml file must match the name of the timestamp columns in the PRESENTMENT database table. These names do not always match the names that are displayed on the user interface. The following table shows the states that support displaying the progress indicators and the name that is shown for that state on the batch (ICL) pages.

State name	Name that is used on the batch (ICL) pages
`ACTIVITY_MONITORED`	Exposure Limit Checked
`ADJUSTED`	Adjusted
`AUXILIARY_EXTRACT_1`	Auxiliary Extract 1
`BALANCED`	Balanced
`BILLED`	Billed
`DUP_DETECTED`	Duplicate Detected
`ENTRY_ALLOCATED`	Entry Allocated
`FRAUD_DETECTION`	Fraud Detection
`ICRE_EXTRACTED`	ICRE Extracted
`ISN_ALLOCATED`	ISN Allocated
`KEYED`	Keyed
`NOC_PROCESSED`	NOC Processed
`RECONCILED`	Reconciled
`REDECORATE`	Redecorate
`REPAIRED`	Repaired
`REVIEWED`	Reviewed
`USR_STATE_FLD_1`	User State Field 1
`USR_STATE_FLD_2`	User State Field 2

No progress indicator configuration is needed for the states that are shown in the following table. The states that automatically show an in-progress indicator at the appropriate time are states that are part of a two-step process. If the first step is complete and the second step is not, it means that the second step is in progress. An in-progress icon for these states indicates that something needs to be reviewed.

State name	Name that is used on the batch (ICL) pages
`AUTH_REVIEWED`	Payment Authorization Reviewed
`DUP_REVIEWED`	Duplicate Reviewed
`FRAUD_REVIEWED`	Fraud Reviewed
`RISK_REVIEWED`	Exposure Limit Reviewed

Examples from the reference implementation

The reference implementation includes several examples of specifying the name of the appropriate progress states. To help locate these examples, the following table shows the value that is in the name element of these stanzas in the Scheduler.xml file.

Name of the stanza in the scheduler file	State set
Amount Keying for out of balance work	`KEYED, BALANCED`
Adjustment - Ingestion Exceptions	`ADJUSTED, BALANCED`
Adjustment - Batch	`ADJUSTED, BALANCED`
Billing Deposit - Inbound	`BILLING`
Image Compliance Review - Transmission Group	`REVIEWED`
NOC - COR Batch Loaded	`NOC_PROCESSED`
NOC - DNE Batch Loaded	`NOC_PROCESSED`
NOC - Generate NOC	`NOC_PROCESSED`
Payment Repair - Forward Presentment	`REPAIRED`
Payment Repair - Return Presentment	`REPAIRED`
Risk Profile - States Reached Auth	`AUTH_CHECKED`
Risk Profile - File and Presentment States Reached	`ACTIVITY_MONITORED`
Risk Profile - States Reached Return	`ACTIVITY_MONITORED`
Risk Profile - Internal OFAC Risk States Reached	`ACTIVITY_MONITORED`
Risk Profile - Internal OFAC Risk States Reached Return	`ACTIVITY_MONITORED`
TCR - Batch	`RECONCILED, BALANCED`