Clearing attributes user exit

The clearing attributes user exit provides Gateway Server with the attributes that are needed to clear work. When the user exit is not specified, Gateway Server uses the Business Rules workflow specified in the ClearingAttributesBusinessRulesWorkflow property to obtain the clearing attributes. The Gateway Server calls this user exit just before beginning its final incoming transmission processing pass, and it is called for every batch (ICL) in the transmission. This allows different business days or categories to be assigned to each batch (ICL). The user exit implements the com.ibm.icpcs.gatewayserver.user.UserClearingAttributesInterface Java™ interface. The interface contains the following methods:
setFileRcvTimeStamp (String fileRcvDate, String fileRcvTime)
Gateway Server calls this method to provide the time that it started to process this transmission. The fileRcvDate argument has the year, month, and day concatenated together as YYYYMMDD. The fileRcvTime argument has the hours, minutes, seconds, and milliseconds concatenated together as HHMMSSmmm.
setPayDirRecvTimeStamp(String payDirRecvTimeStamp)
Gateway Server calls this method to provide the PayDirRecvTimeStamp. The format of payDirRecvTimeStamp is 'xsd:datetime' : '2007-03-27T09:58:53.026-05:00.
setFileName (String fileName)
Gateway Server calls this method to provide the name of this transmission. The fileName argument is the path qualified name of the transmission.
setPresentmentDetails (PresentmentDetailsInterface presentmentDetails)
Gateway Server calls this method to provide the batch (ICL) details. The presentmentDetails argument is an object which has several details about the first batch (ICL) in the transmission. For an X9.37 file, the batch (ICL) data comes from the header of the transmission and cash letter records. For other transmission types, Gateway obtains the batch (ICL) data from the incoming transmission. The file reader for the individual transmission type determines what data goes into the batch (ICL) data.
setFileHdrRec (ICLFileRecord fileHdrRec)
For transmission types that have file header records, Gateway Server calls this method to provide the normalized file header record.
getClearingAttributes ()
Gateway Server calls this method to obtain clearing attributes. It returns the clearing attributes to use for this batch (ICL) within Common Services. A ClearingAttributes instance holds the attributes.
The UserClearingAttributesInterface Java interface should be extended to create the user exit, which helps isolate the user exit from future additions to the interface. UserClearingAttributes is an abstract class that implements the setter methods for the interface. It provides this data as protected fields:
  • String fileRcvDate;
  • String fileRcvTime;
  • String fileName;
  • PresentmentDetailsInterface presentmentDetails;
  • ICLFileRecord fileHdrRec;

ClearingAttributes

ClearingAttributes is a data object that holds the information that is shown in the following table. It has a default constructor and setters for each attribute. Gateway Server uses the information to store the batch (ICL) in the Transaction Server.

Table 1. Clearing attributes
Keyword Description
Business Date A DateMarker object with the business day date. In check processing, this is also known as the cycle date.
Business Category A String object with the business day category. In check processing, this is also known as the cycle number.
Sort Pattern A short integer with the 3-digit sort pattern number. This is also known as the sort type.
Bank A short integer with the 3-digit bank number
Site ID A short integer value which represents the site identifier. Typically, the site ID is 0.

Sample user exit

The SampleClearingAttributes.java source file in the samples directory is an example of a class that extends UserClearingAttributes. Activate the class by specifying the Java class name in the ClearingAttributesClass property in the izxconfig.properties file.

This sample user exit sets the business date to the date Gateway Server started processing the transmission. It sets the business category to a digit that represents the day of week that the Gateway Server started to process the transmission (1 is Sunday, 2 is Monday, and so forth). The sort pattern is set to 105. The bank is set to 002. Refer to the sample, including comments, and the Javadoc information for UserClearingAttributesInterface, UserClearingAttributes, PresentmentDetailsInterface, and ClearingAttributes, for more information.