CLI Options
In addition to the UI, the QuickBooks Gateway has a command-line interface that makes it easy to deploy on machines where a user is not always logged in, for example, a Web server. To facilitate deployment to these environments, the QuickBooks Gateway contains two executables:
| RemoteConnector.exe | Provides the user interface and allows configuration of the application. |
| RemoteConnectorService.exe | Processes requests and performs all interaction with QuickBooks. |
The syntax for managing the QuickBooks Gateway Windows service from the command line is as follows:
RemoteConnectorService.exe /Service <Command>
The following commands are available:
| Install | Installs the Windows service. |
| Delete | Deletes the Windows service. |
| Start | Starts the Windows service. |
| Stop | Stops the Windows service. |
| State | Reports the current state of the Windows service (started or stopped). |
| Auto | Changes the Windows service startup type to Automatic. |
| Manual | Changes the Windows service startup type to Manual. |
| Disabled | Changes the Windows service startup type to Disabled. |
You can start the MySQL daemon from the command line, as shown below:
java -jar cdata.jdbc.quickbooks.jar [ options ]The following command-line options are available:
| Option | Description | |
| -h, --help | Display help for available options and exit. | |
| -f, --config-file | The configuration file for the daemon. | |
| -u, --user | The user allowed to connect. Use a configuration file to configure multiple users. If a user is specified on the command line, then only that user is given access. | |
| -p, --password | The password for the user specified with the user option. If both user and password are set on the command line, the users section in the config file is ignored. | |
| -d, --database | The database that clients will use to connect. If multiple databases are specified in the config file, connections are allowed to only the database specified on the command line. | |
| -c, --connection | The connection string used to connect to the data source being surfaced. If no connection string is specified on the command line, the connection string is read from the config file. | |
| -P, --port | The port number to use to listen for TCP/IP connections. The default port is 3306. | |
| -m, --max-connections | The maximum number of allowed TCP/IP connections. The default value is 25 connections. | |
| --session-timeout | The session timeout time in seconds. The default timeout is 20 seconds. | |
| -t, --protocol | The protocol used for remoting. The default value is MySQL. | |
| -g, --logfile | The full path of the log file. | |
| -F, --logrotationscheme | The interval at which to truncate the logs. The options are 1 (daily in the format [MyFileName]_2016_3_21.txt), 2 (weekly in the format [MyFileName]_Week_5.txt, where 5 is the fifth week in the year), and 3 (monthly in the format [MyFileName]_2016_3_21.txt). | |
| -v, --verbosity | The verbosity of the log. 1 is informational. Levels up to 5 add the following subsequent details: (2) HTTP headers, (3) the HTTP body, (4) transport-level communication including SSL, and (5) interface commands and other data source communication. | |
| --test | The database to test the connection with. If this property is not specified, the default database is used. | |
| --ssl-cert | The path to the SSL certificate. | |
| --ssl-subject | The subject of the SSL certificate. | |
| --ssl-password | The password of the SSL certificate. | |
| -n, --nodeid | Displays the NodeId of this machine. | |
| -l, --license | Installs the license on this machine. This option will prompt you for the type of license and other details. |