Non-supported ReleaseNon-supported Release
ECI no longer supports this version of e-automate, and this version of the online help is no longer being updated. ECI recommends upgrading to the current release. Contact your account manager for more information.

Updating Database Components

If your company is using an on-premise installation of e-automate, ECI may occasionally ask you to update your database components. Typically, ECI will supply you with a file containing the db component updates, which you will then copy to your e-automate server and process through e-admin.

If you receive files for installing a database component listed in the following table, use the link listed in the table to access specific instructions for that database component.

Database Component	Instructions Link
Contract Rate Schedule Audit	Installing the Service Contract Schedule Rate Audit E-view
Dashboard (Replacement for legacy Metrics)	Installing and Enabling ECI Cognytics
Dashboard (for SBR)	Installing and Configuring ECI Cognytics for SBR
Equipment Swapping	Installing and Configuring Equipment Swapping Functionality
FixedAssetChangesReport	Installing the Fixed Asset Changes Report
Inventory Optimization Reports	Installing the Inventory Optimization Reports
Making Tax Digital	Installing the Making Tax Digital Utility (HMRC Only)
PeriodBalanceSummaryReport	Installing the Period Balance Summary Report
Sales Order Connector	Integrating the Sales Order Connector with E-automate
ScanIt Import	ScanIt Import Utility
Shipping Integration	Installing the Shipping Integration Report
Vendor Connector Export Module	VendorConnector

If you receive files for installing a database component not listed in the preceding table, use the following general guidelines for installing a database component.

Copying the Database Component Updates FileCopying the Database Component Updates File

When you receive the database component updates file (e.g., _components.zip), whether by download from the Customer Support Center web site or directly from ECI, do the following:

Locate the _components.zip file containing the updates.

Extract the _components.zip file's contents into your ECi\e-automate\sql\CompanyDb\_components folder.

Note: The location of your ECi folder may vary. The default location is C:\Program Files (x86)\ECi\.

Note: This process will copy the extracted files into the _components sub folder within the CompanyDb folder. If the _components sub folder does not already exist in that location, create the folder in that location before extracting the files. If the _components sub folder does already exist in that location, do not delete the existing folder. If prompted, do allow the system to merge new files into the existing folder.

Note: The process of unzipping the _components.zip file varies. You will use a process similar to the following:

From the location on your server where you copied the _components.zip file, right-click the file and select the Extract All... option from the right-click menu. The system displays an Extract Compressed (Zipped) Folders window.

Click the [Browse...] button. The system display a Select a Destination window.

On the Select a Destination window, do the following:

Navigate to the location where you want to extract the files (e.g., ECi\e-automate\sql\CompanyDb\_components).

Note: If the _components sub folder does not already exist in this location, create the folder in this location.

Click the [Select Folder] button to accept the specified folder location and to close the Select a Destination window.

Click the [Extract] button to extract the files to that location and to close the Extract Compressed (Zipped) Folders window.

When the system finishes extracting the files to this location, proceed to the Installing the Database Component Updates section of this topic.

Installing the Database Component UpdatesInstalling the Database Component Updates

When you have copied the file with the updates to the specified location, log in to e-admin.

From the list of companies, select the company for which you want to update database components.

From the Company menu, select Maintenance > Database Components.... If you have your e-admin toolbar visible, you can use the drop-down menu on [Maintenance] and select Database Components.... You can also use the right-click menu and select Maintenance > Database Components....

Note: This option is only enabled for company databases with a Version of 17.1 or greater. If you want to update database components for a company database with an earlier version number, you will need to update the database before updating its database components. For more information, see the Updating a Database topic.

The system displays the Enter Admin Password window.

In the Admin password for [Company ID] field, enter your admin password.

Click [OK]. If the system verifies your admin password for the company you selected, the system displays the Database Components window.

For each component in the list, the system displays the following information: Name (of the component), Updates (Yes indicates new updates are available), Installed Version (the existing version of the component if the component is already installed), and Available Version (the new version of the component that is available to be installed).

In the sample image above, Name1 represents an installed database component for which no update is available. Name2 represents a database component that can be installed for the first time using the available update. Name3 represents an installed database component that can be updated using the available update.

For each component you want to update, do the following:

In the display, select the database component you want to install.

Click the [Install] button. The system displays the Backup Database Location window. Prior to installing a database component, e-admin requires a backup of the database so that you can restore the backup if the database component installation does not complete as expected.

Enter a name for this backup in the File name field.

Note: Your backup name must be unique.

E-admin always displays the last navigated path in the Backup location field. If you want to browse your network for a different backup location, click [(...)] to open the Browse for Backup File... window.
Select the backup location you want to use and click [OK] to return to the Backup database location window. The filename you selected displays in the File name field.

Click [OK]. If you opted to use a file name that has already been used in e-admin, e-admin notifies you that you cannot use the file name identified. Enter a different name.

After the database is backed up, the system attempts to install the database component.

If the installation is successful, the system displays the message, "Installation complete." Click [OK] to acknowledge the message. When you click [OK], the system removes the Yes from the Updates column, updates the Installed Version to the new version, and clears the Available Version column. If the Database Components window lists additional database components to install, return to Step 5.a above.

Note: As long as the Database Components window remains open, the system will not prompt you to create a new backup each time you install a new component; if you close this window, you will be prompted to create a new backup the next time you open this window, select a component, and click [Install]. For this reason, you may want to keep this window open until you have finished updating database components (or until an error occurs).

If the installation is not successful, the system displays an Unexpected Error Information window. Review the Description field.

If the Description field reports only that one or more exceptions occurred, then the system was able to restore the backup you created before trying to install the update; you do not need to manually restore your database.

If the Description field—in addition to reporting that one or more exceptions occurred—includes a NOTICE letting you know you need to manually restore your backup, then the system was not able to automatically restore your backup. You need to restore your backup manually, and the NOTICE lists the name of the backup you created prior to trying to install the update. For information on restoring a backup, see the Restoring a Database topic.

Note: If an error occurs and a database backup is restored, automatically or manually, you will need to re-install any database components you installed after you created the backup.

To have the system check for additional updates, click [Refresh].

Note: If e-automate Customer Care instructs you to copy an additional file with updates to your system while the Database Components window is still open, you can copy the file and then click the [Refresh] button to have the system locate and display the additional updates.