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:
- Stop your web application server (Tomcat)
- Edit the
settings.jsonfile - Find the
elastic-search-data→job→scheduler_settingssection - Set
disabledtotrue:
{
"elastic-search-data": {
"job": {
"scheduler_settings": {
"disabled": true
}
}
}
}
- 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.jsonfile with every value
After (versions ≥ 17):
- Lightened
settings.jsonfile (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
- Stop Tomcat
- Delete the old
anyfolder in$TOMCAT_HOME/webapps/ - Delete the old
any.warfile - Copy the new
any.warfile into$TOMCAT_HOME/webapps/ - Restart Tomcat
The web application redeploys automatically.
Upgrading the Messaging Server
Deploying the new WAR
- Stop Tomcat
- Delete the old
MessagingServerfolder in$TOMCAT_HOME/webapps/ - Delete the old
MessagingServer.warfile - Copy the new
MessagingServer.warfile into$TOMCAT_HOME/webapps/ - 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:
- Disable the scheduler (see the Preparation step)
- Open your browser and go to
<any url>/rest/default/install/upgrade - Sign in with your administrator credentials
- 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.