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

dpaymentssdk.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.DetailRecords.Add(new FDMSOmahaRecordType(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, Success 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. Success 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.

Method List

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

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.

Config Settings

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

ApplicationId Property (FDMSOmahaBatchMgr Class)

Identifies the merchant application to the Datawire System.

Syntax

public String getApplicationId();


public void setApplicationId(String applicationId);

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

BatchNumber Property (FDMSOmahaBatchMgr Class)

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

Syntax

public int getBatchNumber();


public void setBatchNumber(int batchNumber);

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

ClientRef Property (FDMSOmahaBatchMgr Class)

Uniquely identifies the transaction within the Datawire system.

Syntax

public String getClientRef();


public void setClientRef(String clientRef);

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

DatawireId Property (FDMSOmahaBatchMgr Class)

Identifies the merchant to the Datawire System.

Syntax

public String getDatawireId();


public void setDatawireId(String datawireId);

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

DetailRecords Property (FDMSOmahaBatchMgr Class)

Collection of detail records to send in the close batch transaction.

Syntax

public FDMSOmahaRecordTypeList getDetailRecords();


public void setDetailRecords(FDMSOmahaRecordTypeList detailRecords);

Remarks

Each FDMSOmahaRecordType object in the collection specifies an XML aggregate representing the transaction to be settled. The XML aggregate to be settled is generated from the FDMSOmahaRetail, FDMSOmahaRestaurant, FDMSOmahaECommerce, or FDMSOmahaDetailRecord class.

The following example shows how to add a detail record to the collection. FDMSOmahaEcommerce1.Authorize(); FDMSOmahaBatchMgr1.DetailRecords.Add(new FDMSOmahaRecordType(FDMSOmahaEcommerce1.GetDetailAggregate()));

Xml aggregates are used instead of directly passing Objects because it is easy to store XML aggregates in a database after authorization, and then retrieve them for settlement at the end of the business day.

Up to 998 detail records may be settled in the above manner, just by adding a transactions to the DetailRecords property. However, it is recommended that Batch Closes be kept relatively small - around 100 transactions or so - to decrease the number of records that must be present in the event of an error.

DeviceId Property (FDMSOmahaBatchMgr Class)

POS Device Identification.

Syntax

public String getDeviceId();


public void setDeviceId(String deviceId);

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.

LocalHost Property (FDMSOmahaBatchMgr Class)

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

Syntax

public String getLocalHost();


public void setLocalHost(String localHost);

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

LocalPort Property (FDMSOmahaBatchMgr Class)

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

Syntax

public int getLocalPort();


public void setLocalPort(int localPort);

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

MerchantNumber Property (FDMSOmahaBatchMgr Class)

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

Syntax

public String getMerchantNumber();


public void setMerchantNumber(String merchantNumber);

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.

MerchantTerminalID Property (FDMSOmahaBatchMgr Class)

Used to identify a unique terminal within a merchant location.

Syntax

public String getMerchantTerminalID();


public void setMerchantTerminalID(String merchantTerminalID);

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.

Proxy Property (FDMSOmahaBatchMgr Class)

A set of properties related to proxy access.

Syntax

public Proxy getProxy();


public void setProxy(Proxy proxy);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

RemoteHost Property (FDMSOmahaBatchMgr Class)

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

Syntax

public String getRemoteHost();


public void setRemoteHost(String remoteHost);

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

RemotePort Property (FDMSOmahaBatchMgr Class)

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

Syntax

public int getRemotePort();


public void setRemotePort(int remotePort);

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

Response Property (FDMSOmahaBatchMgr Class)

Contains the response to an authorization request.

Syntax

public FDMSOmahaBatchResponse getResponse();

Remarks

This property will contain the response returned from the FDMS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The FDMSOmahaBatchResponse type contains the following fields:

This property is read-only.

SSLAcceptServerCert Property (FDMSOmahaBatchMgr Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (FDMSOmahaBatchMgr Class)

The certificate to be used during SSL negotiation.

Syntax

public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (FDMSOmahaBatchMgr Class)

This specifies the SSL/TLS implementation to use.

Syntax

public int getSSLProvider();


public void setSSLProvider(int SSLProvider);


Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

Default Value

0

Remarks

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

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 the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

SSLServerCert Property (FDMSOmahaBatchMgr Class)

The server certificate for the last established connection.

Syntax

public Certificate getSSLServerCert();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (FDMSOmahaBatchMgr Class)

A timeout for the class.

Syntax

public int getTimeout();


public void setTimeout(int timeout);

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

TransactionNumber Property (FDMSOmahaBatchMgr Class)

The transaction number for the current transaction.

Syntax

public int getTransactionNumber();


public void setTransactionNumber(int transactionNumber);

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.

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.

URL Property (FDMSOmahaBatchMgr Class)

Location of the Datawire server to which transactions are sent.

Syntax

public String getURL();


public void setURL(String URL);

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

CloseBatch Method (Fdmsomahabatchmgr Class)

Sends a Close Batch request.

Syntax

public void 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. Success 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();

Config Method (Fdmsomahabatchmgr Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

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.

DepositInquiry Method (Fdmsomahabatchmgr Class)

Sends a Deposit Inquiry request.

Syntax

public void 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();

Interrupt Method (Fdmsomahabatchmgr Class)

Interrupts the current action.

Syntax

public void interrupt();

Remarks

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

Reset Method (Fdmsomahabatchmgr Class)

Clears all properties to their default values.

Syntax

public void reset();

Remarks

This method clears all properties to their default values.

Connected Event (Fdmsomahabatchmgr Class)

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

Syntax

public class DefaultFdmsomahabatchmgrEventListener implements FdmsomahabatchmgrEventListener {
  ...
  public void connected(FdmsomahabatchmgrConnectedEvent e) {}
  ...
}

public class FdmsomahabatchmgrConnectedEvent {
  public int statusCode;
  public String description;
}

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

public class DefaultFdmsomahabatchmgrEventListener implements FdmsomahabatchmgrEventListener {
  ...
  public void dataPacketIn(FdmsomahabatchmgrDataPacketInEvent e) {}
  ...
}

public class FdmsomahabatchmgrDataPacketInEvent {
  public byte[] dataPacket;
}

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

public class DefaultFdmsomahabatchmgrEventListener implements FdmsomahabatchmgrEventListener {
  ...
  public void dataPacketOut(FdmsomahabatchmgrDataPacketOutEvent e) {}
  ...
}

public class FdmsomahabatchmgrDataPacketOutEvent {
  public byte[] dataPacket;
}

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

public class DefaultFdmsomahabatchmgrEventListener implements FdmsomahabatchmgrEventListener {
  ...
  public void disconnected(FdmsomahabatchmgrDisconnectedEvent e) {}
  ...
}

public class FdmsomahabatchmgrDisconnectedEvent {
  public int statusCode;
  public String description;
}

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

public class DefaultFdmsomahabatchmgrEventListener implements FdmsomahabatchmgrEventListener {
  ...
  public void error(FdmsomahabatchmgrErrorEvent e) {}
  ...
}

public class FdmsomahabatchmgrErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

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

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

RevisionInquiry Event (Fdmsomahabatchmgr Class)

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

Syntax

public class DefaultFdmsomahabatchmgrEventListener implements FdmsomahabatchmgrEventListener {
  ...
  public void revisionInquiry(FdmsomahabatchmgrRevisionInquiryEvent e) {}
  ...
}

public class FdmsomahabatchmgrRevisionInquiryEvent {
  public int startTransactionNumber;
  public String revisionNumbers;
}

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

public class DefaultFdmsomahabatchmgrEventListener implements FdmsomahabatchmgrEventListener {
  ...
  public void specificPoll(FdmsomahabatchmgrSpecificPollEvent e) {}
  ...
}

public class FdmsomahabatchmgrSpecificPollEvent {
  public int transactionNumber;
  public String aggregate;
}

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

public class DefaultFdmsomahabatchmgrEventListener implements FdmsomahabatchmgrEventListener {
  ...
  public void SSLServerAuthentication(FdmsomahabatchmgrSSLServerAuthenticationEvent e) {}
  ...
}

public class FdmsomahabatchmgrSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept;
}

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

public class DefaultFdmsomahabatchmgrEventListener implements FdmsomahabatchmgrEventListener {
  ...
  public void SSLStatus(FdmsomahabatchmgrSSLStatusEvent e) {}
  ...
}

public class FdmsomahabatchmgrSSLStatusEvent {
  public String message;
}

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

public class DefaultFdmsomahabatchmgrEventListener implements FdmsomahabatchmgrEventListener {
  ...
  public void status(FdmsomahabatchmgrStatusEvent e) {}
  ...
}

public class FdmsomahabatchmgrStatusEvent {
  public String message;
}

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

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X.509 public key.

public Certificate( certificateData);

Parses CertificateData as an X.509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

FDMSOmahaBatchResponse Type

Contains the response to a batch operation.

Remarks

This type contains the results of a transaction made with the FDMSOmahaBatchMgr class. The fields contained by this type are listed below.

Fields

Constructors

public FDMSOmahaBatchResponse();

FDMSOmahaRecordType Type

Detail record storage type.

Remarks

This type contains the XML aggregate for a single transaction, as well as an XML aggregate of any additional addenda to be added to the record at batch closing. The fields contained by this type are listed below.

Fields

Constructors

public FDMSOmahaRecordType();

public FDMSOmahaRecordType( detailAggregate);

Proxy Type

The proxy the class will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

public Proxy();

public Proxy( server,  port);

public Proxy( server,  port,  user,  password);

Config Settings (Fdmsomahabatchmgr Class)

FDMSOmahaBatchMgr Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (Fdmsomahabatchmgr Class)

FDMSOmahaBatchMgr Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors