Properties   Methods   Events   Configuration Settings  

Enables sending of multiple requests to an OFX server through a single connection .

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The OFXBatch component allows your application to download bank, credit card, investment statements, and/or FI profile of the same financial institution in one single request submitted to the FI's OFX server.

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 (stored in OFXRequest), depending on each request type, the corresponding IBiz E-Bank Integrator components should be used. So, if bank statement, credit card statement and FI profile are part of this multiple request, then instances of BANKSTATEMENT, CCSTATEMENT, 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.

After setting the OFXRequestCount property to the number of requests you want to include in the batch, 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 .

Once you have finished setting the properties that describe each individual request, set the OFXRequest in OFXBATCH (indexed from 0 to OFXRequestCount - 1) to OFXRequest of each corresponding component. For example:

OFXBatch.OFXRequest[0] = BankStatement.OFXRequest; OFXBatch.OFXRequest[1] = CCStatement.OFXRequest; OFXBatch.OFXRequest[2] = FIProfile.OFXRequest;

Then, use the PostRequest method to build and transmit the request automatically.

When the response returns, the OFXResponse 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 OFXResponse at the same index should be passed as OFXResponse of the corresponding component using the same order as submitted in the request. Requests/Response matches are made through the corresponding array indexes (ReqIndex) and OFXTrnUIDs.

BankStatement.OFXResponse = OFXBatch.OFXResponse[0]; CCStatement.OFXResponse = OFXBatch.OFXResponse[1]; FIProfile.OFXResponse = OFXBatch.OFXResponse[2];

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.

Method List

Event List

Configuration Settings