QuickBooks Integrator 2022 ActiveX Edition
Version 22.0 [Build 8594]

QBConnector Control

Properties   Methods   Events   Config Settings   Errors  

The QBCONNECTOR control is a utility that allows you to connect your QuickBooks Integrator applications to remote QuickBooks instances.

Syntax

QBConnector

Remarks

The QBConnector control is a lightweight web server which listens for HTTP requests originating from the QuickBooks Integrator controls. Each request sent to the QBConnector by a QuickBooks Integrator control contains the XML data to be communicated to QuickBooks as well as configuration settings specifying how the connection is to be opened. The QBConnector then communicates with QuickBooks via COM, and returns the QuickBooks response (or an error message) in the HTTP reply.

Using the QBConnector control is easy. Simply set Listening to True, and the control will begin listening for incoming messages on the specified LocalPort. The messages will be processed by the QuickBooks application that is running on the same machine as the QBConnector, and the results will automatically be returned to the requesting client.

Basic authentication is enabled by default, meaning the connecting clients must present a user name and password in the QBConnectionString of the control they're using. The supplied user name and password are checked against the list of AuthorizedUsers. If no user in the list matches the supplied credentials, the Authorization event will fire with the Accept parameter set to false. If the user was found in the list of AuthorizedUsers then the parameter will be set to True. You may override this functionality by setting the Accept parameter inside the Authorization event manually. If no "Authorization" header supplied in the request, the Authorization event will fire with blank User and Password parameters.

Note that the AuthorizedUserQBConnectionString will be used to make the connection to QuickBooks for a user found in the AuthorizedUsers collection.

Any of the QuickBooks Integrator controls can connect to the QBConnector using the QBConnectionString property of any of the controls. For instance, an example using the Invoice control follows: Invoice.QBConnectionString = "URL='http://www.foo.com:2080'" User='Foo' Password='Bar'";

Using SSL along with a digital certificate greatly increases the security of the Remote Connector. SSL will encrypt all data transmitted across the network, ensuring that only the Connector can read incoming requests, and that only the requesting client can read the QuickBooks responses. This prevents unauthorized parties from accessing your QuickBooks data. You should use a full digital certificate on the server (Connector) side, and this will contain a public key and a private key. This version of your certificate should be kept private. You may export a version of the certificate containing the public key only, and distribute this to all clients that need to communicate with the Connector.

To use this functionality, set the SSLCert with a valid certificate and then change the SSLStartMode to sslImplicit. Now all clients must post to the QBConnector using HTTPS. eg: Invoice.QBConnectionString = "URL='https://www.foo.com:2080' User='Foo' Password='Bar'"; // https instead of http

The client (in these examples Invoice) has an SSLServerAuthentication event that will fire when the server presents its certificate. If the public key presented by the QBConnector is trusted by the system, the Accept parameter will be True. If it is not trusted by the system (Accept is False), you should inspect the certificate and if valid, override by setting Accept to True.

Property List


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

AuthorizedUserCountThe number of records in the Authorized arrays.
AuthorizedAuthModeThis property defines how the user is authorized.
AuthorizedUserPasswordA password associated with the User who is allowed to connect to the control.
AuthorizedUserQBConnectionStringAn aggregate consisting of various QuickBooks connection properties that are used to connect the authorized client to the QuickBooks application.
AuthorizedUserName of a user which is allowed to connect to the control.
ConnectedToQBOpens or closes a persistent connection to QuickBooks.
EnableSSLIndicates whether server starts in SSL-mode.
ListeningIf set to True, the control accepts incoming connections on LocalPort.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the control listens.
SSLAuthenticateClientsIf set to True, the server asks the client(s) for a certificate.
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
TimeoutAn initial timeout value to be used by incoming connections.

Method List


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

AddUserAdds a new user to the AuthorizedUsers collection.
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
ResetClears all properties to their default values.
ShutdownShutdown the server.

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.

AuthorizationFired when the client presents its credentials to the server.
ConnectedThis event is fired immediately after a connection completes (or fails).
ConnectionRequestThis event is fired when a request for connection comes from a remote host.
DisconnectedThis event is fired when a connection is closed.
ErrorThis event fires information about errors during data delivery.
HeaderHTTP headers sent by the client.
RequestFired when a client sends a request to the control.
ResponseFired when the control sends a response to the client.
SSLClientAuthenticationThis event is fired when the client presents its credentials to the server.
SSLConnectionRequestThis event fires when a Secure Sockets Layer (SSL) connection is requested.
SSLStatusThis event is fired to show the progress of the secure connection.
StatusShows the status of the server as clients connect and transactions are made.

Config Settings


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

AuthFlagsAuth Flags to use when connecting to QuickBooks.
ConnectedToQBUsed to connect or disconnect from QuickBooks.
DefaultConnectionStringDefault connection string to use for users not in the AuthorizedUsers collection.
ReadOnly[i]Whether a user is restricted to read-only access.
UseInteractiveLogonWhether interactive or network logon is used when AuthMode is set to Windows.
CodePageThe system code page used for Unicode to Multibyte translations.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the control whether or not to use the system security libraries or an internal implementation.

AuthorizedUserCount Property (QBConnector Control)

The number of records in the Authorized arrays.

Syntax

qbconnectorcontrol.AuthorizedUserCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

AuthorizedAuthMode Property (QBConnector Control)

This property defines how the user is authorized.

Syntax

qbconnectorcontrol.AuthorizedAuthMode(AuthorizedUserIndex)[=integer]

Possible Values

amNormal(0), 
amWindows(1)

Default Value

0

Remarks

This property defines how the user is authorized.

There are two ways that the user may be authorized, against the user list defined in the control, or as a Windows user. From the client side the process of connecting is exactly the same no matter which option you choose. Possible values are:

0 (amNormal - default) The user is authenticated against the user list defined in the control.
1 (amWindows) The user is authenticated as a Windows user.

When using the amNormal AuthMode (default) the user's password will be checked against the Password property.

When using the amWindows AuthMode the control will validate the user's credentials with Windows. When calling AddUser the Password parameter should be set to empty string.

The AuthorizedUserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthorizedUserCount property.

This property is not available at design time.

Data Type

Integer

AuthorizedUserPassword Property (QBConnector Control)

A password associated with the User who is allowed to connect to the control.

Syntax

qbconnectorcontrol.AuthorizedUserPassword(AuthorizedUserIndex)[=string]

Default Value

""

Remarks

A password associated with the AuthorizedUser who is allowed to connect to the control. Connecting clients' authorization headers will be compared against this AuthorizedUser and AuthorizedPassword.

The AuthorizedUserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthorizedUserCount property.

This property is not available at design time.

Data Type

String

AuthorizedUserQBConnectionString Property (QBConnector Control)

An aggregate consisting of various QuickBooks connection properties that are used to connect the authorized client to the QuickBooks application.

Syntax

qbconnectorcontrol.AuthorizedUserQBConnectionString(AuthorizedUserIndex)[=string]

Default Value

""

Remarks

An aggregate consisting of various QuickBooks connection properties that are used to connect the authorized client to the QuickBooks application.

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:

ApplicationNameThe 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.
CompanyFileThe 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.
QBConnectionModeThe mode of connection to QuickBooks. Specifies whether the integrated application logs in using single-user or multi-user mode. Allowable values include "DontCare", "SingleUserMode" and "MultiUserMode".

The AuthorizedUserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthorizedUserCount property.

This property is not available at design time.

Data Type

String

AuthorizedUser Property (QBConnector Control)

Name of a user which is allowed to connect to the control.

Syntax

qbconnectorcontrol.AuthorizedUser(AuthorizedUserIndex)[=string]

Default Value

""

Remarks

Name of a user which is allowed to connect to the control. Connecting clients' authorization headers will be compared against this AuthorizedUser and AuthorizedPassword.

The AuthorizedUserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AuthorizedUserCount property.

This property is not available at design time.

Data Type

String

ConnectedToQB Property (QBConnector Control)

Opens or closes a persistent connection to QuickBooks.

Syntax

qbconnectorcontrol.ConnectedToQB

Default Value

False

Remarks

You may use this property to determine whether the control is currently connected to QuickBooks.

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

Data Type

Boolean

EnableSSL Property (QBConnector Control)

Indicates whether server starts in SSL-mode.

Syntax

qbconnectorcontrol.EnableSSL[=boolean]

Default Value

False

Remarks

This property must be set before setting Listening to True. When EnableSSL is True, plaintext connections to the control will be rejected.

This property is not available at design time.

Data Type

Boolean

Listening Property (QBConnector Control)

If set to True, the control accepts incoming connections on LocalPort.

Syntax

qbconnectorcontrol.Listening[=boolean]

Default Value

False

Remarks

This property indicates whether the control is listening for connections on the port specified by the LocalPort property.

Note: Use the StartListening and StopListening methods to control whether the control is listening.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (QBConnector Control)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

qbconnectorcontrol.LocalHost[=string]

Default Value

""

Remarks

The LocalHost property 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 property 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).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (QBConnector Control)

The TCP port in the local host where the control listens.

Syntax

qbconnectorcontrol.LocalPort[=integer]

Default Value

2080

Remarks

The LocalPort property must be set before QBConnector starts listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of the LocalPort property after Listening is set to True.

The service port is not shared among servers (i.e. there can be only one QBConnector 'listening' on a particular port at one time).

The default value for LocalPort is 2080.

Data Type

Integer

SSLAuthenticateClients Property (QBConnector Control)

If set to True, the server asks the client(s) for a certificate.

Syntax

qbconnectorcontrol.SSLAuthenticateClients[=boolean]

Default Value

False

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCertEncoded Property (QBConnector Control)

This is the certificate (PEM/base64 encoded).

Syntax

qbconnectorcontrol.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 (QBConnector Control)

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

Syntax

qbconnectorcontrol.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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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 (QBConnector 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

qbconnectorcontrol.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 (QBConnector Control)

This is the type of certificate store for this certificate.

Syntax

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

0

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 (QBConnector Control)

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

Syntax

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLProvider Property (QBConnector Control)

This specifies the SSL/TLS implementation to use.

Syntax

qbconnectorcontrol.SSLProvider[=integer]

Possible Values

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

Default Value

0

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

Timeout Property (QBConnector Control)

An initial timeout value to be used by incoming connections.

Syntax

qbconnectorcontrol.Timeout[=integer]

Default Value

30

Remarks

Timeout is used by the control to set the operational timeout value of all inbound connections once they are established.

The default value is 30 seconds.

Data Type

Integer

AddUser Method (QBConnector Control)

Adds a new user to the AuthorizedUsers collection.

Syntax

qbconnectorcontrol.AddUser User, Password, QBConnectionString, AuthMode

Remarks

Please refer to the AuthorizedUsers collection for more information.

User specifies the user which will be allowed to connect.

Password specifies the password of the user. This is not applicable when AuthMode is set to 1 (amWindows).

QBConnectionString sets the connection properties for the user. See AuthorizedUserQBConnectionString for details.

AuthMode defines how the user will be authenticated. There are two ways that the user may be authorized, against the user list defined in the control, or as a Windows user. From the client side the process of connecting is exactly the same no matter which option you choose. Possible values are:

0 (amNormal - default) The user is authenticated against the user list defined in the control.
1 (amWindows) The user is authenticated as a Windows user.

When using the amNormal AuthMode (default) the user's password will be checked against the Password property.

When using the amWindows AuthMode the control will validate the user's credentials with Windows. When calling AddUser the Password parameter should be set to empty string.

Config Method (QBConnector Control)

Sets or retrieves a configuration setting.

Syntax

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

DoEvents Method (QBConnector Control)

Processes events from the internal message queue.

Syntax

qbconnectorcontrol.DoEvents 

Remarks

When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Reset Method (QBConnector Control)

Clears all properties to their default values.

Syntax

qbconnectorcontrol.Reset 

Remarks

This method clears all properties to their default values.

Shutdown Method (QBConnector Control)

Shutdown the server.

Syntax

qbconnectorcontrol.Shutdown 

Remarks

When this method is called, the control will stop Listening, break all active connections, and disconnect from QuickBooks.

Authorization Event (QBConnector Control)

Fired when the client presents its credentials to the server.

Syntax

Sub qbconnectorcontrol_Authorization(ConnectionId As Integer, UserIndex As Integer, User As String, Password As String, Accept As Boolean)

Remarks

This is where the server can decide whether to continue or not, based on the supplied User and Password.

To accept or reject a connection set Accept to True of False.

The Accept parameter defaults to True if User is found in the AuthorizedUsers collection and Password matches, and False otherwise. The UserIndex parameter indicates the index at which the authorized user was found in the collection.

A UserIndex of -1 means that no matching credentials were found in the AuthorizedUsers collection.

Connected Event (QBConnector Control)

This event is fired immediately after a connection completes (or fails).

Syntax

Sub qbconnectorcontrol_Connected(ConnectionId As Integer, StatusCode As Integer, Description As String)

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (QBConnector Control)

This event is fired when a request for connection comes from a remote host.

Syntax

Sub qbconnectorcontrol_ConnectionRequest(Address As String, Port As Integer, Accept As Boolean)

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

Disconnected Event (QBConnector Control)

This event is fired when a connection is closed.

Syntax

Sub qbconnectorcontrol_Disconnected(ConnectionId As Integer, StatusCode As Integer, Description As String)

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

Error Event (QBConnector Control)

This event fires information about errors during data delivery.

Syntax

Sub qbconnectorcontrol_Error(ConnectionId As Integer, 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.

ConnectionId indicates the connection for which the error is applicable.

Header Event (QBConnector Control)

HTTP headers sent by the client.

Syntax

Sub qbconnectorcontrol_Header(ConnectionId As Integer, Header As String, Value As String)

Remarks

When a client connects, this event will fire for each HTTP header received.

Request Event (QBConnector Control)

Fired when a client sends a request to the control.

Syntax

Sub qbconnectorcontrol_Request(ConnectionId As Integer, UserIndex As Integer, Request As String)

Remarks

This event will fire with the raw XML data received from the client, which is to be processed by QuickBooks.

The ConnectionId indicates which client connection this Request event is firing for. The UserIndex is the index of the user in the AuthorizedUser array property. Request is the QBXML Request sent from the client.

A UserIndex of -1 means that no matching credentials were found in the AuthorizedUsers collection.

Response Event (QBConnector Control)

Fired when the control sends a response to the client.

Syntax

Sub qbconnectorcontrol_Response(ConnectionId As Integer, UserIndex As Integer, Response As String)

Remarks

This event will fire with the raw XML retrieved from QuickBooks and sent to the client.

The ConnectionId indicates which client connection this Request event is firing for. The UserIndex is the index of the user in the AuthorizedUser array property. Response is the QBXML Response from QuickBooks, which is being transmitted back to the client.

A UserIndex of -1 means that no matching credentials were found in the AuthorizedUsers collection.

SSLClientAuthentication Event (QBConnector Control)

This event is fired when the client presents its credentials to the server.

Syntax

Sub qbconnectorcontrol_SSLClientAuthentication(ConnectionId As Integer, CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

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

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLConnectionRequest Event (QBConnector Control)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Syntax

Sub qbconnectorcontrol_SSLConnectionRequest(ConnectionId As Integer, SupportedCipherSuites As String, SupportedSignatureAlgs As String, CertStoreType As Integer, CertStore As String, CertPassword As String, CertSubject As String)

Remarks

This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.

This event allows the control to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

ConnectionId is the connection Id of the client requesting the connection.

SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.

SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.

CertStoreType is the store type of the alternate certificate to use for this connection. 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 and set 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.

CertStore is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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).

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the 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.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

SSLStatus Event (QBConnector Control)

This event is fired to show the progress of the secure connection.

Syntax

Sub qbconnectorcontrol_SSLStatus(ConnectionId As Integer, Message As String)

Remarks

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

Status Event (QBConnector Control)

Shows the status of the server as clients connect and transactions are made.

Syntax

Sub qbconnectorcontrol_Status(ConnectionId As Integer, Message As String)

Remarks

The event is fired for informational and logging purposes only.

Config Settings (QBConnector 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.

QBConnector Config 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 control is already connected to QuickBooks, setting ConnectedToQB to True will cause the control to fails with an error. Connecting in this manner is only useful if there are no connection strings specified in any AuthorizedUsers, as in that case the control 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 control 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 control who is not in the AuthorizedUsers collection, and you set the Accept parameter in the Authorization event to True anyways, the control 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 AuthorizedAuthMode 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 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:

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

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

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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 (QBConnector Control)

Errors

The following errors may be generated by the control. Note that frequently the error message will contain more specific information than what is listed here.

QBConnector Errors

20101    You cannot change the RemotePort at this time. A connection is in progress.
20102    You cannot change the RemoteHost at this time. A connection is in progress.
20103    The RemoteHost address is invalid (0.0.0.0).
20105    IPDaemon is already listening.
20107    Cannot change LocalPort when IPDaemon is Listening.
20108    Cannot change LocalHost when IPDaemon is Listening.
20109    Cannot change MaxConnections when IPDaemon is Listening.
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.
20127    Invalid ConnectionId.
20136    Operation would block.

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

Copyright (c) 2023 4D Payments Inc.
QuickBooks Integrator 2022 ActiveX Edition - Version 22.0 [Build 8594]