Upgrade from earlier versions of IM than 5.1.0

About this guide

The guide describes how to upgrade from a previous version of Identity Manger (4.x or earlier) to version 5.x.
If you are upgrading from a IM 5.1.0 version to a later, please click this link.
Additional information is found on PhenixID support site and solution documents.

Audience

This document is primarily written for system administrators with at good Identity Manager skills.

Upgrade overview

In short when upgrading from an older version of IM these are the recommended steps:

  1. INSTALL IM ON NEW SERVER
    Install the latest version on a new Windows/Linux server. Advanced is that you can keep the old installation alive and at the same time install, configure and test on the new server.
    This approach works well if you do not have a test environment since the new server will not conflict with the existing server.
  2. MOVE ALL CONFIGURATION DATA TO NEW SERVER
    All configuration data: Policies, Forms and searches needs to be moved to new server. There are basically two places where you can find existing configuration data:

    1. STORED IN LDAP DIRECTORY
      If stored in LDAP directory you need to:

      1. FORMS or PREDEFINED SEARCH
        Open e.g. an existing form in an LDAP browser and find attribute tabXMLdata. Copy the data and move to a file and save in corresponding role on new server.
        – Forms are to be moved to new_server/../role/role_x/form
        – PreDef searches are to be moved to new_server/../role/role_x/search
      2. POLICES
        In today IM polices are stored in one of two places. Either in the DSEditor.properties of the app or in the DSEditor.properties of the role. You need to find all the places in the directory where you have policies and move them to corresponding role.
    2. STORED IN FILE SYSTEM
      This is easier than stored in LDAP. Just move the existing configuration to new server.
  3. MOVE ALL CLASSES, FILTER AND CUSTOM CONTROLS
    If there are specific classes, filters and custom controls created for your environment those files needs to be moved. If you have only used classes, filters and custom controls included in the product you only have to verify that those file are still valid and not removed.
  4. MOVE OTHER FILES
    Other files can be language files, theme files. This is if you have custom files for your environment. If you only used what was included in product then you can ignore this.
  5. TEST
    Now you are ready to test your new installation. You especially need to test custom controls that might was created for your solution.
    Otherwise you need to check every form to verify it works as expected and looks alright.

  6. POST IM INSTALLATION CONFIGURATION
    For some post IM tips, please read PSD1110

Prerequisite

Installation of 5.x

Install PhenixID Identity Manager 5.x by following the installation guide.

Applying older customisations

Important! Depending on your installation the copy and merge of files described below might not be applicable for your specific upgrade. If for example you have not been using Themes in your current solution, just skip that section.

Classes, filters and custom controls

– Classes
Copy all the classes sub-folders from:
[old installation]\webapps\nordicedge\WEB-INF\classes except Controls and filter to:
[new installation]\PhenixID\IM\customer\extension\class\
(the Controls and Filters shipped in previous versions are now included in identity-manager-x.x.x.jar file, where x.x.x. is the version number of you are using)

– JAR
Copy the jar-files that are required by customisations (if any) from:
[old installation]\webapps\nordicedge\WEB-INF\lib to:
[new installation]\PhenixID\IM\customer\extension\lib\

– JSP
Copy any jsp-files that are required by customisations (if any) from:
[old installation]\webapps\nordicedge\jsp to:
[new installation]\PhenixID\IM\customer\extension\web\jsp\

Translations (language-files)

Do NOT copy and replace your existing lang-files since the new includes words not used before in IM. Open new and add old lang content.
Merge and/or move the *.lang files from:
[old installation]\webapps\nordicedge\WEB-INF\NEIDMgmt\language with the newly installed in:
[new installation]\PhenixID\IM\customer\lang\

Theme

Merge the themes from (DO NOT COPY AND REPLACE):
[old installation]\webapps\nordicedge\WEB-INF\NEIDMgmt\themes\*.* with the newly installed in:
[new installation]\PhenixID\IM\customer\theme\*.*

Copy all necessary images from [old installation]\webapps\nordicedge\editor\themes to:
[new installation]\PhenixID\IM\customer\web\editor\themes\PhenixID\*.*
(create folder under web if not existing)

Disk based Roles – (only Identity Manager 4.6 or later)

Copy the role folder from:
[old installation]\webapps\nordicedge\WEB-INF\NEIDMgmt to:
[new installation]\PhenixID\IM\customer\role
If you have an older version of IM then you need to extract the roles from the directory and create the roles manually in file system.

DSEditor.properties

Update [new installation]\PhenixID\IM\customer\config\DSEditor.properties with the necessary policy settings from [old installation]\webapps\nordicedge\WEB-INF\NEIDMgmt\DSEditor.properties.
(DO NOT COPY AND REPLACE)

Remove service name

Earlier installations of Identity Manager might have a service name like “Apache Tomcat”.
New service name will be added during installation of IM.