Check21 Configuration
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.Check21 Configuration Settings
| ASCIIOutput: Indicates whether to output ASCII or EBCDIC. If set to True, the class will create check21 files using the ASCII character set instead of the default EBCDIC character set. | |||||||||||||||||||||||||||||||||
| Overwrite: Indicates whether local files can be overwritten. If the file specified by Filename exists and Overwrite is False, BuildFile and BuildAndUploadFile will fail with an error indicating the file exists. Overwrite is true by default. | |||||||||||||||||||||||||||||||||
| OverwriteRemoteFile: Indicates whether remote files can be overwritten on the FTP server. If the file specified by FTPRemoteFile exists and OverwriteRemoteFile is False, BuildAndUploadFile will fail with an error indicating the file exists. OverwriteRemoteFile is true by default. | |||||||||||||||||||||||||||||||||
| ArchiveType: Indicates the type of archive that supports each Check in this file. This code indicates the way the Checks are archived. Access method, availability, and timeframes shall be defined by clearing arrangements. Valid values for this field include:
| |||||||||||||||||||||||||||||||||
| BOFDIndicator: Indicates whether the origin is also the bank of first deposit. This code indicates whether the ECE institution specified in the Origin properties is the Bank of First Deposit (BOFD). Allowable values include:
This setting is global for all checks. | |||||||||||||||||||||||||||||||||
| AllowAllBOFDIndicators: Allows for any value to be specified within the BOFDIndicator field. The default value is False, indicating that the BOFDIndicator is limited to the allowable values listed. | |||||||||||||||||||||||||||||||||
| TestFile: Indicates whether the file being built is a test file or a production file. The default value for TestFile is False, indicating that production files are being construction. | |||||||||||||||||||||||||||||||||
| ResendIndicator: Indicates whether the file being built has been previously transmitted in its entirety. The default value for this setting is False. | |||||||||||||||||||||||||||||||||
| FileCreationDate: The date the file is created. The class normally uses the current system date when building a file. You can override this functionality by setting the FileCreationDate manually through Config. | |||||||||||||||||||||||||||||||||
| FileCreationTime: The time the file is created. The class normally uses the current system time when building a file. You can override this functionality by setting the FileCreationTime manually through Config. | |||||||||||||||||||||||||||||||||
| FileUserField: A User Field. A field used at the discretion of users. | |||||||||||||||||||||||||||||||||
| FedWorkType: Federal Reserve work type. A code that specifies the Federal Reserve work type. Valid values include:
| |||||||||||||||||||||||||||||||||
| IncludeAddendA: Whether to include Detail Addendum A Record. Whether to include Detail Addendum A Record (Record 26) in the file. Default value is True. If set to False the Detail Addendum A Record will not be included in the file. | |||||||||||||||||||||||||||||||||
| ReservedField: A field reserved for future use. A field reserved for future use by the Accredited Standards Committee X9. | |||||||||||||||||||||||||||||||||
| CashLetterCreationDate: The date the cash letter is created. The class normally uses the current system date when building the cash letter inside a file. You can override this functionality by setting the CashLetterCreationDate manually through Config. | |||||||||||||||||||||||||||||||||
| CashLetterCreationTime: The time the cash letter is created. The class normally uses the current system time when building a the cash letter inside a file. You can override this functionality by setting the CashLetterCreationTime manually through Config. | |||||||||||||||||||||||||||||||||
| CountryCode: A code that identifies the country in which the payor bank is located. The default is "US". | |||||||||||||||||||||||||||||||||
| FileId: A code used to uniquely identify this file. This 1-character code permits multiple files, created on the same date, same time, and between the same institutions to be distinguished from one another. This property is part of the File Header record (type 01), and has a default value of "0". | |||||||||||||||||||||||||||||||||
| BundleCount: Total number of bundles in the file. By default, each cash letter contains one bundle. If you wish to specify multiple bundles, increase the BundleCount and then set the BundleIndex to the bundle you wish to operate on. The CycleNumber, ReturnRoutingNumber, and Checks properties should be set for each bundle contained in the file. | |||||||||||||||||||||||||||||||||
| BundleCreationDate: The date the bundle is created. The class normally uses the current system date when building the bundle inside a file. You can override this functionality by setting the BundleCreationDate manually through Config. | |||||||||||||||||||||||||||||||||
| BundleId: Unique identifier for the bundle inside the Cash Letter. The class normally uses the same CashLetterId as the BundleId when constructing a bundle header record. You can override this functionality by setting the BundleId manually through Config. | |||||||||||||||||||||||||||||||||
| BundleIndex: Index of the current bundle. By default, each cash letter contains one bundle. If you wish to specify multiple bundles, increase the BundleCount and then set the BundleIndex to the bundle you wish to operate on. The CycleNumber, ReturnRoutingNumber, and Checks properties should be set for each bundle contained in the file. | |||||||||||||||||||||||||||||||||
| ReturnAcceptance: A code that indicates whether the institution that creates this file will or will not support electronic return processing. Valid values include:
| |||||||||||||||||||||||||||||||||
| DetailAddendumRecordNumber: The Check Detail Addendum A Record Number. This field is used to specify the record number within the Check Detail Addendum A Record. The default value used is '0' but can be changed with this field. | |||||||||||||||||||||||||||||||||
| CheckIsCredit[i]: Indicates whether a Check is to be sent as a Credit (61) Record. Valid array indices are from 0 to Checks.Count - 1. When set to True, the Check at the specified index 'i' will be sent as a Credit Record (61) within the X9.37 file. The DocumentationType is used in the creation of this record as are the following Checks fields: MICRAuxOnUs, MICRProcessingCode, MICRRoutingNumber, MICROnUs, Amount, and SequenceNumber. The default value is False. |
Base Configuration Settings
| SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. |
Base Configuration Settings
| CodePage: The system code page used for Unicode to Multibyte translations. The default code page is the Active Code Page (0). The following is a list of valid code page identifiers:
The following is a list of valid code page identifiers for Mac OS only:
|