This topic describes the necessary steps for upgrading an existing installation of LumisXP. If you are installing LumisXP for the first time, follow the section Installation Steps and its subsections.

See the section Version Highlights to check for product changes, relevant notes, and possible specific steps for correctly upgrading the version. It is necessary to analyze from the source version to the target version.

It is recommended to perform the upgrade in the development environment, with the sources of the implemented services, and then recompile the solution classes.

Important: Starting from version 6.2, Lumis does not allow upgrading the portal while there are items in the execution queue. It is necessary to let the entire queue be consumed before executing the upgrade steps.

Steps for the upgrade

Stop the application server. In a multi-server environment, all application servers must be stopped.
Make a backup of the existing installation;
Unpack the distribution file in a temporary directory;
Configure, in the temporary directory, the files from the /lumisdata/config folder and in /www/WEB-INF/*.xml according to changes previously made in relation to the default configuration of the previous installation;
Copy, to the temporary directory, the necessary files from the solution. For example, files that the solution added in /lumisdata/shared/def, /www, and /www/WEB-INF/lib;

Note

No file should be overwritten in this copy.
Copy, to the temporary directory, the existing data files in /lumisdata/data, lumisdata/logs, and www/data from the previous installation;
Delete (or rename for backup) the previously existing installation and move the temporary directory to the final directory;
Check if the JAVA_HOME variable is configured in the operating system;
Optionally execute, from the command line, the file upgradeportal.cmd (Windows environment) or upgradeportal.sh (Linux environment), located in /setup. If you choose not to execute this command line at this moment, this processing will occur when the application is started on the application server in a later step. In this case, the processing will occur in a non-interactive manner, with information sent to the log, stopping the process in case of any error.
Note
- To execute the upgradeportal from the command line, the following settings must be temporarily adjusted:
  - The lumishibernate.cfg.xml cannot be configured to use Data Source.
  - The lumishibernate.cfg.xml cannot have any extra entity mapping.
  - The lumishibernate.cfg.xml cannot have the property jdbc.factory_class configured for javamelody.
  - The lumisportalconfig.xml cannot have cluster configured.
- In multi-server environments, simply execute upgradeportal only once - it is not necessary to execute it on the other servers.
Proceed with the Elasticsearch upgrade.
Review the specific installation steps for your application server, including configurations and shared libraries;

Note

Observe, in the version highlights, the shared libraries that have been removed.
Start the application server, deploying the LumisXP web application if necessary according to the application server being used and the way the application is installed. In multi-server environments, start only one of the application servers and wait to start the others until the first one is updated and functioning, responding to accesses normally. The first boot after the upgrade may take longer depending on the changes involved. Logs should be monitored for information on problems, progress, or completeness of the boot. HTTP 503 responses when trying to access the web application may occur while the boot is still incomplete.
Register the services that are not standard for LumisXP in the Service Manager.
Clear the Portal cache.