FDMSOmahaBatchMgr Class

Properties   Methods   Events   Config Settings   Errors  

The FDMSOmahaBatchMgr class is used to close batches and also handles the sending of all offline transactions to the FDMS Host.

Syntax

FDMSOmahaBatchMgr

Remarks

This component allows for a connection to the FDMS Omaha platform via a VPN or PPP (dial-up) connection. This component can be integrated into web pages or stand-alone Point Of Sale applications.

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

First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance: FDMSOmahaBatchMgr.MerchantNumber = "123456789123456" FDMSOmahaBatchMgr.MerchantTerminalID = "XXX01" FDMSOmahaBatchMgr.DeviceId = "DID1" // Optional, Merchant-Assigned

Next, add all the detail records for the transactions you wish to settle in the batch. Note that all the added detail records must be transactions that are processed within the same batch that you wish to close. Below is an example of how to add a detail record to the OmahaBatchMgr component. FDMSOmahaBatchMgr.DetailRecordCount = 1; FDMSOmahaBatchMgr.DetailRecordAggregate[0] = FDMSOmahaRetail.GetDetailAggregate()

The BatchNumber and TransactionNumber should then be set. Note the BatchNumber should be the same value as all the transactions contained within the DetailRecords. The TransactionNumber specified must be 1 greater than the number of Credit Card transactions specified within DetailRecords and less than the last Debit/EBT Card TransactionNumber specified. See TransactionNumber for more specific information. FDMSOmahaBatchMgr.BatchNumber = 1 FDMSOmahaBatchMgr.TransactionNumber = 2

Finally the batch can be closed by calling CloseBatch. When CloseBatch is called, all the off-line transactions (Voids, Revisions, etc.) will be sent to the Host. After all the off-line transactions have been successfully sent, the batch close request will be sent. If the batch was successfully closed, ResponseSuccess will be 'True'. FDMSOmahaBatchMgr.CloseBatch()

Note it is possible that the Host may be out-of-balance with the Total Amount specified (which is calculated by the component based on the information contained within the DetailRecords). If such a case occurs, the Host may request an inquiry to synchronize all transactions (this request is sent after a batch close message is sent by the component). When the component receives this request, it will handle all inquiries and respond accordingly based on the request and information contained within DetailRecords. Once the host is in sync, the Host will send the close batch response and Response will be populated. ResponseSuccess will be true if the batch was successfully closed.

Property List


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

ApplicationIdIdentifies the merchant application to the Datawire System.
BatchNumberNumber identifying the batch (assigned by the POS device).
ClientRefUniquely identifies the transaction within the Datawire system.
DatawireIdIdentifies the merchant to the Datawire System.
DetailRecordCountThe number of records in the DetailRecord arrays.
DetailRecordAggregateSet this property with xml aggregates of the transactions you wish to settle.
DeviceIdPOS Device Identification.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the class binds.
MerchantNumberA unique number used to identify the merchant within the FDMS systems.
MerchantTerminalIDUsed to identify a unique terminal within a merchant location.
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a username if authentication is to be used for the proxy.
RemoteHostThis property includes the address of the remote host. Domain names are resolved to IP addresses.
RemotePortThis property includes the Transmission Control Protocol (TCP) port in the remote host.
ResponseBatchAmountThe total authorized amount for all Credit Card transactions in the batch.
ResponseBatchIDCode identifying batch to the Host.
ResponseBatchNumberNumber identifying the batch assigned by the POS device.
ResponseDebitBatchAmountThe total authorized amount for all Debit/EBT Card transactions in the batch.
ResponseDebitTextMessage from the Host describing the transaction in relation to Debit cards.
ResponseSuccessDetermines whether the transaction was successful.
ResponseTextMessage from the Host describing the transaction.
ResponseTransactionNumberNumber of the transaction in the batch as specified by the Point of Sale device.
SSLAcceptServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/Base64 encoded).
TimeoutA timeout for the class.
TransactionNumberThe transaction number for the current transaction.
URLLocation of the Datawire server to which transactions are sent.

Method List


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

CloseBatchSends a Close Batch request.
ConfigSets or retrieves a configuration setting.
DepositInquirySends a Deposit Inquiry request.
InterruptInterrupts the current action.
ResetClears all properties to their default values.

Event List


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

ConnectedThis event is fired immediately after a connection completes (or fails).
DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
DisconnectedThis event is fired when a connection is closed.
ErrorFired when information is available about errors during data delivery.
RevisionInquiryFired when a revision inquiry request is received from the host.
SpecificPollFired when a specific poll request is received from the host.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StatusShows the progress of the FDMS/Datawire connection.

Config Settings


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

CreditBatchAmountDollar-and-cent amount ($$$$$$.cc) of all the credit card transactions in the batch.
DebitBatchAmountTotal dollar-and-cent amount ($$$$$$.cc) of all the debit card transactions in the batch.
DebitBatchCountNumber of debit items in the batch.
TransportProtocolSpecifies the transport protocol to use to communicate with the FDMS Omaha server.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

ApplicationId Property (FDMSOmahaBatchMgr Class)

Identifies the merchant application to the Datawire System.

Syntax

ANSI (Cross Platform)
char* GetApplicationId();
int SetApplicationId(const char* lpszApplicationId); Unicode (Windows) LPWSTR GetApplicationId();
INT SetApplicationId(LPCWSTR lpszApplicationId);
char* dpaymentssdk_fdmsomahabatchmgr_getapplicationid(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setapplicationid(void* lpObj, const char* lpszApplicationId);
QString GetApplicationId();
int SetApplicationId(QString qsApplicationId);

Default Value

"NSOFTDIRECTPXML"

Remarks

The Application ID includes the Merchant's application name and version number. This property is used to identify the merchant application within the Datawire system, and may be validated along with the MerchantTerminalNumber and DatawireId as connection credentials.

The default value of this property is assigned to the 4D Payments FDMS Integrator, but you may be required to have a new ApplicationId assigned for the software you create with this class.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

Data Type

String

BatchNumber Property (FDMSOmahaBatchMgr Class)

Number identifying the batch (assigned by the POS device).

Syntax

ANSI (Cross Platform)
int GetBatchNumber();
int SetBatchNumber(int iBatchNumber); Unicode (Windows) INT GetBatchNumber();
INT SetBatchNumber(INT iBatchNumber);
int dpaymentssdk_fdmsomahabatchmgr_getbatchnumber(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setbatchnumber(void* lpObj, int iBatchNumber);
int GetBatchNumber();
int SetBatchNumber(int iBatchNumber);

Default Value

0

Remarks

This property is used to specify the number identifying the batch that the transaction will be processed in.

This is a consecutive numbering system assigned by the POS application that identifies a batch of transactions. The batch number must increment each time a batch is successfully closed. When the batch number reaches 9, it is the responsibility of the application to recycle the batch number to 0. The Host will allow a variety of sequencing of the batch number, but you cannot have the same batch number in consecutive batches. For example: The application can close batch 2 and open the next batch with number 5, but you cannot close batch 2 then re-open batch 2 without a different batch number in between. If you should receive a message of "INV BATCH SEQ", this usually indicates the current batch number is the same as the previous batch number closed or there is a batch still open on the Host and the application is trying to process a transaction with a different batch number. If a batch is left open for more than 45 days, (45 days from the open date, not last activity date), the system will automatically purge the batch and it will not be retrievable.

Valid values: 0-9

Data Type

Integer

ClientRef Property (FDMSOmahaBatchMgr Class)

Uniquely identifies the transaction within the Datawire system.

Syntax

ANSI (Cross Platform)
char* GetClientRef();
int SetClientRef(const char* lpszClientRef); Unicode (Windows) LPWSTR GetClientRef();
INT SetClientRef(LPCWSTR lpszClientRef);
char* dpaymentssdk_fdmsomahabatchmgr_getclientref(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setclientref(void* lpObj, const char* lpszClientRef);
QString GetClientRef();
int SetClientRef(QString qsClientRef);

Default Value

""

Remarks

The ClientRef (Client Reference Number) uniquely identifies the packet sent by the application to the Datawire system. This parameter stores some unique token of information, and is used to match the response to the initial request sent. For example, the client application could use a static counter that is increased with the each executed request.

The maximum length of this property is 14 alphanumeric characters.

The FDMS recommended format is "tttttttVnnnrrr" where ttttttt is a 7 digit transaction id, V is a constant, nnn is a 3 digit version number and rrr is a 3 digit revision number. The 6 digit version and revision number is typically static but unique for an application (Example: Version 2.5 = tttttttV002500).

The entire TransactionNumber must be unique within a 24 hour time period.

Note: If a value is not specified, the component will generate a value for you. The transaction id will be generated based on the current time (hour of day and minutes) along with the TransactionNumber specified. The version number is hard-coded based on the current library version which is 16.X.X (016XX0).

Data Type

String

DatawireId Property (FDMSOmahaBatchMgr Class)

Identifies the merchant to the Datawire System.

Syntax

ANSI (Cross Platform)
char* GetDatawireId();
int SetDatawireId(const char* lpszDatawireId); Unicode (Windows) LPWSTR GetDatawireId();
INT SetDatawireId(LPCWSTR lpszDatawireId);
char* dpaymentssdk_fdmsomahabatchmgr_getdatawireid(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setdatawireid(void* lpObj, const char* lpszDatawireId);
QString GetDatawireId();
int SetDatawireId(QString qsDatawireId);

Default Value

""

Remarks

The Datawire Id is a unique customer identifier generated by Datawire and returned to the client after successfully registering the merchant (using the FDMSRegister class). This Id (which is sent in all subsequent transactions) allows a transaction, to pass through the Datawire system and be correctly routed to the FDMS Payment processor.

The maximum length for this property is 32 characters.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

Data Type

String

DetailRecordCount Property (FDMSOmahaBatchMgr Class)

The number of records in the DetailRecord arrays.

Syntax

ANSI (Cross Platform)
int GetDetailRecordCount();
int SetDetailRecordCount(int iDetailRecordCount); Unicode (Windows) INT GetDetailRecordCount();
INT SetDetailRecordCount(INT iDetailRecordCount);
int dpaymentssdk_fdmsomahabatchmgr_getdetailrecordcount(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setdetailrecordcount(void* lpObj, int iDetailRecordCount);
int GetDetailRecordCount();
int SetDetailRecordCount(int iDetailRecordCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

DetailRecordAggregate Property (FDMSOmahaBatchMgr Class)

Set this property with xml aggregates of the transactions you wish to settle.

Syntax

ANSI (Cross Platform)
char* GetDetailRecordAggregate(int iDetailRecordIndex);
int SetDetailRecordAggregate(int iDetailRecordIndex, const char* lpszDetailRecordAggregate); Unicode (Windows) LPWSTR GetDetailRecordAggregate(INT iDetailRecordIndex);
INT SetDetailRecordAggregate(INT iDetailRecordIndex, LPCWSTR lpszDetailRecordAggregate);
char* dpaymentssdk_fdmsomahabatchmgr_getdetailrecordaggregate(void* lpObj, int detailrecordindex);
int dpaymentssdk_fdmsomahabatchmgr_setdetailrecordaggregate(void* lpObj, int detailrecordindex, const char* lpszDetailRecordAggregate);
QString GetDetailRecordAggregate(int iDetailRecordIndex);
int SetDetailRecordAggregate(int iDetailRecordIndex, QString qsDetailRecordAggregate);

Default Value

""

Remarks

Set this property with xml aggregates of the transactions you wish to settle.

To settle previously authorized transactions, this property must be set with the xml aggregate returned from the FDMSOmahaECommerce, FDMSOmahaRetail, FDMSOmahaRestaurant, or FDMSOmahaDetailRecord class's GetDetailAggregate method. For instance:

FDMSOmahaBatchMgr1.DetailRecords.Add(new FDMSOmahaRecordType(FDMSOmahaRetail1.GetDetailAggregate()));

On occasion, you may need to modify these aggregates before sending them to settlement. For instance, if you're running a restaurant you may need to add a gratuity to the charge. If you're accepting installment payments, you will need to add the installment info. To accomplish this, you may use the FDMSOmahaDetailRecord class.

The DetailRecordIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DetailRecordCount property.

This property is not available at design time.

Data Type

String

DeviceId Property (FDMSOmahaBatchMgr Class)

POS Device Identification.

Syntax

ANSI (Cross Platform)
char* GetDeviceId();
int SetDeviceId(const char* lpszDeviceId); Unicode (Windows) LPWSTR GetDeviceId();
INT SetDeviceId(LPCWSTR lpszDeviceId);
char* dpaymentssdk_fdmsomahabatchmgr_getdeviceid(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setdeviceid(void* lpObj, const char* lpszDeviceId);
QString GetDeviceId();
int SetDeviceId(QString qsDeviceId);

Default Value

""

Remarks

Merchant-assigned code identifying the device at the merchant's location.

This field is required if there is one MerchantNumber assigned to more than one terminal at a merchant's location.

The maximum length of this property is 4 characters.

Data Type

String

LocalHost Property (FDMSOmahaBatchMgr Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* dpaymentssdk_fdmsomahabatchmgr_getlocalhost(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

Data Type

String

LocalPort Property (FDMSOmahaBatchMgr Class)

The TCP port in the local host where the class binds.

Syntax

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort); Unicode (Windows) INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);
int dpaymentssdk_fdmsomahabatchmgr_getlocalport(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setlocalport(void* lpObj, int iLocalPort);
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

Data Type

Integer

MerchantNumber Property (FDMSOmahaBatchMgr Class)

A unique number used to identify the merchant within the FDMS systems.

Syntax

ANSI (Cross Platform)
char* GetMerchantNumber();
int SetMerchantNumber(const char* lpszMerchantNumber); Unicode (Windows) LPWSTR GetMerchantNumber();
INT SetMerchantNumber(LPCWSTR lpszMerchantNumber);
char* dpaymentssdk_fdmsomahabatchmgr_getmerchantnumber(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setmerchantnumber(void* lpObj, const char* lpszMerchantNumber);
QString GetMerchantNumber();
int SetMerchantNumber(QString qsMerchantNumber);

Default Value

""

Remarks

This 19 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the FDMS systems, and is used along with the MerchantTerminalNumber as connection credentials.

Data Type

String

MerchantTerminalID Property (FDMSOmahaBatchMgr Class)

Used to identify a unique terminal within a merchant location.

Syntax

ANSI (Cross Platform)
char* GetMerchantTerminalID();
int SetMerchantTerminalID(const char* lpszMerchantTerminalID); Unicode (Windows) LPWSTR GetMerchantTerminalID();
INT SetMerchantTerminalID(LPCWSTR lpszMerchantTerminalID);
char* dpaymentssdk_fdmsomahabatchmgr_getmerchantterminalid(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setmerchantterminalid(void* lpObj, const char* lpszMerchantTerminalID);
QString GetMerchantTerminalID();
int SetMerchantTerminalID(QString qsMerchantTerminalID);

Default Value

""

Remarks

This nine digit property contains an ID assigned by FDMS to uniquely identify a terminal within a merchant location, and is used along with the MerchantNumber as connection credentials.

Data Type

String

ProxyAuthScheme Property (FDMSOmahaBatchMgr Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); Unicode (Windows) INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

Possible Values

AUTH_BASIC(0), 
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5)
int dpaymentssdk_fdmsomahabatchmgr_getproxyauthscheme(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which 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 class. Look at the configuration file for the class 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 (FDMSOmahaBatchMgr Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect); Unicode (Windows) BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);
int dpaymentssdk_fdmsomahabatchmgr_getproxyautodetect(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (FDMSOmahaBatchMgr Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* dpaymentssdk_fdmsomahabatchmgr_getproxypassword(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword 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 (FDMSOmahaBatchMgr Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int dpaymentssdk_fdmsomahabatchmgr_getproxyport(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains 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 (FDMSOmahaBatchMgr Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer); Unicode (Windows) LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);
char* dpaymentssdk_fdmsomahabatchmgr_getproxyserver(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyserver(void* lpObj, const char* lpszProxyServer);
QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

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 (FDMSOmahaBatchMgr Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL); Unicode (Windows) INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

Possible Values

PS_AUTOMATIC(0), 
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
int dpaymentssdk_fdmsomahabatchmgr_getproxyssl(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyssl(void* lpObj, int iProxySSL);
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

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

psAutomatic (0)Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (FDMSOmahaBatchMgr Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser); Unicode (Windows) LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);
char* dpaymentssdk_fdmsomahabatchmgr_getproxyuser(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setproxyuser(void* lpObj, const char* lpszProxyUser);
QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains 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

RemoteHost Property (FDMSOmahaBatchMgr Class)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Syntax

ANSI (Cross Platform)
char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost); Unicode (Windows) LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);
char* dpaymentssdk_fdmsomahabatchmgr_getremotehost(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setremotehost(void* lpObj, const char* lpszRemoteHost);
QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

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

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

Example. Connecting:

TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

Data Type

String

RemotePort Property (FDMSOmahaBatchMgr Class)

This property includes the Transmission Control Protocol (TCP) port in the remote host.

Syntax

ANSI (Cross Platform)
int GetRemotePort();
int SetRemotePort(int iRemotePort); Unicode (Windows) INT GetRemotePort();
INT SetRemotePort(INT iRemotePort);
int dpaymentssdk_fdmsomahabatchmgr_getremoteport(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setremoteport(void* lpObj, int iRemotePort);
int GetRemotePort();
int SetRemotePort(int iRemotePort);

Default Value

0

Remarks

This property specifies a service port on the remote host to connect to.

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

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

Data Type

Integer

ResponseBatchAmount Property (FDMSOmahaBatchMgr Class)

The total authorized amount for all Credit Card transactions in the batch.

Syntax

ANSI (Cross Platform)
char* GetResponseBatchAmount();

Unicode (Windows)
LPWSTR GetResponseBatchAmount();
char* dpaymentssdk_fdmsomahabatchmgr_getresponsebatchamount(void* lpObj);
QString GetResponseBatchAmount();

Default Value

""

Remarks

The total authorized amount for all Credit Card transactions in the batch.

This value is taken directly from ResponseText. Note in the case of a negative amount, a minus '-' sign will be put at the beginning of the amount.

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

Data Type

String

ResponseBatchID Property (FDMSOmahaBatchMgr Class)

Code identifying batch to the Host.

Syntax

ANSI (Cross Platform)
char* GetResponseBatchID();

Unicode (Windows)
LPWSTR GetResponseBatchID();
char* dpaymentssdk_fdmsomahabatchmgr_getresponsebatchid(void* lpObj);
QString GetResponseBatchID();

Default Value

""

Remarks

Code identifying batch to the Host.

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

Data Type

String

ResponseBatchNumber Property (FDMSOmahaBatchMgr Class)

Number identifying the batch assigned by the POS device.

Syntax

ANSI (Cross Platform)
int GetResponseBatchNumber();

Unicode (Windows)
INT GetResponseBatchNumber();
int dpaymentssdk_fdmsomahabatchmgr_getresponsebatchnumber(void* lpObj);
int GetResponseBatchNumber();

Default Value

0

Remarks

Number identifying the batch assigned by the POS device.

This property is read-only.

Data Type

Integer

ResponseDebitBatchAmount Property (FDMSOmahaBatchMgr Class)

The total authorized amount for all Debit/EBT Card transactions in the batch.

Syntax

ANSI (Cross Platform)
char* GetResponseDebitBatchAmount();

Unicode (Windows)
LPWSTR GetResponseDebitBatchAmount();
char* dpaymentssdk_fdmsomahabatchmgr_getresponsedebitbatchamount(void* lpObj);
QString GetResponseDebitBatchAmount();

Default Value

""

Remarks

The total authorized amount for all Debit/EBT Card transactions in the batch.

This value is taken directly from ResponseDebitText. Note in the case of a negative amount, a minus '-' sign will be put at the beginning of the amount.

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

Data Type

String

ResponseDebitText Property (FDMSOmahaBatchMgr Class)

Message from the Host describing the transaction in relation to Debit cards.

Syntax

ANSI (Cross Platform)
char* GetResponseDebitText();

Unicode (Windows)
LPWSTR GetResponseDebitText();
char* dpaymentssdk_fdmsomahabatchmgr_getresponsedebittext(void* lpObj);
QString GetResponseDebitText();

Default Value

""

Remarks

Message from the Host describing the transaction in relation to Debit cards.

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

Data Type

String

ResponseSuccess Property (FDMSOmahaBatchMgr Class)

Determines whether the transaction was successful.

Syntax

ANSI (Cross Platform)
int GetResponseSuccess();

Unicode (Windows)
BOOL GetResponseSuccess();
int dpaymentssdk_fdmsomahabatchmgr_getresponsesuccess(void* lpObj);
bool GetResponseSuccess();

Default Value

FALSE

Remarks

Determines whether the transaction was successful.

This field can be queried to determine whether the transaction was successful.

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

Data Type

Boolean

ResponseText Property (FDMSOmahaBatchMgr Class)

Message from the Host describing the transaction.

Syntax

ANSI (Cross Platform)
char* GetResponseText();

Unicode (Windows)
LPWSTR GetResponseText();
char* dpaymentssdk_fdmsomahabatchmgr_getresponsetext(void* lpObj);
QString GetResponseText();

Default Value

""

Remarks

Message from the Host describing the transaction.

Below are some of the common message responses from the Host.

ValueDescription
APPROVED 999999 The Host computer sends this response on an authorization-only transaction. The authorization code appears in place of the "999999".
AUTH/TKT 999999 The Host computer sends this response on a sale transaction. The authorization code appears in place of the "999999".
PRTL SALE 999999 The Host computer sends this response on a sale transaction when the transaction was only partially approved. The authorization code appears in place of the "999999".
BAL 999999.99 This is the Host response to an EBT Balance Inquiry transaction. The "999999.99" represents the amount of the balance returned by the Network.
CALL _CENTER A condition exists with the cardholder account that requires special handling. The merchant must contact the Voice Authorization Center for instructions about how to proceed.
CLOSE UNAVAIL This is the Host response when the Host cannot accept the close batch message packet at that time. The merchant will need to retry the close at a later time.
CLOSE 999999.99 This is the Host response for a successful close transaction. The "999999.99" represents the batch amount for which the Host closed the batch.
DECLINED The issuer has declined the authorization of the transaction for one or more reasons. The merchant should accept another form of payment.
DEP 999999.99 This is the Host response to a deposit inquiry transaction. The "999999.99" represents the batch amount for which the Host closed the last batch.
EXPIRED CARD The expiration date sent with the authorization request indicates that the card has expired.
INVALID EXP DATE The expiration date sent with the authorization request was formatted incorrectly.
FORCE 99999.99 The Host closed the batch with an out-of-balance condition. The Host was unable to balance with the POS device. The merchant needs to contact the financial institution for assistance.
INVALID AMOUNT The POS device sends the Host an unacceptable dollar amount for authorization or the format of the number is incorrect.
INV BATCH SEQ The batch number of a transaction message (message packet) is out of sequence with the batch number the Host is expecting for the merchant number and device ID combination. This message can also appear if trying to post a transaction with a revision number that is less than or equal too the revision number already posted to the Host.
INVLD BATCH SEQ The batch number of a close batch message (message packet) is out of sequence with the batch number the Host is expecting for the merchant number and device ID combination.
INVALID CARD # The cardholder account number entered is not valid and is not acceptable for payment. The merchant must verify the cardholder account number.
INVALID MRCH # The merchant number in the transaction or close batch message is invalid or is not acceptable for the transaction code of the message packet being sent to the Host.
INVALID PIN The PIN entered by the cardholder is not valid. Attempt transaction again.
CASH 999999 The Host computer sends this response on an EBT Cash Withdrawal transaction. The authorization code appears in place of the "999999".

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

Data Type

String

ResponseTransactionNumber Property (FDMSOmahaBatchMgr Class)

Number of the transaction in the batch as specified by the Point of Sale device.

Syntax

ANSI (Cross Platform)
int GetResponseTransactionNumber();

Unicode (Windows)
INT GetResponseTransactionNumber();
int dpaymentssdk_fdmsomahabatchmgr_getresponsetransactionnumber(void* lpObj);
int GetResponseTransactionNumber();

Default Value

0

Remarks

Number of the transaction in the batch as specified by the Point of Sale device.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertEncoded Property (FDMSOmahaBatchMgr Class)

This is the certificate (PEM/Base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int dpaymentssdk_fdmsomahabatchmgr_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_fdmsomahabatchmgr_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is 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

Binary String

SSLCertEncoded Property (FDMSOmahaBatchMgr Class)

This is the certificate (PEM/Base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int dpaymentssdk_fdmsomahabatchmgr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_fdmsomahabatchmgr_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is 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

Binary String

SSLCertStore Property (FDMSOmahaBatchMgr Class)

This is the name of the certificate store for the client certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int dpaymentssdk_fdmsomahabatchmgr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_fdmsomahabatchmgr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is 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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

Data Type

Binary String

SSLCertStorePassword Property (FDMSOmahaBatchMgr Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* dpaymentssdk_fdmsomahabatchmgr_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

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 (FDMSOmahaBatchMgr Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int dpaymentssdk_fdmsomahabatchmgr_getsslcertstoretype(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (FDMSOmahaBatchMgr Class)

This is the subject of the certificate used for client authentication.

Syntax

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* dpaymentssdk_fdmsomahabatchmgr_getsslcertsubject(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLProvider Property (FDMSOmahaBatchMgr Class)

This specifies the SSL/TLS implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int dpaymentssdk_fdmsomahabatchmgr_getsslprovider(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class 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:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
Additional Notes

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

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (FDMSOmahaBatchMgr Class)

This is the certificate (PEM/Base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int dpaymentssdk_fdmsomahabatchmgr_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is 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

Binary String

Timeout Property (FDMSOmahaBatchMgr Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int dpaymentssdk_fdmsomahabatchmgr_gettimeout(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will return with an error after Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionNumber Property (FDMSOmahaBatchMgr Class)

The transaction number for the current transaction.

Syntax

ANSI (Cross Platform)
int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber); Unicode (Windows) INT GetTransactionNumber();
INT SetTransactionNumber(INT iTransactionNumber);
int dpaymentssdk_fdmsomahabatchmgr_gettransactionnumber(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_settransactionnumber(void* lpObj, int iTransactionNumber);
int GetTransactionNumber();
int SetTransactionNumber(int iTransactionNumber);

Default Value

0

Remarks

This property is used to specify the transaction number for the current transaction. The valid values are 0 - 999. A TransactionNumber of 0 is only used and MUST be used for AuthOnly transactions, thus all other transaction types must have a TransactionNumber of 1 or greater. The maximum value of TransactionNumber is 999 (note: closing a batch requires an item number and thus the actual number of transactions in a batch is 998).

If a transaction is unsuccessful the TransactionNumber should be re-used.

For Credit Card transactions, the TransactionNumber starts at 1 (provided it is not an AuthOnly transaction) and must increment with each successful transaction.

For Debit/EBT Card transactions, the TransactionNumber starts at 999 and must decrement with each successful transaction.

Note TransactionNumbers for Credit Card and Debit/EBT cards *cannot* overlap and must be unique. Additionally, there must be an open TransactionNumber for the close batch transaction. For example, you can have 1-454 for Credit Card transactions and 456-999 for Debit/EBT cards but TransactionNumber 455 must be left available for the close batch transaction.

Item numbers do NOT have to be processed in sequence (i.e. 1, 2, 3, etc.). However, when a batch is closed all transactions up to the TransactionNumber specified to close the batch must be accounted for. For example; if a batch is closed using TransactionNumber 5, transactions 1, 2, 3, and 4 MUST be accounted for. Additionally, if the batch is closed using an TransactionNumber that is not one more than the number of items in the batch, the Host will delete all records over the close TransactionNumber. For example; if a batch is closed using TransactionNumber 5, transaction records 5, 6, 7, etc. will be automatically deleted by the system.

Each transaction that posts to the Host with an TransactionNumber must keep that TransactionNumber until the batch is closed. Note: the Host accepts two or more transactions with the same TransactionNumber, but the last transaction will overwrite any previous transactions. For example, if a Sale is performed for TransactionNumber 1 and then a Credit is performed, only the Credit will post to the cardholder's account (it will be as if the Sale transaction never happened, with the exception of the reserved funds).

This property is not applicable for the ottRevise and ottVoid transaction types. Thus when GetDetailAggregate is called, the returned aggregate will contain the TransactionNumber specified within the original transaction.

Below is a table of the various transaction types and how TransactionNumber should be handled for Credit Card transactions. Note that the below table is only applicable to Credit Card transactions.

Credit Card Transaction Type TransactionNumber Handling
AuthOnly TransactionNumber = 0 (This is the case for all AuthOnly transactions).
Sale Last TransactionNumber + 1
Capture Last TransactionNumber + 1
Refund Last TransactionNumber + 1
Revise Not applicable as the TransactionNumber contained within the DetailAggregate is used.
Void Not applicable as the TransactionNumber contained within the DetailAggregate is used.

Debit/EBT cards are always performed online and thus each successful transaction should have their own unique TransactionNumber that starts at 999 and decrements by 1 for each success transaction performed.

Debit/EBT Card Transaction Type TransactionNumber Handling
All Last TransactionNumber - 1

Data Type

Integer

URL Property (FDMSOmahaBatchMgr Class)

Location of the Datawire server to which transactions are sent.

Syntax

ANSI (Cross Platform)
char* GetURL();
int SetURL(const char* lpszURL); Unicode (Windows) LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);
char* dpaymentssdk_fdmsomahabatchmgr_geturl(void* lpObj);
int dpaymentssdk_fdmsomahabatchmgr_seturl(void* lpObj, const char* lpszURL);
QString GetURL();
int SetURL(QString qsURL);

Default Value

"https://staging1.datawire.net/sd/"

Remarks

This is the URL to which all authorization and settlement transactions are sent. This URL is acquired by using the FDMSRegister class. Once you Register and Activate the merchant using the FDMSRegister class, you may then do a Service Discovery. After sending a Service Discovery transaction, the Datawire system will return a list of transaction URLs. The URL from this list with the shortest round-trip transit time from a ping is the URL you should use here.

Note: By default, this property is populated with the Datawire Staging (test) server, and is not the correct URL to use in a production environment. In a production environment, this URL is supplied by the FDMSRegister class.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

Data Type

String

CloseBatch Method (FDMSOmahaBatchMgr Class)

Sends a Close Batch request.

Syntax

ANSI (Cross Platform)
int CloseBatch();

Unicode (Windows)
INT CloseBatch();
int dpaymentssdk_fdmsomahabatchmgr_closebatch(void* lpObj);
int CloseBatch();

Remarks

This method sends a close batch request to the FDMS transaction processor, which initiates the settlement of the transactions contained within the batch.

By default, prior to CloseBatch being called, all the detail aggregates for every transaction within the batch should be added to DetailRecords. These detail records are used by the component to send all offline transactions and compute the total transaction amounts for the batch (which are sent in the close batch request).

When CloseBatch is called, all the offline transactions (Voids, Revisions, etc) contained within DetailRecords will be sent prior to the actual close batch request. After all the offline transactions have been sent, the batch close message is sent. If the Host is out-of-balance with the Total Amount specified (which is calculated by the component based on the information contained within the DetailRecords), the Host may request an inquiry to synchronize all transactions. If such a case occurs, the component will handle all inquiries and respond accordingly based on the request and information contained within DetailRecords. Once the host is in sync, the Host will send the close batch response and Response will be populated. ResponseSuccess will be true if the batch was successfully closed.

Note: TransactionNumber must be one greater than the number of Credit Card transactions and must also be less than the number of Debit/EBT Card transactions within the batch.

Note under specific circumstances, it may be advantageous for you to manually handle batch amounts and polling or revision inquiries (rather then adding all the transaction aggregates to DetailRecords). To do this, you can set the following configuration settings CreditBatchAmount, DebitBatchCount, and DebitBatchAmount. When these configuration settings are set, the component does not compute batch amount totals and thus only the offline transaction aggregates need to be added to DetailRecords. If a revision or specific poll inquiry is requested by the host, rather than the component automatically sending a response based on the DetailRecords, the RevisionInquiry or SpecificPoll events will fire. Within these events, you will be required to set the information requested which will be used to send the inquiry response. OmahaBatchMgr.BatchNumber = 1; OmahaBatchMgr.TransactionNumber = 10; OmahaBatchMgr.CloseBatch();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (FDMSOmahaBatchMgr Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* dpaymentssdk_fdmsomahabatchmgr_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

Remarks

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

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

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DepositInquiry Method (FDMSOmahaBatchMgr Class)

Sends a Deposit Inquiry request.

Syntax

ANSI (Cross Platform)
int DepositInquiry();

Unicode (Windows)
INT DepositInquiry();
int dpaymentssdk_fdmsomahabatchmgr_depositinquiry(void* lpObj);
int DepositInquiry();

Remarks

This method sends a Deposit Inquiry request and allows the merchant to view the last batch closed with the same MerchantNumber and DeviceId from the previous processing day.

Response will contain the details of the deposit inquiry response. OmahaBatchMgr.DepositInquiry();

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (FDMSOmahaBatchMgr Class)

Interrupts the current action.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
int dpaymentssdk_fdmsomahabatchmgr_interrupt(void* lpObj);
int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (FDMSOmahaBatchMgr Class)

Clears all properties to their default values.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int dpaymentssdk_fdmsomahabatchmgr_reset(void* lpObj);
int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (FDMSOmahaBatchMgr Class)

This event is fired immediately after a connection completes (or fails).

Syntax

ANSI (Cross Platform)
virtual int FireConnected(FDMSOmahaBatchMgrConnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } FDMSOmahaBatchMgrConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(FDMSOmahaBatchMgrConnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } FDMSOmahaBatchMgrConnectedEventParams;
#define EID_FDMSOMAHABATCHMGR_CONNECTED 1

virtual INT DPAYMENTSSDK_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);
class FDMSOmahaBatchMgrConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Connected(FDMSOmahaBatchMgrConnectedEventParams *e);
// Or, subclass FDMSOmahaBatchMgr and override this emitter function. virtual int FireConnected(FDMSOmahaBatchMgrConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

DataPacketIn Event (FDMSOmahaBatchMgr Class)

Fired when receiving a data packet from the transaction server.

Syntax

ANSI (Cross Platform)
virtual int FireDataPacketIn(FDMSOmahaBatchMgrDataPacketInEventParams *e);
typedef struct {
const char *DataPacket; int lenDataPacket; int reserved; } FDMSOmahaBatchMgrDataPacketInEventParams;
Unicode (Windows) virtual INT FireDataPacketIn(FDMSOmahaBatchMgrDataPacketInEventParams *e);
typedef struct {
LPCSTR DataPacket; INT lenDataPacket; INT reserved; } FDMSOmahaBatchMgrDataPacketInEventParams;
#define EID_FDMSOMAHABATCHMGR_DATAPACKETIN 2

virtual INT DPAYMENTSSDK_CALL FireDataPacketIn(LPSTR &lpDataPacket, INT &lenDataPacket);
class FDMSOmahaBatchMgrDataPacketInEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void DataPacketIn(FDMSOmahaBatchMgrDataPacketInEventParams *e);
// Or, subclass FDMSOmahaBatchMgr and override this emitter function. virtual int FireDataPacketIn(FDMSOmahaBatchMgrDataPacketInEventParams *e) {...}

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this class.

DataPacketOut Event (FDMSOmahaBatchMgr Class)

Fired when sending a data packet to the transaction server.

Syntax

ANSI (Cross Platform)
virtual int FireDataPacketOut(FDMSOmahaBatchMgrDataPacketOutEventParams *e);
typedef struct {
const char *DataPacket; int lenDataPacket; int reserved; } FDMSOmahaBatchMgrDataPacketOutEventParams;
Unicode (Windows) virtual INT FireDataPacketOut(FDMSOmahaBatchMgrDataPacketOutEventParams *e);
typedef struct {
LPCSTR DataPacket; INT lenDataPacket; INT reserved; } FDMSOmahaBatchMgrDataPacketOutEventParams;
#define EID_FDMSOMAHABATCHMGR_DATAPACKETOUT 3

virtual INT DPAYMENTSSDK_CALL FireDataPacketOut(LPSTR &lpDataPacket, INT &lenDataPacket);
class FDMSOmahaBatchMgrDataPacketOutEventParams {
public:
  const QByteArray &DataPacket();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void DataPacketOut(FDMSOmahaBatchMgrDataPacketOutEventParams *e);
// Or, subclass FDMSOmahaBatchMgr and override this emitter function. virtual int FireDataPacketOut(FDMSOmahaBatchMgrDataPacketOutEventParams *e) {...}

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this class.

Disconnected Event (FDMSOmahaBatchMgr Class)

This event is fired when a connection is closed.

Syntax

ANSI (Cross Platform)
virtual int FireDisconnected(FDMSOmahaBatchMgrDisconnectedEventParams *e);
typedef struct {
int StatusCode;
const char *Description; int reserved; } FDMSOmahaBatchMgrDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(FDMSOmahaBatchMgrDisconnectedEventParams *e);
typedef struct {
INT StatusCode;
LPCWSTR Description; INT reserved; } FDMSOmahaBatchMgrDisconnectedEventParams;
#define EID_FDMSOMAHABATCHMGR_DISCONNECTED 4

virtual INT DPAYMENTSSDK_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);
class FDMSOmahaBatchMgrDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Disconnected(FDMSOmahaBatchMgrDisconnectedEventParams *e);
// Or, subclass FDMSOmahaBatchMgr and override this emitter function. virtual int FireDisconnected(FDMSOmahaBatchMgrDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

Error Event (FDMSOmahaBatchMgr Class)

Fired when information is available about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(FDMSOmahaBatchMgrErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } FDMSOmahaBatchMgrErrorEventParams;
Unicode (Windows) virtual INT FireError(FDMSOmahaBatchMgrErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } FDMSOmahaBatchMgrErrorEventParams;
#define EID_FDMSOMAHABATCHMGR_ERROR 5

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class FDMSOmahaBatchMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(FDMSOmahaBatchMgrErrorEventParams *e);
// Or, subclass FDMSOmahaBatchMgr and override this emitter function. virtual int FireError(FDMSOmahaBatchMgrErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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.

RevisionInquiry Event (FDMSOmahaBatchMgr Class)

Fired when a revision inquiry request is received from the host.

Syntax

ANSI (Cross Platform)
virtual int FireRevisionInquiry(FDMSOmahaBatchMgrRevisionInquiryEventParams *e);
typedef struct {
int StartTransactionNumber;
char *RevisionNumbers; int reserved; } FDMSOmahaBatchMgrRevisionInquiryEventParams;
Unicode (Windows) virtual INT FireRevisionInquiry(FDMSOmahaBatchMgrRevisionInquiryEventParams *e);
typedef struct {
INT StartTransactionNumber;
LPWSTR RevisionNumbers; INT reserved; } FDMSOmahaBatchMgrRevisionInquiryEventParams;
#define EID_FDMSOMAHABATCHMGR_REVISIONINQUIRY 6

virtual INT DPAYMENTSSDK_CALL FireRevisionInquiry(INT &iStartTransactionNumber, LPSTR &lpszRevisionNumbers);
class FDMSOmahaBatchMgrRevisionInquiryEventParams {
public:
  int StartTransactionNumber();

  const QString &RevisionNumbers();
  void SetRevisionNumbers(const QString &qsRevisionNumbers);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void RevisionInquiry(FDMSOmahaBatchMgrRevisionInquiryEventParams *e);
// Or, subclass FDMSOmahaBatchMgr and override this emitter function. virtual int FireRevisionInquiry(FDMSOmahaBatchMgrRevisionInquiryEventParams *e) {...}

Remarks

This event fires when a revision inquiry request is received. Note that this is only applicable when manually handling the batch close details (occurs when setting CreditBatchAmount and DebitBatchAmount). Otherwise the component will compute batch details and handle all revision and specific poll inquiries.

StartTransactionNumber is used to identify the transaction number where the revision number list should begin.

RevisionNumbers is a comma-separated list containing the total number of revisions for each transaction. The maximum length of the list is 10 revision numbers or until you reach the last transaction number within the batch (whichever comes first).

For example, you have 12 transactions within the current batch with transaction 3 being voided, 9 being revised once and then voided, and transaction 12 being revised once. (Revisions include all transactions that have been revised or voided). A revision inquiry is requested and RevisionInquiry is fired with a StartTransactionNumber of 1. '1' specifies that we need to start with the first transaction number. Therefore RevisionNumbers should be set to the following list for transactions 1-10: "0,0,1,0,0,0,0,0,2,0". So the '1' in the list represents transaction 3 which was voided. The '2' in the list represents transaction 9 which was revised once and then voided (thus it was revised twice). Once specified, the component will send the revision inquiry response with the numbers specified. Upon a successful response, the host may send back a batch close response or request another revision inquiry. Let's say a second revision inquiry was requested. When RevisionInquiry is fired, TransactionNumber will be 11 (from our current example). Thus RevisionNumbers should be set to: "0,1" for transactions 11 and 12 (12 being the last one in the batch).

Note FDMS does have time constraints on when a response should be sent and received by the host which can be as low as 4 seconds. Therefore the handling and specifying of the RevisionNumbers should occur in a timely manner to ensure that all requests/responses can be processed without the connection being closed.

SpecificPoll Event (FDMSOmahaBatchMgr Class)

Fired when a specific poll request is received from the host.

Syntax

ANSI (Cross Platform)
virtual int FireSpecificPoll(FDMSOmahaBatchMgrSpecificPollEventParams *e);
typedef struct {
int TransactionNumber;
char *Aggregate; int reserved; } FDMSOmahaBatchMgrSpecificPollEventParams;
Unicode (Windows) virtual INT FireSpecificPoll(FDMSOmahaBatchMgrSpecificPollEventParams *e);
typedef struct {
INT TransactionNumber;
LPWSTR Aggregate; INT reserved; } FDMSOmahaBatchMgrSpecificPollEventParams;
#define EID_FDMSOMAHABATCHMGR_SPECIFICPOLL 7

virtual INT DPAYMENTSSDK_CALL FireSpecificPoll(INT &iTransactionNumber, LPSTR &lpszAggregate);
class FDMSOmahaBatchMgrSpecificPollEventParams {
public:
  int TransactionNumber();

  const QString &Aggregate();
  void SetAggregate(const QString &qsAggregate);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SpecificPoll(FDMSOmahaBatchMgrSpecificPollEventParams *e);
// Or, subclass FDMSOmahaBatchMgr and override this emitter function. virtual int FireSpecificPoll(FDMSOmahaBatchMgrSpecificPollEventParams *e) {...}

Remarks

This event fires when a specific poll request is received (which occurs when the host is out-of-balance with the Total Amount specified). Note that this is only applicable when manually handling the batch close details (occurs when setting CreditBatchAmount and DebitBatchAmount). Otherwise the component will compute batch details and handle all revision and specific poll inquiries.

TransactionNumber is used to identify the transaction number requested by the host.

Aggregate should be set to the detail aggregate for the specified TransactionNumber. The component will then use the detail aggregate data to build and send the specific poll response to the host.

If no aggregate is specified, the component will send a negative response to the specific poll inquiry.

Note FDMS does have time constraints on when a response should be sent and received by the host which can be as low as 4 seconds. Therefore the handling and specifying of the Aggregate should occur in a timely manner to ensure that all requests/responses can be processed without the connection being closed.

SSLServerAuthentication Event (FDMSOmahaBatchMgr Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(FDMSOmahaBatchMgrSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } FDMSOmahaBatchMgrSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(FDMSOmahaBatchMgrSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } FDMSOmahaBatchMgrSSLServerAuthenticationEventParams;
#define EID_FDMSOMAHABATCHMGR_SSLSERVERAUTHENTICATION 8

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class FDMSOmahaBatchMgrSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(FDMSOmahaBatchMgrSSLServerAuthenticationEventParams *e);
// Or, subclass FDMSOmahaBatchMgr and override this emitter function. virtual int FireSSLServerAuthentication(FDMSOmahaBatchMgrSSLServerAuthenticationEventParams *e) {...}

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 (FDMSOmahaBatchMgr Class)

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(FDMSOmahaBatchMgrSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } FDMSOmahaBatchMgrSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(FDMSOmahaBatchMgrSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } FDMSOmahaBatchMgrSSLStatusEventParams;
#define EID_FDMSOMAHABATCHMGR_SSLSTATUS 9

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);
class FDMSOmahaBatchMgrSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSLStatus(FDMSOmahaBatchMgrSSLStatusEventParams *e);
// Or, subclass FDMSOmahaBatchMgr and override this emitter function. virtual int FireSSLStatus(FDMSOmahaBatchMgrSSLStatusEventParams *e) {...}

Remarks

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

Status Event (FDMSOmahaBatchMgr Class)

Shows the progress of the FDMS/Datawire connection.

Syntax

ANSI (Cross Platform)
virtual int FireStatus(FDMSOmahaBatchMgrStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } FDMSOmahaBatchMgrStatusEventParams;
Unicode (Windows) virtual INT FireStatus(FDMSOmahaBatchMgrStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } FDMSOmahaBatchMgrStatusEventParams;
#define EID_FDMSOMAHABATCHMGR_STATUS 10

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);
class FDMSOmahaBatchMgrStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Status(FDMSOmahaBatchMgrStatusEventParams *e);
// Or, subclass FDMSOmahaBatchMgr and override this emitter function. virtual int FireStatus(FDMSOmahaBatchMgrStatusEventParams *e) {...}

Remarks

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

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

Config Settings (FDMSOmahaBatchMgr Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

FDMSOmahaBatchMgr Config Settings

CreditBatchAmount:   Dollar-and-cent amount ($$$$$$.cc) of all the credit card transactions in the batch.

This value is sent in a close batch request and used by the host to sync up the transactions and help ensure that all the transactions have been accounted for. The CreditBatchAmount usually consists of an unsigned value, entered without a plus (+) or minus (-) sign. However, when the amount of returns exceeds the amount of sales, then a leading minus sign is necessary to indicate a negative amount.

Note the amount includes both online and offline transactions. All sale and capture transaction amounts should be added to CreditBatchAmount. Refund transaction amounts should be subtracted from CreditBatchAmount. For void transactions, the amount can be either added or subtracted from CreditBatchAmount depending on the transaction type being voided (in essence just offsetting the previous transaction amount being voided). When voiding a sale or capture transaction, the amount should be subtracted. When voiding a refund transaction, the amount should be added.

Note by default, all detail aggregates can be added to DetailRecords and the component will automatically compute the batch totals for you and handle all revision and specific polling inquiries. However when this config is set it enables you to handle the computing of the batch amounts. Additionally if a revision or specific polling inquiry is requested, the RevisionInquiry or SpecificPoll event will fire and the details requested must be specified within the event.

DebitBatchAmount:   Total dollar-and-cent amount ($$$$$$.cc) of all the debit card transactions in the batch.

This value is sent in a close batch request and used by the host to sync up the transactions and help ensure that all the transactions have been accounted for. The DebitBatchAmount usually consists of an unsigned value, entered without a plus (+) or minus (-) sign. However, when the amount of returns exceeds the amount of sales, then a leading minus sign is necessary to indicate a negative amount.

All Debit/EBT Sale transaction amounts should be added to DebitBatchAmount. EBTCashWithdrawal transaction amounts should also be added to DebitBatchAmount. All Debit/EBT DebitRefund transaction amounts should be subtracted from DebitBatchAmount.

Note by default, all detail aggregates can be added to DetailRecords and the component will automatically compute the batch totals for you and handle all revision and specific polling inquiries. However when this config is set it enables you to handle the computing of the batch amounts. Additionally if a revision or specific polling inquiry is requested, the RevisionInquiry or SpecificPoll event will fire and the details requested must be specified within the event.

DebitBatchCount:   Number of debit items in the batch.

This value should contain the total number of debit card transactions executed within the current batch. This value is sent in the close batch request and allows the Host to properly account for all debit card transactions intended to be sent. Valid values range from 0 - 998.

Note by default, all detail aggregates can be added to DetailRecords and the component will automatically compute the batch totals for you and handle all revision and specific polling inquiries. However when this config is set it enables you to handle the computing of the batch amounts. Additionally if a revision or specific polling inquiry is requested, the RevisionInquiry or SpecificPoll event will fire and the details requested must be specified within the event.

TransportProtocol:   Specifies the transport protocol to use to communicate with the FDMS Omaha server.

This config is used to specify how you wish to connect to the FDMS Omaha server. The current protocols support are:

0 (Default) Datawire (HTTP)
1 VPN or PPP (TCP Connection)

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (FDMSOmahaBatchMgr Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

FDMSOmahaBatchMgr Errors

432   Invalid index.
501   Invalid length for this property.
502   Invalid data format for this property.
503   Value is out of range.
504   Credit card digit check failed.
505   Card date invalid.
506   Card expired.
519   Corrupt response.
520   Response payload empty.
521   Response truncated.
526   Invalid timeout value.
593   A property required for this transaction is missing.
529   Error in XML response.
530   Status code received in response indicates an error condition.
531   Return code received in response indicates an error condition.
532   Cannot generate detail aggregate - this transaction was not successfully authorized.
533   Internal error constructing payload.

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

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in URL
153   Specified URLScheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open AttachedFile.

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

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).