Skip to main content
Skip table of contents

Upgrade Identity Manager

This article describes how to upgrade PRIME. To read about how to upgrade Smart ID Identity Manager, see Upgrade Smart ID.

If an existing Smart ID Identity Manager System is being updated, re-installation of the Tomcat server (or another application server) is not usually necessary.

Only the .war files, which contain the actual program files of the program package, are replaced or installed over the existing files.


Step-by-step instruction

Backup current installation

To create a backup:

  1. Go to the webapps folder in the Tomcat installation directory, for example:
    C:/Program Files/nexus-PRIME-tomcat7/webapps/

  2. Back up files and folders:

    1. Back up all subfolders, in case something interrupts the installation.

    2. Make individual backups of the following configuration files:
      ▪ log4j.xml
      from each of the following subfolders:
      ▪ prime_designer\WEB-INF\classes\
      ▪ prime_explorer\WEB-INF\classes\
      ▪ prime_tenant\WEB-INF\classes\

    3. For PRIME Self-Service, backup the following locations:
      ▪ ussp\WEB-INF\config.xml
      ▪ ussp\WEB-INF\classes\log4j.xml
      ▪ ussp\branding

    4. Make individual backup of any custom beans in the following folder:
      ▪ prime_explorer\WEB-INF\classes\spring

Replace .war files

To replace the .war files:

  1. Stop the Tomcat service.

  2. Delete the following subfolders:
    ▪ prime_designer
    ▪ prime_explorer
    ▪ prime_tenant
    ▪ ussp

  3. Copy all the provided .war files into the webapps subfolder of the Tomcat installation directory:
    ▪ prime_designer.war
    ▪ prime_explorer.war
    ▪ prime_tenant.war
    ▪ ussp.war
    ▪ plus any other provided .war file

  4. Open the Tomcat properties via the Tomcat Icon in that System Tray or in the Windows Services.

  5. In the General tab, verify the information and set Startup type to Automatic. Click Start.

    The Tomcat server is started and unzips the .war files into the new folders:
    ▪ prime_designer
    ▪ prime_explorer
    ▪ prime_tenant
    ▪ ussp

    This process usually takes a few minutes.

Restore configuration files from backup

Restore the configuration files from the backup:

  1. Copy the following configuration files from the backup:
    ▪ log4j.xml
    to the following subfolders:
    ▪ prime_designer\Web-inf\classes\
    ▪ prime_explorer\Web-inf\classes\
    ▪ prime_tenant\Web-inf\classes\

  2. Copy the following configuration files for PRIME Self-Service from the backup:
    ▪ ussp\WEB-INF\config.xml
    ▪ ussp\WEB-INF\classes\log4j.xml
    ▪ ussp\branding

  3. Copy any custom beans from the backup to the following folder:
    ▪ prime_explorer\WEB-INF\classes\spring

Update database

Identity Manager uses a tool called Liquibase to update the database. This allows database changes to be made independently of the underlying database type, therefore making it easy to maintain the database schema for different databases with maximum flexibility.

To update the database:

  1. Stop the Tomcat service:
    In the General tab, click Stop.

  2. Open the following file:
    update_db.bat, in the delivery directory db_update

  3. Adjust the URL, USER, and PASSWORD parameters to reflect the database. See Database properties file.

  4. Save the file.

  5. Run the batch file. Note that the server on which these scripts are run requires access to the database server. If the script is run on the application server, this should not be a problem because the connection is also needed at runtime.

  6. After successful execution, the following message is displayed on the console:
    Liquibase Update Successful

  7. Restart Tomcat to establish the database connection. 

Additional information

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.