FDMSOmahaBatchMgr Component
Properties Methods Events Configuration Settings Errors
The FDMSOmahaBatchMgr component is used to close batches and also handles the sending of all offline transactions to the FDMS Host.
Syntax
nsoftware.InPayDirect.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 component with short descriptions. Click on the links for further details.
| ApplicationId | Identifies the merchant application to the Datawire System. |
| BatchNumber | Number identifying the batch (assigned by the POS device). |
| ClientRef | Uniquely identifies the transaction within the Datawire system. |
| DatawireId | Identifies the merchant to the Datawire System. |
| DetailRecords | Collection of detail records to send in the close batch transaction. |
| DeviceId | POS Device Identification. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where IPPort binds. |
| MerchantNumber | A unique number used to identify the merchant within the FDMS systems. |
| MerchantTerminalID | Used to identify a unique terminal within a merchant location. |
| Proxy | A set of properties related to proxy access. |
| RemoteHost | The address of the remote host. Domain names are resolved to IP addresses. |
| RemotePort | The TCP port in the remote host. |
| Response | Contains the response to an authorization request. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| Timeout | A timeout for the component. |
| TransactionNumber | The transaction number for the current transaction. |
| URL | Location of the Datawire server to which transactions are sent. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| CloseBatch | Sends a Close Batch request. |
| Config | Sets or retrieves a configuration setting . |
| DepositInquiry | Sends a Deposit Inquiry request. |
| Interrupt | Interrupts the current action. |
| Reset | Clears all properties to their default values. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Connected | Fired immediately after a connection completes (or fails). |
| DataPacketIn | Fired when receiving a data packet from the transaction server. |
| DataPacketOut | Fired when sending a data packet to the transaction server. |
| Disconnected | Fired when a connection is closed. |
| Error | Information about errors during data delivery. |
| RevisionInquiry | Fired when a revision inquiry request is received from the host. |
| SpecificPoll | Fired when a specific poll request is received from the host. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| Status | Shows the progress of the FDMS/Datawire connection. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| CreditBatchAmount | Dollar-and-cent amount ($$$$$$.cc) of all the credit card transactions in the batch. |
| DebitBatchCount | Number of debit items in the batch. |
| DebitBatchAmount | Total dollar-and-cent amount ($$$$$$.cc) of all the debit card transactions in the batch. |
| TransportProtocol | Specifies the transport protocol to use to communicate with the FDMS Omaha server. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |