FIProfile Component
Properties Methods Events Configuration Settings Errors
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.
Syntax
nsoftware.InEBank.Fiprofile
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.
| ChallengeQuestions | A list of MFA challenge question/answer pairs required for Multi-Factor Authentication. |
| 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. |
| Firewall | A set of properties related to firewall access. |
| FIState | State. |
| FITechSupportPhone | Phone number for Technical Support. |
| FIUrl | Financial institution URL. |
| LastUpdate | Date and time of the last profile update. |
| MessageSets | A list of message sets supported by the current Financial Institution. |
| OFXAccessKey | Access key value received after a MFA authentication in a previous signon. |
| 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. |
| OFXVersion | OFX API version. |
| SignOnDetails | A list of sign on details for the current Financial Institution. |
| 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 . |
| GetProfile | Download the message set profile for a given Financial Institution. |
| ReadOFXDataFile | Reads an OFX response from a file. |
| RequestChallengeQuestions | Download the challenge questions when Multi-Factor Authentication (MFA) is required. |
| Reset | Reset the internal state of the component and all properties to their default values. |
| SendChallengeAnswers | Send the answers to challenge questions for a Multi-Factor Authentication (MFA). |
| 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.
| CurrencyFormat | The format to be used for returning currency values. |
| OFXDateFormat | The date format as required by OFX FI server. |
| DateFormat | The format to be used for input and output dates. |
| GetResponseVar | Parses additional information out of the response. |
| NewPassword | New password for the current OFX user. |
| OFXLog | Log file for the OFX transaction. |
| ServerMessage | Server message if a warning or other information returned. |
| ClientUId | Unique ID identifying OFX Client. |
| UserCred1A | Additional user credential required by server. |
| UserCred2A | Additional user credential required by server. |
| AuthToken | Authentication token required for this signon session only. |
| CorrectFITID[i] | The FITID of a previously sent transaction corrected by the current one. |
| CorrectAction[i] | The action taken to a previously sent transaction corrected by the current one. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if 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 authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| 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. |
| 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). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |