Enables sending of multiple requests to an OFX server through a single connection.
The OFXBatch component allows your application to download account information, bank, credit card, investment, loan statements, make intrabank and/or interbank transfers, and/or download your FI profile in one single request submitted to the FI's OFX server. This component provides for applying a single authentication context to multiple requests in order to reduce the overhead of user authentication.
All downloads are batched into a single secure HTTPS connection to the financial institution. To use the OFXBatch component first identify the financial institution by setting the FIId, FIOrganization and FIUrl,properties. Next identify the OFX user and application by setting the OFXUser, OFXPassword, OFXAppId and OFXAppVersion properties. The same signon information will be used for the entire batch.
To build the request, depending on each request type, the corresponding IPWorks OFX components should be used. So, if account information, bank, credit card, investment, loan statement, bank transfer, and FI profile are part of this multiple request, then instances of Account, BankStatement, CCStatement, InvStatement, LoanStatement, BankTransfer, and FIProfile (corresponding to the each request type) should be used. The individual components that generate the OFX request aggregate will not need the sign on data to generate their request.
Set properties of each corresponding component (excluding the SignOn part which is already set), as you would do when using these components to send single requests to the server. Please refer to each component help files for details on how to build each individual OFX request .
OFXBatch.OFXBatchItems.Request = BankStatement.OFXRequest; OFXBatch.OFXBatchItems.Request = CCStatement.OFXRequest; OFXBatch.OFXBatchItems.Request = FIProfile.OFXRequest;
Then, use the PostRequest method to build and transmit the request automatically.
Message sets will/must appear in the following order in the request: Signon, Signup, Bank statement, Intrabank funds transfers, Credit card statements, Loan statements, Investment statements, Interbank funds transfers, and FI Profile, regardless of their order while populating the OFXBatchItems. In the server response, the message sets will be returned in the server response in the same order.
Upon successful response, the Response array property will be populated automatically, which will contain several blocks of information consisting of a server response for each request. To parse this response, the Response at the same index should be passed as OFXResponse of the corresponding component using the same order as submitted in the request.
BankStatement.OFXResponse = OFXBatch.OFXBatchItems.Response; CCStatement.OFXResponse = OFXBatch.OFXBatchItems.Response; FIProfile.OFXResponse = OFXBatch.OFXBatchItems.Response;
Properties of each component are now populated and ready for retrieval.
Note: If signon data is different across components, then they cannot be used in the same batch, otherwise an error will be thrown.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|FIId||Financial institution identifier.|
|FIOrganization||Financial institution organization name.|
|Firewall||A set of properties related to firewall access.|
|FIUrl||Financial institution URL.|
|OFXAppId||OFX application identifier.|
|OFXAppVersion||OFX application version.|
|OFXBatchItems||A list of items (requests/response pairs) that make up the current OFX batch.|
|Proxy||A set of properties related to proxy access.|
|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.|
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|config||Sets or retrieves a configuration setting.|
|postRequest||Submits a batch of requests to an OFX server through a single connection.|
|readOFXDataFile||Reads an OFX response from a file.|
|reset||Reset the internal state of the component and all properties to their default values.|
|writeOFXDataFile||Writes the OFX response sent by the server to a file.|
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
|ConnectionStatus||Fired to indicate changes in connection state.|
|Error||Information about errors during data delivery.|
|SSLServerAuthentication||Fired after the server presents its certificate to the client.|
|SSLStatus||Shows the progress of the secure connection.|
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
|CacheContent||If true, the original XML is saved in a buffer.|
|ErrorOnEmptyAttr||If true, passing an invalid attribute to the Attr method will throw an exception.|
|IgnoreBadAttributePrefixes||If true, bad (unknown) attribute prefixes are ignored.|
|IgnoreBadElementPrefixes||If true, bad (unknown) element prefixes are ignored.|
|PreserveWhitespace||If true, leading and trailing whitespace in element text is preserved.|
|BuildInfo||Information about the product's build.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|LicenseInfo||Information about the current license.|
|UseDaemonThreads||Whether threads created by the component are daemon threads.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|