QWCFileInfo Type

This type holds details of the QWC file which will be created.

Remarks

The fields below define the requirements for the QWC file. Call CreateQWCFile to create the file.

Fields

A brief description of the application. This will be displayed in the QB Web Connector UI. For the best results use a value less than 80 characters in length.

This field is required.

AppDisplayName
String

The display name of the application. This is use for display purposes in the QB Web Connector UI only.

This field is optional.

AppId
String

The application Id. This value is passed to QuickBooks or QuickBooks POS when a connection is opened, however it is not used at the time of this writing.

This field is optional.

AppName
String

The name of the application. This name is displayed in the QB Web Connector UI. It is also the name supplied to QuickBooks when a connection is created.

This field is required.

AppSupportURL
String

A URL where users can find support for your product.

The domain name specified in this URL must match the domain name specified in AppURL.

During development you may specify "localhost" or a machine name in place of the domain name. If a machine name is specified, it must match the machine name specified in AppURL.

The URL provided in AppURL must be a https:// URL. The only exception to this is when using "localhost" for development, in that case a http:// URL may be used.

This field is required.

AppUniqueName
String

If this field is set the QuickBooks Web Connector will not use its clone/replace model for the AppName and will instead use the replace routine.

This field is optional.

AppURL
String

The URL of your web application.

The domain name specified in this URL must match the domain name specified in AppURL.

During development you may specify "localhost" or a machine name in place of the domain name. If a machine name is specified, it must match the machine name specified in AppURL.

The URL provided in AppURL must be a https:// URL. The only exception to this is when using "localhost" for development, in that case a http:// URL may be used.

This field is required.

AuthFlags
String

This field specifies which versions of QuickBooks your application supports. By default all editions are supported, including Simple Start.

This property is optional. If this is not set the QuickBooks Web Connector will support all versions. In most cases it is recommended to leave this value as empty string unless you need to restrict which versions of QuickBooks your application supports.

Possible values are:


0x0	All
0x1	QuickBooks Simple Start
0x2	QuickBooks Professional
0x4	QuickBooks Premier
0x8	QuickBooks Enterprise

If you need to support multiple editions you may AND the desired values together.

This field is optional.

CertURL
String

This field specifies a URL which is used by the QuickBooks Web Connector to obtain and validate the SSL certificate. This is typically only used when the *rpCertURL; is not the web server where your application is running.

This field is optional.

FileId
String

This field specifies a unique Id. The first time the QuickBooks Web Connector connects to the company this Id is stored as an extension to the company record along with OwnerId.

The storage of this data allows you to perform a Company query (using the Company component) to determine if you've worked with this company file previously. When the Company query is performed specify your OwnerId and validate the FileId in the response.

This format of this value must adhere to the GUIDTYPE defined in the QuickBooks SDK. The format is

{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}

where X is a hexadecimal digit. For example:

{6B063959-81B0-4622-85D6-F548C8CCB517}

This field is required.

IsReadOnly
Boolean

Specifies whether read or read/write access is needed.

This field specifies whether your application will need read or read/write access to the company file. The default value is False, meaning both read and write access is required.

Notify
Boolean

Determines if notification are allowed.

This field determines if system tray notification pop-ups are allowed at the application level. The default value is False.

OwnerId
String

This field specifies an Id which identifies your application.

This format of this value must adhere to the GUIDTYPE defined in the QuickBooks SDK. The format is

{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}

where X is a hexadecimal digit. For example:

{6B063959-81B0-4622-85D6-F548C8CCB517}

This field is required.

PersonalDataPref
PersonalDataPrefTypes

This field defines the type of access to personal/sensitive data required by your application. Possible values are:


0 (pdpNotNeeded - default)	Access to personal data is not needed.
1 (pdpOptional)	Access to personal data is optional.
2 (pdpRequired)	Access to personal data is required.

UnattendedModePref
UnattendedModePrefTypes

This field specifies whether you need to access QuickBooks in unattended mode (when QuickBooks is closed). Possible values are:


0 (umpOptional - default)	Access to QuickBooks when it is closed is not required. The user may still grant access.
1 (umpRequired)	Access to QuickBooks when it is closed is required.

UpdateInterval
Integer

This field specifies the desired update interval in seconds. If set to a positive value the QuickBooks Web Connector will automatically enable the "Auto-Run" option when adding the application, and the "Every_Min" value will be set to the nearest minute value. The default value is 0, which means this option will not be included in the created file.

This field is optional.

User
String

This field species the user. When QuickBooks Web Connector connects to your application and ProcessRequest is called the Authenticate event will fire and the user and password will be available to you for verification.

This field is required.

Constructors

[VB.NET]
Public QWCFileInfo()

[C#]
public QWCFileInfo();