Upgrading a Server

Prerequisites:

To upgrade a server:

  1. Download the updated version of Spectrum™ Technology Platform using the download instructions contained in the release announcement email.
  2. Unzip the downloaded installer to a temporary folder on the server you want to upgrade.
  3. Back up module-specific data for any of these modules if you have them installed.
    Module Items to Back Up
    Advanced Matching Module, Data Normalization Module, and Universal Name Module Back up the contents of these subfolders located in SpectrumLocation/server/modules:
    • cdqdb
    • lucene
    • matcher
    • parser
    • searchindex
    • tables
    .
    Data Hub Module If you do not already have a backup copy of your models, create a backup manually. To create a backup manually, open the Relationship Analysis Client and click Manage. Select the model you want to back up then click Backup.
    In addition to backing up your models, back up these two property files:
    • server\modules\hub\hub.properties
    • server\modules\db\neo4j.properties
    Location Intelligence Module Back up your named resources, data, and configuration files.
  4. Stop the Spectrum™ Technology Platform server. To stop the server, right-click the Spectrum™ Technology Platform icon in the Windows system tray and select Stop Spectrum™. Alternatively, you can use the Windows Services control panel and stop the Pitney Bowes Spectrum™ Technology Platform service.
  5. Wait for the server to finish the shutdown process before proceeding.
    Important: If you have the Data Hub Module installed, make sure that all models shut down properly. Models that do not shut down properly will not open successfully after upgrading.
  6. If you have the Address Now Module installed, shut down the Address Now server by going to the Windows services control panel and stopping the Address Now Server service.
  7. If you have the Global Sentry Module installed, shut down the Global Sentry database server by going to the Windows services control panel and stopping the Global Sentry Database Server service.
  8. Run the Spectrum™ Technology Platform installer to upgrade your system.
Note: Any job or subflow stored in the system during a server upgrade is marked as exposed to provide the same behavior for those jobs and subflows as before the upgrade. Any job or subflow that is exported prior to the upgrade will not be exposed. Therefore, when importing these jobs or subflows back into the system, you must manually expose the imported job or subflow.

Some modules have post-upgrade steps you need to perform.

Data Hub Module Open this file in a text editor: server/modules/hub/neo4j.properties and set the property allow_store_upgrade property to true. The purpose of this property is to protect against unintentional and irreversible store upgrades. Setting this property to "true" indicates that you understand the ramifications of proceeding with an upgrade and have taken the necessary precautions before proceeding.

Restart the Spectrum™ Technology Platform server. The server will upgrade each model. Examine the file server/app/repository/logs/wrapper.log for errors or warning messages. Once all models have been upgraded, go back to the hub.properties file and comment out the allow_store_upgrade property.