BuildFile Method

Builds an X9.37 file.

Syntax

check21.buildFile([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method builds a complete X9.37 file. If the Filename is specified, the file will be saved to the path and filename indicated there. If no Filename is given, the resultant file will be stored in memory, and can be accessed in the FileData property.

An X9.37 file created by this class will contain the following records:

• File Header Record (1)
• Cash Letter Header Record (1)
• Bundle Header Record (1)
• Check detail record structure (0 to CheckCount), which contains:
  • Check Detail Record (1)
  • Check Detail Addenda A (1)
  • Front Image View Detail Record (0 or 1)
  • Front Image View Data Record (0 or 1)
  • Back Image View Detail Record (0 or 1)
  • Back Image View Data Record (0 or 1)
• Bundle Control Record (1)
• Cash Letter Control Record (1)
• File Control Record (1)