Transaction level fields user exit

The transaction level fields user exit is used to set specific flags on each transaction. This exit is called for every transaction, so the user must ensure that their code is efficient and does not adversely affect the overall ingestion rate of transmissions through the Gateway. This user exit is called after IQA is run and before the transaction is written to the .TXS file and Transaction Server. It gives the user the opportunity to set flags on a transaction by transaction basis.

The user defines which user exit to call by using the userItemLevelClass configuration keyword. The user exit should extend the ItemLevelFields class. This base class implements the ItemLevelFieldsInterface class and all of the necessary getter and setter methods in the interface. The user must implement one method, processItem(). This method is passed one parameter, an ItemRecord object. The ItemRecord object gives the user access to the codeline data fields of the transaction. The user can do any processing that is necessary in the processItem method in order to set the transaction level fields.

The user exit has access to the following fields when making decisions.
  • Sort Type
  • Bank Num
  • Transmission Header Record
  • Transmission Control Record
  • Batch (ICL) Header Record
  • Batch (ICL) Control Record
The user can set the clearing channel flag. The ItemLevelFlagsInterface class defines the following possible values for this field:
  • CLEAR_CHANNEL_ARC= 1
  • CLEAR_CHANNEL_BOC= 2
  • CLEAR_CHANNEL_POP= 3

Use the setClearingChannel() method to set the clearing channel to the appropriate value. The value the user sets in the user exit is stored in the FTM database in the CLEARING_CHANNEL column of the PAYMENT table.

The user can set the expanded MICR fields (field 9 - 15) and have them saved to the Item table in the FTM database. To facilitate this, first make sure the size of the corresponding fields in the Item table is large enough to store the data. If not, they must be expanded. In the processItem method of the user exit, the user should call the setMicrFieldn(String field) method of ICLItemRecord, where n is 9 through 15, and pass in the string value to be set.