Batch (ICL) attributes user exit

The batch (ICL) attributes user exit allows the user to update the batch (ICL) attributes. This user exit is called by the Gateway Server when an incoming transmission has passed validation and before the routing decision is completed. The user exit implements the com.ibm.icpcs.gatewayserver.user.PresentmentAttributesInterface Java™ interface. The interface has the following methods:

setFileType (String type): Gateway Server calls this method to provide the transmission type. The valid transmission types are the fileTypeChoice enumerations in the routingfileschema.xsd file.
setUser1Field (byte[] user1Field): For transmission types that have user fields such as CIFF, the Gateway Server calls this method to provide user field 1.
setUser2Field (byte[] user2Field): For transmission types that have user fields such as CIFF, the Gateway Server calls this method to provide user field 2.
setUser3Field (byte[] user3Field): For transmission types that have user fields such as CIFF, the Gateway Server calls this method to provide user field 3.
setFileHdrRec (ICLFileRecord fileHdrRec): For transmission types that have file header records, the Gateway Server calls this method to provide the normalized file header record.
setCashLetterHdrRec (ICLCashLetterRecord cashLetterHdrRec): For transmission types that have batch (ICL) header records, the Gateway Server calls this method to provide the normalized batch (ICL) header record.
lookupTransmissionAttributes (PresentmentSetterInterface presentmentSetter): The Gateway Server calls this method to obtain the batch (ICL) attributes.

The main method implemented by the user is the lookupTransmissionAttributes method. The user implements it by setting any or all of the batch (ICL) attributes that are exposed in the PresentmentSetterInterface. The SampleTransmissionAttributes.java file in the samples directory is an example of implementing the PresentmentAttributesInterface. This class is activated by specifying the Java class name in the presentmentAttributeClass property in the izxconfig.properties file.

The sample user exit assigns certain batch (ICL) attributes based on the CIFF work type value found in the RFIELD23 composite field of the CIFF file. Refer to the sample, including comments, and the Javadoc information for PresentmentAttributeInterface and PresentmentSetterInterface, for more information.