.. include:: /includes.rst.txt .. comments - headings # with overline, for parts * with overline, for chapters = for sections - for subsections ^ for subsubsections " for paragraphs .. 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 6.4 to 7.2 you’ll need to follow the migration notes for 6.4 to 7.0 and 7.0 to 7.1 and 7.1 to 7.2. 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.1 to 7.2 Migrations ===================== **Data Platform** * Users of Data Platform need to upgrade to the 1.1.0 delta server jar as well. Please pull this from the TopQuadrant download site. The versions of EDG and Data Platform need to be in sync. **ADS** * Users of ADS are strongly encouraged to read the detailed change-log (https://www.topquadrant.com/release-notes-topbraid-7-2/) for any API changes. **SHACL** * Running all inference rules (with `sh:values` on) will now also assert `sh:defaultValues`. In case this is not desirable for your use case, please mark the surrounding property shape with `dash:neverMaterialize` true. **Customizations** * The user menu consumes many of the top level links that would have previously been in the Primary Nav. For extension developers that have defined primary nav links that are not project types, this is likely where the links should be included. The user menu has been setup similar to the previous primary nav. Menu items must be of type `teamwork:UserMenuLink` or `teamwork:HomePageTab`. To be considered for the menu, items must have an 'swa:tabIndex' less than 0 and be associated with `edgproduct:EDG` via `teamwork:userMenuLink` or `teamwork:userMenuPageTab`. ex: `edgproduct:EDG teamwork:userMenuLink teamwork:helpLink ;` * Customers that have defined their own project types will want to update their `teamwork:projectTypeWeight` values as well to ensure inclusion in the new collections menu. * `TableUtils.dateformat` JavaScript function is deprecated. Customers using this in their customizations should start using `DisplayUtil.dateFormat` instead. `TableUtils.getDateCell` no longer uses a 'dateFormat' parameter. It uses the date format from `DisplayUtil.dateFormat`.Customers using this parameter in their customizations will receive a warning in the JavaScript console. **APIs** * The Search the EDG API has changed slightly. If appropriate, the client now requests the ‘summary’ field (among others) instead of the ‘description’ field. And the returned payload will include a ‘summary’ section that includes the ‘description’ along with a number of other fields. * The Export RDF File web services are now at `/tbl/service/${graphId}/tbs/exportToRDF/${format}`. Please update any API or scripts using this service. **LineageModel** * Customers who have purchased a package including Lineage Model and are using the LineageGram, please reach out to TopQuadrant support to receive this download. It's now an add-on feature. Upgrade Steps from EDG 7.1 to EDG 7.2 ========================== **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 new lib directory. 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.