TSYSHCBatchMgr Control

Properties   Methods   Events   Config Settings   Errors  

The TSYSHCBatchMgr control is used to manually close batches as well as retrieve details and summaries about batches. This control makes closing batches very easy.

Syntax

TSYSHCBatchMgr

Remarks

This control allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This control can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the control, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

The TSYSHCBatchMgr control makes closing batches very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the control and authorizing a transaction are outlined below:

First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance:

TSYSHCBatchMgr1.GenKey = "gen_key_value" TSYSHCBatchMgr1.MerchantId = "merchant_id" TSYSHCBatchMgr1.RoutingId = "routing_id"

Next, set BatchNumber to the batch number you wish to close or retrieve details about.

TSYSHCBatchMgr1.BatchNumber = 1

Finally, submit the transaction by calling one of three authorization methods: CloseBatch, GetDetails, or GetSummary. The following code demonstrates closing a batch:

TSYSHCBatchMgr1.CloseBatch()

When the control receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode indicates whether the transaction was approved. The remaining properties provide additional information about the transaction.

Property List

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

Method List

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

Event List

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

Config Settings

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

BatchNumber Property (TSYSHCBatchMgr Control)

The batch number to close or retrieve details about.

Syntax

tsyshcbatchmgrcontrol.BatchNumber[=integer]

Default Value

0

Remarks

This property is used to specify the batch number that you want to retrieve details about (via GetDetails or GetSummary) or to manually close (via CloseBatch).

This property is required to be set in CloseBatch calls. However for GetDetails and GetSummary calls, if BatchNumber is not set the current open batch will be used.

Data Type

Integer

DetailResultCount Property (TSYSHCBatchMgr Control)

The number of records in the DetailResult arrays.

Syntax

tsyshcbatchmgrcontrol.DetailResultCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• DetailResultCardLast4
• DetailResultCardType
• DetailResultRetrievalNumber
• DetailResultSettlementAmount
• DetailResultTransactionAmount
• DetailResultTransactionNumber
• DetailResultTransactionType

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

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

Data Type

Integer

DetailResultCardLast4 Property (TSYSHCBatchMgr Control)

The last four (4) digits of the customer card number.

Syntax

tsyshcbatchmgrcontrol.DetailResultCardLast4(DetailResultIndex)

Default Value

""

Remarks

The last four (4) digits of the customer card number.

The DetailResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailResultCount property.

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

Data Type

String

DetailResultCardType Property (TSYSHCBatchMgr Control)

The type of card sent in the authorization request.

Syntax

tsyshcbatchmgrcontrol.DetailResultCardType(DetailResultIndex)

Default Value

""

Remarks

The type of card sent in the authorization request.

Possible values are:

• CHECK
• VISA
• MASTERCARD
• AMEX
• DISCOVER
• JCB
• PRIVATE LABEL
• GIFT CARD
• DEBIT
• EBT

The DetailResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailResultCount property.

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

Data Type

String

DetailResultRetrievalNumber Property (TSYSHCBatchMgr Control)

The Retrieval Reference Number from the transaction.

Syntax

tsyshcbatchmgrcontrol.DetailResultRetrievalNumber(DetailResultIndex)

Default Value

""

Remarks

The Retrieval Reference Number from the transaction.

The DetailResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailResultCount property.

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

Data Type

String

DetailResultSettlementAmount Property (TSYSHCBatchMgr Control)

This property contains the final settlement amount of the transaction.

Syntax

tsyshcbatchmgrcontrol.DetailResultSettlementAmount(DetailResultIndex)

Default Value

""

Remarks

This field contains the final settlement amount of the transaction. The decimal is implied.

The DetailResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailResultCount property.

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

Data Type

String

DetailResultTransactionAmount Property (TSYSHCBatchMgr Control)

The Transaction Amount from the transaction.

Syntax

tsyshcbatchmgrcontrol.DetailResultTransactionAmount(DetailResultIndex)

Default Value

""

Remarks

The Transaction Amount from the transaction.

The DetailResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailResultCount property.

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

Data Type

String

DetailResultTransactionNumber Property (TSYSHCBatchMgr Control)

This is the Transaction Original Number (TON) from the transaction.

Syntax

tsyshcbatchmgrcontrol.DetailResultTransactionNumber(DetailResultIndex)

Default Value

0

Remarks

This is the Transaction Original Number (TON) from the transaction.

The DetailResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailResultCount property.

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

Data Type

Integer

DetailResultTransactionType Property (TSYSHCBatchMgr Control)

The original authorization transaction type.

Syntax

tsyshcbatchmgrcontrol.DetailResultTransactionType(DetailResultIndex)

Possible Values

atUnknown(0), 
atSale(1), 
atCredit(2), 
atForce(3)

Default Value

0

Remarks

The original authorization transaction type.

This field provides you with the transaction type of the original authorization request (regardless of any adjustments, voids, or reversals performed).

Possible values are:

The DetailResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailResultCount property.

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

Data Type

Integer

GenKey Property (TSYSHCBatchMgr Control)

The unique GenKey value used to identify a POS device.

Syntax

tsyshcbatchmgrcontrol.GenKey[=string]

Default Value

""

Remarks

This property is used to specify the unique GenKey value used to identify the POS device to the host capture system. This property is required to be specified in every transaction performed.

Your GenKey value is obtained from the host capture system when you successfully authenticate your POS device, which can be accomplished by calling AuthenticateDevice. Once retrieved, your GenKey value must be stored in the POS device.

Data Type

String

MerchantId Property (TSYSHCBatchMgr Control)

The unique ID that associates the POS device with the merchant account.

Syntax

tsyshcbatchmgrcontrol.MerchantId[=string]

Default Value

""

Remarks

The unique ID, also known as the POS ID, that associates the POS device with the merchant account.

This property is required to be specified in every transaction performed.

Data Type

String

PendingTransactionCount Property (TSYSHCBatchMgr Control)

The number of transactions that will not be captured in the current batch.

Syntax

tsyshcbatchmgrcontrol.PendingTransactionCount

Default Value

0

Remarks

This property contains the number of transactions that will not be captured in the current batch because they are waiting for adjustment.

If they are adjusted before the current batch closes, they will be captured in the current batch. If they are not adjusted in the current batch, they will be captured in the next batch adjusted or not.

This property is read-only.

Data Type

Integer

ResponseBatchNumber Property (TSYSHCBatchMgr Control)

Contains the incrementing ID assigned by TSYS to identify a merchant batch.

Syntax

tsyshcbatchmgrcontrol.ResponseBatchNumber

Default Value

0

Remarks

Contains the incrementing ID assigned by TSYS to identify a merchant batch.

The batch number that is returned by the host is the current batch number. This will typically the same batch number used by TSYSHCBatchMgr to close the batch.

Note that if CaptureMode is set to Delay, Hold, or Capture the value here may not necessarily be the final batch number when captured. See CaptureMode for more details.

This property is read-only.

Data Type

Integer

ResponseCloseDate Property (TSYSHCBatchMgr Control)

The date that the batch was closed (in MMDDYY format).

Syntax

tsyshcbatchmgrcontrol.ResponseCloseDate

Default Value

""

Remarks

The date that the batch was closed (in MMDDYY format).

Note that this indicates when the batch close began, rather than when the batch close completed. The date is local based on the host-stored time zone differential. If this value is not available, the time will be in Pacific time.

This property is read-only.

Data Type

String

ResponseCloseTime Property (TSYSHCBatchMgr Control)

The time that the batch was closed (in HHMMSS format).

Syntax

tsyshcbatchmgrcontrol.ResponseCloseTime

Default Value

""

Remarks

The time that the batch was closed (in HHMMSS format).

Note that this indicates when the batch close began, rather than when the batch close completed. The time is local based on the host-stored time zone differential. If this value is not available, the time will be in Pacific time.

This property is read-only.

Data Type

String

ResponseCode Property (TSYSHCBatchMgr Control)

Indicates the status of the close batch request.

Syntax

tsyshcbatchmgrcontrol.ResponseCode

Default Value

""

Remarks

Indicates the status of the close batch request.

This property contains the response code indicating the status of a batch management request. The Point of Sale (POS) system must evaluate this response code and NOT the ResponseText to determine nature of a response message. A response code of "00" represents a successful request. All other response codes represent non-approved requests.

This property is read-only.

Data Type

String

ResponseStatus Property (TSYSHCBatchMgr Control)

The current status of the batch in an inquiry.

Syntax

tsyshcbatchmgrcontrol.ResponseStatus

Default Value

""

Remarks

The current status of the batch in an inquiry.

A value of "O" indicates that the batch is still open. A value of "C" indicates that the batch has been closed and sent on to the settlement system.

This property is read-only.

Data Type

String

ResponseText Property (TSYSHCBatchMgr Control)

Text information that describes each response code.

Syntax

tsyshcbatchmgrcontrol.ResponseText

Default Value

""

Remarks

Text information that describes each response code.

This property contains a 32-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language. The English-language response text messages are listed in the table of contents.

This property is read-only.

Data Type

String

RetrievalNumber Property (TSYSHCBatchMgr Control)

The retrieval reference number (RRN) used to identify a transaction.

Syntax

tsyshcbatchmgrcontrol.RetrievalNumber[=string]

Default Value

""

Remarks

This property is used to specify the retrieval reference number (RRN) for the transaction that you wish to retrieve or adjust. This value is used by the Host Capture system to identify the transaction.

Note either RetrievalNumber or TransactionNumber may be used to reference the transaction that is to be retrieved, adjusted or voided. If both are supplied, the RetrievalNumber will be used and the TransactionNumber ignored.

In the case of performing level 3 or settlement transactions, TransactionNumber is not supported and thus RetrievalNumber must be used to reference the transaction.

Data Type

String

RoutingId Property (TSYSHCBatchMgr Control)

The Routing ID assigned to the merchant by TSYS.

Syntax

tsyshcbatchmgrcontrol.RoutingId[=string]

Default Value

""

Remarks

This property is used to specify the six alphanumeric character routing ID assigned to you via TSYS.

This property is required to be set for every transaction request.

Data Type

String

SSLAcceptServerCertEffectiveDate Property (TSYSHCBatchMgr Control)

The date on which this certificate becomes valid.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertEffectiveDate

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 (TSYSHCBatchMgr Control)

The date on which the certificate expires.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertExpirationDate

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 (TSYSHCBatchMgr Control)

A comma-delimited list of extended key usage identifiers.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertExtendedKeyUsage

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertFingerprint

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertFingerprintSHA1

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertFingerprintSHA256

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 (TSYSHCBatchMgr Control)

The issuer of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertIssuer

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 (TSYSHCBatchMgr Control)

The private key of the certificate (if available).

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertPrivateKey

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 (TSYSHCBatchMgr Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertPrivateKeyAvailable

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertPrivateKeyContainer

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 (TSYSHCBatchMgr Control)

The public key of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertPublicKey

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertPublicKeyAlgorithm

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertPublicKeyLength

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 (TSYSHCBatchMgr Control)

The serial number of the certificate encoded as a string.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertSerialNumber

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 (TSYSHCBatchMgr Control)

The text description of the certificate's signature algorithm.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertSignatureAlgorithm

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 (TSYSHCBatchMgr Control)

The name of the certificate store for the client certificate.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertStore[=string]

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertStorePassword[=string]

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 (TSYSHCBatchMgr Control)

The type of certificate store for this certificate.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

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

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (TSYSHCBatchMgr Control)

The MD5 hash of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertThumbprintMD5

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 (TSYSHCBatchMgr Control)

The SHA-1 hash of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertThumbprintSHA1

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 (TSYSHCBatchMgr Control)

The SHA-256 hash of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertThumbprintSHA256

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 (TSYSHCBatchMgr Control)

The text description of UsageFlags .

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertUsage

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 (TSYSHCBatchMgr Control)

The flags that show intended use for the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertUsageFlags

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 (TSYSHCBatchMgr Control)

The certificate's version number.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertVersion

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 (TSYSHCBatchMgr Control)

The subject of the certificate used for client authentication.

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertSubject[=string]

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=example@email.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 (TSYSHCBatchMgr Control)

The certificate (PEM/Base64 encoded).

Syntax

tsyshcbatchmgrcontrol.SSLAcceptServerCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (TSYSHCBatchMgr Control)

The date on which this certificate becomes valid.

Syntax

tsyshcbatchmgrcontrol.SSLCertEffectiveDate

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 (TSYSHCBatchMgr Control)

The date on which the certificate expires.

Syntax

tsyshcbatchmgrcontrol.SSLCertExpirationDate

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 (TSYSHCBatchMgr Control)

A comma-delimited list of extended key usage identifiers.

Syntax

tsyshcbatchmgrcontrol.SSLCertExtendedKeyUsage

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLCertFingerprint

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLCertFingerprintSHA1

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLCertFingerprintSHA256

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 (TSYSHCBatchMgr Control)

The issuer of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLCertIssuer

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 (TSYSHCBatchMgr Control)

The private key of the certificate (if available).

Syntax

tsyshcbatchmgrcontrol.SSLCertPrivateKey

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 (TSYSHCBatchMgr Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

tsyshcbatchmgrcontrol.SSLCertPrivateKeyAvailable

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLCertPrivateKeyContainer

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 (TSYSHCBatchMgr Control)

The public key of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLCertPublicKey

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLCertPublicKeyAlgorithm

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLCertPublicKeyLength

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 (TSYSHCBatchMgr Control)

The serial number of the certificate encoded as a string.

Syntax

tsyshcbatchmgrcontrol.SSLCertSerialNumber

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 (TSYSHCBatchMgr Control)

The text description of the certificate's signature algorithm.

Syntax

tsyshcbatchmgrcontrol.SSLCertSignatureAlgorithm

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 (TSYSHCBatchMgr Control)

The name of the certificate store for the client certificate.

Syntax

tsyshcbatchmgrcontrol.SSLCertStore[=string]

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLCertStorePassword[=string]

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 (TSYSHCBatchMgr Control)

The type of certificate store for this certificate.

Syntax

tsyshcbatchmgrcontrol.SSLCertStoreType[=integer]

Possible Values

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

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (TSYSHCBatchMgr Control)

The MD5 hash of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLCertThumbprintMD5

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 (TSYSHCBatchMgr Control)

The SHA-1 hash of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLCertThumbprintSHA1

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 (TSYSHCBatchMgr Control)

The SHA-256 hash of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLCertThumbprintSHA256

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 (TSYSHCBatchMgr Control)

The text description of UsageFlags .

Syntax

tsyshcbatchmgrcontrol.SSLCertUsage

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 (TSYSHCBatchMgr Control)

The flags that show intended use for the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLCertUsageFlags

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 (TSYSHCBatchMgr Control)

The certificate's version number.

Syntax

tsyshcbatchmgrcontrol.SSLCertVersion

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 (TSYSHCBatchMgr Control)

The subject of the certificate used for client authentication.

Syntax

tsyshcbatchmgrcontrol.SSLCertSubject[=string]

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=example@email.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 (TSYSHCBatchMgr Control)

The certificate (PEM/Base64 encoded).

Syntax

tsyshcbatchmgrcontrol.SSLCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

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 control 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:

In most cases using the default value (Automatic) is recommended. The control 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 (TSYSHCBatchMgr Control)

The date on which this certificate becomes valid.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertEffectiveDate

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 (TSYSHCBatchMgr Control)

The date on which the certificate expires.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertExpirationDate

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 (TSYSHCBatchMgr Control)

A comma-delimited list of extended key usage identifiers.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertExtendedKeyUsage

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLServerCertFingerprint

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLServerCertFingerprintSHA1

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLServerCertFingerprintSHA256

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 (TSYSHCBatchMgr Control)

The issuer of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertIssuer

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 (TSYSHCBatchMgr Control)

The private key of the certificate (if available).

Syntax

tsyshcbatchmgrcontrol.SSLServerCertPrivateKey

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 (TSYSHCBatchMgr Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertPrivateKeyAvailable

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLServerCertPrivateKeyContainer

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 (TSYSHCBatchMgr Control)

The public key of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertPublicKey

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLServerCertPublicKeyAlgorithm

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 (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLServerCertPublicKeyLength

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 (TSYSHCBatchMgr Control)

The serial number of the certificate encoded as a string.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertSerialNumber

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 (TSYSHCBatchMgr Control)

The text description of the certificate's signature algorithm.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertSignatureAlgorithm

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 (TSYSHCBatchMgr Control)

The name of the certificate store for the client certificate.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertStore

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertStoreB.

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLServerCertStorePassword

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 (TSYSHCBatchMgr Control)

The type of certificate store for this certificate.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertStoreType

Possible Values

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

0

Remarks

The type of certificate store for this certificate.

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

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (TSYSHCBatchMgr Control)

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

Syntax

tsyshcbatchmgrcontrol.SSLServerCertSubjectAltNames

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (TSYSHCBatchMgr Control)

The MD5 hash of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertThumbprintMD5

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 (TSYSHCBatchMgr Control)

The SHA-1 hash of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertThumbprintSHA1

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 (TSYSHCBatchMgr Control)

The SHA-256 hash of the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertThumbprintSHA256

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 (TSYSHCBatchMgr Control)

The text description of UsageFlags .

Syntax

tsyshcbatchmgrcontrol.SSLServerCertUsage

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 (TSYSHCBatchMgr Control)

The flags that show intended use for the certificate.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertUsageFlags

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 (TSYSHCBatchMgr Control)

The certificate's version number.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertVersion

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 (TSYSHCBatchMgr Control)

The subject of the certificate used for client authentication.

Syntax

tsyshcbatchmgrcontrol.SSLServerCertSubject

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=example@email.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 (TSYSHCBatchMgr Control)

The certificate (PEM/Base64 encoded).

Syntax

tsyshcbatchmgrcontrol.SSLServerCertEncoded

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

SummaryResultCount Property (TSYSHCBatchMgr Control)

The number of records in the SummaryResult arrays.

Syntax

tsyshcbatchmgrcontrol.SummaryResultCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• SummaryResultNetAmount
• SummaryResultPurchaseCount
• SummaryResultRefundCount
• SummaryResultType

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

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

Data Type

Integer

SummaryResultNetAmount Property (TSYSHCBatchMgr Control)

This is the net amount total for the particular summary type in the batch.

Syntax

tsyshcbatchmgrcontrol.SummaryResultNetAmount(SummaryResultIndex)

Default Value

""

Remarks

This is the net amount total for the particular summary type in the batch. This will be the total transaction amount for all purchases (with voids and adjustments taken into account) minus refunds.

The SummaryResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

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

Data Type

String

SummaryResultPurchaseCount Property (TSYSHCBatchMgr Control)

The total count for the particular summary type of all purchases in the batch.

Syntax

tsyshcbatchmgrcontrol.SummaryResultPurchaseCount(SummaryResultIndex)

Default Value

0

Remarks

The total count for the particular summary type of all purchases in the batch.

The SummaryResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

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

Data Type

Integer

SummaryResultRefundCount Property (TSYSHCBatchMgr Control)

The total count for the particular summary type of all refunds in the batch.

Syntax

tsyshcbatchmgrcontrol.SummaryResultRefundCount(SummaryResultIndex)

Default Value

0

Remarks

The total count for the particular summary type of all refunds in the batch.

The SummaryResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

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

Data Type

Integer

SummaryResultType Property (TSYSHCBatchMgr Control)

This is the type of summary being provided in the Batch Summary Inquiry.

Syntax

tsyshcbatchmgrcontrol.SummaryResultType(SummaryResultIndex)

Default Value

""

Remarks

This is the type of summary being provided in the Batch Summary Inquiry. The following are current valid values, though this is to be considered a "free text" field.

The SummaryResultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

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

Data Type

String

Timeout Property (TSYSHCBatchMgr Control)

A timeout for the control.

Syntax

tsyshcbatchmgrcontrol.Timeout[=integer]

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the control will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

CloseBatch Method (TSYSHCBatchMgr Control)

Sends a batch close request.

Syntax

tsyshcbatchmgrcontrol.CloseBatch 

Remarks

This method allows you to manually close the batch specified by BatchNumber. If the batch close request was successful, the ResponseCode property will contain "00". Response will contain additional details about the close batch request.

Minimum required properties:

• GenKey
• MerchantId
• RoutingId
• BatchNumber

Config Method (TSYSHCBatchMgr Control)

Sets or retrieves a configuration setting.

Syntax

tsyshcbatchmgrcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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.

GetDetails Method (TSYSHCBatchMgr Control)

Sends a batch detail inquiry request.

Syntax

tsyshcbatchmgrcontrol.GetDetails 

Remarks

This method allows you to retrieve details for up to 5 transactions within the current batch. The transaction details can be retrieved via DetailResults and Response will contain details about the inquiry request.

You can specify the transactions you wish to retrieve details for by setting RetrievalNumber. When set, the transactions prior to the specified RetrievalNumber will be returned. Otherwise, the most recent transactions will be returned.

Minimum required properties:

• GenKey
• MerchantId
• RoutingId

BatchNumber can optionally be set to specify the batch you want to retrieve details for. If BatchNumber is not set, the current open batch will be used.

GetSummary Method (TSYSHCBatchMgr Control)

Sends a batch summary inquiry request.

Syntax

tsyshcbatchmgrcontrol.GetSummary 

Remarks

This method allows you to retrieve summary details about each type in the current batch. The summary details can be retrieved via SummaryResults and Response will contain details about the inquiry request.

Minimum required properties:

• GenKey
• MerchantId
• RoutingId

BatchNumber can optionally be set to specify the batch you want to retrieve details for. If BatchNumber is not set, the current open batch will be used.

Interrupt Method (TSYSHCBatchMgr Control)

Interrupts the current action.

Syntax

tsyshcbatchmgrcontrol.Interrupt 

Remarks

This method interrupts any processing that the control is currently executing.

Reset Method (TSYSHCBatchMgr Control)

Clears all properties to their default values.

Syntax

tsyshcbatchmgrcontrol.Reset 

Remarks

This method clears all properties to their default values.

Error Event (TSYSHCBatchMgr Control)

Information about errors during data delivery.

Syntax

Sub tsyshcbatchmgrcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing.

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 (TSYSHCBatchMgr Control)

Fired after the server presents its certificate to the client.

Syntax

Sub tsyshcbatchmgrcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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 (TSYSHCBatchMgr Control)

Fired when secure connection progress messages are available.

Syntax

Sub tsyshcbatchmgrcontrol_SSLStatus(Message As String)

Remarks

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

Config Settings (TSYSHCBatchMgr Control)

TSYSHCBatchMgr Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (TSYSHCBatchMgr Control)

TSYSHCBatchMgr Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors