Sample user exit

The sample user exit adds records before or after the one passed to it. It also modifies records. During ICRE file creation, the user exit inserts sample records after the string header record, modifies the detailed records, and removes batch statistics records.

The Java™ source file for the sample ICRE user exit is SampleIcreUserExit.java. The files for user exits are provided in the FTM artifacts pod and must be downloaded from the pod. For more information about getting files from the artifacts container for your offering, see Getting the files from the artifacts container for your FTM offering.

The sample user exit extends the UserControlICRERecord class. The user exit overrides the methods that are shown in the following table.

Table 1. Sample user exit methods
Method	Description
`void getUserControlRecord(ICRERecord icrerecord)`	Returns the current user control record without modification.
`ICRERecordInterface[] processICREBatchStatsRecord(ICREBatchStatsRecord icreBatchStatsRecord,ICRERecordParams icreRecordParams) throws ICREException`	Removes the ICRE batch statistics record.
`ICRERecordInterface[] processICREDetailRecord(ICREDetailRecord icreDetail,ICRERecordParams icreRecordParams) throws ICREException`	Modifies some of the properties of the ICRE item detail record. Control doc and record type are examples of the properties modified.
`ICRERecordInterface[] processICREHeaderRecord(ICREHeaderRecord icreHeaderRecord,ICRERecordParams icreRecordParams) throws ICREException`	Adds the sample record after the string header record.
`ICRERecordInterface[] processICRESTGHeaderRecord(ICRESTGRecord icrestgHeaderRecord, ICRERecordParams icreRecordParams) throws ICREException`	Adds the sample record after the string header record.
`void finalizeICRESTGRecords(ICRESTGRecord icrestgHeaderRecord) throws ICREException`	This method does nothing.
`ICRERecordInterface[] processICRESTGMicrRecord(ICRESTGRecord icreStgMicrRecord, ICRERecordParams icreRecordParams) throws ICREException`	Adds the sample record after the string header record.
`void finalize(Long[] entriesICREd, BusinessDay businessDay, String taskCompletionStatus)`	Cleans up the resources that were used.