erwin Evolve 2024.0.0 - User Guide

Introduction

Elastic/Global Search Using Too Much Memory

Introduction

The latest release of the EvolveWebPlatform has had the version of Elastic Search that it uses upgraded to 7.16. If this version when installed with evolve is using too much memory, then it can be reduced by changing some settings in the options file.

For these settings to take effect, the Elastic Search service needs to be uninstalled and reinstalled. While this operation does not take too long, we recommend that it is done when the evolve application is not being used or during a relatively quiet period.

Option File Changes

Option File Changes

If the EvolveWebPlatform has been installed using the default location, then you need to change the file.

•The file to be changed is in the folder:

“C:\erwin\Evolve\Elasticsearch\elasticsearch-7.16.2\config”

•The file required to change is called “jvm.options”

Edit this file with any text editor, but don’t set it as the default.

Locate these lines

################################################################

## IMPORTANT: JVM heap size

################################################################

After a short description you should find these lines

##

#   -Xms4g

#    -Xmx4g

##

Change them to the following

##

-Xms500M

-Xmx1g

##

So that whole section should look like this

################################################################

## IMPORTANT: JVM heap size

################################################################

##

## The heap size is automatically configured by Elasticsearch

## based on the available memory in your system and the roles

## each node is configured to fulfill. If specifying heap is

## required, it should be done through a file in jvm.options.d,

## and the min and max should be set to the same value. For

## example, to set the heap to 4 GB, create a new file in the

## jvm.options.d directory containing these lines:

##

-Xms500M

-Xmx1g

##

## See https://www.elastic.co/guide/en/elasticsearch/reference/7.16/heap-size.html

## for more information

##

################################################################

•Save the file.

Updating the Service

Updating the Service

1.Start the Windows Services (eg. by typing services in the windows search and clicking the application that appears)

2.Locate the “CWS.elasticsearch-service-x64” and stop it, this will also stop the “CWS.Search” service

3.Open a command prompt and navigate to the folder “C:\erwin\Evolve\Elasticsearch” assuming the default location.

In the command prompt type: UninstallService

When complete type: InstallService

4.When completed open the Windows Services application. If it did not open, refresh it, and start the “CWS.elasticsearch-service-x64” service. Wait a minute or so and start the “CWS.Search” service.

5.The memory usage for the service should now be at a reasonable level.

Upgrading

Upgrading from Evolve Web Platform 2020.1.x

If you are upgrading to the latest Evolve 2020.1 from any 2020.1.x version.

The following steps also ensure compatibility between Evolve Web Platform and Evolve Suite (CWSuite) when run on the same machine.

1.First BACKUP your SQL Database, to ensure any updates can be reverted should there be a problem.

2.Now uninstall Evolve Services.
To do this you may need to first stop the CWS Services from running

3.Then uninstall your previous version of Evolve Web Platform 2020
A restart may be required.

4.Now uninstall your previous version of Evolve Suite 2020 * only if previously installed *
A restart may be required.

5.Follow the steps below:

•Go to your previous Evolve Web Platform folder (defaults to C:\erwin\Evolve)
right-click on the 'Evolve' sub-folder, then choose
'Sent to >' - 'Compressed (zipped) folder'

•Let Windows compress the remnants of this folder to a backup file
This zip will contain any customizations made to Evolve Web Platform, various settings, and your Global Search cache
This is a useful backup to keep, should you need to revert any changes.

•Finally delete all the contents of the Evolve folder EXCEPT these 2 folders (if you want to preserve your Global Search cache):
  * CWSServices - folder
  * Elasticsearch - folder

6.Install the latest Evolve Suite release (aka CWSuite)  * If only the Web Platform is required, this step can be skipped. *
(The Suite should be installed first, if both Desktop and Web components are to co-exist on a single machine)

7.Install Evolve Web Platform 2020
And copy any custom files back to their respective folders (nb: only copy files customized by your organization)

8.** ENSURE YOU HAVE BACKED UP YOUR DATABASE **
 Follow the instructions to upgrade your database

9.Any version upgrade can be performed from a previous version but the below is required when updating to 2020.0.2 or later in the 2020 series
Continuing on from the database upgrade instructions, also run the following command
ValidateRepository.exe -connection:YourConnectionName -username:YourUserName password:YourPassword -applyfixes
When prompted to apply fixes, review the changes (there may be other faults that need fixing, check you are happy with them) then press 'a' for all.

10.Your upgrade is complete - continue to configure Evolve Web Platform and re-publish the sites.