Overview

You must upgrade your local IRM Library Manager installation after each iManage Cloud Service update for Records Manager to ensure it can communicate with the IRM Cloud Service. The Library Manager version must match the equivalent server version of the Cloud Service update.

This Appendix includes preparation details for upgrading an existing iManage Records Manager (IRM) Library Manager installation to the latest version. For new Library Manager installations, refer to Setting up Library Manager for connection to IRM Cloud Service.

Preparation and prerequisites

Preparation note

If you have an existing Library Manager, you must uninstall it before upgrading to the new version.
(During the upgrade process, the server installation folder will be backed up to <installation directory>:\iManage RM Server_backup.)

Prerequisites

Java isn't bundled with IRM, so a compatible version of Java must be installed.

  • Java 11

    • 64-bit version only

  • The Java path: <Java install folder>\bin must be on either of the following:

    • Set on JAVA_HOME, and

    • On either the system path variable or

    • In a created IRM_JAVA_HOME variable
      NOTE: The IRM_JAVA_HOME variable takes precedence over the system path variable when IRM is determining where Java is installed.
      Using IRM_JAVA_HOME prevents conflicts with other JAVA versions that may be installed or required for other services.

Oracle and OpenJDK implementations of Java are both supported.

NOTE: JAVA isn’t bundled with IRM, and must be installed separately.

Upgrade procedure

Step 1: Reapply optional proxy server settings

If you have configured IRM Service in the Cloud with a proxy server, you can copy over the relevant configuration values to preserve the connection settings after an upgrade.

To do so:

  1. Browse to …\rmserver\config\programs, where ... is the location that you installed the local iManage Library Manager.

  2. Locate libmgr.properties.

  3. Copy or save the file to another location.

  4. Using the values in the saved file for reference as required, perform Step 3: Optionally configure proxy server in Setting up Library Manager for connection to IRM server in the Cloud.

You can now proceed to the next steps.

Step 2: Library Manager upgrade

Before you begin, ensure you have uninstalled any existing Library Manager.

Perform the following steps in the IRM Library Manager:

  1. Terminate any processes that are using the server’s installation folder.

  2. To commence installation, run the IRM Library Manager x64.exe file as an administrator.

  3. Check the option to agree to the terms and conditions.

  4. If you want to modify the installation path, select Options.

  5. Select Install.

Step 3: Configure programinit.properties file

  1. The programinit.properties file must be configured (or copied) per the following options:

    1. To configure the new programinit.properties file:

      1. Browse to …\iManage RM Server\rmserver\config\programs, where ... is the location that you installed the IRM server in Step 2 above.

      2. The file programinit.properties is located in this folder. Open programinit.properties with a suitable editor.

      3. Edit:

        1.  

          com.imanage.cms.ssl.client.require=false

          to:

          com.imanage.cms.ssl.client.require=true

           

          and

        2.  

          com.imanage.cms.fc.net.rpc.transport = Tcp,Http

          to:

          com.imanage.cms.fc.net.rpc.transport = Http

      4. Save and close the programinit.properties file.

    2. To copy over the programinit.properties file from the previous installation:

      1. Browse to <Installation directory>:\iManage RM Server_backup and locate the programinit.properties file.

      2. Copy (or drag) the file to …\iManage RM Server\rmserver\config\programs, where ... is the location that you installed the IRM server in Step 2 above.

      3. Compare any custom values in the .properties files from the \config\programs folder of the backed-up server installation

Connecting the updated Library Manager component to IRM Server in the Cloud, after local IRM Library Manager

After updating the Library Manager, you can connect the updated Library Manager to the IRM server in the Cloud.

Follow Step 3: Connect Library Manager to IRM Cloud Service in Setting up Library Manager for connection to IRM Cloud Service.