MicroStrategy ONE

5. MicroStrategy Library

In MicroStrategy 10.9 through 11.0, MicroStrategy Library was automatically deployed in Tomcat and the MicroStrategyLibrary.war file installed in the <INSTALL_PATH>\Library directory. MicroStrategy 2019 and above requires administrators to perform the upgrade for their Library deployment.

You must manually deploy a new Library WAR File after upgrading MicroStrategy Library.

This section contains high level steps and considerations for performing an upgrade or migrating MicroStrategy Library to a new environment.

Windows Environments

In MicroStrategy 10.9 to 11.0, MicroStrategy Library is automatically deployed in Tomcat and the MicroStrategyLibrary.war file is installed in the <INSTALL_PATH>\Library directory. Starting in MicroStrategy 2019, administrators can choose Tomcat as an option under "Other Components" to deploy Library to Tomcat, or deselect it so that only the WAR file is created in the directory referenced above.

Perform the following steps when doing a direct upgrade of MicroStrategy Library 10.9 - 11.0 to MicroStrategy 2020.

  1. Within the Tomcat directory, back up the following files:
    • webapps folder
    • server.xml
    • tomcat-users.xml
  2. Uninstall Tomcat.
  3. Install Tomcat 9.0.12 or higher.
  4. Restore all backed up files in the new Tomcat installation.

  5. Start Tomcat.

    The new MicroStrategyLibrary.war file appears in <INSTALL_PATH>\Library.

Deploying the New WAR File

A new Library WAR File must be manually deployed after upgrading MicroStrategy Library, even between service packs.

You should backup the webapps folder as they are overwritten when deploying new .war files.

Use the following steps to deploy a new WAR file for both Windows and Linux.

  1. Use the MicroStrategy installer to create a new MicroStrategy 2020 MicroStrategyLibrary.war file by doing a direct upgrade or new installation.
  2. Redeploy the new MicroStrategyLibrary.war file from the Library install directory to the J2EE server being used. See the list of supported servers.

  3. Migrate your customizations to the new environment, such as:

    • .../webapps/MicroStrategyLibrary/images/
    • .../webapps/MicroStrategyLibrary/plugins/
    • .../webapps/MicroStrategyLibrary/WEB-INF/classes/auth/
      • Customized authentication configuration, such as SAML authentication
    • .../webapps/MicroStrategyLibrary/WEB-INF/classes/config/configOverride.properties
      • Make sure MicroStrategy Library is pointing to the correct Intelligence Server and Collaboration Server with correct authentication setting by going to the Library Administration Control Panel.
    • .../webapps/MicroStrategyLibrary/WEB-INF/classes/logback.xml
    • Any other customizations including SSL configurations
  4. Verify that MicroStrategy Library functionality including collaboration, sharing, exporting, printing, and all other features are working properly. Ensure dashboards and documents are appearing.

The Collaboration Server is a separate component of MicroStrategy that is upgraded independently of Library. See Upgrade MicroStrategy Collaboration for more information.