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.1 to 7.4 you’ll need to follow the migration notes for 7.1 to 7.2 and 7.2 to 7.3 and 7.3 to 7.4.

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.3 to 7.4 Migrations

RDF import

  • Import of RDF files (e.g., Turtle files) into asset collections is now doing stricter validity checks. Files containing some invalid URIs that would have been previously accepted are now rejected. For example, URIs containing multiple hash characters (#) or square brackets ([, ]) are now rejected.

Processes that produce RDF files for import into EDG must take care to produce valid URIs, and must %-encode or remove invalid characters.

Custom editor panels

  • With the library replacement for EDG editor panels, the following function has changed. LayoutManager.ensurePanelOpen() has been turned into a promise, and is recommended to be used when communicating between panels with events(when you aren’t sure if a panel is open yet).

Any existing calls should be modified to have a .then(), wrapping the subsequent code within it. this.props.glContainer.setTitle() has been removed. It is instead suggested to use a ‘title’ state object, passing that to the <Panel .../> Component as a title prop. Contact TopQuadrant support for questions.

Legacy functions

  • The legacy SPARQL functions uix:isEVN() and uix:isEDG() have been removed

  • Customization using the partial imports (such as rdfex.org dctems, created, creator, publisher, source), will now be ignored and the ontologies will no longer see the imported triples. This should be very rare.

  • Defined SPIN magic properties outside of .spin.* or .ui.* files need to be moved to .spin.* or .ui.*

Upgrade Steps from EDG 7.3 to EDG 7.4

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 Tomcat 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 tomcats 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.