Update EQuIS Database

<< Click to Display Table of Contents >>

 >Professional > Databases > Admin >

Update EQuIS Database

New releases of EQuIS often include schema updates with changes to the functions and tables within the EQuIS Database Schema (in Microsoft SQL Server).  These database updates need to be applied as part of the upgrade by an administrator, using the SQL Database login with the full read/write credentials.  


The following article explains the database update process using EQuIS Professional. Alternatively, an API is available for updating databases. The API may be particularly useful if you have many EQuIS Databases hosted in Microsoft SQL Server. The API is available as a static/shared .NET method that can be called from .NET code or PowerShell. See the EQuIS Enterprise documentation for more details on using the API.



Prior to updating the schema, backup the database. A backup on the same day is required to perform the EQuIS Professional Schema update.

Users must have db_owner permissions on the database in order to successfully update the EQuIS Schema.

When a schema update is applied, records with the details are added to ST_VERSION and ST_MODULE (MODULE_TYPE=db).  Records are only created when updates to a schema are available and applied.




The EQuIS Professional Quickstart - Update Database Schema - 2018 is available to view here, and can also be downloaded.


Update a Database


1.Launch EQuIS Professional and connect to a database server in the Backstage view. If you are already connected to a facility, access the Backstage from the File button on the EQuIS ribbon.

2.On the Connect tab, right-click on a database in the database list on the left.



3.Select Update by clicking from the context menu. The Update Database(s) window opens and lists the databases for which updates are available.

a.The available updates reflect the schema files (*.xme / *.xml) present in the directories below.

i.EQuIS Professional - C:\Program Files\EarthSoft\EQuIS\db\

ii.EQuIS Enterprise - C:\Program Files\EarthSoft\Database#\

b.By default, databases without a current backup are listed, but not available for selection. Backing up the database will enable its selection. A header message and tooltip provide information about the current update status of the selected database, and also warn users to backup databases within 24 hours of updating the schema.

4.Expand the database row of interest to review the available updates.

a.When each database row in the grid is expanded, each table, stored procedure, and view or function that needs to be updated for that database is listed. Each is listed by date and includes a comment providing more detailed information regarding required updates. Each object definition or update in the schema is defined by a tag similar to that shown below.


<version date="24 Aug 2004 08:10:12">




5.Right-click on the Module column or anywhere in the grid and select Module(s).

a.Check or uncheck the modules listed to select only the appropriate schema(s) for the update to apply. The Update function will only process those schema files with check marks in the corresponding check box.

b.Professional and Enterprise Schemas are required; both must be checked when updates are available.

6.Select and highlight the database of interest. Multiple databases can be selected using the Shift+click or Ctrl+click common to multiple selections with Windows.

7.Click Update.

8.Click Yes on the warning prompt if you are certain about proceeding with the update.

9.Click OK on the Update Status window that pops up to indicate success.

a.When working with multiple databases, the Database Update screen only shows a single confirmation message, regardless of how many databases are selected. The error message is: Successfully updated X of Y database(s). Databases that update successfully are shown with a light gray background.

b.Databases that do not update successfully are shown with a red background and the tooltip of the row shows the error message. Expand the row to see exactly what update caused the error.

10.Close the Update Database(s) window when complete.


Note: Significant updates may need an extended connection. If a timeout issue occurs, extending the timeout may be needed as shown in the Connection String Options section of the help article Connecting EQuIS Professional To a Database.


How to Fix Failed Updates


1.Review the error message(s).

2.Correct the issue(s).

3.Repeat the update process.