Collapse AllExpand All

7.1. Connection Arguments

Connection arguments enable you to pass the database connection, username, and password information to the xTuple Connect Batch Manager at runtime. The following list describes the connection arguments which are available for use:

-databaseURL=

This argument enables you to pass the server, database name, and port. xTuple ERP runs on the PostgreSQL database, so the form of this argument is:

psql://server/databasename:port

For example, if you run PostgreSQL on a server whose IP address is 192.168.1.150 and the name of your database is xtuple_db and PostgreSQL is listening on port 5432, the argument would look like this:

-databaseURL=psql://192.168.1.151/xtuple_db:5432
-username=

This optional argument enables you to pass the username that the xTuple Connect Batch Manager will log in as. A common practice is to create a user through the xTuple client that has all application privileges—and is also a super user on the PostgreSQL database. (The super user requirement is needed to permit the user to perform database reindexing, which is part of the Schedule Server Maintenance job). While you want the xTuple Connect Batch Manager admin user to have all xTuple ERP privileges, you should consider withholding access to all xTuple ERP menus for this user. (To do this, simply de-select all the menu options on the User Preferences screen and revoke the MaintainPreferencesSelf and MaintainPreferencesOthers privileges.) This ensures that if a user logs into xTuple with the xTuple Connect Batch Manager user, no menu options will be available to them. To pass the username argument on the command line for a xTuple Connect Batch Manager admin user defined as "batch", the argument would look like this:

-username=batch
-passwd=

This optional argument enables you to pass the xTuple Connect Batch Manager admin user's password to the xTuple Connect Batch Manager client at log in. This is necessary if you plan to auto start the xTuple Connect Batch Manager when the computer the xTuple Connect Batch Manager is running on reboots. (For more information, see Section 8, “Automatic Startup Techniques”.) If you do not pass this argument, the password must be entered manually. For example, if the xTuple Connect Batch Manager admin's password is "@xbatch1", then the argument would look like this:

-passwd=@xbatch1