Tuning Options

In this section we describe several options available to you if you want or need to modify the default xTuple Connect Batch Manager timing options or temporarily override the stored settings. The following interval arguments can be used to fine-tune specific timing intervals:

-refresh

The refresh interval argument defines in seconds how often the xTuple Connect Batch Manager attempts to reestablish a connection with the xTuple server. This is useful if the network connection is temperamental. The default is 86400, which is 1 hour. Here is an example where the interval is ten minutes:

-refresh 600

This option temporarily overrides the xTuple Connect Batch Manager preference field "Between Database Connection Checks".

-idle

The idle interval argument defines in seconds how long the xTuple Connect Batch Manager waits when there are no jobs presently scheduled before looking for a new job to process. The default is 300 (5 minutes). The following shows an example where the xTuple Connect Batch Manager will remain idle for 30 seconds when no jobs are presently scheduled before checking to see if there is a new job to run:

-idle 30

This option temporarily overrides the xTuple Connect Batch Manager preference field "After the Last Pending Task".

-rest

The number of seconds the xTuple Connect Batch Manager should wait between jobs after finishing a job (default is 30 seconds). The following shows an example where the xTuple Connect Batch Manager will remain idle for 10 seconds between consecutive jobs:

-rest 10

This option temporarily overrides the xTuple Connect Batch Manager preference field "Between Consecutive Tasks".

All of the above interval arguments may be issued individually or combined in a single command line statement or startup script. Here is an example combination you might use for the xTuple Connect Batch Manager executable on the Windows platform:

BatchManager.exe -databaseURL=psql://192.168.1.151/xtuple_db:5432 -refresh 600 -idle 30 -rest 15

In this example, the PostgreSQL server is 192.168.1.151, the name of the database is xtuple_db, and PostgreSQL is listening on port 5432. The xTuple Connect Batch Manager will check its connection to the database server every 600 seconds (10 minutes), check for new jobs every 30 seconds, and rest for 15 seconds after every job.

Note

xTuple recommends that you use the default values for these intervals. If you do change them, be careful not to set them too high or too low. The risk of setting them too high is that jobs won't be run in a timely manner. The risk of setting them too low is that the database server may get overwhelmed with requests from the xTuple Connect Batch Manager.