An aggregate consisting of various QuickBooks connection properties.
QBConnectionString allows the user to customize the application's interaction with QuickBooks.
The connection properties should be formatted in a sequence as follows:
propertyname = "propertyvalue" propertyname = "propertyvalue" ...
The order is irrelevant, and the whitespace around the equal sign is optional.
The following properties are currently supported:
|ApplicationName||The name of the developer's application. This name will appear when the application first connects to QuickBooks; QuickBooks will display this name and prompt the user to grant or refuse access.|
|CompanyFile||The name of the company file to open. If QuickBooks is not currently open with a company
file, QuickBooks will be automatically opened in the background with the file specified.
Do not set CompanyFile when QuickBooks is open; if QuickBooks is open through the
application UI, only that company file may be used.
This setting is not applicable when communicating with QB Connector.
|URL||The URL for the Remote Connector, e.g., 'http://localhost:2080'. If the URL is specified, the component will not communicate directly with QuickBooks, and will instead send a request to the specified web address. QuickBooks and the Remote Connector should be installed at the remote location, and if the connector is listening on the specified port, it will communicate the component's request to QuickBooks, and return the response.|
|User||A username for the Remote Connector connection (if required on the Connector side)|
|Password||A password for the Remote Connector connection (if required on the Connector side)|
|Timeout||A timeout, in seconds, for the Remote Connector connection. If the Connector does not finish and respond within the chosen length of time, the component will generate an exception instead of hanging.|
|DelayAfterClose||A delay, in milliseconds, to be applied after each time a connection to QuickBooks is closed. If QuickBooks is generating internal errors (in particular with automatic login) setting this delay to a positive value may solve the problem.|
|FirewallHost||Contains the name or IP address of firewall. If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.|
|FirewallPassword||Contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.|
|FirewallPort||Contains the TCP port for the firewall FirewallHost. Note this is set automatically when FirewallType is set to a valid value.|
|FirewallType||Determines the type of firewall to connect through. Supported values are: 0 - no firewall (default), 1 - Tunneling proxy, 2 - SOCKS4 proxy, and 3 - SOCKS5 proxy. For the Tunneling proxy (1), the FirewallPort defaults to 80. For SOCKS4 (2) and SOCKS5 (3) the FirewallPort defaults to 1080.|
|FirewallUser||Contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, the FirewallUser and FirewallPassword configs are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.|
|ProxyAuthorization||Supported values are 0 - Basic authorization, 1 - Digest authentication, 3 - No authentication, and 4 - NTLM authentication.|
|ProxyPassword||Contains a password if authentication is to be used for the proxy.|
|ProxyPort||Contains the TCP port for a ProxyServer; (default 80).|
|ProxySSL||Determines when to use SSL for the connection to the proxy. The applicable values are 0 - Automatic (SSL for https URLs, non-SSL for http URLs), 1 - The connection is always SSL-enabled, 2 - SSL is not enabled for any connection, and 3 - Connection is through a tunneling proxy.|
|ProxyServer||If a ProxyServer is specified, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the ProxyServer is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the ProxyServer is set to the corresponding address. If the search is not successful, an error is returned.|
|ProxyUser||Contains a user name, if authentication is to be used for the proxy.|
|LocalHost||The name of the local host or user-assigned IP interface through which connections are initiated or accepted.|
|LocalPort||The TCP port in the local host where the component binds.|
|UseRDS||Whether to connect using Remote Data Sharing (RDS). If set to True, the component will attempt to connect using the RDS client installed on the machine. The RDS client and server must be configured separately. The default value is False.|