xTuple logo

xTuple Dashboards Product Guide

  
Collapse AllExpand All
3. Installing the Packages
Prev Chapter 1. Installation Next

3. Installing the Packages

Having xTuple ERP (version 4.10 or later) installed and running is a prerequisite for installing the xTuple Dashboards package. Assuming this is the case, then you are ready to begin.

Note

Before you install the xTuple Dashboards 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 xTuple Dashboards 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.

The following screen shows the log in screen you are presented with when you launch the Updater application:

Connect to xTuple database using Updater

Tip

If you are having trouble connecting to your xTuple ERP database with the Updater, select the OPTIONS button on the Log In screen to ensure your connection information is correct.

Once you have successfully connected to the database, you are ready to load the nodejsshim package. Remember: the nodejsshim package must be loaded prior to loading the xtdash package. To begin loading the nodejsshim package, follow these steps:

  1. Select the File menu option

  2. Select the Open option, as shown in the following screen:

Load package into Updater

Once you locate the nodejsshim package on your file system (e.g., nodejsshim-1.0.0.gz), a short series of prerequisite checks will be performed. The following screen shows the results of a successful prerequisite check:

Update Manager and package

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.

Note

Contact your system administrator if you encounter errors or extreme slowness after selecting the START UPDATE button.

After the update has completed, close the Updater application. Once you have closed the Updater application, restart the application and then load the xtdash package using the same steps described above.

To verify the two packages have been installed successfully, log into xTuple ERP. Navigate to the installed packages directory, using the following path: System > Design > Packages. If xTuple Dashboards were installed correctly, the two packages should appear as shown in the following screen:

Package installed in xTuple ERP
Prev Up Next
2. Getting the Required Files Home Chapter 2. Setup