GlobalBatchMgr Component

Properties   Methods   Events   Config Settings   Errors  

The GlobalBatchMgr component is used to manage your Global Transport account. It can be used to check the connection to the Server , verify your merchant setup, retrieve a summary of transactions in the current batch, and capture (settle) the current batch.

Syntax

TibcGlobalBatchMgr

Remarks

This component offers four different services:

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.

BatchResponseApprovalCode Property (GlobalBatchMgr Component)

Contains the transaction authorization code from the card issuer.

Syntax

__property String BatchResponseApprovalCode = { read=FBatchResponseApprovalCode };

Default Value

""

Remarks

Contains the transaction authorization code from the card issuer.

For approved transaction responses (BatchResponseCode 0 or 200) the Global Transport Gateway sends a 6-character approval code in the BatchResponseApprovalCode property and a human-readable approval message in the BatchResponseMessage property. In the case of a decline, the BatchResponseApprovalCode will contain an error message. Your application should display the BatchResponseApprovalCode as part of the approval message for an approved transaction. For declined responses, the BatchResponseHostCode property will contain an additional code that provides detail on the reason for the decline.

After a call to CheckConnection this property will contain "OK" if everything is okay. If not, the BatchResponseCode, BatchResponseMessage, and BatchResponseMessageDetail will indicate the problem. For batch settlement responses it will contain the approval code. For all other transaction responses BatchResponseApprovalCode will remain empty.

This property is read-only.

Data Type

String

BatchResponseBatchNumber Property (GlobalBatchMgr Component)

Indicates the number of the current batch.

Syntax

__property String BatchResponseBatchNumber = { read=FBatchResponseBatchNumber };

Default Value

""

Remarks

Indicates the number of the current batch.

If this is a response to a BatchInquiry transaction, this property will contain the number of the current open batch. If in response to a CaptureAll transaction this property will contain the number of the batch that was just closed.

This property is read-only.

Data Type

String

BatchResponseCode Property (GlobalBatchMgr Component)

Contains the transaction result code from the Global Transport Gateway.

Syntax

__property String BatchResponseCode = { read=FBatchResponseCode };

Default Value

""

Remarks

Contains the transaction result code from the Global Transport Gateway. This value signifies the result of the transaction (i.e. approved, declined, etc). When programmatically validating a transaction's result, this value should ALWAYS be used instead of any response message describing the result. See the table below for a full list of result codes and descriptions.

A Partial Authorization transaction occurs when the issuer authorizes part of the sale amount on a pre-paid credit card. The transaction is approved for an amount less than the original TransactionAmount, and the customer must tender the remaining balance with another form of payment. When a transaction is partially approved, the BatchResponseCode will contain "200", the BatchResponseMessage will contain "Partial Approval", and the BatchResponseMessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the BatchResponseAuthorizedAmount will contain the amount of the transaction that was authorized, and the BatchResponseBalanceDue property will indicate the amount still owed by the customer.

If a partial authorization occurs and the customer does not wish to go through with the transaction, you must submit a reversal of the authorization in order to return funds to the prepaid card.

This property is read-only.

Data Type

String

BatchResponseMessage Property (GlobalBatchMgr Component)

Contains a human-readable response message concerning the processed transaction.

Syntax

__property String BatchResponseMessage = { read=FBatchResponseMessage };

Default Value

""

Remarks

Contains a human-readable response message concerning the processed transaction.

This value is typically either Approved or Declined, but may also contain a description of any error condition. Do NOT use this when programmatically validating a transaction's result; use the BatchResponseCode property instead.

This property is read-only.

Data Type

String

BatchResponseMessageDetail Property (GlobalBatchMgr Component)

Contains a formatted response message concerning the processed transaction.

Syntax

__property String BatchResponseMessageDetail = { read=FBatchResponseMessageDetail };

Default Value

""

Remarks

Contains a formatted response message concerning the processed transaction. This property will contain an additional message about the results of the transaction, providing more detail than the BatchResponseMessage property alone. For approved transactions this property will typically be "APPROVAL", and for declined transactions will contain a detailed error message. Do NOT use this when programmatically validating a transaction's result; Use the BatchResponseCode property instead.

Note: For Debit Card Sales and Refund, the string value in BatchResponseMessageDetail includes non-printable characters. Global Transport removes all non-printable characters from the returned BatchResponseMessageDetail.

This property is read-only.

Data Type

String

BatchResponseNetTransAmount Property (GlobalBatchMgr Component)

The net dollar amount of all transactions.

Syntax

__property String BatchResponseNetTransAmount = { read=FBatchResponseNetTransAmount };

Default Value

""

Remarks

The net dollar amount of all transactions.

This is the total transaction amount of the settlement, minus all refunds. If positive it indicates a payment to the merchant. If negative it means more refunds than sales were contained in the batch, and the merchant will be charged. Note that a void transaction DOES count towards the total BatchResponseNetTransAmount, but a Refund or Credit subtracts from it.

For instance, a batch containing one $10 transaction and one $10 void will have a BatchResponseNetTransAmount of "20.00". However, a batch containing one $10 transaction and one $3 refund will have a BatchResponseNetTransAmount of "7.00". In either case, the BatchResponseNetTransCount will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

BatchResponseNetTransCount Property (GlobalBatchMgr Component)

This property contains the total number of transactions contained in the batch settlement.

Syntax

__property int BatchResponseNetTransCount = { read=FBatchResponseNetTransCount };

Default Value

0

Remarks

This property contains the total number of transactions contained in the batch settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).

This property is read-only.

Data Type

Integer

BatchResponseSettleDate Property (GlobalBatchMgr Component)

The date the batch was settled.

Syntax

__property String BatchResponseSettleDate = { read=FBatchResponseSettleDate };

Default Value

""

Remarks

The date the batch was settled. This date property is in the format "YYYY-MM-DD HH:MM:SS"

This property is read-only.

Data Type

String

BenefitTransNetAmount Property (GlobalBatchMgr Component)

The net dollar amount of all transactions of a particular transaction type.

Syntax

__property String BenefitTransNetAmount = { read=FBenefitTransNetAmount };

Default Value

""

Remarks

The net dollar amount of all transactions of a particular transaction type.

This is the total amount of all the transactions (for this transaction type) in the settlement - including sales, voids, captures, and forces - minus all refunds/credits. If positive it indicates net payment to the merchant. If negative it means more refunds than sales were contained in the batch, and a net loss for the merchant. Note that a Void transaction DOES count towards the total BenefitTransNetAmount, but a Refund or Credit transaction subtracts from it.

For instance, a batch containing one $10 Charge and one $10 Void of this type will have a BenefitTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a BenefitTransNetAmount of "7.00". In either case, the BenefitTransNetCount will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

BenefitTransNetCount Property (GlobalBatchMgr Component)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

__property int BenefitTransNetCount = { read=FBenefitTransNetCount };

Default Value

0

Remarks

This property contains the total number of transactions (for this transaction type) in the settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).

This property is read-only.

Data Type

Integer

BenefitTransRefundAmount Property (GlobalBatchMgr Component)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

__property String BenefitTransRefundAmount = { read=FBenefitTransRefundAmount };

Default Value

""

Remarks

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

BenefitTransRefundCount Property (GlobalBatchMgr Component)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

__property int BenefitTransRefundCount = { read=FBenefitTransRefundCount };

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

BenefitTransSaleAmount Property (GlobalBatchMgr Component)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

__property String BenefitTransSaleAmount = { read=FBenefitTransSaleAmount };

Default Value

""

Remarks

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

BenefitTransSaleCount Property (GlobalBatchMgr Component)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

__property int BenefitTransSaleCount = { read=FBenefitTransSaleCount };

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CheckTransNetAmount Property (GlobalBatchMgr Component)

The net dollar amount of all transactions of a particular transaction type.

Syntax

__property String CheckTransNetAmount = { read=FCheckTransNetAmount };

Default Value

""

Remarks

The net dollar amount of all transactions of a particular transaction type.

This is the total amount of all the transactions (for this transaction type) in the settlement - including sales, voids, captures, and forces - minus all refunds/credits. If positive it indicates net payment to the merchant. If negative it means more refunds than sales were contained in the batch, and a net loss for the merchant. Note that a Void transaction DOES count towards the total CheckTransNetAmount, but a Refund or Credit transaction subtracts from it.

For instance, a batch containing one $10 Charge and one $10 Void of this type will have a CheckTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a CheckTransNetAmount of "7.00". In either case, the CheckTransNetCount will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CheckTransNetCount Property (GlobalBatchMgr Component)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

__property int CheckTransNetCount = { read=FCheckTransNetCount };

Default Value

0

Remarks

This property contains the total number of transactions (for this transaction type) in the settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).

This property is read-only.

Data Type

Integer

CheckTransRefundAmount Property (GlobalBatchMgr Component)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

__property String CheckTransRefundAmount = { read=FCheckTransRefundAmount };

Default Value

""

Remarks

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CheckTransRefundCount Property (GlobalBatchMgr Component)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

__property int CheckTransRefundCount = { read=FCheckTransRefundCount };

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CheckTransSaleAmount Property (GlobalBatchMgr Component)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

__property String CheckTransSaleAmount = { read=FCheckTransSaleAmount };

Default Value

""

Remarks

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CheckTransSaleCount Property (GlobalBatchMgr Component)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

__property int CheckTransSaleCount = { read=FCheckTransSaleCount };

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CreditTransNetAmount Property (GlobalBatchMgr Component)

The net dollar amount of all transactions of a particular transaction type.

Syntax

__property String CreditTransNetAmount = { read=FCreditTransNetAmount };

Default Value

""

Remarks

The net dollar amount of all transactions of a particular transaction type.

This is the total amount of all the transactions (for this transaction type) in the settlement - including sales, voids, captures, and forces - minus all refunds/credits. If positive it indicates net payment to the merchant. If negative it means more refunds than sales were contained in the batch, and a net loss for the merchant. Note that a Void transaction DOES count towards the total CreditTransNetAmount, but a Refund or Credit transaction subtracts from it.

For instance, a batch containing one $10 Charge and one $10 Void of this type will have a CreditTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a CreditTransNetAmount of "7.00". In either case, the CreditTransNetCount will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CreditTransNetCount Property (GlobalBatchMgr Component)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

__property int CreditTransNetCount = { read=FCreditTransNetCount };

Default Value

0

Remarks

This property contains the total number of transactions (for this transaction type) in the settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).

This property is read-only.

Data Type

Integer

CreditTransRefundAmount Property (GlobalBatchMgr Component)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

__property String CreditTransRefundAmount = { read=FCreditTransRefundAmount };

Default Value

""

Remarks

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CreditTransRefundCount Property (GlobalBatchMgr Component)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

__property int CreditTransRefundCount = { read=FCreditTransRefundCount };

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CreditTransSaleAmount Property (GlobalBatchMgr Component)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

__property String CreditTransSaleAmount = { read=FCreditTransSaleAmount };

Default Value

""

Remarks

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CreditTransSaleCount Property (GlobalBatchMgr Component)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

__property int CreditTransSaleCount = { read=FCreditTransSaleCount };

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

DebitTransNetAmount Property (GlobalBatchMgr Component)

The net dollar amount of all transactions of a particular transaction type.

Syntax

__property String DebitTransNetAmount = { read=FDebitTransNetAmount };

Default Value

""

Remarks

The net dollar amount of all transactions of a particular transaction type.

This is the total amount of all the transactions (for this transaction type) in the settlement - including sales, voids, captures, and forces - minus all refunds/credits. If positive it indicates net payment to the merchant. If negative it means more refunds than sales were contained in the batch, and a net loss for the merchant. Note that a Void transaction DOES count towards the total DebitTransNetAmount, but a Refund or Credit transaction subtracts from it.

For instance, a batch containing one $10 Charge and one $10 Void of this type will have a DebitTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a DebitTransNetAmount of "7.00". In either case, the DebitTransNetCount will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

DebitTransNetCount Property (GlobalBatchMgr Component)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

__property int DebitTransNetCount = { read=FDebitTransNetCount };

Default Value

0

Remarks

This property contains the total number of transactions (for this transaction type) in the settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).

This property is read-only.

Data Type

Integer

DebitTransRefundAmount Property (GlobalBatchMgr Component)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

__property String DebitTransRefundAmount = { read=FDebitTransRefundAmount };

Default Value

""

Remarks

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

DebitTransRefundCount Property (GlobalBatchMgr Component)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

__property int DebitTransRefundCount = { read=FDebitTransRefundCount };

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

DebitTransSaleAmount Property (GlobalBatchMgr Component)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

__property String DebitTransSaleAmount = { read=FDebitTransSaleAmount };

Default Value

""

Remarks

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

DebitTransSaleCount Property (GlobalBatchMgr Component)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

__property int DebitTransSaleCount = { read=FDebitTransSaleCount };

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

ForceClose Property (GlobalBatchMgr Component)

Forces a batch Capture even if there are mismatched transaction totals.

Syntax

__property bool ForceClose = { read=FForceClose, write=FSetForceClose };

Default Value

false

Remarks

Calling CaptureAll with ForceClose set to True will settle all transactions for all payment types in the current batch regardless of whether the totals match with the Global Payments server (which can happen if there are timeouts or discrepancies based on other connectivity issues). This function should only be used when the merchant's account is setup for "merchant-initiated" close on the Global Payments server and if a normal CaptureAll batch close request fails with a "MUST BALANCE NOW" response.

Data Type

Boolean

InquiryType Property (GlobalBatchMgr Component)

Indicates whether to perform an inquiry on the current batch or on the previous batch.

Syntax

__property TibcGlobalBatchMgrInquiryTypes InquiryType = { read=FInquiryType, write=FSetInquiryType };

enum TibcGlobalBatchMgrInquiryTypes {
  itCurrentBatch=0,
  itPreviousBatch=1
};

Default Value

itCurrentBatch

Remarks

This property is used by the BatchInquiry method to indicate whether you wish to retrieve results for the current open batch, or for the most recently closed batch. This property is not applicable for the GetBatchSummary method.

Data Type

Integer

Password Property (GlobalBatchMgr Component)

Password for authentication with the Global Payments Server .

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

ProxyAuthScheme Property (GlobalBatchMgr Component)

The type of authorization to perform when connecting to the proxy.

Syntax

__property TibcGlobalBatchMgrProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TibcGlobalBatchMgrProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (GlobalBatchMgr Component)

Whether to automatically detect and use proxy system settings, if available.

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (GlobalBatchMgr Component)

A password if authentication is to be used for the proxy.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (GlobalBatchMgr Component)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (GlobalBatchMgr Component)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (GlobalBatchMgr Component)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

__property TibcGlobalBatchMgrProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TibcGlobalBatchMgrProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (GlobalBatchMgr Component)

A username if authentication is to be used for the proxy.

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

Server Property (GlobalBatchMgr Component)

Global Payments transaction server.

Syntax

__property String Server = { read=FServer, write=FSetServer };

Default Value

"https://api.globalpay.com"

Remarks

This is the server to which all transactions are sent. The live URL for Global Payments is "https://api.globalpay.com". For testing and certification purposes you may set this to the test server located at "https://certapia.globalpay.com" instead.

Data Type

String

SetupFieldCount Property (GlobalBatchMgr Component)

The number of records in the SetupField arrays.

Syntax

__property int SetupFieldCount = { read=FSetupFieldCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SetupFieldName
• SetupFieldValue

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

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

Data Type

Integer

SetupFieldName Property (GlobalBatchMgr Component)

Contains the name of a property returned by Global Payments, which reflects the current state of the merchant setup.

Syntax

__property String SetupFieldName[int SetupFieldIndex] = { read=FSetupFieldName };

Default Value

""

Remarks

Contains the name of a field returned by Global Payments, which reflects the current state of the merchant setup.

The SetupFieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SetupFieldCount property.

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

Data Type

String

SetupFieldValue Property (GlobalBatchMgr Component)

Contains the value of a property returned by Global Payments, which reflects the current state of the merchant setup.

Syntax

__property String SetupFieldValue[int SetupFieldIndex] = { read=FSetupFieldValue };

Default Value

""

Remarks

Contains the value of a field returned by Global Payments, which reflects the current state of the merchant setup.

The SetupFieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SetupFieldCount property.

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

Data Type

String

SSLAcceptServerCertEffectiveDate Property (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr Component)

The type of certificate store for this certificate.

Syntax

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

enum TibcGlobalBatchMgrSSLAcceptServerCertStoreTypes {
  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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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=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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr Component)

The type of certificate store for this certificate.

Syntax

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

enum TibcGlobalBatchMgrSSLCertStoreTypes {
  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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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=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 (GlobalBatchMgr 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 (GlobalBatchMgr Component)

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

Syntax

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

enum TibcGlobalBatchMgrSSLProviders {
  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:

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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr Component)

The type of certificate store for this certificate.

Syntax

__property TibcGlobalBatchMgrSSLServerCertStoreTypes SSLServerCertStoreType = { read=FSSLServerCertStoreType };

enum TibcGlobalBatchMgrSSLServerCertStoreTypes {
  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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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 (GlobalBatchMgr 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=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 (GlobalBatchMgr 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

SummaryBeginDate Property (GlobalBatchMgr Component)

Optional filter for use when retrieving a batch summary.

Syntax

__property String SummaryBeginDate = { read=FSummaryBeginDate, write=FSetSummaryBeginDate };

Default Value

""

Remarks

The begin date of the date range may be entered in "MM/DD/YYYY" format if you wish. This date will be converted by the Global system to: "MM/DD/YYYYT00:00:00:0000AM."

Data Type

String

SummaryEndDate Property (GlobalBatchMgr Component)

Optional filter for use when retrieving a batch summary.

Syntax

__property String SummaryEndDate = { read=FSummaryEndDate, write=FSetSummaryEndDate };

Default Value

""

Remarks

The end date of the date range may be entered in "MM/DD/YYYY" format if you wish. This date will be converted by the Global system to "MM/DD/YYYYT12:59:59:9999PM".

Data Type

String

SummaryResultCount Property (GlobalBatchMgr Component)

The number of records in the SummaryResult arrays.

Syntax

__property int SummaryResultCount = { read=FSummaryResultCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SummaryResultAuthorizationAmount
• SummaryResultAuthorizationCount
• SummaryResultCaptureAmount
• SummaryResultCaptureCount
• SummaryResultForceCaptureAmount
• SummaryResultForceCaptureCount
• SummaryResultPaymentType
• SummaryResultPostAuthAmount
• SummaryResultPostAuthCount
• SummaryResultRefundAmount
• SummaryResultRefundCount
• SummaryResultRepeatSaleAmount
• SummaryResultRepeatSaleCount
• SummaryResultSaleAmount
• SummaryResultSaleCount
• SummaryResultTotalCount

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

SummaryResultAuthorizationAmount Property (GlobalBatchMgr Component)

Contains the dollar amount authorized for all transactions for the indicated PaymentType .

Syntax

__property String SummaryResultAuthorizationAmount[int SummaryIndex] = { read=FSummaryResultAuthorizationAmount };

Default Value

""

Remarks

Contains the dollar amount authorized for all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultAuthorizationCount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultAuthorizationCount[int SummaryIndex] = { read=FSummaryResultAuthorizationCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Authorization-only transactions for the indicated SummaryResultPaymentType. Auth-only transactions are also known as preauth transactions.

The SummaryIndex 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

SummaryResultCaptureAmount Property (GlobalBatchMgr Component)

Contains the dollar amount captured for all transactions for the indicated PaymentType .

Syntax

__property String SummaryResultCaptureAmount[int SummaryIndex] = { read=FSummaryResultCaptureAmount };

Default Value

""

Remarks

Contains the dollar amount captured for all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultCaptureCount Property (GlobalBatchMgr Component)

Contains the transaction count of all transactions that have been settled for the indicated PaymentType .

Syntax

__property int SummaryResultCaptureCount[int SummaryIndex] = { read=FSummaryResultCaptureCount };

Default Value

0

Remarks

Contains the transaction count of all transactions that have been settled for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultForceCaptureAmount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SummaryResultForceCaptureAmount[int SummaryIndex] = { read=FSummaryResultForceCaptureAmount };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Force transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultForceCaptureCount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultForceCaptureCount[int SummaryIndex] = { read=FSummaryResultForceCaptureCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Force transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultPaymentType Property (GlobalBatchMgr Component)

The type of transactions being summarized.

Syntax

__property String SummaryResultPaymentType[int SummaryIndex] = { read=FSummaryResultPaymentType };

Default Value

""

Remarks

The type of transactions being summarized.

This field varies based on the value specified via SearchCriteriaCardBreakdown. When set to 'False', PaymentType will be set to transaction type returned in the response such as "Sale", "Return", "Force", etc.

When set to 'True', PaymentType will be set to the card and transaction type returned in the response and separated by " - " such as "VISA - Force", "MasterCard - Return", "Discover - Sale", etc.

The SummaryIndex 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

SummaryResultPostAuthAmount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SummaryResultPostAuthAmount[int SummaryIndex] = { read=FSummaryResultPostAuthAmount };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all PreAuth Complete (Capture) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultPostAuthCount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultPostAuthCount[int SummaryIndex] = { read=FSummaryResultPostAuthCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all PreAuth Complete (Capture) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultRefundAmount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SummaryResultRefundAmount[int SummaryIndex] = { read=FSummaryResultRefundAmount };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Refund and Credit transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultRefundCount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultRefundCount[int SummaryIndex] = { read=FSummaryResultRefundCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Refund and Credit transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultRepeatSaleAmount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SummaryResultRepeatSaleAmount[int SummaryIndex] = { read=FSummaryResultRepeatSaleAmount };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all RepeatSale (Recurring Billing) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultRepeatSaleCount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultRepeatSaleCount[int SummaryIndex] = { read=FSummaryResultRepeatSaleCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all RepeatSale (Recurring Billing) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultSaleAmount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property String SummaryResultSaleAmount[int SummaryIndex] = { read=FSummaryResultSaleAmount };

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Sale transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultSaleCount Property (GlobalBatchMgr Component)

* No longer supported as the underlying Global API has changed.

Syntax

__property int SummaryResultSaleCount[int SummaryIndex] = { read=FSummaryResultSaleCount };

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Sale transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

SummaryResultTotalCount Property (GlobalBatchMgr Component)

Contains the total count of all transactions for the indicated PaymentType .

Syntax

__property int SummaryResultTotalCount[int SummaryIndex] = { read=FSummaryResultTotalCount };

Default Value

0

Remarks

Contains the total count of all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex 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

Timeout Property (GlobalBatchMgr Component)

The timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UserId Property (GlobalBatchMgr Component)

UserId for authentication with the Global Payments Server .

Syntax

__property String UserId = { read=FUserId, write=FSetUserId };

Default Value

""

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

VendorNumber Property (GlobalBatchMgr Component)

The merchant's RP/Vendor number.

Syntax

__property String VendorNumber = { read=FVendorNumber, write=FSetVendorNumber };

Default Value

""

Remarks

The Vendor number is also known as the "RP Number" or "RPNum", and is required by the GetBatchSummary method to retrieve information about transactions in the current open batch. If you do not know your Vendor/RPNum you may log into your Global Payments virtual terminal, or simply use the CheckSetup method to find it.

Data Type

String

BatchInquiry Method (GlobalBatchMgr Component)

Retrieves the current state of the open batch.

Syntax

void __fastcall BatchInquiry();

Remarks

A batch inquiry will provide the host batch totals to the Point Of Sale (POS). If the POS and the Host are out of balance, discrepancies can be corrected (using the virtual terminal or GlobalTransactionSearch component) prior to the batch being captured. A batch inquiry will not release the batch for settlement. Use the CaptureAll method or Global Payments' online merchant interface to settle the batch.

The results of a batch inquiry will be returned in the BatchResponse property, and transaction totals will be contained in the CreditTransactions, DebitTransactions, BenefitTransactions, and CheckTransactions properties. To inquire about the most recent closed batch (instead of the current open batch), set the InquiryType property to itPreviousBatch.

CaptureAll Method (GlobalBatchMgr Component)

Marks the current batch for settlement.

Syntax

void __fastcall CaptureAll();

Remarks

This operation will settle all transactions for all payment types in the current batch. This function should only be used when the merchant's account is setup for "merchant-initiated" close on the Global Payments server. The results of the CaptureAll will be returned in the BatchResponse property, and any transaction totals that may be returned will be contained in the CreditTransactions, DebitTransactions, BenefitTransactions, and CheckTransactions properties.

CheckConnection Method (GlobalBatchMgr Component)

Checks the connection status to the Global Payments server and validates login information.

Syntax

void __fastcall CheckConnection();

Remarks

Returns "OK" in the BatchResponseApprovalCode property if a connection can be made to the Global Transport Gateway with the supplied UserId and Password otherwise the BatchResponseCode and BatchResponseMessage will indicate an error condition.

CheckSetup Method (GlobalBatchMgr Component)

Retrieves information about the merchant's current setup.

Syntax

void __fastcall CheckSetup();

Remarks

This method will return information relating to the merchant's current setup as name/value pairs. By default, the component returns detailed information about the merchant. if you wish for a simpler response, the SetupResultMode configuration setting can be used to switch between basic and advanced (default) result modes. In either case, results of the CheckSetup method call will be contained within the SetupFields property.

Config Method (GlobalBatchMgr 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.

GetBatchSummary Method (GlobalBatchMgr Component)

Retrieves a summary of the current open batch for a merchant.

Syntax

void __fastcall GetBatchSummary();

Remarks

* This method is no longer available as the underlying Global Transport API has changed. This method retrieves information about all of the transactions in the current open batch, and stores this information in the SummaryResults collection. The results will be separated by payment type ("MasterCard", "Visa", "DEBIT", etc.). You may optionally set a start and ending date to filter transactions with, using the SummaryBeginDate and SummaryEndDate properties.

To retrieve a summary of all transactions (even transactions that have already been settled) use the GlobalTransactionSearch component's GetTransactionSummary method instead.

Interrupt Method (GlobalBatchMgr 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 (GlobalBatchMgr Component)

Clears all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

This method clears all properties to their default values.

Error Event (GlobalBatchMgr Component)

Fired when information is available about errors during data delivery.

Syntax

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

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter 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 (GlobalBatchMgr 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;
} TibcGlobalBatchMgrSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibcGlobalBatchMgrSSLServerAuthenticationEvent)(System::TObject* Sender, TibcGlobalBatchMgrSSLServerAuthenticationEventParams *e);
__property TibcGlobalBatchMgrSSLServerAuthenticationEvent 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 (GlobalBatchMgr Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TibcGlobalBatchMgrSSLStatusEventParams;
typedef void __fastcall (__closure *TibcGlobalBatchMgrSSLStatusEvent)(System::TObject* Sender, TibcGlobalBatchMgrSSLStatusEventParams *e);
__property TibcGlobalBatchMgrSSLStatusEvent 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 (GlobalBatchMgr Component)

Shows the progress of the Global Payments connection.

Syntax

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

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (GlobalBatchMgr Component)

GlobalBatchMgr 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 (GlobalBatchMgr Component)

GlobalBatchMgr Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors