#
Upgrade Service Module

Actions

The following are workbench actions and must be run from the workbench menu in the sequence as indicated by these numbers.

01. Read and understand manual

This action launches the release notes page ("doc/manual/upgrade.html" page locally). This page contains all the relevant information regarding the upgrade including what to watch out for each upgrade. This page may include platform and module specific notes, bug fixes, and list of new features if necessary.

02. Back up everything

This action zips up the "MasterInstall" and "CentralHub" folders and all its contents. The compressed files are of *.zip format. The backed up files are saved in "PartnerHub/UpgradeBackup/TimeStamp/" folder. The "MasterInstall" is packed into the "MasterInstall.zip" file.

On the other hand, the backup file for the "CentralHub" is broken into several pieces due to CentralHub can be very large in size and exceed the limit. The CentralHub will be zipped up into "CentralHub-v3x.zip" for "v3x" folder, "CentralHub-config.zip" for "config" folder, "CentralHub-data.zip" for "data" folder, "CentralHub-maps.zip" for "maps" folder, and "CentralHub-main.zip" for rest of the standard folders ("logs", "modules", "os", "system", "temp", and "update"). Depending on the client and how many active jobs are in the system, this process may take a while.

03. Run pre-upgrade diagnostics

Runs all pre-upgrade diagnostic scripts in sub-folders under the "UpgradeService/system/scripts/Before Upgrade/diagnostic/point_release_folder/" folder. The assumption is, there will be a sub-folder for each module containing all pre-upgrade diagnostic scripts for that module. This action will run these scripts sorted by the point release folders.

04. Run pre-upgrade fix-it scripts

Runs all pre-upgrade fix-it scripts from the sub-folders under the "UpgradeService/system/scripts/Before Upgrade/Fixit/point_release_folder/" folder. There will be a sub-folders containing scripts for pre upgrade fixes. This action will run these fix-it scripts sorted by lower-to-higher point release folders.

05. Upgrade platform software

It shuts down the workbench and upgrades the platform code in "MasterInstall" to the next stable release (as configured in the "/resources/settings.xml" file). This action modifies the source url in the "UpdateSource.txt" file before it launches the platform update action. Currently, the user will re-launch the workbench using "MasterInstall/os/windows/programs/Workbench.bat" when platform upgrade is complete. It will be automated in the future.

06. Upgrade modules

This action shuts down the workbench and upgrades the modules in the "MasterInstall" to the next stable release (as configured in the "/resources/settings.xml" file). This action modifies the source url in the "UpdateSource.txt" file before it launches updating the modules.

In addition, this action reads the "UpgradeService/system/resources/AdditionalModulesToDownload.xml" file and downloads those modules. Finally, it installs these additional modules. The idea is for the developers to include the additional module names in this file. If needed to be, this file can be used by production/support team as well. It important to configure this file prior to running this action otherwise no additional module will be downloaded.

Currently, the user will re-launch the workbench using "MasterInstall/os/windows/programs/Workbench.bat" when modules are upgraded. It will be automated in the future.

07. Run scripted configuration changes

Similar to pre-upgrade diagnostic/fix-it scripts, this action runs scripts in the sub-folders under the "UpgradeService/system/scripts/After Upgrade/AutomatedConfigurationChanges/point_release_folder" folder. The goal is to make configuration changes automated and the assumption is there will be a sub-folder for each module containing scripts for that module.

08. Make manual configuration changes

This action opens the "doc/manual/Manual Changes.html" file. This file contains notes and reminders to perform manual configuration changes, if any needed.

09. Run post-upgrade diagnostics

At this point, the system will be updated to the next stable version and may require post-upgrade diagnostic. This action runs scripts from sub-folders under "UpgradeService/system/scripts/After Upgrade/diagnostic/point_release_folder/" folder. The script files are sorted and run in the similar fashion as the pre upgrade diagnostic scripts (by point release sort order).

10. Run post-upgrade fix-it scripts

This action will run all post-upgrade fix-it scripts from sub-folders under "UpgradeService/system/scripts/After Upgrade/Fixit/point_release_folder/" sub-folder containing the fixit scripts.

11. Post everything to Central Hub

This action post upgraded platform, modules, and changes to the CentralHub.