Skip to end of metadata
Go to start of metadata

Corporate Edition only!

The upgrade procedure described here applies to iteraplan Corporate Edition only. Updating the Lite Edition is not possible.


1 Verify System Requirements

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

2 Preparation

This guide provides instructions to upgrade iteraplan from release 6.2 to release 6.3. 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.2 first.

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.

3 Upgrade

3.1 Upgrade the database structure

Be sure that you have stopped the iteraplan docker container. It's recommended to remove the existing container using the docker rm command.

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.2To6.3/ several files are provided:

migration_iteraplan_620_to_630_[database].sql

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.

Restrictions

With iteraplan 6.3 some predefined attributes are converted to user defined attributes. The new user defined attributes are organized in an attribute type group "[Core Attributes]". If an attribute type group with this name already exists in iteraplan 6.2 this attribute type group needs to be renamed. This attribute type group can be reorganized with iteraplan 6.3 after the upgrade.

3.2 Configure and start iteraplan

Configuration

Take the docker compose file from the 6.3 distribution package and apply the configuration as decribed in the installation guide

Note: Generally it is recommended to not use the docker compose file from the version previous. This can result in unexpected side effects if parameters were added or removed.

Check file system permissions

With iteraplan 6.3 tomcat inside the docker container is started as user 1001. Therefore shared local files and folders require permissions for this user:

  • the jdbc driver: read permission
  • log and index folder: write and execute permission

Final restart

As a final step, iteraplan can be started from the directory the Docker Compose file is in via command line:

docker-compose -f iteraplan.yml up -d

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.

3.3 Setup iteraplan

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.

3.4 Notes

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.


  • No labels