QuickBooks Integrator 2020 .NET Edition

Questions / Feedback?

QBConnector Configuration

The component 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 component, access to these internal properties is provided through the Config method.

QBConnector Configuration Settings

AuthFlags:   Auth Flags to use when connecting to QuickBooks.

This configuration setting controls what auth flags are sent to QuickBooks. The default value is 0 (no auth flags set).

ConnectedToQB:   Used to connect or disconnect from QuickBooks.

This setting allows you to connect and disconnect to the QuickBooks request processor which resides on the server machine. Calling Config with ConnectedToQB=False will immediately disconnect from QuickBooks. ConnectedToQB=True, however, will use the DefaultConnectionString (if present) to open a persistent connection to QuickBooks. Note that if the component is already connected to QuickBooks, setting ConnectedToQB to True will cause the component to throws an exception. Connecting in this manner is only useful if there are no connection strings specified in any AuthorizedUsers, as in that case the component will disconnect from QuickBooks and reconnect with the credentials specified for that individual user. However, it is not necessary to use this configuration setting to connect to QuickBooks. If no connection strings are specified in the AuthorizedUsers and the component is not currently connected to QuickBooks, a new connection will be made using the DefaultConnectionString.

DefaultConnectionString:   Default connection string to use for users not in the AuthorizedUsers collection.

If a user connects to the component who is not in the AuthorizedUsers collection, and you set the Accept parameter in the Authorization event to True anyways, the component will use this connection string to open a connection with QuickBooks. This is blank by default.

ReadOnly[i]:   Whether a user is restricted to read-only access.

This setting specifies whether a user is limited to read-only access. The index should be the of the user in the AuthorizedUsers collection. For instance:

QBConnector1.Config("ReadOnly[0]=True");
This indicates that the first user is limited to read-only access. The default value is False (full access).
UseInteractiveLogon:   Whether interactive or network logon is used when AuthMode is set to Windows.

This setting only applies when the AuthMode is set to 1 (amWindows). When performing windows authentication a regular network logon is attempted by default. When this setting is set to true an interactive logon is performed instead. This setting may be required in certain circumstances, such as using a domain account and the domain controller is Samba.

Base Configuration Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

GUIAvailable:   Tells the component whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g. RuntimeLicense, License File).
  • License Type: The type of license installed (e.g. Royalty Free, Single Server).
UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

By default the component will use the system security libraries to perform cryptographic functions. When set to False calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 .NET Edition - Version 20.0 [Build 7941]