Reindex 2022.1 Search Indexes before upgrading to 2023.1 - spectrum_platform - 23 - 23.1

Spectrum Installation Guide for Windows

Product type
Software
Portfolio
Integrate
Locate
Verify
Product family
Spectrum
Product
Spectrum > Spectrum Platform
Version
23.1
Language
English
Product name
Spectrum Technology Platform
Title
Spectrum Installation Guide for Windows
Topic type
How Do I
Overview
Installation
Configuration
First publish date
2007
ft:lastEdition
2023-11-03
ft:lastPublication
2023-11-03T19:05:52.996250
If you upgraded from a previous version of the Spectrum Technology Platform (such as, 19.1. or 20.1) to Spectrum 2022.1, you must first reindex the search indexes before upgrading to 2023.1. You do not need to perform this procedure if you did not upgrade to 2022.1 from a previous version of Spectrum.

Reindex 2022.1 Search Indexes on a standalone server

For a standalone server configuration, perform this procedure before you upgrade Spectrum Technology Platform 2022.1 to 2023.1.

Note: In this procedure, SpectrumDirectory is the directory where the Spectrum Technology Platform server is installed (for example, C:\Program Files\Precisely\Spectrum).
  1. Stop the Spectrum Technology Platform server if it is not stopped already
  2. To stop the server, right-click the Spectrum Technology Platform icon in the Windows system tray, and click Stop Spectrum.
  3. Check that all Spectrum Java processes are stopped.
  4. Back up the SpectrumDirectory\index\data folder.
  5. Use the link provided here to download the ZIP file containing the reindex files.
  6. Extract the contents of the downloaded Reindex_20221.zip file to the SpectrumDirectory folder.
  7. Open a Command Prompt window and from the command prompt, run the elasticsearch.bat file located in SpectrumDirectory\index\bin folder.
  8. Open a new Command Prompt window and run the reindex.bat file located in the SpectrumDirectory\index\bin folder.
  9. Once the reindex has completed, close the reindex Command Prompt window.
  10. Verify that the reindex was successful.
    1. Open the SpectrumDirectory\index\logs\reindex.log in a text editor, such as Notepad++.
      The log file will show you a count of indexes before and after the reindex.
    2. Search the reindex.log file for Not reindexing index.
    3. If you find Not reindexing index in the log for one or more indexes, open the SpectrumDirectory\index\config\jvm.options file.
    4. Increase the minimum and maximum heap space, then run the reindex again (steps 8 and 9).
      # Xms represents the initial size of total heap space
      -Xms1g
      # Xmx represents the maximum size of total heap space
      -Xmx1g
  11. You can verify the reindex was successful by opening the reindex.log file in the SpectrumDirectory\index\logs folder.
    The log file will show you a count of indexes before and after the reindex.
  12. Press Ctrl-C to stop Elasticsearch, then close the Command Prompt window.
  13. Verify that all Java processes are stopped.
After you finish this procedure, complete the Spectrum Server Upgrade.

Reindex 2022.1 Search Indexes on a cluster server

For a clustered configuration, perform this procedure before you upgrade 2022.1 to 2023.1 on each node in the cluster. For a distributed cluster configuration, perform this procedure on each node in the Spectrum Technology Platform server configuration.

  1. Stop the Spectrum Technology Platform server on each node in the cluster.
    To stop Spectrum, right-click the Spectrum Technology Platform icon in the Windows system tray and click Spectrum.
  2. Check that all Spectrum Java processes are stopped.
  3. Back up the SpectrumDirectory\index\data folder on each node in the cluster.
  4. Use the link provided here to download the ZIP file containing the reindex files.
  5. Extract the contents of the downloaded ZIP file (Reindex_20221.zip) to the SpectrumDirectory.
  6. After steps 1 through 5 have been completed on each node in the cluster, run the elasticsearch.bat file from the Command Prompt simultaneously on each node in the cluster to start Elasticsearch in cluster mode.
  7. From a new Command Prompt window, run the reindex.bat file on one of the nodes in the cluster.
  8. Once the reindex has completed, close the reindex Command Prompt window.
  9. Verify that the reindex was successful.
    1. Open the SpectrumDirectory\index\logs\reindex.log in a text editor, such as Notepad++.
      The log file will show you a count of indexes before and after the reindex.
    2. Search the reindex.log file for Not reindexing index.
    3. If you find Not reindexing index in the log for one or more indexes, open the SpectrumDirectory/index/config/jvm.options file.
    4. Increase the minimum and maximum heap space, then run the reindex again (steps 7 and 8).
      # Xms represents the initial size of total heap space
      -Xms1g
      # Xmx represents the maximum size of total heap space
      -Xmx1g
  10. Repeat steps 7 through 9 on each node in the cluster.
    Make sure that the reindex completes on each node before you run it on the next node.
    Note: Even though the other cluster nodes should already be reindexed, it is best practice to run the reindex on each node. You will see the following message if cluster node has already been reindexed:
    INFO: no need to reindex cluster
  11. Press Ctrl-C to stop Elasticsearch and then close the Command Prompt window.
  12. Verify all Java processes are stopped.
After you finish this procedure, complete the Spectrum Server Upgrade.