.. include:: /includes.rst.txt

.. comments - headings

   # with overline, for parts
   * with overline, for chapters
   = for sections
   - for subsections
   ^ for subsubsections
   " for paragraphs
   * for H5
   + for H6

.. index:: pair: TopBraid EDG ; Upgrading

.. _upgrading_topbraid_edg:

***********************
Upgrades and Migrations
***********************
 

Before upgrading from an older version of EDG, consult this documentation for migration tasks that might apply to your upgrade. 
The migration documentation keeps your data and the EDG application functioning correctly after an upgrade, please pay close attention to those details. 
You can upgrade from any previous release straight to the current release, but you’ll need to use the migration documentation starting at the version you’re currently on and following along to current release. 
For example, if you upgrade from version 7.0 to 7.3 you’ll need to follow the migration notes for 7.0 to 7.1 and 7.1 to 7.2 and 7.2 to 7.3. 


Migration Instructions
======================

* Please make sure to take backups of everything (workspace, database, tomcat installation, etc.) first. 
* Workspaces cannot be downgraded once you upgrade. If you need to revert versions of EDG, you will have to use the backed up workspace.
* If you need to, take screenshots of your setting on the Rights Management page. 
* Have your credentials and connections strings/URLs handy for Explorer, RDBMS and S3 connections. 
* Upgrade on your test/development environment successfully before the production environment gets upgraded. This is important when testing customizations to the UI or models especially. 

7.2 to 7.3 Migrations
=====================

**Backup and Restore**

* Backup and Restore utility was rewritten to use turtle instead of trig for better prefix management. In doing so the contract of the API has changed. 
  Please review the new specifications in the Swagger API documentation in EDG. As a reminder, backup and restore shouldn't be used between versions. After upgrading, please initiate a new backup. 


**SPARQL Query Panel**

* SPARQL Query Panel now includes querying subgraphs by default. Please notify your users of this change in behavior. 

**ADS**

* Users of ADS are strongly encouraged to read the detailed change-log (https://www.topquadrant.com/release-notes-topbraid-7-3/) for any API changes. 

**SHACL**

EDG users who have put classes, properties or shapes into their non-Ontologies will get violations on this data.  Please notify your users of this expected change in behavior. 

**Apache Tika2 upgrade for Corpus**

* Corpus loses import support for various exotic file formats. Likely these are unused by EDG customers.
* Tika 2 extracts certain metadata fields under different names than before. This may impact the metadata properties extracted on Corpus import.

Upgrade Steps from EDG 7.2 to EDG 7.3
=====================================

**EDG Upgrade**

REQUIRED : TAKE A BACKUP OF THE WORKSPACE (You cannot revert a workspace). Read all the instructions prior to beginning. 

1. Stop Tomcat, make sure the process is fully stopped

2. Backup and remove the `/edg` directory and `edg.war` file located in `[Tomcat Root]/webapps/`. 

3. Clear work and temp directories.

4. Place the current releases’ edg.war found in the download package into the webapps directory 

5. Backup and remove Tomcat `lib` directory. Extract TopBraid-Auth.zip from current releases' download package into newly created Tomcat lib directory. (This step is to update all the SAML and OAuth authentication jars for EDG. Be aware of any jars that are needed in this directory for Tomcat in your distribution)

6. Backup and clear the logs directory (optional)

7. Start Tomcat (the current war creates a new /edg/ directory)

8. If your installation used the Interactive setup method, this will need to be redone upon EDG startup. 
   Please refer to backup copy of your previous EDG directory at `edg/WEB-INF/setupdata/edg-setup.properties` for previous values.
   Alternatively prior to upgrade, navigate to `/edg/tbl/setup` in the EDG UI and find these values at the bottom of the page. 

9. Perform migration steps applicable to your installation

10. Regression test before upgrading production

Note: If your license has expired, you will need to install your new license before upgrading.