FIProfile Control

Properties Methods Events Config Settings Errors

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

Syntax

FIProfile

Remarks

The FIProfile control 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 control, 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 control with short descriptions. Click on the links for further details.


ChallengeQuestionCount	The number of records in the Challenge arrays.
ChallengeAggregate	Wrapper for a MFA challenge question.
ChallengeAnswer	User's answer to the challenge question identified by QuestionId .
ChallengeQuestion	The textual challenge question.
ChallengeQuestionId	Identifier for the challenge question.
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.
FirewallAutoDetect	This property tells the control whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
FIState	State.
FITechSupportPhone	Phone number for Technical Support.
FIUrl	Financial institution URL.
LastUpdate	Date and time of the last profile update.
MessageSetCount	The number of records in the MessageSet arrays.
MessageSetAggregate	Wrapper for a message set.
MessageSetClosingInfoAvailability	This is an indicator of the Financial Institution's statement closing information capabilities.
MessageSetClosingInfoImage	This is an indicator of the Financial Institution's statement closing image capabilities.
MessageSetLanguage	Languages the server supports.
MessageSetName	Name of a message set supported by the given FI.
MessageSetRecovery	This is an indicator of the Financial Institution's error-recovery capabilities.
MessageSetRefresh	If true, the server can support Synchronized Refresh.
MessageSetSecurityLevel	Security level of the Message Set.
MessageSetServiceProvider	If the OFX server has been outsourced to a service provider other than the Financial Institution, then the name of that provider should appear here.
MessageSetSignOnRealm	This is the name of the SignOn realm used by this message set.
MessageSetSyncMode	Level of synchronization offered by the server for this message set.
MessageSetTransportSecurity	It indicates whether any security measures are taken at the Transport Layer for this message set.
MessageSetTxImage	It indicates whether FI supports transaction image download for this message set.
MessageSetURL	This is the address of the server to which OFX (HTTP) connections are made for this particular message set.
MessageSetVersion	This version number corresponds to the version of the OFX Specification which the server uses for the message set.
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.
SignOnInfoCount	The number of records in the SignOn arrays.
SignOnAggregate	Wrapper for signon information.
SignOnAuthToken	Text label for the Authentication Token.
SignOnAuthTokenFirst	Indicates whether server requires clients to send the Authentication Token as part of first signon.
SignOnAuthTokenUrl	URL where Authentication Token information is provided by the institution operating the OFX server.
SignOnCaseSensitive	Indicates whether the password is case-sensitive or not.
SignOnCharType	Type of characters the password can contain.
SignOnClientUIdReq	Indicates whether the Client Unique Identifier is required to be included in the signon.
SignOnMaxPwdLength	Maximum number of characters a SignOn password on this server can have.
SignOnMFAChallengeFirst	Indicates whether the Multi-Factor Authentication (MFA) challenge is required to be included in the first signon to this server.
SignOnMFAChallengeReq	Indicates whether the Multi-Factor Authentication (MFA) challenge is required by this FI server.
SignOnMinPwdLength	Minimum number of characters a SignOn password on this server can have.
SignOnPINChange	It indicates whether the server accepts any PIN Change Requests at all.
SignOnPINChangeFirst	Indicates whether server requires clients to change password as part of first signon.
SignOnRealm	SignOn realm used by this message set.
SignOnSpaces	It indicates whether the password can contain whitespaces.
SignOnSpecial	It indicates whether the password can contain special characters.
SignOnUserCred1Q	Text prompt for user credential.
SignOnUserCred2Q	Text prompt for user credential.
SSLAcceptServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/base64 encoded).
Timeout	A timeout for the control.

Method List

The following is the full list of the methods of the control 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 control 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 control with short descriptions. Click on the links for further details.


ConnectionStatus	This event is fired to indicate changes in the 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.

Config Settings

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


AuthToken	Authentication token required for this signon session only.
ClientUId	Unique ID identifying OFX Client.
CorrectAction[i]	The action taken to a previously sent transaction corrected by the current one.
CorrectFITID[i]	The FITID of a previously sent transaction corrected by the current one.
CurrencyFormat	The format to be used for returning currency values.
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.
OFXDateFormat	The date format as required by OFX FI server.
OFXLog	Log file for the OFX transaction.
ServerMessage	Server message if a warning or other information returned.
UserCred1A	Additional user credential required by server.
UserCred2A	Additional user credential required by server.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
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.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the control.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the control will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the control.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
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.
SentHeaders	The full set of headers as sent by the client.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the control.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the control 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.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
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 port in the local host where the control binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
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).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
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.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the control whether or not to use the system security libraries or an internal implementation.

ChallengeQuestionCount Property (FIProfile Control)

The number of records in the Challenge arrays.

Syntax

fiprofilecontrol.ChallengeQuestionCount[=integer]

Default Value

Remarks

This property controls the size of the following arrays:

ChallengeAggregate
ChallengeAnswer
ChallengeQuestion
ChallengeQuestionId

The array indices start at 0 and end at ChallengeQuestionCount - 1.

This property is not available at design time.

Data Type

Integer

ChallengeAggregate Property (FIProfile Control)

Wrapper for a MFA challenge question.

Syntax

fiprofilecontrol.ChallengeAggregate(ChallengeQuestionIndex)

Default Value

Remarks

Wrapper for a MFA challenge question.

Each challenge question aggregate contains elements and values associated with the following properties:

ChallengeQuestionId
ChallengeQuestion

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the control's properties. However, some of these elements, and/or their potential values, may not be supported by the control. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate control or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the control internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The ChallengeQuestionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeQuestionCount property.

This property is read-only and not available at design time.

Data Type

String

ChallengeAnswer Property (FIProfile Control)

User's answer to the challenge question identified by QuestionId .

Syntax

fiprofilecontrol.ChallengeAnswer(ChallengeQuestionIndex)[=string]

Default Value

Remarks

User's answer to the challenge question identified by ChallengeQuestionId.

Depending on the value of ChallengeQuestionId, this answer can be collected by user or client. Values above MFA100 are reserved for questions that the server expects the client to answer. These do not require customer responses. All other IDs as well as server specific IDs expect customer responses. Clients may need to identify out of band which of the IDs above MFA100 they support.

The ChallengeQuestionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeQuestionCount property.

This property is not available at design time.

Data Type

String

ChallengeQuestion Property (FIProfile Control)

The textual challenge question.

Syntax

fiprofilecontrol.ChallengeQuestion(ChallengeQuestionIndex)

Default Value

Remarks

The textual challenge question.

The following table details the list of possible reserved values for ChallengeQuestionId and corresponding textual description of the challenge question:


ChallengeQuestionId	ChallengeQuestion
MFA1	City of birth
MFA2	Date of birth, formatted MM/DD/YYYY
MFA3	Debit card number
MFA4	Father's middle name
MFA5	Favorite color
MFA6	First pet's name
MFA7	Five digit ZIP code
MFA8	Grandmother's maiden name on your father's side
MFA9	Grandmother's maiden name on your mother's side
MFA10	Last four digits of your cell phone number
MFA11	Last four digits of your daytime phone number
MFA12	Last four digits of your home phone number
MFA13	Last four digits of your social security number
MFA14	Last four digits of your tax ID
MFA15	Month of birth of youngest sibling, do not abbreviate
MFA16	Mother's maiden name
MFA17	Mother's middle name
MFA18	Name of the company where you had your first job
MFA19	Name of the manufacturer of your first car
MFA20	Name of the street you grew up on
MFA21	Name of your high school football team, do not include high school name, e.g. "Beavers" rather than "Central High Beavers"
MFA22	Recent deposit or recent withdrawal amount
MFA23	Year of birth, formatted YYYY
MFA101	Datetime, formatted YYYYMMDDHHMMSS
MFA102	Host name
MFA103	IP Address
MFA104	MAC Address
MFA105	Operating System version
MFA106	Processor architecture, e.g. I386
MFA107	UserAgent

Note:Values above MFA100 are reserved for questions that the server expects the client to answer. These do not require customer responses. All other IDs as well as server specific IDs expect customer responses. Clients may need to identify out of band which of the IDs above MFA100 they support.

The ChallengeQuestionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeQuestionCount property.

This property is read-only and not available at design time.

Data Type

String

ChallengeQuestionId Property (FIProfile Control)

Identifier for the challenge question.

Syntax

fiprofilecontrol.ChallengeQuestionId(ChallengeQuestionIndex)

Default Value

Remarks

Identifier for the challenge question.

This is unique for this challenge question, but not unique for the user, session, etc.

The following table details the list of possible reserved values for ChallengeQuestionId and corresponding textual description of the challenge question:


ChallengeQuestionId	ChallengeQuestion
MFA1	City of birth
MFA2	Date of birth, formatted MM/DD/YYYY
MFA3	Debit card number
MFA4	Father's middle name
MFA5	Favorite color
MFA6	First pet's name
MFA7	Five digit ZIP code
MFA8	Grandmother's maiden name on your father's side
MFA9	Grandmother's maiden name on your mother's side
MFA10	Last four digits of your cell phone number
MFA11	Last four digits of your daytime phone number
MFA12	Last four digits of your home phone number
MFA13	Last four digits of your social security number
MFA14	Last four digits of your tax ID
MFA15	Month of birth of youngest sibling, do not abbreviate
MFA16	Mother's maiden name
MFA17	Mother's middle name
MFA18	Name of the company where you had your first job
MFA19	Name of the manufacturer of your first car
MFA20	Name of the street you grew up on
MFA21	Name of your high school football team, do not include high school name, e.g. "Beavers" rather than "Central High Beavers"
MFA22	Recent deposit or recent withdrawal amount
MFA23	Year of birth, formatted YYYY
MFA101	Datetime, formatted YYYYMMDDHHMMSS
MFA102	Host name
MFA103	IP Address
MFA104	MAC Address
MFA105	Operating System version
MFA106	Processor architecture, e.g. I386
MFA107	UserAgent

The ChallengeQuestionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChallengeQuestionCount property.

This property is read-only and not available at design time.

Data Type

String

ClientRouting Property (FIProfile Control)

Client routing capabilities of the Financial Institution.

Syntax

fiprofilecontrol.ClientRouting[=integer]

Possible Values

crNone(0), 
crService(1), 
crMessageSet(2)

Default Value

Remarks


crNone (0)	Client cannot perform any routing, URLs must all be the same, and all message sets share one signon realm.
crService (1)	Client can perform limited routing.
crMessageSet (2)	Client can route at the message-set level. Each message set can have a different URL and/or signon realm.

Data Type

Integer

FIAddress1 Property (FIProfile Control)

Street address.

Syntax

fiprofilecontrol.FIAddress1

Default Value

Remarks

The first line of the street address of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FIAddress2 Property (FIProfile Control)

Street address.

Syntax

fiprofilecontrol.FIAddress2

Default Value

Remarks

The second line of the street address of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FIAddress3 Property (FIProfile Control)

Street address.

Syntax

fiprofilecontrol.FIAddress3

Default Value

Remarks

The third line of the street address of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FICity Property (FIProfile Control)

City.

Syntax

fiprofilecontrol.FICity

Default Value

Remarks

The city where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FICountry Property (FIProfile Control)

Country.

Syntax

fiprofilecontrol.FICountry

Default Value

Remarks

The country where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FICustomerServicePhone Property (FIProfile Control)

Phone number for Customer Service.

Syntax

fiprofilecontrol.FICustomerServicePhone

Default Value

Remarks

This is the Financial Institution's Customer Service phone number.

This property is read-only.

Data Type

String

FIEmailAddress Property (FIProfile Control)

Email address for contacting the Financial Institution.

Syntax

fiprofilecontrol.FIEmailAddress

Default Value

Remarks

The FI email address.

This property is read-only.

Data Type

String

FIHomePage Property (FIProfile Control)

Home web page for general information about the Financial Institution.

Syntax

fiprofilecontrol.FIHomePage

Default Value

Remarks

The Financial Institution's home page URL.

This property is read-only.

Data Type

String

FIId Property (FIProfile Control)

Financial institution identifier.

Syntax

fiprofilecontrol.FIId[=string]

Default Value

Remarks

FIId holds the identifier of the OFX Financial Institution and is used during signon. This value is unique for each organization name.

Data Type

String

FIName Property (FIProfile Control)

Name.

Syntax

fiprofilecontrol.FIName

Default Value

Remarks

The name of the individual or business is stored in this property as a string.

This property is read-only.

Data Type

String

FIOrganization Property (FIProfile Control)

Financial institution organization name.

Syntax

fiprofilecontrol.FIOrganization[=string]

Default Value

Remarks

This is the name of the OFX Financial Institution and is used during signon. Each organization has a unique FIId that must also be used at signon.

Data Type

String

FIPostalCode Property (FIProfile Control)

Postal Code.

Syntax

fiprofilecontrol.FIPostalCode

Default Value

Remarks

The postal code where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FIProfileDate Property (FIProfile Control)

The date the current profile was posted.

Syntax

fiprofilecontrol.FIProfileDate

Default Value

Remarks

The date the OFX Financial Institution posted the current profile.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

Note: you may use this date on subsequent profile requests to ensure that you receive the latest profile. Simply set the LastUpdate property to the value in this property on any subsequent profile requests.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (FIProfile Control)

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Syntax

fiprofilecontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (FIProfile Control)

This property determines the type of firewall to connect through.

Syntax

fiprofilecontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Data Type

Integer

FirewallHost Property (FIProfile Control)

This property contains the name or IP address of firewall (optional).

Syntax

fiprofilecontrol.FirewallHost[=string]

Default Value

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (FIProfile Control)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

fiprofilecontrol.FirewallPassword[=string]

Default Value

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (FIProfile Control)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

fiprofilecontrol.FirewallPort[=integer]

Default Value

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (FIProfile Control)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

fiprofilecontrol.FirewallUser[=string]

Default Value

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

FIState Property (FIProfile Control)

State.

Syntax

fiprofilecontrol.FIState

Default Value

Remarks

The state or province where the individual or business is located is stored in this property as a string.

This property is read-only.

Data Type

String

FITechSupportPhone Property (FIProfile Control)

Phone number for Technical Support.

Syntax

fiprofilecontrol.FITechSupportPhone

Default Value

Remarks

The Financial Institution's Tech Support department phone number.

This property is read-only.

Data Type

String

FIUrl Property (FIProfile Control)

Financial institution URL.

Syntax

fiprofilecontrol.FIUrl[=string]

Default Value

Remarks

This is the URL of the OFX Financial Institution to which the control will signon and fetch data.

Data Type

String

LastUpdate Property (FIProfile Control)

Date and time of the last profile update.

Syntax

fiprofilecontrol.LastUpdate[=string]

Default Value

"20000101120000.000[+0:GMT]"

Remarks

This is the date (last time) the FI updated the profile on their end. If this is the first time the FIProfile control is being used, use the default value to ensure that the latest update is received. This property must be set to a value that was returned in the FIProfileDate property after a previous profile request.

This format specifies also how the returned dates are going to get parsed.

This property is not available at design time.

Data Type

String

MessageSetCount Property (FIProfile Control)

The number of records in the MessageSet arrays.

Syntax

fiprofilecontrol.MessageSetCount

Default Value

Remarks

This property controls the size of the following arrays:

MessageSetAggregate
MessageSetClosingInfoAvailability
MessageSetClosingInfoImage
MessageSetLanguage
MessageSetName
MessageSetRecovery
MessageSetRefresh
MessageSetSecurityLevel
MessageSetServiceProvider
MessageSetSignOnRealm
MessageSetSyncMode
MessageSetTransportSecurity
MessageSetTxImage
MessageSetURL
MessageSetVersion

The array indices start at 0 and end at MessageSetCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

MessageSetAggregate Property (FIProfile Control)

Wrapper for a message set.

Syntax

fiprofilecontrol.MessageSetAggregate(MessageSetIndex)

Default Value

Remarks

Wrapper for a message set.

A list of all of a given Financial Institution's supported services are stored in a series of aggregates called 'Message Sets'.

Each message set aggregate contains data (elements and values) associated with the following properties:

MessageSetName
MessageSetLanguage
MessageSetRecovery
MessageSetRefresh
MessageSetSecurityLevel
MessageSetServiceProvider
MessageSetSignOnRealm
MessageSetSyncMode
MessageSetTransportSecurity
MessageSetURL
MessageSetVersion

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetClosingInfoAvailability Property (FIProfile Control)

This is an indicator of the Financial Institution's statement closing information capabilities.

Syntax

fiprofilecontrol.MessageSetClosingInfoAvailability(MessageSetIndex)

Default Value

False

Remarks

This is an indicator of the Financial Institution's statement closing information capabilities. If true, the server can support statement closing information download for this message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetClosingInfoImage Property (FIProfile Control)

This is an indicator of the Financial Institution's statement closing image capabilities.

Syntax

fiprofilecontrol.MessageSetClosingInfoImage(MessageSetIndex)

Default Value

False

Remarks

This is an indicator of the Financial Institution's statement closing image capabilities. If true, the server can support image of the statement closing information for this message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetLanguage Property (FIProfile Control)

Languages the server supports.

Syntax

fiprofilecontrol.MessageSetLanguage(MessageSetIndex)

Default Value

Remarks

Languages the server supports. More than one may appear in given response.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetName Property (FIProfile Control)

Name of a message set supported by the given FI.

Syntax

fiprofilecontrol.MessageSetName(MessageSetIndex)

Default Value

Remarks

Name of a message set supported by the given FI.

Each MessageSetAggregate corresponds to a different OFX command. For example, SIGNONMSGSET corresponds to SignOn Request Message. The MessageSetName is used to retrieve the name of the command associated with this Message Set.

The following table lists each message set, along with its aggregate name and the OFX Versions that support it.


Message Set	Message Set Aggregate	OFX Version support
Signon	SIGNONMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Signup	SIGNUPMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Banking	BANKMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Credit Card Statements	CREDITCARDMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Loan Statements	LOANMSGSETV1	2.1, 2.1.1
Investment Statements	INVSTMTMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Interbank Funds Transfers	INTERXFERMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Payments	BILLPAYMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Investment security list	SECLISTMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
FI Profile	PROFMSGSETV1	1.0.2, 1.0.3, 1.5.1, 1.6, 2.0, 2.0.1, 2.0.2, 2.0.3, 2.1, 2.1.1
Image download	IMAGEMSGSETV1	2.1, 2.1.1

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetRecovery Property (FIProfile Control)

This is an indicator of the Financial Institution's error-recovery capabilities.

Syntax

fiprofilecontrol.MessageSetRecovery(MessageSetIndex)

Default Value

False

Remarks

This is an indicator of the Financial Institution's error-recovery capabilities. If true, the server can support file-based error recovery.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetRefresh Property (FIProfile Control)

If true, the server can support Synchronized Refresh.

Syntax

fiprofilecontrol.MessageSetRefresh(MessageSetIndex)

Default Value

False

Remarks

If true, the server can support Synchronized Refresh. Even if this property is set to false, the Financial Institution's server may still be able to support Lite Synchronization.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetSecurityLevel Property (FIProfile Control)

Security level of the Message Set.

Syntax

fiprofilecontrol.MessageSetSecurityLevel(MessageSetIndex)

Default Value

Remarks

Security level of the Message Set.

Legal values are defined as follows: "NONE" and "TYPE 1". If the MessageSetSecurityLevel of a Message Set is 'TYPE 1', then the requests for that Message Set submitted to that FI will require a challenge request to be present during the signon.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetServiceProvider Property (FIProfile Control)

If the OFX server has been outsourced to a service provider other than the Financial Institution, then the name of that provider should appear here.

Syntax

fiprofilecontrol.MessageSetServiceProvider(MessageSetIndex)

Default Value

Remarks

If the OFX server has been outsourced to a service provider other than the Financial Institution, then the name of that provider should appear here.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetSignOnRealm Property (FIProfile Control)

This is the name of the SignOn realm used by this message set.

Syntax

fiprofilecontrol.MessageSetSignOnRealm(MessageSetIndex)

Default Value

Remarks

This is the name of the SignOn realm used by this message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetSyncMode Property (FIProfile Control)

Level of synchronization offered by the server for this message set.

Syntax

fiprofilecontrol.MessageSetSyncMode(MessageSetIndex)

Default Value

Remarks

Level of synchronization offered by the server for this message set. The valid values are:


FULL
LITE

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetTransportSecurity Property (FIProfile Control)

It indicates whether any security measures are taken at the Transport Layer for this message set.

Syntax

fiprofilecontrol.MessageSetTransportSecurity(MessageSetIndex)

Default Value

False

Remarks

It indicates whether any security measures are taken at the Transport Layer for this message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetTxImage Property (FIProfile Control)

It indicates whether FI supports transaction image download for this message set.

Syntax

fiprofilecontrol.MessageSetTxImage(MessageSetIndex)

Default Value

False

Remarks

It indicates whether FI supports transaction image download for this message set. If True, the server supports transaction image (e.g., check image) for this message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

Boolean

MessageSetURL Property (FIProfile Control)

This is the address of the server to which OFX (HTTP) connections are made for this particular message set.

Syntax

fiprofilecontrol.MessageSetURL(MessageSetIndex)

Default Value

Remarks

This is the address of the server to which OFX (HTTP) connections are made for this particular message set.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

MessageSetVersion Property (FIProfile Control)

This version number corresponds to the version of the OFX Specification which the server uses for the message set.

Syntax

fiprofilecontrol.MessageSetVersion(MessageSetIndex)

Default Value

Remarks

This version number corresponds to the version of the OFX Specification which the server uses for the message set. Usually this will be the same version supplied by the client, but sometimes versions may differ across message sets. Servers are required to provide this value in the VER element of the message set aggregate.

The MessageSetIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MessageSetCount property.

This property is read-only and not available at design time.

Data Type

String

OFXAccessKey Property (FIProfile Control)

Access key value received after a MFA authentication in a previous signon.

Syntax

fiprofilecontrol.OFXAccessKey[=string]

Default Value

Remarks

This might be returned in the server response after a MFA authentication (i.e. MFA challenge question/answer pairs were validated by the server when the SendChallengeAnswers method in FIProfile control was called).

To prevent servers from needing to authenticate the user in each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response (when the SendChallengeAnswers method in FIProfile control was called).

The server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the OFXAccessKey it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request again (by calling the RequestChallengeQuestions method in FIProfile control). This allows the server to determine the lifetime of the OFXAccessKey.

Data Type

String

OFXAppId Property (FIProfile Control)

OFX application identifier.

Syntax

fiprofilecontrol.OFXAppId[=string]

Default Value

Remarks

This is the unique identifier of the user's OFX application.

Data Type

String

OFXAppVersion Property (FIProfile Control)

OFX application version.

Syntax

fiprofilecontrol.OFXAppVersion[=string]

Default Value

Remarks

This is the version of the user's OFX application.

Data Type

String

OFXPassword Property (FIProfile Control)

User's password.

Syntax

fiprofilecontrol.OFXPassword[=string]

Default Value

Remarks

This is the password used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXRequest Property (FIProfile Control)

The current OFX request aggregate.

Syntax

fiprofilecontrol.OFXRequest

Default Value

Remarks

Polling OFXRequest will cause the control to generate and return an OFX request aggregate.

This property is read-only and not available at design time.

Data Type

String

OFXResponse Property (FIProfile Control)

The current OFX response aggregate.

Syntax

fiprofilecontrol.OFXResponse[=string]

Default Value

Remarks

This can be used especially for debugging purposes. This can also be used to parse an OFX Response. To do so, you can set the OFX Response data (in string format) to OFXResponse. Once set, the supplied OFX data will be parsed and will populate the same read-only properties that ReadOFXDataFile does.

This property is not available at design time.

Data Type

String

OFXUser Property (FIProfile Control)

User's id.

Syntax

fiprofilecontrol.OFXUser[=string]

Default Value

Remarks

This is the UserID used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXVersion Property (FIProfile Control)

OFX API version.

Syntax

fiprofilecontrol.OFXVersion[=string]

Default Value

"102"

Remarks

This is the OFX API version used in all requests sent to your FI server (such as 1.0.2, 2.0.1, 2.1.1, etc.). Valid values: 102, 103, 200, 201, 203, 210, 211. Note that not all OFX Versions are supported by FIs.

Note: If the OFXVersion is set to 1x, the request and the response are going to be in SGML format. If set to 2x, the request will be in XML format (the response format depends on the FI's server capabilities). Note that if the OFX FI server does not support version 2x, the server will return an error (such as 'Bad Request').

Certain services are available only for a specific OFX version. For example, image download, is available only in OFX version 2.1.1.

Data Type

String

SignOnInfoCount Property (FIProfile Control)

The number of records in the SignOn arrays.

Syntax

fiprofilecontrol.SignOnInfoCount

Default Value

Remarks

This property controls the size of the following arrays:

SignOnAggregate
SignOnAuthToken
SignOnAuthTokenFirst
SignOnAuthTokenUrl
SignOnCaseSensitive
SignOnCharType
SignOnClientUIdReq
SignOnMaxPwdLength
SignOnMFAChallengeFirst
SignOnMFAChallengeReq
SignOnMinPwdLength
SignOnPINChange
SignOnPINChangeFirst
SignOnRealm
SignOnSpaces
SignOnSpecial
SignOnUserCred1Q
SignOnUserCred2Q

The array indices start at 0 and end at SignOnInfoCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SignOnAggregate Property (FIProfile Control)

Wrapper for signon information.

Syntax

fiprofilecontrol.SignOnAggregate(SignOnIndex)

Default Value

Remarks

Wrapper for signon information.

Each signon information aggregate contains data (elements and values) associated with the following properties:

SignOnMaxPwdLength
SignOnMinPwdLength
SignOnCaseSensitive
SignOnCharType
SignOnSpaces
SignOnSpecial
SignOnPINChangeFirst
SignOnPINChange
SignOnAuthTokenFirst
SignOnAuthToken
SignOnAuthTokenUrl
SignOnClientUIdReq
SignOnMFAChallengeReq
SignOnMFAChallengeFirst
SignOnUserCred1Q
SignOnUserCred2Q
SignOnRealm

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SignOnAuthToken Property (FIProfile Control)

Text label for the Authentication Token.

Syntax

fiprofilecontrol.SignOnAuthToken(SignOnIndex)

Default Value

Remarks

Text label for the Authentication Token.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SignOnAuthTokenFirst Property (FIProfile Control)

Indicates whether server requires clients to send the Authentication Token as part of first signon.

Syntax

fiprofilecontrol.SignOnAuthTokenFirst(SignOnIndex)

Default Value

False

Remarks

Indicates whether server requires clients to send the Authentication Token as part of first signon.

If True, then server requires clients to send the AuthToken as part of first signon.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnAuthTokenUrl Property (FIProfile Control)

URL where Authentication Token information is provided by the institution operating the OFX server.

Syntax

fiprofilecontrol.SignOnAuthTokenUrl(SignOnIndex)

Default Value

Remarks

URL where Authentication Token information is provided by the institution operating the OFX server.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SignOnCaseSensitive Property (FIProfile Control)

Indicates whether the password is case-sensitive or not.

Syntax

fiprofilecontrol.SignOnCaseSensitive(SignOnIndex)

Default Value

False

Remarks

Indicates whether the password is case-sensitive or not.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnCharType Property (FIProfile Control)

Type of characters the password can contain.

Syntax

fiprofilecontrol.SignOnCharType(SignOnIndex)

Possible Values

sctAlphaOnly(0), 
sctNumericOnly(1), 
sctAlphaOrNumeric(2), 
sctAlphaAndNumeric(3), 
sctUnknown(4)

Default Value

Remarks

Type of characters the password can contain. The valid values of this string are:


sctAlphaOnly (0)	Password may not contain numeric characters. The server would allow "abbc", but not "1223" or "a122".
sctNumericOnly (1)	Password may not contain alphabetic characters. The server would allow "1223", but no "abbc" or "a122".
sctAlphaOrNumeric (2)	Password may contain alphabetic or numeric characters (or both). The server would allow "abbc", "1223", or "a122".
sctAlphaAndNumeric (3)	Password must contain both alphabetic and numeric characters. The server would allow "a122", but not "abbc" or "1223".
sctUnknown (4)	The server has sent an unrecognized character type. Please refer to the SignOnAggregate to obtain the original response.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Integer

SignOnClientUIdReq Property (FIProfile Control)

Indicates whether the Client Unique Identifier is required to be included in the signon.

Syntax

fiprofilecontrol.SignOnClientUIdReq(SignOnIndex)

Default Value

False

Remarks

Indicates whether the Client Unique Identifier is required to be included in the signon.

If this is True, then the ClientUId is required to be set and included in the request.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnMaxPwdLength Property (FIProfile Control)

Maximum number of characters a SignOn password on this server can have.

Syntax

fiprofilecontrol.SignOnMaxPwdLength(SignOnIndex)

Default Value

Remarks

Maximum number of characters a SignOn password on this server can have.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Integer

SignOnMFAChallengeFirst Property (FIProfile Control)

Indicates whether the Multi-Factor Authentication (MFA) challenge is required to be included in the first signon to this server.

Syntax

fiprofilecontrol.SignOnMFAChallengeFirst(SignOnIndex)

Default Value

False

Remarks

Indicates whether the Multi-Factor Authentication (MFA) challenge is required to be included in the first signon to this server.

If True, then server requires clients to request MFA challenge questions (required for MFA) in the first signon request. See RequestChallengeQuestions in FIProfile for more information.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnMFAChallengeReq Property (FIProfile Control)

Indicates whether the Multi-Factor Authentication (MFA) challenge is required by this FI server.

Syntax

fiprofilecontrol.SignOnMFAChallengeReq(SignOnIndex)

Default Value

False

Remarks

Indicates whether the Multi-Factor Authentication (MFA) challenge is required by this FI server.

If True, then server requires multi-factor authentication during each signon. See RequestChallengeQuestions in FIProfile for more information.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnMinPwdLength Property (FIProfile Control)

Minimum number of characters a SignOn password on this server can have.

Syntax

fiprofilecontrol.SignOnMinPwdLength(SignOnIndex)

Default Value

Remarks

Minimum number of characters a SignOn password on this server can have.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Integer

SignOnPINChange Property (FIProfile Control)

It indicates whether the server accepts any PIN Change Requests at all.

Syntax

fiprofilecontrol.SignOnPINChange(SignOnIndex)

Default Value

False

Remarks

It indicates whether the server accepts any PIN Change Requests at all.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnPINChangeFirst Property (FIProfile Control)

Indicates whether server requires clients to change password as part of first signon.

Syntax

fiprofilecontrol.SignOnPINChangeFirst(SignOnIndex)

Default Value

False

Remarks

Indicates whether server requires clients to change password as part of first signon.

If True, then server requires clients to change OFXPassword as part of first signon. However, if SignOnMFAChallengeFirst is also True, this pin change request should be sent immediately after the session containing multi-factor authentication.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnRealm Property (FIProfile Control)

SignOn realm used by this message set.

Syntax

fiprofilecontrol.SignOnRealm(SignOnIndex)

Default Value

Remarks

SignOn realm used by this message set. The name of the SignOn realm in this message set.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SignOnSpaces Property (FIProfile Control)

It indicates whether the password can contain whitespaces.

Syntax

fiprofilecontrol.SignOnSpaces(SignOnIndex)

Default Value

False

Remarks

It indicates whether the password can contain whitespaces.

This does not refer to any special characters. To determine whether special characters are allowed, check the value of SignOnSpecial.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnSpecial Property (FIProfile Control)

It indicates whether the password can contain special characters.

Syntax

fiprofilecontrol.SignOnSpecial(SignOnIndex)

Default Value

False

Remarks

It indicates whether the password can contain special characters. Special characters do not include spaces.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SignOnUserCred1Q Property (FIProfile Control)

Text prompt for user credential.

Syntax

fiprofilecontrol.SignOnUserCred1Q(SignOnIndex)

Default Value

Remarks

Text prompt for user credential.

If this is present in the server response, a third credential is required to authenticate the user in all future requests. This is in addition to OFXUser and OFXPassword. This new credential is represented by UserCred1A) which is the corresponding answer of SignOnUserCred1Q. This should be then included in each request.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SignOnUserCred2Q Property (FIProfile Control)

Text prompt for user credential.

Syntax

fiprofilecontrol.SignOnUserCred2Q(SignOnIndex)

Default Value

Remarks

Text prompt for user credential.

If this is present in the server response, a fourth credential is required to authenticate the user in all future requests. This is in addition to OFXUser, OFXPassword and SignOnUserCred2Q. This new credential is represented by UserCred2A) which is the corresponding answer of SignOnUserCred2Q. This should be then included in each request. In this case, the UserCred1A should also be present in the request.

The SignOnIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignOnInfoCount property.

This property is read-only and not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (FIProfile Control)

This is the certificate (PEM/base64 encoded).

Syntax

fiprofilecontrol.SSLAcceptServerCertEncoded[=string]

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (FIProfile Control)

This is the certificate (PEM/base64 encoded).

Syntax

fiprofilecontrol.SSLCertEncoded[=string]

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (FIProfile Control)

This is the name of the certificate store for the client certificate.

Syntax

fiprofilecontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (FIProfile Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fiprofilecontrol.SSLCertStorePassword[=string]

Default Value

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (FIProfile Control)

This is the type of certificate store for this certificate.

Syntax

fiprofilecontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used the control will automatically determine the type. This property can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr control. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (FIProfile Control)

This is the subject of the certificate used for client authentication.

Syntax

fiprofilecontrol.SSLCertSubject[=string]

Default Value

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (FIProfile Control)

This specifies the SSL/TLS implementation to use.

Syntax

fiprofilecontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (FIProfile Control)

This is the certificate (PEM/base64 encoded).

Syntax

fiprofilecontrol.SSLServerCertEncoded

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (FIProfile Control)

A timeout for the control.

Syntax

fiprofilecontrol.Timeout[=integer]

Default Value

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

Config Method (FIProfile Control)

Sets or retrieves a configuration setting.

Syntax

fiprofilecontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetProfile Method (FIProfile Control)

Download the message set profile for a given Financial Institution.

Syntax

fiprofilecontrol.GetProfile

Remarks

This function generates the Signon and FIProfile request page, submits it to the financial institution via HTTP, receives the response, and parses it. Individual transactions are downloaded with the statement.

Read-only properties that are populated as a result of response parsing include:

FIAddress1
FIAddress2
FIAddress3
FICity
FICountry
FICustomerServicePhone
FIEmailAddress
FIHomePage
FIName
FIPostalCode
FIProfileDate
FIState
FITechSupportPhone
MessageSets
SignOnDetails

ReadOFXDataFile Method (FIProfile Control)

Reads an OFX response from a file.

Syntax

fiprofilecontrol.ReadOFXDataFile FileName

Remarks

This method reads a previously recorded OFX response from a file, including HTTP and OFX headers.

The following read-only properties are populated as a result of parsing the data file:

FIAddress1
FIAddress2
FIAddress3
FICity
FICountry
FICustomerServicePhone
FIEmailAddress
FIHomePage
FIName
FIPostalCode
FIProfileDate
FIState
FITechSupportPhone
MessageSets
SignOnDetails

RequestChallengeQuestions Method (FIProfile Control)

Download the challenge questions when Multi-Factor Authentication (MFA) is required.

Syntax

fiprofilecontrol.RequestChallengeQuestions

Remarks

This function generates the Signon and Multi-Factor Authentication challenge questions request page, submits it to the financial institution via HTTP, receives the response, and parses it.

When sending requests to a FI, if the information in the signon request is correct, but it is not sufficient to authenticate the user, the server can reply with a signon error code of 3000, which indicates that the client must perform multi-factor challenge authentication before proceeding with future OFX requests.

When this error is returned, the user should call this RequestChallengeQuestions method, which request the server to send a list of challenge questions that must be correctly answered before the OFX client may proceed with further OFX requests.

Upon successful response, the server will return a list of challenge questions, stored to ChallengeQuestions, where each question is specified by ChallengeQuestionId and ChallengeQuestion. If the server does not return such list, the control will throw an HTTP 400 error.

The user should inspect the ChallengeQuestions. When this list of challenge questions is returned, then the user has to answer each question by setting the ChallengeAnswer for each ChallengeQuestion, and then call the SendChallengeAnswers method to send the answers back to the server. The control will include these answers within the signon request included as part of the next request message. If these answers are correct, the server will process the request file. If they are incorrect, the server will return an error code of 3001.

When MFA is required, to prevent servers from needing to authenticate the user with each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response. However, the server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the OFXAccessKey it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request. This allows the server to determine the lifetime of the OFXAccessKey.

Note: If in the profile response SignOnMFAChallengeFirst is True, the client must send this MFA challenge request in the first connection with the server, before sending any other requests.

The following properties are populated as a result of parsing a successful response:

ChallengeQuestions

Note: The Multi-Factor Authentication (MFA) is applicable only in OFXVersions: 1.0.3, 2.0.3, 2.1.0, and 2.1.1.

Reset Method (FIProfile Control)

Reset the internal state of the control and all properties to their default values.

Syntax

fiprofilecontrol.Reset

Remarks

The Reset method does not have any parameters and does not return any value.

SendChallengeAnswers Method (FIProfile Control)

Send the answers to challenge questions for a Multi-Factor Authentication (MFA).

Syntax

fiprofilecontrol.SendChallengeAnswers

Remarks

This function generates the Signon and Multi-Factor Authentication challenge questions request page, submits it to the financial institution via HTTP, receives the response, and parses it.

Note: If in the profile response SignOnMFAChallengeFirst is True, the client must send this MFA challenge request in the first connection with the server, before sending any other requests.

The following properties are populated as a result of parsing a successful response:

ChallengeQuestions

Note: The Multi-Factor Authentication (MFA) is applicable only in OFXVersions: 1.0.3, 2.0.3, 2.1.0, and 2.1.1.

WriteOFXDataFile Method (FIProfile Control)

Writes the OFX response sent by the server to a file.

Syntax

fiprofilecontrol.WriteOFXDataFile FileName

Remarks

This method records the entire OFX response, including HTTP and OFX headers to a file. This file can later be read and parsed by the ReadOFXDataFile method as though it were a live response.

ConnectionStatus Event (FIProfile Control)

This event is fired to indicate changes in the connection state.

Syntax

Sub fiprofilecontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:


	Firewall connection complete.
	Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
	Remote host connection complete.
	Remote host disconnected.
	SSL or S/Shell connection broken.
	Firewall host disconnected.

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Error Event (FIProfile Control)

Information about errors during data delivery.

Syntax

Sub fiprofilecontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (FIProfile Control)

Fired after the server presents its certificate to the client.

Syntax

Sub fiprofilecontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (FIProfile Control)

Shows the progress of the secure connection.

Syntax

Sub fiprofilecontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (FIProfile Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

OFX Config Settings

AuthToken: Authentication token required for this signon session only.

This credential is provided to the user out of band.

In the profile response, if SignOnAuthTokenFirst is True, then AuthToken should be sent in the very first signon.

ClientUId: Unique ID identifying OFX Client.

In the profile response, if SignOnClientUIdReq is True, then ClientUId should be set and included in all future requests.

CorrectAction[i]: The action taken to a previously sent transaction corrected by the current one.

If present in the list of transactions response, this represents the action taken to a previously sent transaction that is corrected by this record. Possible values are: REPLACE or DELETE. REPLACE replaces the transaction that it corrects referenced by CorrectFITID[i];. DELETE deletes it. This is applicable to statement download components only.

CorrectFITID[i]: The FITID of a previously sent transaction corrected by the current one.

If present in the list of transactions response, this represents the FITID of a previously sent transaction that is corrected by this record. Based on the value of CorrectAction[i];, this transaction replaces or deletes the transaction that it corrects. This is applicable to statement download components only.

CurrencyFormat: The format to be used for returning currency values.

If this is set to a non-empty string, the control will attempt to use the value as a pattern to format all currency strings returned from the server. You may use any of the system's default number formatting strings.

DateFormat: The format to be used for input and output dates.

This format is used for input and output dates. You may use any of the system's default date formatting strings.

When submitting the request: all your input dates should be entered in a format specified by DateFormat and the control will convert those to OFXDateFormat right before sending the request.

For example, if you set a date to '2000.01.01' (by first setting the DateFormat to 'yyyy.MM.dd'), for a EST timezone, the control will convert it to '20000101000000.000[-5:EST]' (format specified by OFXDateFormat).

When parsing the response: if DateFormat is set to a non-empty string, the control will attempt to use the value as a pattern to format all date strings as they are returned. Otherwise, the system's default value will be used for formatting.

If the DateFormat is set to the special value "OFXDATE": During input:, any values you supply to date properties are passed to the server directly with no changes; During output: all dates will be returned in the OFX format as it was provided by the server without performing any modifications.

GetResponseVar: Parses additional information out of the response.

Any additional response information contained within the OFX response that is not available via the Response fields, may be retrieved with this GetResponseVar config.

To obtain a response value, pass the XPath to the value you wish to receive. For instance, if the OFX response contains: "<OFX><SIGNONMSGSRSV1><SONRS><STATUS><CODE>0<SEVERITY>INFO</STATUS><DTSERVER>20120104223836.575<LANGUAGE>ENG"

Then calling GetResponseVar("/OFX/SIGNONMSGSRVSV1/LANGUAGE") will return "ENG".

NewPassword: New password for the current OFX user.

Setting NewPassword to a non-empty value will cause the control to issue a password change request during sign-on along with the regular current OFX request. After the request is sent, this value will be cleared.

The correct current password is needed as well during signon request and must be supplied through the OFXPassword. Upon successful reply from the server, the NewPassword used becomes the new password.

OFXDateFormat: The date format as required by OFX FI server.

Most of OFX FI servers, accept the default format, where the offset (G) and timezone (Z) are specified. However, there might still be some servers that do not accept that part. In such cases, you will have to set the OFXDateFormat to "YYYYMMddHHmmss.xxx" and GMT will be assumed as the default value.

Your input dates should be entered in a format specified by DateFormat and the control will convert those to OFXDateFormat (format that OFX FI server recognizes) right before sending the request.

OFXLog: Log file for the OFX transaction.

This setting records the OFX communication, but without including HTTP headers, to a file.

Please note that ReadOFXDataFile will not be able to parse this file because of the OFX request content present. If only the response of the server is required, please look at the WriteOFXDataFile method instead.

ServerMessage: Server message if a warning or other information returned.

When sending a transaction request to a FI, their server with return either a successful reply or an error. However, even when a transaction is successful, a warning or other server messages might still be returned and are to be treated as informational notes only.

UserCred1A: Additional user credential required by server.

In the profile response, if SignOnUserCred1Q is present, then UserCred1A should be set (as the answer to question identified by SignOnUserCred1Q) and it should be included in all future requests as part of the signon.

UserCred2A: Additional user credential required by server.

In the profile response, if SignOnUserCred2Q is present, then UserCred2A should be set (as the answer to question identified by SignOnUserCred2Q) and it should be included in all future requests as part of the signon.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the control adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The control only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the control will accept compressed data. It then will uncompress the data it has received. The control will handle data compressed by both gzip and deflate compression algorithms.

When True, the control adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the control will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the control fails with an error if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP control can be extended with other security schemes in addition to the authorization schemes already implemented by the control.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the control.

If set to True, the URL passed to the control will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the control returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the control fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the control fails with an error instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the control will perform a GET on the new location.

The default value is False. If set to True, the control will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the control.

This property specifies the HTTP version used by the control. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the control will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to Connection: Keep-Alive. If False, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is False.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the control will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the control will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (Chr$(13) & Chr$(10)) .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the control beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

This configuration setting is provided for use by controls that do not directly expose Proxy properties.

ProxyPassword: A password if authentication is to be used for the proxy.

This configuration setting is provided for use by controls that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration setting is provided for use by controls that do not directly expose Proxy properties.

ProxyServer: Name or IP address of a proxy server (optional).

This configuration setting is provided for use by controls that do not directly expose Proxy properties.

ProxyUser: A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by controls that do not directly expose Proxy properties.

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusLine: The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the control.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the control.

TransferredHeaders: The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest: The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the control will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the control will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs: Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the control will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to True.

When True (default), the control will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the control will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the control whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by controls that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by controls that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

The appropriate values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the control fails with an error.

Note: This setting is provided for use by controls that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the control returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the control binds.

This must be set before a connection is attempted. It instructs the control to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the control will use IPv4 exclusively. When set to 1, the control will use IPv6 exclusively. To instruct the control to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:


0	IPv4 Only
1	IPv6 Only
2	IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the control will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the control is the same.

SSLCACerts: A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the control will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the control will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The control will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the control fails with an error.

When set to 0 (default) the CRL check will not be performed by the control. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the control will use OCSP to check the validity of the server certificate. If set to 1 or 2, the control will first obtain the OCSP URL from the server certificate's OCSP extension. The control will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the control fails with an error.

When set to 0 (default) the control will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the control will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internal:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the control will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

The platform provider is only available on Windows 11 / Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is by default, but can be set to to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the control will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the control will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion: Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts: A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the control will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the control fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI: Tells the control whether or not to use the system security libraries or an internal implementation.

When set to , the control will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to tells the control to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (FIProfile Control)

OFX Errors

22001    Required field missing from server response.
22002    OFX server error. Description follows.
22003    Invalid OFX response.
22004    OFX response contains unknown element tags.

The control may also return one of the following error codes, which are inherited from other controls.

XML Errors

20102    Invalid attribute index.
20103    No attributes available.
20104    Invalid namespace index.
20105    No namespaces available.
20106    Invalid element index.
20107    No elements available.
20108    Attribute does not exist.
20202    Unbalanced element tag.
20203    Unknown element prefix (can't find namespace).
20204    Unknown attribute prefix (can't find namespace).
20205    Invalid XML markup.
20206    Invalid end state for parser.
20207    Document contains unbalanced elements.
20208    Invalid XPath.
20209    No such child.
20210    Top element does not match start of path.
20211    DOM tree unavailable (set BuildDOM to true and reparse).
20303    Can't open file.
20402    Invalid XML would be generated.
20403    An invalid XML name has been specified.

HTTP Errors

20119    Firewall Error. Error description contains detailed message.
20144    Busy executing current method.
20152    HTTP protocol error. The error message has the server response.
20153    No server specified in URL
20154    Specified URLScheme is invalid.
20156    Range operation is not supported by server.
20157    Invalid cookie index (out of range).
20302    Interrupted.
20303    Can't open AttachedFile.

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

20101    You cannot change the RemotePort at this time. A connection is in progress.
20102    You cannot change the RemoteHost (Server) at this time. A connection is in progress.
20103    The RemoteHost address is invalid (0.0.0.0).
20105    Already connected. If you want to reconnect, close the current connection first.
20107    You cannot change the LocalPort at this time. A connection is in progress.
20108    You cannot change the LocalHost at this time. A connection is in progress.
20113    You cannot change MaxLineLength at this time. A connection is in progress.
20117    RemotePort cannot be zero. Please specify a valid service port number.
20118    You cannot change the UseConnection option while the control is active.
20136    Operation would block.
20202    Timeout.
20212    Action impossible in control's present state.
20213    Action impossible while not connected.
20214    Action impossible while listening.
20302    Timeout.
20303    Could not open file.
20435    Unable to convert string to selected CodePage.
21106    Already connecting. If you want to reconnect, close the current connection first.
21118    You need to connect first.
21120    You cannot change the LocalHost at this time. A connection is in progress.
21121    Connection dropped by remote host.

SSL Errors

20271    Cannot load specified security library.
20272    Cannot open certificate store.
20273    Cannot find specified certificate.
20274    Cannot acquire security credentials.
20275    Cannot find certificate chain.
20276    Cannot verify certificate chain.
20277    Error during handshake.
20281    Error verifying certificate.
20282    Could not find client certificate.
20283    Could not find server certificate.
20284    Error encrypting data.
20285    Error decrypting data.

TCP/IP Errors

25005    [10004] Interrupted system call.
25010    [10009] Bad file number.
25014    [10013] Access denied.
25015    [10014] Bad address.
25023    [10022] Invalid argument.
25025    [10024] Too many open files.
25036    [10035] Operation would block.
25037    [10036] Operation now in progress.
25038    [10037] Operation already in progress.
25039    [10038] Socket operation on non-socket.
25040    [10039] Destination address required.
25041    [10040] Message too long.
25042    [10041] Protocol wrong type for socket.
25043    [10042] Bad protocol option.
25044    [10043] Protocol not supported.
25045    [10044] Socket type not supported.
25046    [10045] Operation not supported on socket.
25047    [10046] Protocol family not supported.
25048    [10047] Address family not supported by protocol family.
25049    [10048] Address already in use.
25050    [10049] Can't assign requested address.
25051    [10050] Network is down.
25052    [10051] Network is unreachable.
25053    [10052] Net dropped connection or reset.
25054    [10053] Software caused connection abort.
25055    [10054] Connection reset by peer.
25056    [10055] No buffer space available.
25057    [10056] Socket is already connected.
25058    [10057] Socket is not connected.
25059    [10058] Can't send after socket shutdown.
25060    [10059] Too many references, can't splice.
25061    [10060] Connection timed out.
25062    [10061] Connection refused.
25063    [10062] Too many levels of symbolic links.
25064    [10063] File name too long.
25065    [10064] Host is down.
25066    [10065] No route to host.
25067    [10066] Directory not empty
25068    [10067] Too many processes.
25069    [10068] Too many users.
25070    [10069] Disc Quota Exceeded.
25071    [10070] Stale NFS file handle.
25072    [10071] Too many levels of remote in path.
25092    [10091] Network subsystem is unavailable.
25093    [10092] WINSOCK DLL Version out of range.
25094    [10093] Winsock not loaded yet.
26002    [11001] Host not found.
26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
26005    [11004] Valid name, no data record (check DNS setup).


	22001 Required field missing from server response.
	22002 OFX server error. Description follows.
	22003 Invalid OFX response.
	22004 OFX response contains unknown element tags.


	20102 Invalid attribute index.
	20103 No attributes available.
	20104 Invalid namespace index.
	20105 No namespaces available.
	20106 Invalid element index.
	20107 No elements available.
	20108 Attribute does not exist.
	20202 Unbalanced element tag.
	20203 Unknown element prefix (can't find namespace).
	20204 Unknown attribute prefix (can't find namespace).
	20205 Invalid XML markup.
	20206 Invalid end state for parser.
	20207 Document contains unbalanced elements.
	20208 Invalid XPath.
	20209 No such child.
	20210 Top element does not match start of path.
	20211 DOM tree unavailable (set BuildDOM to true and reparse).
	20303 Can't open file.
	20402 Invalid XML would be generated.
	20403 An invalid XML name has been specified.


	20119 Firewall Error. Error description contains detailed message.
	20144 Busy executing current method.
	20152 HTTP protocol error. The error message has the server response.
	20153 No server specified in URL
	20154 Specified URLScheme is invalid.
	20156 Range operation is not supported by server.
	20157 Invalid cookie index (out of range).
	20302 Interrupted.
	20303 Can't open AttachedFile.


	20101 You cannot change the RemotePort at this time. A connection is in progress.
	20102 You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	20103 The RemoteHost address is invalid (0.0.0.0).
	20105 Already connected. If you want to reconnect, close the current connection first.
	20107 You cannot change the LocalPort at this time. A connection is in progress.
	20108 You cannot change the LocalHost at this time. A connection is in progress.
	20113 You cannot change MaxLineLength at this time. A connection is in progress.
	20117 RemotePort cannot be zero. Please specify a valid service port number.
	20118 You cannot change the UseConnection option while the control is active.
	20136 Operation would block.
	20202 Timeout.
	20212 Action impossible in control's present state.
	20213 Action impossible while not connected.
	20214 Action impossible while listening.
	20302 Timeout.
	20303 Could not open file.
	20435 Unable to convert string to selected CodePage.
	21106 Already connecting. If you want to reconnect, close the current connection first.
	21118 You need to connect first.
	21120 You cannot change the LocalHost at this time. A connection is in progress.
	21121 Connection dropped by remote host.


	20271 Cannot load specified security library.
	20272 Cannot open certificate store.
	20273 Cannot find specified certificate.
	20274 Cannot acquire security credentials.
	20275 Cannot find certificate chain.
	20276 Cannot verify certificate chain.
	20277 Error during handshake.
	20281 Error verifying certificate.
	20282 Could not find client certificate.
	20283 Could not find server certificate.
	20284 Error encrypting data.
	20285 Error decrypting data.


	25005 [10004] Interrupted system call.
	25010 [10009] Bad file number.
	25014 [10013] Access denied.
	25015 [10014] Bad address.
	25023 [10022] Invalid argument.
	25025 [10024] Too many open files.
	25036 [10035] Operation would block.
	25037 [10036] Operation now in progress.
	25038 [10037] Operation already in progress.
	25039 [10038] Socket operation on non-socket.
	25040 [10039] Destination address required.
	25041 [10040] Message too long.
	25042 [10041] Protocol wrong type for socket.
	25043 [10042] Bad protocol option.
	25044 [10043] Protocol not supported.
	25045 [10044] Socket type not supported.
	25046 [10045] Operation not supported on socket.
	25047 [10046] Protocol family not supported.
	25048 [10047] Address family not supported by protocol family.
	25049 [10048] Address already in use.
	25050 [10049] Can't assign requested address.
	25051 [10050] Network is down.
	25052 [10051] Network is unreachable.
	25053 [10052] Net dropped connection or reset.
	25054 [10053] Software caused connection abort.
	25055 [10054] Connection reset by peer.
	25056 [10055] No buffer space available.
	25057 [10056] Socket is already connected.
	25058 [10057] Socket is not connected.
	25059 [10058] Can't send after socket shutdown.
	25060 [10059] Too many references, can't splice.
	25061 [10060] Connection timed out.
	25062 [10061] Connection refused.
	25063 [10062] Too many levels of symbolic links.
	25064 [10063] File name too long.
	25065 [10064] Host is down.
	25066 [10065] No route to host.
	25067 [10066] Directory not empty
	25068 [10067] Too many processes.
	25069 [10068] Too many users.
	25070 [10069] Disc Quota Exceeded.
	25071 [10070] Stale NFS file handle.
	25072 [10071] Too many levels of remote in path.
	25092 [10091] Network subsystem is unavailable.
	25093 [10092] WINSOCK DLL Version out of range.
	25094 [10093] Winsock not loaded yet.
	26002 [11001] Host not found.
	26003 [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	26004 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	26005 [11004] Valid name, no data record (check DNS setup).