Search: 
Available in: OFX
FIProfile Component [IBiz E-Banking Integrator V2]

Properties   Methods   Events   Configuration Settings  

The FIProfile control is a single component that supports the SignOn and FI Profile functions of Open Financial eXchange, as described by the OFX Specification version 1.0.2.

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 FIProfile component provides the ability to download an OFX Financial Institution Profile. These profiles contain information about how to communicate with the financial institution, such as what message sets are supported and what URLs to post to for them as well as the type of data that is supported for sign on.

To use the FIProfile 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. Use the ClientRouting property to notify the server as to the client's routing capabilities. Finally, set the LastUpdate property to the date of the most recent profile request. Then just call the GetProfile method to retrieve the financial institution's profile.

To determine whether the client has the latest version of the FI profile, the server checks the date and time passed by the client in LastUpdate. If the client has the latest version of the FI profile, the server does not return a profile specific response. In this case, the ServerMessage will contain the message returned by the server (such as: 'Up to date', etc.).

The Sign On properties ( SignOnCharType, SignOnCaseSensitive, etc. ) and the Message Set properties (MessageSetLanguage, MessageSetRecovery, etc. ) may be imagined as arrays, where valid indices are from 1 to Count. For example, MessageSetLanguage(1) gives the default language of the first Message Set and MessageSetLanguage(MessageSetCount) gives the default language of the last Message Set.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

ClientRouting Client routing capabilities of the Financial Institution.
FIAddress1 Street address.
FIAddress2 Street address.
FIAddress3 Street address.
FICity City.
FICountry Country.
FICustomerServicePhone Phone number for Customer Service.
FIEmailAddress Email address for contacting the Financial Institution.
FIHomePage Home web page for general information about the Financial Institution.
FIId Financial institution identifier.
FIName Name.
FIOrganization Financial institution organization name.
FIPostalCode Postal Code.
FIProfileDate The date the current profile was posted.
FIState State.
FITechSupportPhone Phone number for Technical Support.
FIUrl Financial institution URL.
FirewallHost Name or IP address of firewall (optional).
FirewallPassword A password if authentication is to be used when connecting through the firewall.
FirewallPort Port of the firewall to connect to.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
LastUpdate Date and time of the last profile update.
MessageSetAggregate Wrapper for message sets, each pertaining to a different aggregate type.
MessageSetCount Number of message sets described in this response.
MessageSetLanguage Language supported by the server.
MessageSetName The name of the Message Set.
MessageSetRecovery If true, the server can support file-based error recovery.
MessageSetRefresh If true, the server can support Synchronized Refresh.
MessageSetSecurityLevel Security level of the message set.
MessageSetServiceProvider Name of the Service Provider.
MessageSetSignOnRealm SignOn realm used by this message set.
MessageSetSyncMode Level of synchronization offered by the server.
MessageSetTransportSecurity If true, use Transport Level security.
MessageSetURL URL to which messages from the client should be sent.
MessageSetVersion Version number of the message set.
OFXAppId OFX application identifier.
OFXAppVersion OFX application version.
OFXPassword User's password.
OFXRequest The current OFX request aggregate.
OFXResponse The current OFX response aggregate.
OFXUser User's id.
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded The SSL certificate (PEM/base64 encoded).
SSLCertStore The name of the certificate store for the client certificate.
SSLCertStorePassword The password for the certificate store (if any).
SSLCertStoreType The type of certificate store for the client certificate.
SSLCertSubject The subject of the certificate used for client authentication.
SSLServerCert The server certificate for the last established connection.
SSLServerCertStatus The verification status of the server certificate for the last established connection.
SignOnCaseSensitive If true, the password is case-sensitive.
SignOnCharType Type of characters the password can contain.
SignOnFirstPINChange If true, support PIN Change Requests in the first signon.
SignOnInfoAggregate List of Sign On Info aggregates corresponding to the queried Financial Institution.
SignOnInfoCount Number of SignOn aggregates in this response.
SignOnMaxPwdLength Maximum password length.
SignOnMinPwdLength Minimum password length.
SignOnPINChange If true, support PIN Change Requests.
SignOnRealm SignOn realm used by this message set.
SignOnSpaces If true, the password can contain spaces.
SignOnSpecial If true, the password can contain special characters.
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 complete descriptions.

Config Sets or retrieves a component configuration setting.
GetProfile Download the message set profile for a given Financial Institution.
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 complete descriptions.

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 complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
CurrencyFormat The format to be used for returning currency values.
DateFormat The format to be used for returning and parsing date strings.
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
NewPassword New password for the current OFX user.
OFXLog Log file for the OFX transaction.
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).
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic authentication is to be used for the proxy.
ProxyPort Port for the proxy server (default 80).
ProxyServer Name or IP address of a proxy server (optional).
ProxyUser A user name if Basic authentication is to be used for the proxy.
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
ServerMessage Server message if a warning or other information returned.
SocketHandle The handle of the main socket used by the component.
UseWinInet If set, the WinInet API is used for retrieving the URL
UseWinInetCookies Controls whether to send and accept cookies when making http requests through WinInet
UserAgent Information about the user agent (browser).
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.