Common image archive task user exit interfaces

The archive tasks provide a custom user exit that can be called at several points during the unit of work and transaction workflows. The full interface name is com.ibm.fxh.archivetask.userexit.ArchiveWriterUserExitInterface. The following list shows the methods that are implemented in this interface.

void open( UowInfo, Connection )
boolean isIncluded( ImageResourceData )
void updatePayment( ImageResourceData )
byte[] updateIndexRecord( ImageResourceData, byte[] )
void close( boolean )

ArchiveWriterUserExitInterface

The following table describes the user exit interface methods of archive tasks.

Table 1. User exit interface methods
Method	Description
open	This method is called before the task begins extracting transactions for the unit of work. This method contains information about the unit of work and database connection.
isIncluded	This method is called after the transaction data is read from the database, but before the images are fetched for the transaction. The user exit then inspects the transaction attributes and determines whether the transaction needs archiving.
updatePayment	This method is called after the transaction and images are read. The user exit then updates the transaction attributes before the index record is built.
updateIndexRecord	This method is called after the index record is formatted based on the index definition file that is configured for the task. The user exit then updates the formatted record.
close	This method is called after all the transactions are processed or if the task stops prematurely due to an error. If the processing is successful, the boolean parameter is set to true. If the processing stops, the boolean parameter is set to false. The user exit then cleans up and releases the resources that are used during the processing for the unit of work.

If the user exit throws the ArchiveWriterUxException, the task throws the TaskProcessingException back to Services Framework and the task instance goes into an error status.