Using the Remote Connector
The RemoteConnector.exe is a distributable utility that allows you to connect the driver to local and remote QuickBooks instances. It is also used to connect to QuickBooks in situations where direct COM access to QuickBooks is not available (e.g., ASP.NET, Java, or QuickBooks on a remote machine). Follow the procedure below to get started using the Remote Connector.
- Copy the RemoteConnector.exe and RemoteConnectorService.exe files, located in the RemoteConnector folder where the driver was installed, to the machine where QuickBooks is installed.
- Start the Remote Connector.
- Open the Users tab and add at least one user. The Remote Connector does not use the User and Password properties to access QuickBooks; the User and Password properties authenticate the user to the Remote Connector. Authentication to QuickBooks is handled based on the ApplicationName property.
- Open the company file in QuickBooks using an administrator account.
- Connect to QuickBooks from your application. Set the same User and Password connection properties that you authorized in the Remote Connector. Additionally, set the URL connection option. For connections on the same machine, the URL for the Remote Connector is "http://localhost:2080". Otherwise, set the URL to the name of the computer where QuickBooks is running.
- When you first connect, a dialog will appear in QuickBooks prompting you to authorize the application.
- In the dialog, select the option to always allow access, even when QuickBooks is not running.
How do I start the Remote Connector at startup?
Create a new shortcut to the Remote Connector. Then right-click the shortcut and click Properties -> Shortcut. Append the argument "-start" to the Target property. Copy the shortcut to C:\Users\(User-Name)\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup.
How do I connect to QuickBooks over SSL?
If you have enabled SSL in the Remote Connector, you will need to send your public key certificate to the driver. You can do so by setting the SSLAcceptServerCert property.
All communications to QuickBooks company files must first go through QuickBooks. If QuickBooks is closed, this means that for each attempt to connect to the company file, QuickBooks needs to be launched and then closed again. By default the Remote Connector queues requests for data and performs the necessary authentication for each request. Setting the Persistent Connections option to true overrides this behavior and keeps the connection to the company file alive after the query finishes executing, so further requests will respond more quickly. Setting a keep-alive time for persistent connections will cause the connection to close after the given period of inactivity.
Warning: If a user attempts to manually open QuickBooks while a persistent connection is opened, it will throw an error stating that the company file is already in use.