Skip to main content
Version: Any 26

Upgrading an existing version

Preparation before the upgrade​

Disable the task scheduler​

Before any upgrade, you must stop the task scheduler to avoid running tasks during the migration.

Steps:

  1. Stop your web application server (Tomcat)
  2. Edit the settings.json file
  3. Find the elastic-search-data → job → scheduler_settings section
  4. Set disabled to true:
{
"elastic-search-data": {
"job": {
"scheduler_settings": {
"disabled": true
}
}
}
}
  1. Restart the web server

After the migration, set disabled back to false and restart.


Configuration changes by version​

settings.json management (version 17+)​

Since Any 17, the settings.json file must only hold the changes and not every default value.

Before (versions < 17):

  • Full settings.json file with every value

After (versions ≥ 17):

  • Lightened settings.json file (only your changes)
  • The default values are read from settings-full.json

Action: check settings-full.json to see the default values. Keep only your customizations in settings.json.

Hazelcast cache configuration (version 17+)​

Since Any 17, the Hazelcast cache is configured through a dedicated file instead of settings.json.

Before (versions < 17):

{
"cache": { ... } // In settings.json
}

After (versions ≥ 17):

<!-- In hazelcast.xml -->
<hazelcast>
<!-- Cache configuration -->
</hazelcast>

Action: if you had changes in the cache section of settings.json, carry them over to hazelcast.xml.

For more details: Hazelcast documentation

shiro.ini reconfiguration for SSO​

If you use an SSO (Single Sign-On) authentication, you must reconfigure the shiro.ini file after the upgrade.

See the Sign-in and authentication section for the configuration details.


Upgrading the web application​

Deploying the new WAR​

  1. Stop Tomcat
  2. Delete the old any folder in $TOMCAT_HOME/webapps/
  3. Delete the old any.war file
  4. Copy the new any.war file into $TOMCAT_HOME/webapps/
  5. Restart Tomcat

The web application redeploys automatically.


Upgrading the Messaging Server​

Deploying the new WAR​

  1. Stop Tomcat
  2. Delete the old MessagingServer folder in $TOMCAT_HOME/webapps/
  3. Delete the old MessagingServer.war file
  4. Copy the new MessagingServer.war file into $TOMCAT_HOME/webapps/
  5. Restart Tomcat

Important: disable the task scheduler before this step (see Preparation before the upgrade).


Upgrading the configuration objects​

Once every WAR is redeployed and the new version is started:

  1. Disable the scheduler (see the Preparation step)
  2. Open your browser and go to <any url>/rest/default/install/upgrade
  3. Sign in with your administrator credentials
  4. Click Update the configuration

The configuration objects are automatically migrated to the new version.

After the migration, re-enable the scheduler by setting disabled back to false in settings.json.