Spectrum Server Upgrade - spectrum_platform - 23 - 23.1

Spectrum Installation Guide for Windows

Product type
Product family
Spectrum > Spectrum Platform
Product name
Spectrum Technology Platform
Spectrum Installation Guide for Windows
Topic type
How Do I
First publish date
  • Before upgrading, be sure to read the release notes for the new version. The release notes contain a list of known issues, important compatibility information, supported upgrade paths, and module-specific data backup recommendations.
  • Important: If you upgraded to Spectrum Technology Platform 2022.1 from an earlier version of Spectrum, you must reindex the Spectrum 2022.1 search indexes before you upgrade to Spectrum Technology Platform 2023.1. For instructions how to do this, see Reindex 2022.1 Search Indexes before upgrading to 2023.1 under Upgrading you Installation.
  • Make sure that you follow the appropriate upgrade path for the currently installed version of Spectrum that you want to upgrade.
  • Apply all the latest updates available for your operating system, especially those that resolve issues with Java.
  • Important: We recommend that you create a backup before upgrading so that if an error occurs during the upgrade you can recover your flows, security settings, and other settings and customizations.

    To retain customized settings in the wrapper.conf file located in the SpectrumDirectory\server\bin\wrapper directory, you will need to compare the contents of wrapper.conf installed during the upgrade with the contents of the backed up copy of the file. Before upgrading make sure you have backed up all models and property files. You can then manually copy customizations that you want to retain after the upgrade into the updated version of the file. This is particularly important for changes to the initial and maximum Java heap sizes. This release requires Java 11, so corresponding updates to JVM properties should be used.

This procedure is for upgrading a single Spectrum Technology Platform server. Follow this procedure when upgrading a standard installation or when upgrading a node in a cluster. If you are upgrading a cluster, be sure to follow the cluster upgrade process. For more information, see Upgrading a Cluster.

If you upgrade the main server and start it before upgrading and starting the nodes, you will need to recreate your connections in Management console after upgrading.

  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 the server. For instructions on creating a backup, see the Administration Guide.
  4. Back up module-specific data for any of these modules if you have them installed. The following module sections may also contain other information that you should read before upgrading.
  5. Optional: If you have customized settings that you want to retain in wrapper.conf located in the SpectrumDirectory\server\bin\wrapper directory, copy the customized file to a separate location.
    The upgrade does not retain changes to settings in this file. This is particularly important for changes to the initial and maximum Java heap sizes.
  6. You can reduce the time it takes to upgrade your system by purging old records from the execution history. Consider purging the execution history if it contains over 100,000 entries. You can view your execution history in Enterprise Designer under View > Execution History.

    If you are upgrading from version 19.1 or 20.1, use the JMX console to delete old history records. This process is faster than manually deleting records in Management Console. For more information, see Purging Execution History.

  7. Stop the Spectrum Technology Platform server.
    To stop the server, right-click the Spectrum Technology Platform icon in the Windows system tray and click Stop Spectrum.
  8. Check that all Spectrum Java processes running have been shut down on the machine before you start the Spectrum server upgrade.
    Note: If you have Global Sentry installed, stop the Global Sentry database server by opening the Windows Services Manager and stopping the Global Sentry Database Server service.
  9. Run the Spectrum Technology Platform installer to upgrade your system.
    Important: Clear the option to restart the server after the installation is complete.
  10. After the upgrade is complete, edit the neo4j.template and spectrum-container.properties files if necessary to match the following settings.
    • SpectrumDirectory\repository\neo4j.template
    • SpectrumDirectory\repository\spectrum-container.properties
      Note: The spectrum.repository.cluster.mode setting shown here is for a standard (non-cluster) server or separated database node.
  11. Check that all Spectrum Java processes have been shut down.
  12. Start the Spectrum Technology Platform server.
  13. Apply all the updates for the platform and any modules you have installed.
    For a listing of updates, see Spectrum Technology Platform Updates.
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.

The following module has post-upgrade steps you need to perform.

Spatial During an upgrade, the pool size is reset to 4 if set to a lower value. A pool size setting of 4 or more is unaffected. To change the Remote Component Pool Size value after upgrading, open the Management Console and select Resources > Spatial. Change the pool size value and click Save. For details, see Modifying the Pool Size in the Spectrum Spatial Guide.
Context Graph

Context Graph models are stored on an external Neo4j Graph Database Server. For instructions about how to upgrade Context Graph, see Upgrade Context Graph.