Basic Upgrade Sequence - SmartPlant Foundation - IM Update 47 - Installation & Upgrade

This sequence is presented as a brief overview of the upgrade process. Each of these steps is explained in detail within the sections that follow.

1. Prepare for the upgrade

   1. Clear the load queues and stop schedulers.

   Clearing the Load Queues and stopping the schedulers before upgrading is strongly recommended.

   1. Complete all jobs and delete any failed jobs.

   2. Check out the current CMF.

   3. Perform backups as required, including:

      • SmartPlant Foundation data on the database server

      • Virtual directories on IIS

      • Vault directories and contents

      • Configuration files

      • Schema files, if customizations have been made

      • Any SmartPlant Foundation custom files (DLL files and others) if customized

      • Licensing files

   4. Export site configurations.

   5. Recycle the application pools using IIS.

   6. If you are upgrading from a version earlier than Update 33 and you are switching to use PDFTron for View and Markup, convert Brava! stamps to the new upgraded format.

   You can also stop IIS to prevent users from connecting to a site during the upgrade.

2. Install new software

   1. If upgrading from version 2016 or earlier, uninstall any modules first, and then uninstall the currently installed version of SmartPlant Foundation.

   If the currently installed version is 10.0.x and you are upgrading to the latest Update, you do not need to uninstall SmartPlant Foundation.

   1. Upgrade systems and software as required by the hardware and software recommendations for the new version.

   2. Install the new version.

   3. Run the new version of Server Manager.

3. Update components and software

   1. Import site configurations.

   2. Update a site.

   3. Restore customizations.

   4. Upgrade a site:

      • Upgrade SmartPlant Foundation data on the database server.

      • Upgrade the CMF file, if customized.

   5. Upgrade your license server configuration, if required.

   6. Check in the CMF (either your upgraded customized CMF or the newly installed version if you are not using a customized CMF).

   7. Extract and load the new schema XML into the database.

   8. Upgrade tool map schemas in an integrated environment. For more information, see the upgrade documentation for each tool participating in integration.

   9. If you are upgrading from a version earlier than Update 33, and you are switching to use PDFTron, configure the PDFTron view control.

   10. If you are upgrading from a version earlier than Update 34, configure the GVC view control.

   11. If you are upgrading from a version later than Update 34, upgrade the Visualization Data Service (VDS) Server.

   12. Perform configuration-specific upgrade tasks.

   13. If you are upgrading an installation of SmartPlant Fusion, complete tasks required for upgrading SmartPlant Fusion.

   14. If you are a SmartPlant Master Tag Registry customer upgrading to SmartPlant Foundation 10.0.0 or later, complete the upgrade of SmartPlant Master Tag Registry.

   15. If you are upgrading an installation of SPO/E Core, complete the upgrade of SPO/E Core.

• If you have customized the web.config, specializationvalues.xml, or settings.xml files on the SmartPlant Foundation server you are upgrading, you will want to preserve those changes. Refer to Define the post process batch file for more information about using a batch file to prevent these customized files from being overwritten. After the upgrade, you will want to review the differences between your customized files and the new files delivered with the new version and merge the updated elements with your customized files. The customizations in the module files will be deleted and must be backed before updating the site.

• For information on upgrading from versions of SmartPlant Foundation previous to version 2008 and migrating data to the current version, contact Hexagon Support or your project team.

• After upgrading, if you have sites that are configured to use API Services, you must copy the Security.sdf file located at Web_Sites\ [Site name] \SPFConfigService\SPFAuthentication\App_Data folder and save it into the same location in the new site. This file stores the configuration of the authentication folder for the applications that use API Services.

• If you have any customized menus or toolbar settings on the SmartPlant Foundation server, Server Manager now preserves those settings in the CustomMenus folder during the upgrade of SmartPlant Foundation. The customized module files are not deleted, but should still be backed up before updating the site as part of a backup process.

• All server connection settings and scopes information is now retained between regular update installation. Server connections are located in a file at: C:\ProgramData\SmartPlant\ServerConnections.xml.