Corporate Edition only!
The upgrade procedure described here applies to iteraplan Corporate Edition only. Updating the Docker Lite Edition is not possible.
Verify System Requirements
This guide provides instructions to upgrade iteraplan from release 6.4 to release 6.5. Please note that this guide is only applicable to these versions of iteraplan. For prior versions, please follow the appropriate iteraplan upgrade guides in order to upgrade to iteraplan 6.4 first.
Before starting with the upgrade, please verify that you have the required software packages installed and upgraded to the required version. See here for details: Installation Prerequisites.
The upgrade steps only need to be carried out once. However, they must be repeated for every installed instance of iteraplan (if applicable). The upgrade process is not intended to be reversible, i.e. after performing the upgrade there is no standard way to revert to the previously installed version of iteraplan. For that reason, we strongly recommend to create a complete backup of your entire iteraplan database and the docker configuration files.
The provided Docker compose file mounts some data directories from outside the Docker container, e.g. for the Graphics Reactor. Should you have changed this, please make sure that the iteraplan data directories are backed up and not deleted with the container.
Stop the iteraplan docker container. It's recommended to remove the existing container using the
docker rm command.
Upgrade the database structure
All database upgrade scripts are encoded with UTF-8. Please ensure that you use this encoding. Depending on whether you use MySQL, Oracle or SQLServer, use the SQL script for the respective database vendor. The script will perform all necessary modifications of your database.
In the directory
upgrade/v6.4To6.5/ several files are provided:
Replace the placeholder [database] with the database you use. To execute the scripts, use a database management tool appropriate for your system.
In case any error occurs during execution of the SQL scripts, do NOT continue with the upgrade process. Contact the iteraplan support team with the error message.
Configure and start iteraplan
Take the docker compose file from the 6.5 distribution package and apply the configuration as described in the installation guide.
Note: Generally it is NOT recommended to use the docker compose file from the previous iteraplan version. This can result in unexpected side effects if parameters were added or removed.
Check file system permissions
With iteraplan 6.5 the Tomcat inside the docker container is started as user with id 1001. Therefore shared local files and folders require permissions for this user:
- jdbc driver: read permission
- log and index folder: write and execute permission
iteraplan can be started via command line from the directory the Docker Compose file is located:
Once the application is fully loaded within the Docker container, it can be accessed on the ports given in the Docker Compose file's "ports" section. For example at
http://localhost:8066/ in case of the default port mapping of the provided example Docker Compose file.
Initialize the Search Index
Once Tomcat is successfully started, log in to iteraplan with administrative rights.
In order to utilize the full-text search functionality, the search index needs to be re-build. This can be done via the System settings page: Go to Administration -> System and click the "Recreate index" button. The initial run may take several minutes.
After the upgrade, some users might report that iteraplan does no longer work as expected. Possible observations might include that buttons have wrong titles or that the client freezes when performing certain tasks.
In this case users should clear their local browser cache and re-login into iteraplan.