QBConnector Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

InQB_QBConnector

Procedural Interface

 inqb_qbconnector_open();
 inqb_qbconnector_close($res);
 inqb_qbconnector_register_callback($res, $id, $function);
 inqb_qbconnector_get_last_error($res);
 inqb_qbconnector_get_last_error_code($res);
 inqb_qbconnector_set($res, $id, $index, $value);
 inqb_qbconnector_get($res, $id, $index);
 inqb_qbconnector_do_adduser($res, $user, $password, $qbconnectionstring, $authmode);
 inqb_qbconnector_do_config($res, $configurationstring);
 inqb_qbconnector_do_doevents($res);
 inqb_qbconnector_do_reset($res);
 inqb_qbconnector_do_shutdown($res);

Remarks

The QBConnector class is a lightweight web server which listens for HTTP requests originating from the QuickBooks Integrator classs. Each request sent to the QBConnector by a QuickBooks Integrator class 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 class is easy. Simply set Listening to True, and the class 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 class 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 classs can connect to the QBConnector using the QBConnectionString property of any of the classs. For instance, an example using the Invoice class 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 class with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

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

AuthorizedUserCount Property (InQB_QBConnector Class)

The number of records in the Authorized arrays.

Object Oriented Interface

public function getAuthorizedUserCount();
public function setAuthorizedUserCount($value);

Procedural Interface

inqb_qbconnector_get($res, 1 );
inqb_qbconnector_set($res, 1, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AuthorizedAuthMode
• AuthorizedUser
• AuthorizedUserPassword
• AuthorizedUserQBConnectionString

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

This property is not available at design time.

Data Type

Integer

AuthorizedAuthMode Property (InQB_QBConnector Class)

This property defines how the user is authorized.

Object Oriented Interface

public function getAuthorizedAuthMode($authorizeduserindex);
public function setAuthorizedAuthMode($authorizeduserindex, $value);

Procedural Interface

inqb_qbconnector_get($res, 2 , $authorizeduserindex);
inqb_qbconnector_set($res, 2, $value , $authorizeduserindex);

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 class, 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:

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

When using the amWindows AuthMode the class 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 (InQB_QBConnector Class)

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

Object Oriented Interface

public function getAuthorizedUserPassword($authorizeduserindex);
public function setAuthorizedUserPassword($authorizeduserindex, $value);

Procedural Interface

inqb_qbconnector_get($res, 3 , $authorizeduserindex);
inqb_qbconnector_set($res, 3, $value , $authorizeduserindex);

Default Value

''

Remarks

A password associated with the AuthorizedUser who is allowed to connect to the class. 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 (InQB_QBConnector Class)

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

Object Oriented Interface

public function getAuthorizedUserQBConnectionString($authorizeduserindex);
public function setAuthorizedUserQBConnectionString($authorizeduserindex, $value);

Procedural Interface

inqb_qbconnector_get($res, 4 , $authorizeduserindex);
inqb_qbconnector_set($res, 4, $value , $authorizeduserindex);

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:

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 (InQB_QBConnector Class)

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

Object Oriented Interface

public function getAuthorizedUser($authorizeduserindex);
public function setAuthorizedUser($authorizeduserindex, $value);

Procedural Interface

inqb_qbconnector_get($res, 5 , $authorizeduserindex);
inqb_qbconnector_set($res, 5, $value , $authorizeduserindex);

Default Value

''

Remarks

Name of a user which is allowed to connect to the class. 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 (InQB_QBConnector Class)

Opens or closes a persistent connection to QuickBooks.

Object Oriented Interface

public function getConnectedToQB();

Procedural Interface

inqb_qbconnector_get($res, 6 );

Default Value

false

Remarks

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

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

Data Type

Boolean

EnableSSL Property (InQB_QBConnector Class)

Indicates whether server starts in SSL-mode.

Object Oriented Interface

public function getEnableSSL();
public function setEnableSSL($value);

Procedural Interface

inqb_qbconnector_get($res, 7 );
inqb_qbconnector_set($res, 7, $value );

Default Value

false

Remarks

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

This property is not available at design time.

Data Type

Boolean

Listening Property (InQB_QBConnector Class)

This property indicates whether the class is listening for incoming connections on LocalPort.

Object Oriented Interface

public function getListening();

Procedural Interface

inqb_qbconnector_get($res, 8 );

Default Value

false

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

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

Data Type

Boolean

LocalHost Property (InQB_QBConnector Class)

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

inqb_qbconnector_get($res, 9 );
inqb_qbconnector_set($res, 9, $value );

Default Value

''

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class 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 multihomed 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 (InQB_QBConnector Class)

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

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

inqb_qbconnector_get($res, 10 );
inqb_qbconnector_set($res, 10, $value );

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 (InQB_QBConnector Class)

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

Object Oriented Interface

public function getSSLAuthenticateClients();
public function setSSLAuthenticateClients($value);

Procedural Interface

inqb_qbconnector_get($res, 11 );
inqb_qbconnector_set($res, 11, $value );

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

SSLCertEffectiveDate Property (InQB_QBConnector Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

inqb_qbconnector_get($res, 12 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (InQB_QBConnector Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

inqb_qbconnector_get($res, 13 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (InQB_QBConnector Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

inqb_qbconnector_get($res, 14 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (InQB_QBConnector Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

inqb_qbconnector_get($res, 15 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (InQB_QBConnector Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

inqb_qbconnector_get($res, 16 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (InQB_QBConnector Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

inqb_qbconnector_get($res, 17 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (InQB_QBConnector Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

inqb_qbconnector_get($res, 18 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (InQB_QBConnector Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

inqb_qbconnector_get($res, 19 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (InQB_QBConnector Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

inqb_qbconnector_get($res, 20 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (InQB_QBConnector Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

inqb_qbconnector_get($res, 21 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (InQB_QBConnector Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

inqb_qbconnector_get($res, 22 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (InQB_QBConnector Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

inqb_qbconnector_get($res, 23 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (InQB_QBConnector Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

inqb_qbconnector_get($res, 24 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (InQB_QBConnector Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

inqb_qbconnector_get($res, 25 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (InQB_QBConnector Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

inqb_qbconnector_get($res, 26 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (InQB_QBConnector Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

inqb_qbconnector_get($res, 27 );
inqb_qbconnector_set($res, 27, $value );

Default Value

'MY'

Remarks

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 designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (InQB_QBConnector Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

inqb_qbconnector_get($res, 28 );
inqb_qbconnector_set($res, 28, $value );

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 (InQB_QBConnector Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

inqb_qbconnector_get($res, 29 );
inqb_qbconnector_set($res, 29, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubjectAltNames Property (InQB_QBConnector Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

inqb_qbconnector_get($res, 30 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (InQB_QBConnector Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

inqb_qbconnector_get($res, 31 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (InQB_QBConnector Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

inqb_qbconnector_get($res, 32 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (InQB_QBConnector Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

inqb_qbconnector_get($res, 33 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (InQB_QBConnector Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

inqb_qbconnector_get($res, 34 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (InQB_QBConnector Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

inqb_qbconnector_get($res, 35 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

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

This property is read-only.

Data Type

Integer

SSLCertVersion Property (InQB_QBConnector Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

inqb_qbconnector_get($res, 36 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (InQB_QBConnector Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

inqb_qbconnector_get($res, 37 );
inqb_qbconnector_set($res, 37, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:

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

Data Type

String

SSLCertEncoded Property (InQB_QBConnector Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

inqb_qbconnector_get($res, 38 );
inqb_qbconnector_set($res, 38, $value );

Default Value

''

Remarks

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.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (InQB_QBConnector Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

inqb_qbconnector_get($res, 39 );
inqb_qbconnector_set($res, 39, $value );

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 class 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 as follows:

Additional Notes

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

Timeout Property (InQB_QBConnector Class)

An initial timeout value to be used by incoming connections.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

inqb_qbconnector_get($res, 40 );
inqb_qbconnector_set($res, 40, $value );

Default Value

30

Remarks

Timeout is used by the class 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 (InQB_QBConnector Class)

Adds a new user to the AuthorizedUsers collection.

Object Oriented Interface

public function doAddUser($user, $password, $qbconnectionstring, $authmode);

Procedural Interface

inqb_qbconnector_do_adduser($res, $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 class, 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:

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

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

Config Method (InQB_QBConnector Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inqb_qbconnector_do_config($res, $configurationstring);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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 (InQB_QBConnector Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

inqb_qbconnector_do_doevents($res);

Remarks

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

Reset Method (InQB_QBConnector Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

inqb_qbconnector_do_reset($res);

Remarks

This method clears all properties to their default values.

Shutdown Method (InQB_QBConnector Class)

Shutdown the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

inqb_qbconnector_do_shutdown($res);

Remarks

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

Authorization Event (InQB_QBConnector Class)

Fired when the client presents its credentials to the server.

Object Oriented Interface

public function fireAuthorization($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 1, array($this, 'fireAuthorization'));

Parameter List

 'connectionid'
 'userindex'
 'user'
 'password'
 'accept'

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 (InQB_QBConnector Class)

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

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 2, array($this, 'fireConnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

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.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (InQB_QBConnector Class)

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

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 3, array($this, 'fireConnectionRequest'));

Parameter List

 'address'
 'port'
 'accept'

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 (InQB_QBConnector Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

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.

Please refer to the Error Codes section for more information.

Error Event (InQB_QBConnector Class)

This event fires information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'connectionid'
 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally, the class 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 (InQB_QBConnector Class)

HTTP headers sent by the client.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 6, array($this, 'fireHeader'));

Parameter List

 'connectionid'
 'header'
 'value'

Remarks

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

Request Event (InQB_QBConnector Class)

Fired when a client sends a request to the class.

Object Oriented Interface

public function fireRequest($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 7, array($this, 'fireRequest'));

Parameter List

 'connectionid'
 'userindex'
 'request'

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 (InQB_QBConnector Class)

Fired when the class sends a response to the client.

Object Oriented Interface

public function fireResponse($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 8, array($this, 'fireResponse'));

Parameter List

 'connectionid'
 'userindex'
 'response'

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 (InQB_QBConnector Class)

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

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 9, array($this, 'fireSSLClientAuthentication'));

Parameter List

 'connectionid'
 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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 (InQB_QBConnector Class)

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

Object Oriented Interface

public function fireSSLConnectionRequest($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 10, array($this, 'fireSSLConnectionRequest'));

Parameter List

 'connectionid'
 'supportedciphersuites'
 'supportedsignaturealgs'
 'certstoretype'
 'certstore'
 'certpassword'
 'certsubject'

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 class 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 class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

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 designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 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 as follows:

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

SSLStatus Event (InQB_QBConnector Class)

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

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 11, array($this, 'fireSSLStatus'));

Parameter List

 'connectionid'
 'message'

Remarks

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

Status Event (InQB_QBConnector Class)

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

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

inqb_qbconnector_register_callback($res, 12, array($this, 'fireStatus'));

Parameter List

 'connectionid'
 'message'

Remarks

The event is fired for informational and logging purposes only.

Config Settings (QBConnector Class)

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

QBConnector Config Settings

Base Config Settings

Trappable Errors (QBConnector Class)

Errors

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

QBConnector Errors

SSL Errors

TCP/IP Errors