E-Banking Integrator OFXBatch Component : OFXBatch OCX, OFXBatch .NET Component, OFXBatch Class, OFXBatch Bean, OFXBatch Object

Available in: OFX

OFXBatch Component [E-Banking Integrator V3]

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, depending on each request type, the corresponding E-Banking 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.

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 OFXBatchItems in OFXBATCH to the OFXRequest of each corresponding component. For example:

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

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

When the response returns, the OFXBatchItems 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 OFXBatchItems 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[0].Response; CCStatement.OFXResponse = OFXBatch.OFXBatchItems[1].Response; FIProfile.OFXResponse = OFXBatch.OFXBatchItems[2].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.

Property List

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.
OFXPassword	User's password.
OFXUser	User's id.
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.

Method List

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.

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.


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.

Configuration Settings

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


IgnoreBadAttributePrefixes	If true, bad (unknown) attribute prefixes are ignored
IgnoreBadElementPrefixes	If true, bad (unknown) element prefixes are ignored
CacheContent	If true, the original XML is saved in a buffer
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only)