Upgrade Steps for Profiling and Search Index Users

Note: This process will add some time to the upgrade, as all existing indexes are upgraded to a newer version. This time will depend on the data stored in Search Index.

You are required to first export your indexes before upgrading to this release, then import those indexes after upgrading. Scripts are provided to assist with the manual steps. You must use a semi-manual process to migrate your indexes to maintain compatibility with the current version of Elasticsearch.

Note: The manual (script-based) steps require the server or cluster to be up and running. Do not stop the server until the point noted in this process.

Scripts provided

The Delete, Export, and Import scripts are located in the utilities folder where the Spectrum Installer is placed.

Function	Script or file name
Delete indexes	Unix/Linux - delete-all-indexes.sh Windows - delete-all-indexes.bat
Export indexes	Unix/Linux - export.sh Windows - export.bat
Import indexes	Unix/Linux - import.sh Windows - import.bat

Prerequisites for these upgrades

The export directory should be empty, and should not include hidden files.
The JAVA_HOME environment variable should be set.

Migrate your indexes

Note: It is mandatory to apply all the product updates available for Advanced Matching Module for versions 11.1, 12.2, and 12.2.1 before using these utilities. For upgrading version 10.1, refer Additional Steps for Spectrum™ Technology Platform version 10.1

Follow these steps to set the necessary variable and upgrade then re-import your current indexes.

Set the JAVA_HOME environment variable to point to a Java JDK8 or later.
Note: If you do not set this variable, your export or delete index actions may fail.
Export all current indexes using the export script.
Unix/Linux example:
```
sh export.sh <spectrum_dir> <export_dir>
```
Windows example:
```
export.bat <spectrum_dir> <export_dir>
```
where:
- spectrum_dir is the full path to the Spectrum installation: This location includes the /server, /index, and /repository directories.
- export_dir is the full path to the directory to which indexes will be exported.
This will extract all indexes currently stored in Elasticsearch and write them to a local directory accessible by one of the servers. In a clustered environment, do this only on one node.
Once your Export runs without error, run the delete-all-indexes script to clear all indexes from the running instance of Elasticsearch.
Unix/Linux example:
```
sh delete-all-indexes.sh <spectrum_dir> <export_dir>
```
Windows example:
```
delete-all-indexes.bat <spectrum_dir> <export_dir>
```
where:
- spectrum_dir is the full path to the Spectrum installation.
- export_dir is the full path to the directory to which indexes have been exported.
Once the Delete step has completed successfully, it is safe to shut down your Spectrum node or cluster.
Run the software upgrade process as you would with previous releases of Spectrum™ Technology Platform.
Note: The upgrade process looks for existing indexes. If indexes are found, the installer will generate an error message and will stop the upgrade process.
Once the upgrade is complete, restart the server.
Import back the indexes using the import script. In a clustered environment, this should be done only on one node.
Unix/Linux example:
```
sh import.sh <spectrum_dir> <import_dir>
```
Windows example:
```
import.bat <spectrum_dir> <import_dir>
```
where:
- spectrum_dir is the full path to the Spectrum installation.
- import_dir is the full path to the directory from which Spectrum indexes will be imported.

Additional Steps for Spectrum™ Technology Platform version 10.1

Follow these steps while upgrading from version 10.1 to the latest version:

Note: Stop the Spectrum™ Technology Platform server before performing the first step mentioned below.

Set the http.enabled setting as true in the elastic search file. It is set to false by default. This file is located at: <SpectrumLocation>\server\modules\searchindex\elasticsearch.yml
Start the Spectrum™ Technology Platform server.
Access searchIndex by running any SEARCH job. This will initialize the search engine.
Export the 10.1 indices using the utility provided and explained above.
Upgrade from version 10.1 to the latest version.