JDBC Driver for QuickBooks

Build 23.0.8843


The Users tab provides an interface to add, edit, and delete users. At least one user must be added before communicating with QuickBooks.

This tab displays a list of existing users along with information about the user's configuration.

When adding or editing a user, the following options are available:

  • User: Sets the username. This is required.
  • Password: Sets the password for the user. This is required when using Basic authentication (default).
  • Authentication: Specifies the type of authentication to perform when the user connects. The Desktop Gateway supports the following authentication methods:

    Basic Authentication (default): Authenticates the user with a username and password.
    Windows Authentication: Authenticates the user as a Windows user. In this case, the Password field is not applicable. When the Desktop Gateway receives a connection request, it authenticates the user to Windows using the credentials supplied in the request.

  • Software: The QuickBooks product you are connecting to.
  • Company File: Specifies the company file with which the application will communicate. By default this is the company file that is currently open in QuickBooks. This can also be set to the absolute path to a company file (.qbw file). A company file must be specified in order to access the company file when QuickBooks is closed.
  • Application Name: Optionally sets the name of the application as seen by QuickBooks. Authentication to QuickBooks is handled based on the provided application name.
  • Data Access: Specifies the allowed access for the user.

    Full: Allows read and write access for the user.
    Read-only: Restricts the user to read-only operations, so that QuickBooks data cannot be modified.

The Test Connection button provides a quick way to verify that the application can connect with QuickBooks.

When a user is added, the Desktop Gateway prompts you to authorize the application with QuickBooks, if necessary.

Importing Users

The Import button prompts you to select an .ini file containing one or more user profiles.

Imported .ini files must conform to the following syntax:

Config1 = Value1
Config2 = Value2
The following configurations are available:
  • Password: Corresponds to the "Password" option in the "Add User" form. Required when using basic authentication.
  • AuthMode: Corresponds to the "Authentication" option in the "Add User" form. Options include:
    • 0 (corresponds to "Basic Authentication")
    • 1 (corresponds to "Windows Authentication")
  • Software: Corresponds to the "Software" option in the "Add User" form. Options include:
    • QB Desktop
    • QB Point of Sale 10
    • QB Point of Sale 11
    • QB Point of Sale 12
    • QB Point of Sale 18
  • CompanyFile: Corresponds to the "Company File" option in the "Add User" form.
  • AppName: Corresponds to the "Application Name" option in the "Add User" form.
  • ReadOnly: Corresponds to the "Data Access" option in the "Add User" form. Options include:
    • 0 (corresponds to "Full")
    • 1 (corresponds to "Read-only")

Here is an example configuration:

Password = SamplePassword
AuthMode = 0
Software = QB Desktop
CompanyFile = C:\Users\test\Documents\samplefile.qbw
AppName = Remote Connector
ReadOnly = 0

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8843