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

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.).

Property List


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

ChallengeQuestionsA list of MFA challenge question/answer pairs required for Multi-Factor Authentication.
ClientRoutingClient routing capabilities of the Financial Institution.
FIAddress1Street address.
FIAddress2Street address.
FIAddress3Street address.
FICityCity.
FICountryCountry.
FICustomerServicePhonePhone number for Customer Service.
FIEmailAddressEmail address for contacting the Financial Institution.
FIHomePageHome web page for general information about the Financial Institution.
FIIdFinancial institution identifier.
FINameName.
FIOrganizationFinancial institution organization name.
FIPostalCodePostal Code.
FIProfileDateThe date the current profile was posted.
FirewallA set of properties related to firewall access.
FIStateState.
FITechSupportPhonePhone number for Technical Support.
FIUrlFinancial institution URL.
LastUpdateDate and time of the last profile update.
MessageSetsA list of message sets supported by the current Financial Institution.
OFXAccessKeyAccess key value received after a MFA authentication in a previous signon.
OFXAppIdOFX application identifier.
OFXAppVersionOFX application version.
OFXPasswordUser's password.
OFXRequestThe current OFX request aggregate.
OFXResponseThe current OFX response aggregate.
OFXUserUser's id.
OFXVersionOFX API version
SignOnDetailsA list of sign on details for the current Financial Institution.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA 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.

ConfigSets or retrieves a configuration setting.
GetProfileDownload the message set profile for a given Financial Institution.
ReadOFXDataFileReads an OFX response from a file.
RequestChallengeQuestionsDownload the challenge questions when Multi-Factor Authentication (MFA) is required.
ResetReset the internal state of the component and all properties to their default values.
SendChallengeAnswersSend the answers to challenge questions for a Multi-Factor Authentication (MFA).
WriteOFXDataFileWrites 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.

ConnectionStatusFired to indicate changes in connection state.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows 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.

CurrencyFormatThe format to be used for returning currency values
OFXDateFormatThe date format as required by OFX FI server
DateFormatThe format to be used for input and output dates
NewPasswordNew password for the current OFX user
OFXLogLog file for the OFX transaction
ServerMessageServer message if a warning or other information returned
ClientUIdUnique ID identifying OFX Client
UserCred1AAdditional user credential required by server
UserCred2AAdditional user credential required by server
AuthTokenAuthentication token required for this signon session only
AcceptEncodingUsed to tell the server which types of content encodings the client supports
AllowHTTPCompressionThis property enables HTTP compression for receiving data
AuthorizationThe Authorization string to be sent to the server
EncodeURLIf set to true the URL will be encoded by the component
GetOn302RedirectIf set to true the component will perform a GET on the new location
HTTPVersionThe version of HTTP used by the component
IfModifiedSinceA date determining the maximum age of the desired document
KeepAliveDetermines whether the HTTP connection is closed after completion of the request
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
ProxyAuthorizationThe authorization string to be sent to the proxy server
ProxyAuthSchemeThe authorization scheme to be used for the proxy
ProxyPasswordA password if authentication is to be used for the proxy
ProxyPortPort for the proxy server (default 80)
ProxyServerName or IP address of a proxy server (optional)
ProxyUserA user name if authentication is to be used for the proxy
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component
UsePlatformHTTPClientWhether or not to use the platform HTTP client
UserAgentInformation about the user agent (browser)
UseWinInetIf set, the WinInet API is used for retrieving the URL
UseWinInetCookiesControls whether to send and accept cookies when making HTTP requests through WinInet
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHostName or IP address of firewall (optional)
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall
FirewallPortThe TCP port for the FirewallHost;
FirewallUserA user name if authentication is to be used connecting through a firewall
FirewallTypeDetermines the type of firewall to connect through
TcpNoDelayWhether or not to delay when sending packets
ReuseSSLSessionDetermines if the SSL session is reused
SSLCipherStrengthThe minimum cipher strength used for bulk encryption
SSLEnabledProtocolsUsed to enable/disable the supported security protocols
SSLProviderThe name of the security provider to use
SSLSecurityFlagsFlags that control certificate verification
OpenSSLCADirThe path to a directory containing CA certificates
OpenSSLCAFileName of the file containing the list of CA's trusted by your application
OpenSSLCipherListA string that controls the ciphers to be used by SSL
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG)
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts
FirewallDataUsed to send extra data to the firewall
InBufferSizeThe size in bytes of the incoming queue of the socket
OutBufferSizeThe size in bytes of the outgoing queue of the socket
CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only)

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