Check21 Component

Properties   Methods   Events   Config Settings   Errors  

The Check21 component is used to construct a file containing scanned images of paper checks, and optionally upload it to an FTPS server.

Syntax

TibpCheck21

Remarks

An X9.37 file created by this component 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)

This component makes creating the above file very easy. First set the Origin properties with information about the institution that is originating this file, and the destination it is to be deposited to. Also set the ReturnRoutingNumber. Check21.OriginName = "First Bank of Thor" Check21.OriginRoutingNumber = "111012822" Check21.OriginContactName = "Jake Olsen" Check21.OriginContactPhone = "800-555-5555" Check21.DestinationRoutingNumber = "051000321" Check21.DestinationName = "First Bank of Loki" Check21.ReturnRoutingNumber = "111012822" This file must be differentiated from other files, so now set the CashLetterId and CycleNumber properties, as well as the FileName. (Alternatively FileName may be left empty, and the component will write the file to memory and store it in the FileData property).

Check21.CashLetterId = "123456" Check21.CycleNumber = "01" Check21.FileName = "sample_output.dat" This file is going to contain scanned images of paper checks, so RecordType should be set to rtChecksAndImages and make sure the DocumentationType is set to a compatible value ("G" through "J" are valid when RecordType is rtChecksAndImages). Check21.RecordType = rtChecksAndImages Check21.DocumentationType = "G" This sample file is to contain only one check, but a real file may contain any number of checks. To add a check, set the CheckCount, and then fill the Check array properties with information read off the check's MICR line, as well as the Payee's name and the amount of the check. Check21.CheckCount = 1 Check21.CheckMICROnUs(0) = "1234567890101" ' Account number on the check Check21.CheckMICRRoutingNumber(0) = "902113700" Check21.CheckAmount(0) = "50000" ' $500.00 Check21.CheckSequenceNumber(0) = "407" Check21.CheckPayeeName = "Bruce Banner" Then set information about the Bank of First Deposit. This may be identical to the Origin. The CheckBOFDConversionIndicator should also be set to "2" if this bank converted the original check into the image being included. Check21.CheckBOFDRoutingNumber(0) = "111012822" Check21.CheckBOFDAccountNumber(0) = "181818181818181818" Check21.CheckBOFDBranch(0) = "Asgard" Check21.CheckBOFDConversionIndicator(0) = "2" Finally, you must include images of the front and back of the check, and indicate the format and compression used to create those images. You may use CheckFrontImageFileName and CheckBackImageFileName properties to point to image files on disk, or you may set the binary data directly in CheckFrontImageData and CheckBackImageData. You also need to set a unique identifier that can be used to retrieve the images at a later date. Check21.CheckImageFormat(0) = ifTIFF ' default Check21.CheckImageCompression(0) = icJPEG ' default Check21.CheckCanRecreateImages(0) = True ' default Check21.CheckFrontImageFileName(0) = "front.jpg" Check21.CheckFrontImageReferenceKey(0) = "72234215front" Check21.CheckBackImageFileName(0) = "back.jpg" Check21.CheckBackImageReferenceKey(0) = "72234215back" Now call BuildFile to build the file and save it to the FileName you indicated earlier. If you have an FTPS server (TLS/SSL-secured FTP) to upload the files to, you may set the FTP properties and call BuildAndUploadFile method instead.

Property List

---

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

BusinessDate Property (Check21 Component)

The year, month, and day that designates the business date at the Bank of First Deposit.

Syntax

__property String BusinessDate = { read=FBusinessDate, write=FSetBusinessDate };

Default Value

""

Remarks

This property is 8 characters in length and in the format "YYYYMMDD". If no value is supplied in this property the current system date will be used.

This property is part of the Cash Letter Header record (type 10), Bundle Header record (type 20), Check Detail Addendum A record (type 26), and Image View Data record (type 52).

Data Type

String

CashLetterId Property (Check21 Component)

A code used to uniquely identify the cash letter inside the file.

Syntax

__property String CashLetterId = { read=FCashLetterId, write=FSetCashLetterId };

Default Value

""

Remarks

This code identifies the cash letter, and is assigned by the institution that creates the file. This property is part of the Cash Letter Header record (type 10), and is 8 characters in length. The same value will also be used in the Bundle Header Record (type 20) for the "Bundle Id".

Data Type

String

CheckCount Property (Check21 Component)

The number of records in the Check arrays.

Syntax

__property int CheckCount = { read=FCheckCount, write=FSetCheckCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• CheckAmount
• CheckBackImageCreationDate
• CheckBackImageData
• CheckBackImageFileName
• CheckBackImageReferenceKey
• CheckBOFDAccountNumber
• CheckBOFDBranch
• CheckBOFDConversionIndicator
• CheckBOFDRoutingNumber
• CheckBOFDTruncator
• CheckCanRecreateImages
• CheckFrontImageCreationDate
• CheckFrontImageData
• CheckFrontImageFileName
• CheckFrontImageReferenceKey
• CheckImageCompression
• CheckImageCreatorRoutingNumber
• CheckImageFormat
• CheckMICRAuxOnUs
• CheckMICROnUs
• CheckMICRProcessingCode
• CheckMICRRoutingNumber
• CheckPayeeName
• CheckSequenceNumber

The array indices start at 0 and end at CheckCount - 1.

This property is not available at design time.

Data Type

Integer

CheckAmount Property (Check21 Component)

The US dollar value of the check.

Syntax

__property String CheckAmount[int CheckIndex] = { read=FCheckAmount, write=FSetCheckAmount };

Default Value

""

Remarks

The US dollar value of the check. This property is part of the Check detail record (type 25), and is 10 characters in length.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBackImageCreationDate Property (Check21 Component)

Date assigned by the image creator for the image contained in BackImageData .

Syntax

__property String CheckBackImageCreationDate[int CheckIndex] = { read=FCheckBackImageCreationDate, write=FSetCheckBackImageCreationDate };

Default Value

""

Remarks

Date assigned by the image creator for the image contained in CheckBackImageData. This property is part of the Image View Detail record (type 50), and is in the format "YYYYMMDD".

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBackImageData Property (Check21 Component)

This property contains the scanned image of the back of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression .

Syntax

__property String CheckBackImageData[int CheckIndex] = { read=FCheckBackImageData, write=FSetCheckBackImageData };
__property DynamicArray<Byte> CheckBackImageDataB[int CheckIndex] = { read=FCheckBackImageDataB, write=FSetCheckBackImageDataB };

Default Value

""

Remarks

This property contains the scanned image of the back of the physical check, in the format specified by CheckImageFormat and compressed using the designated CheckImageCompression. You may either specify the raw binary image data in this property, or specify the path and filename of an image on disk in the CheckBackImageFileName property. If both are specified CheckBackImageData will be used. If both properties are left empty, no records referencing the back image of the check will be added to the file.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Byte Array

CheckBackImageFileName Property (Check21 Component)

This property contains location of a scanned image of the back of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression .

Syntax

__property String CheckBackImageFileName[int CheckIndex] = { read=FCheckBackImageFileName, write=FSetCheckBackImageFileName };

Default Value

""

Remarks

This property contains location of a scanned image of the back of the physical check, in the format specified by CheckImageFormat and compressed using the designated CheckImageCompression. You may either specify the path and filename of an image on disk in this property, or you may set the raw binary image data in the CheckBackImageData property. If both properties are specified CheckBackImageData will be used and CheckBackImageFileName will be ignored. If both properties are left empty, no records referencing the back image of the check will be added to the file.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBackImageReferenceKey Property (Check21 Component)

A designator assigned by the ECE institution that uniquely identifies the BackImageData .

Syntax

__property String CheckBackImageReferenceKey[int CheckIndex] = { read=FCheckBackImageReferenceKey, write=FSetCheckBackImageReferenceKey };

Default Value

""

Remarks

A designator assigned by the ECE institution that uniquely identifies the CheckBackImageData. This designator could be a key that would be used by the creating institution to located the unique associated image, or it could provide a full access path and name that would allow direct external look up and access of the image. For example, this could be a URL.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBOFDAccountNumber Property (Check21 Component)

A number that identifies the depository account at the Bank of First Deposit.

Syntax

__property String CheckBOFDAccountNumber[int CheckIndex] = { read=FCheckBOFDAccountNumber, write=FSetCheckBOFDAccountNumber };

Default Value

""

Remarks

A number that identifies the depository account at the Bank of First Deposit. This property is part of the Check Detail Addendum A record (type 26), and is 18 characters in length.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBOFDBranch Property (Check21 Component)

A code that identifies the branch at the Bank of First Deposit.

Syntax

__property String CheckBOFDBranch[int CheckIndex] = { read=FCheckBOFDBranch, write=FSetCheckBOFDBranch };

Default Value

""

Remarks

A code that identifies the branch at the Bank of First Deposit. This property is part of the Check Detail Addendum A record (type 26), and is 5 characters in length.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBOFDConversionIndicator Property (Check21 Component)

A code that indicates the conversion within the processing institution between original paper check, image, and IRD.

Syntax

__property String CheckBOFDConversionIndicator[int CheckIndex] = { read=FCheckBOFDConversionIndicator, write=FSetCheckBOFDConversionIndicator };

Default Value

""

Remarks

A code that indicates the conversion within the processing institution between original paper check, image, and IRD. The indicator is specific to the action of this BOFD endorser. This property is part of the Check Detail Addendum A record (type 26), and may be set to one of the following values:

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBOFDRoutingNumber Property (Check21 Component)

A number that identifies the Bank of First Deposit.

Syntax

__property String CheckBOFDRoutingNumber[int CheckIndex] = { read=FCheckBOFDRoutingNumber, write=FSetCheckBOFDRoutingNumber };

Default Value

""

Remarks

A number that identifies the Bank of First Deposit. This property is part of the Check Detail Addendum A record (type 26), and is exactly 9 characters long, including the check digit.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckBOFDTruncator Property (Check21 Component)

Identifies if this BOFD is the truncator of the original check.

Syntax

__property bool CheckBOFDTruncator[int CheckIndex] = { read=FCheckBOFDTruncator, write=FSetCheckBOFDTruncator };

Default Value

true

Remarks

Identifies if this BOFD is the truncator of the original check. This property is part of the Check Detail Addendum A record (type 26), and is True by default.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Boolean

CheckCanRecreateImages Property (Check21 Component)

A code that indicates whether the sender has the ability to recreate the check images (from the original source) for the duration of the agreed to retention time frame.

Syntax

__property bool CheckCanRecreateImages[int CheckIndex] = { read=FCheckCanRecreateImages, write=FSetCheckCanRecreateImages };

Default Value

true

Remarks

A code that indicates whether the sender has the ability to recreate the check images (from the original source) for the duration of the agreed to retention time frame.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Boolean

CheckFrontImageCreationDate Property (Check21 Component)

Date assigned by the image creator for the image contained in FrontImageData .

Syntax

__property String CheckFrontImageCreationDate[int CheckIndex] = { read=FCheckFrontImageCreationDate, write=FSetCheckFrontImageCreationDate };

Default Value

""

Remarks

Date assigned by the image creator for the image contained in CheckFrontImageData. This property is part of the Image View Detail record (type 50), and is in the format "YYYYMMDD".

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckFrontImageData Property (Check21 Component)

This property contains the scanned image of the front of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression .

Syntax

__property String CheckFrontImageData[int CheckIndex] = { read=FCheckFrontImageData, write=FSetCheckFrontImageData };
__property DynamicArray<Byte> CheckFrontImageDataB[int CheckIndex] = { read=FCheckFrontImageDataB, write=FSetCheckFrontImageDataB };

Default Value

""

Remarks

This property contains the scanned image of the front of the physical check, in the format specified by CheckImageFormat and compressed using the designated CheckImageCompression. You may either specify the raw binary image data in this property, or specify the path and filename of an image on disk in the CheckFrontImageFileName property. If both are specified CheckFrontImageData will be used. If both properties are left empty, no records referencing the front image of the check will be added to the file.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Byte Array

CheckFrontImageFileName Property (Check21 Component)

This property contains location of a scanned image of the front of the physical check, in the format specified by ImageFormat and compressed using the designated ImageCompression .

Syntax

__property String CheckFrontImageFileName[int CheckIndex] = { read=FCheckFrontImageFileName, write=FSetCheckFrontImageFileName };

Default Value

""

Remarks

This property contains location of a scanned image of the front of the physical check, in the format specified by CheckImageFormat and compressed using the designated CheckImageCompression. You may either specify the path and filename of an image on disk in this property, or you may set the raw binary image data in the CheckFrontImageData property. If both properties are specified CheckFrontImageData will be used and CheckFrontImageFileName will be ignored. If both properties are left empty, no records referencing the front image of the check will be added to the file.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckFrontImageReferenceKey Property (Check21 Component)

A designator assigned by the ECE institution that uniquely identifies the FrontImageData .

Syntax

__property String CheckFrontImageReferenceKey[int CheckIndex] = { read=FCheckFrontImageReferenceKey, write=FSetCheckFrontImageReferenceKey };

Default Value

""

Remarks

A designator assigned by the ECE institution that uniquely identifies the CheckFrontImageData. This designator could be a key that would be used by the creating institution to located the unique associated image, or it could provide a full access path and name that would allow direct external look up and access of the image. For example, this could be a URL.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckImageCompression Property (Check21 Component)

A code that identifies the algorithm or method used to compress the images stored in the FrontImageData and BackImageData properties.

Syntax

__property TibpCheck21CheckImageCompressions CheckImageCompression[int CheckIndex] = { read=FCheckImageCompression, write=FSetCheckImageCompression };

enum TibpCheck21CheckImageCompressions {
  icFacsimile=0,
  icJPEG=1,
  icABIC=2,
  icPNG=21,
  icJBIG=22,
  icJPEG2000=23
};

Default Value

icJPEG

Remarks

A code that identifies the algorithm or method used to compress the images stored in the CheckFrontImageData and CheckBackImageData properties. Values 0-20 may be used without a pre-existing agreement. Values 21-99 shall only be used when an agreement exists indicating that sender and receiver both support the specified image compression method and the method is specified below or on the X9 web site. This property is part of the Image View Detail record (type 50), and may be any of the values below:

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Integer

CheckImageCreatorRoutingNumber Property (Check21 Component)

A number that identifies the financial institution that created the image (if different from BOFDRoutingNumber ).

Syntax

__property String CheckImageCreatorRoutingNumber[int CheckIndex] = { read=FCheckImageCreatorRoutingNumber, write=FSetCheckImageCreatorRoutingNumber };

Default Value

""

Remarks

A number that identifies the financial institution that created the image (if different from CheckBOFDRoutingNumber). This property is part of the Image View Detail record (type 50), and is exactly 9 characters long, including the check digit.

If this property is not specified the Originator routing number will be used.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckImageFormat Property (Check21 Component)

A code that identifies the type of image format used for the images contained in the FrontImageData and BackImageData properties.

Syntax

__property TibpCheck21CheckImageFormats CheckImageFormat[int CheckIndex] = { read=FCheckImageFormat, write=FSetCheckImageFormat };

enum TibpCheck21CheckImageFormats {
  ifTIFF=0,
  ifIOCA=1,
  ifPNG=20,
  ifJFIF=21,
  ifSPIFF=22,
  ifJBIG=23,
  ifJPEG2000=24
};

Default Value

ifTIFF

Remarks

A code that identifies the type of image format used for the images contained in the CheckFrontImageData and CheckBackImageData properties. Values 0-19 may e used without a pre-existing agreement. Values 20-99 shall only be used when an agreement exists indicating that the sender and receiver both support the specified image format type and the type is specified below or on the X9 web site. The image format type is also commonly specified by reference to the file extension used when the CheckFrontImageData or CheckBackImageData is saved as an image file. The file extension for each image format is included below for reference.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

Integer

CheckMICRAuxOnUs Property (Check21 Component)

A code used on commercial checks at the discretion of the payor bank, read off of the MICR line on a check.

Syntax

__property String CheckMICRAuxOnUs[int CheckIndex] = { read=FCheckMICRAuxOnUs, write=FSetCheckMICRAuxOnUs };

Default Value

""

Remarks

A code used on commercial checks at the discretion of the payor bank, read off of the MICR line on a check. This property is part of the Check detail record (type 25), and is 15 characters in length.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckMICROnUs Property (Check21 Component)

Account number data specified by the payor bank and read from the MICR line on a check.

Syntax

__property String CheckMICROnUs[int CheckIndex] = { read=FCheckMICROnUs, write=FSetCheckMICROnUs };

Default Value

""

Remarks

Account number data specified by the payor bank and read from the MICR line on a check. On-Us data usually consists of the payor's account number, a serial number or transaction code, or both.

ANS X9.37 requires the collecting bank to capture the entire On-Us field from the physical check. Blanks are to be suppressed, dashes are optional, and each On-Us symbol must be translated to a forward slash ('/'). This property is part of the Check detail record (type 25), and is 20 characters in length.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckMICRProcessingCode Property (Check21 Component)

The external processing code from the MICR line of a check, if present.

Syntax

__property String CheckMICRProcessingCode[int CheckIndex] = { read=FCheckMICRProcessingCode, write=FSetCheckMICRProcessingCode };

Default Value

""

Remarks

The external processing code from the MICR line of a check, if present. This is also known as "Position 44",. and is used for special purposes as authorized by the Accredited Standards Committee X9. This property is part of the Check detail record (type 25), and is 1 character in length.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckMICRRoutingNumber Property (Check21 Component)

Payor bank routing number, read from the MICR line of a check.

Syntax

__property String CheckMICRRoutingNumber[int CheckIndex] = { read=FCheckMICRRoutingNumber, write=FSetCheckMICRRoutingNumber };

Default Value

""

Remarks

Payor bank routing number, read from the MICR line of a check. This number identifies the institution by or through which the item is payable. This property is part of the Check detail record (type 25), and is exactly 9 characters long, including the check digit.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckPayeeName Property (Check21 Component)

The name of the payee from the check.

Syntax

__property String CheckPayeeName[int CheckIndex] = { read=FCheckPayeeName, write=FSetCheckPayeeName };

Default Value

""

Remarks

The name of the payee from the check. This property is part of the Check Detail Addendum A record (type 26), and is 15 characters in length.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CheckSequenceNumber Property (Check21 Component)

ECE Institution Item Sequence Number, assigned by the institution that creates the file.

Syntax

__property String CheckSequenceNumber[int CheckIndex] = { read=FCheckSequenceNumber, write=FSetCheckSequenceNumber };

Default Value

""

Remarks

ECE Institution Item Sequence Number, assigned by the institution that creates the file. The ECE institution must construct the sequence number to guarantee uniqueness for a given OriginRoutingNumber, BusinessDate, and CycleNumber. This property is part of the Check detail record (type 25) and Image View Data Record (type 52), and is 15 characters in length.

The CheckIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CheckCount property.

This property is not available at design time.

Data Type

String

CollectionType Property (Check21 Component)

A code that indicates the type of cash letter and bundle contained in the file.

Syntax

__property TibpCheck21CollectionTypes CollectionType = { read=FCollectionType, write=FSetCollectionType };

enum TibpCheck21CollectionTypes {
  ctForwardInfo=1,
  ctFowardPresentment=2,
  ctForwardSameDay=3,
  ctNoDetail=20
};

Default Value

ctForwardInfo

Remarks

This property is part of the Cash Letter Header record (type 10), and is exactly 2 characters in length. Valid values for this property are listed below.

Data Type

Integer

CycleNumber Property (Check21 Component)

Denotes the cycle under which the file is created.

Syntax

__property String CycleNumber = { read=FCycleNumber, write=FSetCycleNumber };

Default Value

""

Remarks

This code is assigned by the institution that creates the file. This property is part of the Bundle Header record (type 20) and Image View Data record (type 52).

Data Type

String

DestinationName Property (Check21 Component)

The short name that identifies the institution that receives the file.

Syntax

__property String DestinationName = { read=FDestinationName, write=FSetDestinationName };

Default Value

""

Remarks

This property is part of the File Header record (type 01), and is exactly 9 characters long, including the check digit.

Data Type

String

DestinationRoutingNumber Property (Check21 Component)

This number identifies the institution that receives the file.

Syntax

__property String DestinationRoutingNumber = { read=FDestinationRoutingNumber, write=FSetDestinationRoutingNumber };

Default Value

""

Remarks

This property is part of the File Header record (type 01), Cash Letter Header Record (type 10), and Bundle Header Record (type 20), and is exactly 9 characters long including the check digit.

Data Type

String

DocumentationType Property (Check21 Component)

A code that indicates the type of documentation that supports all Checks records in the file.

Syntax

__property String DocumentationType = { read=FDocumentationType, write=FSetDocumentationType };

Default Value

""

Remarks

This property is part of the Cash Letter record (type 10) and Check detail record (type 25), and may be any of the values listed below:

Data Type

String

FileData Property (Check21 Component)

Contains the binary contents of the X9.37 file created by the BuildFile method.

Syntax

__property String FileData = { read=FFileData };
__property DynamicArray<Byte> FileDataB = { read=FFileDataB };

Default Value

""

Remarks

If FileName is specified BuildFile will save to disk, and FileData will remain empty. However if FileName is blank, the file will be created in-memory and stored in this property.

This property is read-only.

Data Type

Byte Array

FileName Property (Check21 Component)

Path and name of the file to be written to disk by the BuildFile method.

Syntax

__property String FileName = { read=FFileName, write=FSetFileName };

Default Value

""

Remarks

If FileName is blank, the BuildFile method will create the file in-memory and store it in the FileData property.

When using the BuildAndUploadFile method, FileName is used slightly different. If a path and filename is specified, the file will be written to disk and uploaded to the FTPRemoteHost. If FileName contains only a path (and ends in "/" or "\"), that directory will be used to store temporary files before uploading to the FTPRemoteHost. If FileName is blank the system temp directory will be used. All temporary files are deleted after a successful upload.

Data Type

String

FTPPassword Property (Check21 Component)

The password to login with.

Syntax

__property String FTPPassword = { read=FFTPPassword, write=FSetFTPPassword };

Default Value

""

Remarks

The password to login with. This property must be set before the component begins a file upload.

This property is not available at design time.

Data Type

String

FTPRemoteFile Property (Check21 Component)

The name of the file as it will appear on the server after upload.

Syntax

__property String FTPRemoteFile = { read=FFTPRemoteFile, write=FSetFTPRemoteFile };

Default Value

""

Remarks

The name of the file as it will appear on the server after upload. The FTPRemoteFile can contain only the file name, an absolute path and filename, or a relative path based on FTPRemotePath.

This property is not available at design time.

Data Type

String

FTPRemoteHost Property (Check21 Component)

The domain name or IP address of the FTP server the file is to be uploaded to.

Syntax

__property String FTPRemoteHost = { read=FFTPRemoteHost, write=FSetFTPRemoteHost };

Default Value

""

Remarks

The domain name or IP address of the FTP server the file is to be uploaded to.

The FTPRemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If the FTPRemoteHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the FTPRemoteHost property is set to the corresponding address. If the search is not successful, an error is returned.

If the component is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

This property is not available at design time.

Data Type

String

FTPRemotePath Property (Check21 Component)

The current path on the FTP server.

Syntax

__property String FTPRemotePath = { read=FFTPRemotePath, write=FSetFTPRemotePath };

Default Value

""

Remarks

The current path on the FTP server. The FTPRemotePath shows the current working directory on the FTP server. It can also be used to change the working directory by setting it to an absolute directory path, or a relative path with respect to the existing value of FTPRemotePath.

If the first two bytes of the new path are "..", then a change to one level above in the directory tree is performed.

The FTPRemotePath must be set before the component begins a file upload.

This property is not available at design time.

Data Type

String

FTPRemotePort Property (Check21 Component)

The port for the FTP service (default is 21).

Syntax

__property int FTPRemotePort = { read=FFTPRemotePort, write=FSetFTPRemotePort };

Default Value

21

Remarks

The port for the FTP service (default is 21). A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

This property is not available at design time.

Data Type

Integer

FTPTimeout Property (Check21 Component)

A timeout to use when uploading via FTP.

Syntax

__property int FTPTimeout = { read=FFTPTimeout, write=FSetFTPTimeout };

Default Value

60

Remarks

A timeout to use when uploading via FTP.

When uploading the X9.37 file to the FTP FTPRemoteHost, the component will use this property to determine how long to wait for the operation to complete before returning control. The FTPTimeout property cannot be set to 0

The default value for the Timeout property is 60 (seconds).

This property is not available at design time.

Data Type

Integer

FTPUser Property (Check21 Component)

The user id to login as.

Syntax

__property String FTPUser = { read=FFTPUser, write=FSetFTPUser };

Default Value

""

Remarks

The user id to login as. This property must be set before the component begins a file upload.

This property is not available at design time.

Data Type

String

OriginContactName Property (Check21 Component)

A contact at the institution that creates the file.

Syntax

__property String OriginContactName = { read=FOriginContactName, write=FSetOriginContactName };

Default Value

""

Remarks

A contact at the institution that creates the file. This property is part of the File Control record (type 99), and is 14 characters in length.

This property is not available at design time.

Data Type

String

OriginContactPhone Property (Check21 Component)

The phone number of the ContactName at the institution that created the file.

Syntax

__property String OriginContactPhone = { read=FOriginContactPhone, write=FSetOriginContactPhone };

Default Value

""

Remarks

The phone number of the OriginContactName at the institution that created the file. This property is part of the Cash Letter Header record (type 10) and File Control record (type 99), and is 10 characters in length.

This property is not available at design time.

Data Type

String

OriginName Property (Check21 Component)

The short name of the ECE institution that created the file.

Syntax

__property String OriginName = { read=FOriginName, write=FSetOriginName };

Default Value

""

Remarks

The short name of the ECE institution that created the file. This property is part of the Cash Letter Header record (type 10) and Cash Letter Control record (type 90), and is 14 characters in length.

This property is not available at design time.

Data Type

String

OriginRoutingNumber Property (Check21 Component)

A number that identifies the ECE institution that originates the file.

Syntax

__property String OriginRoutingNumber = { read=FOriginRoutingNumber, write=FSetOriginRoutingNumber };

Default Value

""

Remarks

A number that identifies the ECE institution that originates the file. This property is part of the File Header record (type 01) and Cash Letter Header record (type 10), and Bundle Header record (type 20), and is exactly 9 characters long including the check digit.

This property is not available at design time.

Data Type

String

RecordType Property (Check21 Component)

A code that indicates the type of records contained in this file.

Syntax

__property TibpCheck21RecordTypes RecordType = { read=FRecordType, write=FSetRecordType };

enum TibpCheck21RecordTypes {
  rtNoChecks=0,
  rtChecksNoImages=1,
  rtChecksAndImages=2,
  rtImagesForCashLetter=3
};

Default Value

rtNoChecks

Remarks

If an image is associated with any (even one) CheckDetail detail record, this property must be set to rtChecksAndImages or rtImagesForCashLetter. This property is part of the Cash Letter record (type 10) and may be set to any of the values listed below:

Data Type

Integer

ReturnRoutingNumber Property (Check21 Component)

A routing number indicating the location to which returns and return notifications should be sent.

Syntax

__property String ReturnRoutingNumber = { read=FReturnRoutingNumber, write=FSetReturnRoutingNumber };

Default Value

""

Remarks

This routing number is specified by the institution that creates the file, and specifies the location to which returns, return notifications, and preliminary return notifications should be sent. This property is part of the Bundle Header record (type 20), and is exactly 9 characters long including the check digit.

Data Type

String

SettlementDate Property (Check21 Component)

The date that the institution that created the file expects settlement.

Syntax

__property String SettlementDate = { read=FSettlementDate, write=FSetSettlementDate };

Default Value

""

Remarks

This property is part of the Cash Letter Control record (type 90), and is in the format YYYYMMDD.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (Check21 Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLAcceptServerCertEffectiveDate = { read=FSSLAcceptServerCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (Check21 Component)

The date on which the certificate expires.

Syntax

__property String SSLAcceptServerCertExpirationDate = { read=FSSLAcceptServerCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (Check21 Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLAcceptServerCertExtendedKeyUsage = { read=FSSLAcceptServerCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (Check21 Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SSLAcceptServerCertFingerprint = { read=FSSLAcceptServerCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (Check21 Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SSLAcceptServerCertFingerprintSHA1 = { read=FSSLAcceptServerCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (Check21 Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SSLAcceptServerCertFingerprintSHA256 = { read=FSSLAcceptServerCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (Check21 Component)

The issuer of the certificate.

Syntax

__property String SSLAcceptServerCertIssuer = { read=FSSLAcceptServerCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (Check21 Component)

The private key of the certificate (if available).

Syntax

__property String SSLAcceptServerCertPrivateKey = { read=FSSLAcceptServerCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (Check21 Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLAcceptServerCertPrivateKeyAvailable = { read=FSSLAcceptServerCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (Check21 Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SSLAcceptServerCertPrivateKeyContainer = { read=FSSLAcceptServerCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (Check21 Component)

The public key of the certificate.

Syntax

__property String SSLAcceptServerCertPublicKey = { read=FSSLAcceptServerCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (Check21 Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SSLAcceptServerCertPublicKeyAlgorithm = { read=FSSLAcceptServerCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (Check21 Component)

The length of the certificate's public key (in bits).

Syntax

__property int SSLAcceptServerCertPublicKeyLength = { read=FSSLAcceptServerCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (Check21 Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLAcceptServerCertSerialNumber = { read=FSSLAcceptServerCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (Check21 Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLAcceptServerCertSignatureAlgorithm = { read=FSSLAcceptServerCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (Check21 Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLAcceptServerCertStore = { read=FSSLAcceptServerCertStore, write=FSetSSLAcceptServerCertStore };
__property DynamicArray<Byte> SSLAcceptServerCertStoreB = { read=FSSLAcceptServerCertStoreB, write=FSetSSLAcceptServerCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLAcceptServerCertStorePassword Property (Check21 Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SSLAcceptServerCertStorePassword = { read=FSSLAcceptServerCertStorePassword, write=FSetSSLAcceptServerCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (Check21 Component)

The type of certificate store for this certificate.

Syntax

__property TibpCheck21SSLAcceptServerCertStoreTypes SSLAcceptServerCertStoreType = { read=FSSLAcceptServerCertStoreType, write=FSetSSLAcceptServerCertStoreType };

enum TibpCheck21SSLAcceptServerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (Check21 Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String SSLAcceptServerCertSubjectAltNames = { read=FSSLAcceptServerCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (Check21 Component)

The MD5 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintMD5 = { read=FSSLAcceptServerCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (Check21 Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintSHA1 = { read=FSSLAcceptServerCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (Check21 Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLAcceptServerCertThumbprintSHA256 = { read=FSSLAcceptServerCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (Check21 Component)

The text description of UsageFlags .

Syntax

__property String SSLAcceptServerCertUsage = { read=FSSLAcceptServerCertUsage };

Default Value

""

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (Check21 Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLAcceptServerCertUsageFlags = { read=FSSLAcceptServerCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (Check21 Component)

The certificate's version number.

Syntax

__property String SSLAcceptServerCertVersion = { read=FSSLAcceptServerCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (Check21 Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLAcceptServerCertSubject = { read=FSSLAcceptServerCertSubject, write=FSetSSLAcceptServerCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (Check21 Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertEffectiveDate Property (Check21 Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLCertEffectiveDate = { read=FSSLCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (Check21 Component)

The date on which the certificate expires.

Syntax

__property String SSLCertExpirationDate = { read=FSSLCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (Check21 Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLCertExtendedKeyUsage = { read=FSSLCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (Check21 Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SSLCertFingerprint = { read=FSSLCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (Check21 Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SSLCertFingerprintSHA1 = { read=FSSLCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (Check21 Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SSLCertFingerprintSHA256 = { read=FSSLCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (Check21 Component)

The issuer of the certificate.

Syntax

__property String SSLCertIssuer = { read=FSSLCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (Check21 Component)

The private key of the certificate (if available).

Syntax

__property String SSLCertPrivateKey = { read=FSSLCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (Check21 Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLCertPrivateKeyAvailable = { read=FSSLCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (Check21 Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SSLCertPrivateKeyContainer = { read=FSSLCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (Check21 Component)

The public key of the certificate.

Syntax

__property String SSLCertPublicKey = { read=FSSLCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (Check21 Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SSLCertPublicKeyAlgorithm = { read=FSSLCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (Check21 Component)

The length of the certificate's public key (in bits).

Syntax

__property int SSLCertPublicKeyLength = { read=FSSLCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (Check21 Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLCertSerialNumber = { read=FSSLCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (Check21 Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLCertSignatureAlgorithm = { read=FSSLCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (Check21 Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (Check21 Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (Check21 Component)

The type of certificate store for this certificate.

Syntax

__property TibpCheck21SSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TibpCheck21SSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (Check21 Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String SSLCertSubjectAltNames = { read=FSSLCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (Check21 Component)

The MD5 hash of the certificate.

Syntax

__property String SSLCertThumbprintMD5 = { read=FSSLCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (Check21 Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLCertThumbprintSHA1 = { read=FSSLCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (Check21 Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLCertThumbprintSHA256 = { read=FSSLCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (Check21 Component)

The text description of UsageFlags .

Syntax

__property String SSLCertUsage = { read=FSSLCertUsage };

Default Value

""

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (Check21 Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLCertUsageFlags = { read=FSSLCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (Check21 Component)

The certificate's version number.

Syntax

__property String SSLCertVersion = { read=FSSLCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (Check21 Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (Check21 Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLProvider Property (Check21 Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

__property TibpCheck21SSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TibpCheck21SSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.

Data Type

Integer

SSLServerCertEffectiveDate Property (Check21 Component)

The date on which this certificate becomes valid.

Syntax

__property String SSLServerCertEffectiveDate = { read=FSSLServerCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (Check21 Component)

The date on which the certificate expires.

Syntax

__property String SSLServerCertExpirationDate = { read=FSSLServerCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (Check21 Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSLServerCertExtendedKeyUsage = { read=FSSLServerCertExtendedKeyUsage };

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (Check21 Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SSLServerCertFingerprint = { read=FSSLServerCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (Check21 Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SSLServerCertFingerprintSHA1 = { read=FSSLServerCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (Check21 Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SSLServerCertFingerprintSHA256 = { read=FSSLServerCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (Check21 Component)

The issuer of the certificate.

Syntax

__property String SSLServerCertIssuer = { read=FSSLServerCertIssuer };

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (Check21 Component)

The private key of the certificate (if available).

Syntax

__property String SSLServerCertPrivateKey = { read=FSSLServerCertPrivateKey };

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (Check21 Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSLServerCertPrivateKeyAvailable = { read=FSSLServerCertPrivateKeyAvailable };

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (Check21 Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SSLServerCertPrivateKeyContainer = { read=FSSLServerCertPrivateKeyContainer };

Default Value

""

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (Check21 Component)

The public key of the certificate.

Syntax

__property String SSLServerCertPublicKey = { read=FSSLServerCertPublicKey };

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (Check21 Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SSLServerCertPublicKeyAlgorithm = { read=FSSLServerCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (Check21 Component)

The length of the certificate's public key (in bits).

Syntax

__property int SSLServerCertPublicKeyLength = { read=FSSLServerCertPublicKeyLength };

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (Check21 Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSLServerCertSerialNumber = { read=FSSLServerCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (Check21 Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSLServerCertSignatureAlgorithm = { read=FSSLServerCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (Check21 Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSLServerCertStore = { read=FSSLServerCertStore };
__property DynamicArray<Byte> SSLServerCertStoreB = { read=FSSLServerCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Byte Array

SSLServerCertStorePassword Property (Check21 Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SSLServerCertStorePassword = { read=FSSLServerCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (Check21 Component)

The type of certificate store for this certificate.

Syntax

__property TibpCheck21SSLServerCertStoreTypes SSLServerCertStoreType = { read=FSSLServerCertStoreType };

enum TibpCheck21SSLServerCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (Check21 Component)

Comma-separated lists of alternative subject names for the certificate.

Syntax

__property String SSLServerCertSubjectAltNames = { read=FSSLServerCertSubjectAltNames };

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (Check21 Component)

The MD5 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintMD5 = { read=FSSLServerCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (Check21 Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintSHA1 = { read=FSSLServerCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (Check21 Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSLServerCertThumbprintSHA256 = { read=FSSLServerCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (Check21 Component)

The text description of UsageFlags .

Syntax

__property String SSLServerCertUsage = { read=FSSLServerCertUsage };

Default Value

""

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (Check21 Component)

The flags that show intended use for the certificate.

Syntax

__property int SSLServerCertUsageFlags = { read=FSSLServerCertUsageFlags };

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (Check21 Component)

The certificate's version number.

Syntax

__property String SSLServerCertVersion = { read=FSSLServerCertVersion };

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (Check21 Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSLServerCertSubject = { read=FSSLServerCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (Check21 Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Byte Array

SSLStartMode Property (Check21 Component)

This property determines how the component starts the Secure Sockets Layer (SSL) negotiation.

Syntax

__property TibpCheck21SSLStartModes SSLStartMode = { read=FSSLStartMode, write=FSetSSLStartMode };

enum TibpCheck21SSLStartModes {
  sslAutomatic=0,
  sslImplicit=1,
  sslExplicit=2,
  sslNone=3
};

Default Value

sslNone

Remarks

The SSLStartMode property may have one of the following values:

Data Type

Integer

BuildAndUploadFile Method (Check21 Component)

Builds an X9.37 file and uploads it to an FTP server.

Syntax

void __fastcall BuildAndUploadFile();

Remarks

This method builds a complete X9.37 file and uploads it to the server specified in the FTPRemoteHost property. If an FileName is specified, it will be saved on the local disc as well. If FileName contains only a path (FileName must terminate in a "/" or "\"), that path will be used to create a temporary file which will be deleted after the upload. If FileName is empty, the system temp directory will be used for creating the temporary file.

An X9.37 file created by this component 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)

BuildFile Method (Check21 Component)

Builds an X9.37 file.

Syntax

void __fastcall BuildFile();

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 component 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)

Config Method (Check21 Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoEvents Method (Check21 Component)

This method processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (Check21 Component)

This method interrupts the current method.

Syntax

void __fastcall Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Reset Method (Check21 Component)

Reset the internal state of the component and all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

The Reset method doesn't have any parameters and doesn't return any value.

Error Event (Check21 Component)

Information about non-fatal errors encountered during file construction.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibpCheck21ErrorEventParams;
typedef void __fastcall (__closure *TibpCheck21ErrorEvent)(System::TObject* Sender, TibpCheck21ErrorEventParams *e);
__property TibpCheck21ErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired to warn the user that it may be operating differently than the user expects. For instance, if the CollectionType is set to ctNoDetail, but check detail records are provided in the Checks array properties the component will fire this event indicating that the specified Checks were ignored.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (Check21 Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibpCheck21SSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibpCheck21SSLServerAuthenticationEvent)(System::TObject* Sender, TibpCheck21SSLServerAuthenticationEventParams *e);
__property TibpCheck21SSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Check21 Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TibpCheck21SSLStatusEventParams;
typedef void __fastcall (__closure *TibpCheck21SSLStatusEvent)(System::TObject* Sender, TibpCheck21SSLStatusEventParams *e);
__property TibpCheck21SSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Status Event (Check21 Component)

Traces the commands sent to the server, and the respective replies.

Syntax

typedef struct {
  String Message;
} TibpCheck21StatusEventParams;
typedef void __fastcall (__closure *TibpCheck21StatusEvent)(System::TObject* Sender, TibpCheck21StatusEventParams *e);
__property TibpCheck21StatusEvent OnStatus = { read=FOnStatus, write=FOnStatus };

Remarks

The Status event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line.

Config Settings (Check21 Component)

The component 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 component, access to these internal properties is provided through the Config method.

Check21 Config Settings

Base Config Settings

Trappable Errors (Check21 Component)

Check21 Errors

The component may also return one of the following error codes, which are inherited from other components.