The xTuple Batch Manager package—otherwise known as xtbatch—is an xTuple extension package, comprising the server portion of the xTuple Batch Manager application. The xtbatch package is installed by default in xTuple ERP Standard and Manufacturing Editions. However, the xtbatch package must be installed separately if you are adding the Batch Manager to a PostBooks Edition installation.
To install the xTuple Batch Manager package, you will need the following items:
- Updater tool
This is the package installer. It is a cross-platform application which connects to your xTuple ERP database and installs the xTuple Batch Manager package (
xtbatch). The Updater is the same tool that is used for upgrading xTuple ERP databases from one version to the next. It also converts xTuple ERP from one edition to the next (e.g., PostBooks to Standard).- xTuple Batch Manager package (xtbatch)
This is the xTuple extension package which integrates the Batch Manager features with your xTuple ERP. The file is loaded into the Updater, which in turn applies the package to your xTuple database. And like all xTuple database upgrade scripts, the file ends with a
.gz
If you purchased the xTuple Batch Manager on the xTuple xChange, then you should already have the files you need—that is, the Updater tool and the xtbatch package. We will explain how to install the package in the next section.
Note
Depending on which edition of xTuple ERP you are running, it may be possible to download the required files from the "Commercial Software" section of the xtuple.org website.
The Updater tool can also be downloaded from the PostBooks project page on SourceForge.net. To reach the PostBooks project, follow these steps:
Point your web browser to http://sourceforge.net/
Search for the PostBooks project
Or use the direct URL: http://sourceforge.net/projects/postbooks/
The following project page will appear:
Next, hover your mouse over the "Download" link. Make sure to select the "Browse All Packages" option. This will give you access to all the available packages. In the following screenshot, the Updater is Package #06:
Tip
If you don't see the Updater package on the Downloads page, make sure you selected the "Browse All Packages" option.
Finally, select the link for the Updater package. Be sure to choose a download which corresponds to your operating system. The Updater is available for Windows, Mac, and Linux, as shown in the following screen:
Once you've downloaded the Updater and the xtbatch package, you are ready to begin the server installation!
Having xTuple ERP installed and running is a prerequisite for installing the Batch Manager (xtbatch) package. Assuming this is the case, then you are ready to begin.
Note
Before you install the Batch Manager package, you should first make a backup copy of your xTuple ERP database. This way you can always restore the backup copy should you encounter problems during the installation process.
To begin installing the Batch Manager package, the first step is to connect the Updater to your xTuple ERP database. The process for connecting is identical to the process used when logging in using your xTuple ERP client software.
After you have downloaded the Updater, extract it into the folder of your choice, execute it, and then click the OPTIONS button. You will see the following screen:
Enter your server, database, and port information. Then select SAVE. Log on with the username and password for your xTuple Administrator user. This is normally "admin". On the Update Manager screen follow these steps:
Select the "File" menu option
Select the "Open" option, as shown in the following screen:
Once you locate the Batch Manager package on your file system (e.g., xtbatch-1.0.0-package.gz), a short series of prerequisite checks will be performed. The following screen shows the results of a successful prerequisite check:
If the prerequisite check was successful, simply select the START UPDATE button to complete installation. Depending on the quality of your network connection, this final step of the installation process should complete quickly. The following screen shows results for a successful install:
Note
Contact your system administrator if you encounter errors or extreme slowness after selecting the START UPDATE button.
To verify the Batch Manager package has been successfully installed, log into xTuple ERP. Finally, navigate to the installed packages directory, using the following path: System > Design > Packages. If the Batch Manager package was installed correctly, the package should appear as shown in the following screen:
