Skip to main content
Pentaho Documentation

Upgrade

Important: This guide describes how to upgrade from Pentaho 7.0 to Pentaho 7.1. If you are currently using Pentaho 6.x with a BA Server and/or DI Server, see Upgrade from 6.x to 7.1 for these upgrade instructions.

Prepare for Your Upgrade from 7.0 to 7.1

Before you begin your Pentaho 7.0 to 7.1 upgrade, you will need the following:

  • Administrator privileges on the Pentaho Server
  • Know where your data is stored
  • Know how to connect to your data 

You will also need to perform the following tasks:

Task Description
Verify Your Current Version of Pentaho Suite and PDI Start with a working installation of Pentaho Server 7.0.

Verify Your System Components are Current

Make sure that your system components, such as web browsers or repository databases, are up-to-date for Pentaho.
Backup Your Databases

Create backups of all Pentaho databases.

  • hibernate
  • quartz
  • jackrabbit
Download and Configure Info-ZIP (Linux only) Download, install, and configure Info-ZIP open source compression utility using the Info-ZIP documentation. Info-ZIP is available at http://www.info‐zip.org/.

The license is a BSD-style license and is provided for most Linux and Unix variants.

A Windows version of Info-ZIP is preconfigured and included in the Pentaho update package.

Verify That No Users Are Logged into the Server Perform this update during off-business hours to minimize impact to your day-to-day operations.

The following tasks are recommended, but not required, for the Pentaho 7.1 upgrade:

Task Description
Review Pentaho 7.1 System Updates

Get the Pentaho Upgrade and Utility Files 

Upgrade and utility files are available for download from the Pentaho Customer Support Portal

  1. On the Customer Portal home page, sign in using the Pentaho support user name and password provided in your Pentaho Welcome Packet. 
  2. Click Downloads, then click Pentaho 7.1 GA Release in the 7.x list. 
  3. On the bottom of the Pentaho 7.1 GA Release page, browse the folders in the Box widget to find the files you need, including the pentaho-server-ee-upgrade- 7.1.0 .zip file in the Utilities and Tools folder.

Available Update Files

The following files are required to perform a complete Pentaho 7.1 update:

Component File Name
Pentaho Server

pentaho-server-ee-upgrade-7.1.x.yy-dist

pentaho-server-ee-7.1.x.yy-dist

DI Client pdi-ee-client-7.1.x.yy-dist
Pentaho Analyzer paz‐plugin‐ee‐7.1.x.yy-dist
Pentaho Dashboard Designer pdd‐plugin‐ee‐7.1.x.yy-dist
Pentaho Interactive Reporting pir‐plugin‐ee‐7.1.x.yy-dist
Report Designer prd‐ee‐7.1.x.yy-dist
Metadata Editor pme‐ee‐7.1.x.yy-dist
Schema Workbench psw‐ee‐3.13.x.yy-dist
Aggregation Designer pad‐ee‐7.1.x.yy-dist
License Files Pentaho [component] Enterprise Edition.lic

Unzipping Distribution Files

The -dist.zip files include an End-User License Agreement. Accept the agreement to extract the files.

Perform the following steps to unzip the distribution files:

  1. Unzip the selected dist.zip file.
  2. Execute the supplied install.bat or install.sh files.
  3. Agree to the end-user license agreement.
  4. Choose a location to store the extracted files.

You are now prepared to begin your 7.0 to 7.1 upgrade. This process assumes you have completed a manual installation of the 7.0 Pentaho Server and are upgrading to version 7.1. 

Upgrade the Pentaho Server

The following steps will guide you through the Pentaho Server 7.1 upgrade process:

  1. Backup Your Pentaho Server Configuration and Solutions Files
  2. Install the Pentaho Server 7.1
  3. Restore Your Server Configuration and Solutions Files
  4. Test Your Server

Step 1: Backup Your Server Configuration and Solutions Files

The backup utility copies your Pentaho configuration and solutions files, then stores the created .zip files in your user's home directory. You will need to merge your customizations if you have previously customized any of these things: server.xml, startup and shutdown scripts, system listeners, or security configuration files.

Complete the following steps to back up your Quartz, Hibernate, and Jackrabbit databases before continuing with the upgrade process:

  1. Stop the Pentaho Server.
  2. Download the the pentaho-server-ee-upgrade- 7.1.0 .zip file from the Pentaho Customer Support Portal.
    1. On the Customer Portal home page, sign in using the Pentaho support user name and password provided in your Pentaho Welcome Packet. 
    2. Click Downloads, then click Pentaho 7.1 GA Release in the 7.x list. 
    3. On the bottom of the Pentaho 7.1 GA Release page, browse the folders in the Box widget to find the files you need, including the pentaho-server-ee-upgrade- 7.1.0 .zip file in the Utilities and Tools folder.
  3. Extract the files to a folder.
  4. Open a command line terminal and navigate to the unzipped folder of the pentaho-server-ee-upgrade.
  5. At the prompt, run the correct PentahoServerConfigAndSolutionsBackup utility for your operating system.

Optional: You have the option of manually setting a version parameter here. If a valid version is not automatically found during back-up, the process will be aborted. You will then be prompted to provide the version information as an argument to the utility.

Windows

PentahoServerConfigAndSolutionsBackup.bat "<path to 7.0 pentaho server>"

Linux

./PentahoServerConfigAndSolutionsBackup.sh <path to 7.0 pentaho server>

The next step is to install a new instance of the Pentaho 7.1 software. 

Step 2: Install the Pentaho Server 7.1

A new archive installation of the Pentaho Server 7.1 package is needed as part of the upgrade process, after you have finished the upgrade prerequisites and backed up your Pentaho configuration and solutions files.  You will need it to get all the required updates.

Make sure to install the new instance of Pentaho on the same server.

Next, do these tasks from the Prepare Your Environment section of the installation guide. Make sure that you leave your Pentaho 7.0 instance "as is" and unpack Pentaho 7.1 into a new directory. 

Windows

Linux

If you are using custom port numbers and a custom fully-qualified URL, refer to the Change the Port and URLs article for the required settings.

Step 3: Restore Your Server Configuration and Solutions Files

After you have unpacked your Pentaho 7.1 bundle, restore your Pentaho files to your 7.1 instance with the restore utility. Use the following steps to apply the PentahoServerConfigAndSolutionsRestore utility:

  1. Except as noted below, delete the content in the Pentaho Server 7.1 pentaho-solutions/system/default-content folder.  Keep these files if you intend to reinstall DI Ops Mart:
  • pentaho-operations-mart-etl-7.1.0.0-12.zip
  • pentaho-operations-mart-operations-di-7.1.0.0-12.zip

Once you have finished the upgrade process, see For Customers Using DI Ops Mart

  1. Open a command line terminal and navigate to the unzipped folder of the pentaho-server-ee-upgrade.
  2. In the prompt, run the PentahoServerConfigAndSolutionsRestore utility to restore your data from the .zip files located in your user home folder. 

    Windows

    PentahoServerConfigAndSolutionsRestore.bat "<path to 7.1 pentaho server>"
    

    Linux

    ./PentahoServerConfigAndSolutionsRestore.sh "<path to 7.1 pentaho server>"
    
  3. If you want to enable logging before restoring files, complete the optional section below. Otherwise, start the Pentaho Server and then go to the Test Your Server section below. 

Previous Version Upgrades

If you have manually upgraded to 7.0 from a previous version of Pentaho that used a DI Server, you must also complete the following steps:

  1. Copy the pentaho-solutions/system/jackrabbit/repository.xml file from the 7.0 server (that was upgraded from a DI Server) to the pentaho-solutions/system/jackrabbit folder on the 7.1 Pentaho Server.
  2. Check the file size of the pentaho-solutions/system/pentaho.xml file. If the file size is 0 KB, then the file is corrupted and must be replaced. To resolve this issue, copy the file from your 7.0 DI server and to the 7.1 Pentaho Server and change the theme to sapphire.

Optional: Enable Logging Before Restoring Files

Before you restore your Pentaho Server configuration and solutions files, you may want to enable logging in the logging configuration file. To enable logging:

  1. Locate the /pentaho-server/tomcat/webapps/pentaho/WEB-INF/classes folder and open the log4j.xml file with any text editor. 
  2. Find the parameter for Threshold and verify its value is set to INFO. If it is not set to INFO, change the value as shown in the example below:
Old param value
<param name="Threshold" value="ERROR"/>
New param value
<param name="Threshold" value="INFO"/>
  1. Verify whether the following category is in the log4j.xml file. If it is not in the file, then add it:
<category name="org.pentaho.platform.engine.core.system.status">
<priority value="INFO"/>
</category>
  1. Save and close the log4j.xml file.

The jackrabbit/repository.xml file contains database connection information. Please ensure this database connection information is properly carried over from your 7.0 version of the repository file into the 7.1 version of the file.

  1. Start the Pentaho Server.

Do not interrupt the server the first time you start it after restoring your data.

Step 4: Test Your Server

Before you begin testing, clear your web browser cache.

The Pentaho Server installs all the Karaf features when it initializes. The system waits for these features to be installed before timing out. The default wait time before timing out is two minutes. If you modify any Karaf feature, you should consider changing the Karaf startup timeout setting

To ensure that your content has been restored to the 7.1 Pentaho Server, navigate to your Pentaho URL (the default URL is http://localhost:8080/Pentaho) and verify the following items:

  • The login screen appears.
  • Log on to PUC and try to run your old BA content.
  • Your schedules exist and are working properly.
  • Your Pentaho plugins are installed and functional by performing the following tasks:
    • Open a report that requires no user prompts and a parameterized report.
    • Create a test report for Interactive Reporting and one for Analyzer, as appropriate.
    • Open a dashboard in Dashboard Designer.
    • Publish a report in Report Designer.
    • Publish an analysis schema from Spoon, if you have installed the Agile BI plugin available in the marketplace. (If not, you can publish an analysis schema using the Publish Model job entry.)
  • Check your application server log.

If you have upgraded to 7.1 from an earlier DI Server, navigate to your Pentaho DI URL (the default URL is http://localhost:9080/pentaho-di) and verify the following items:

Update Your Design Tools

Now that you have completed the upgrade to 7.1, you can upgrade your Pentaho design tools on your workstations.

  1. Exit any of the design tools, if any are currently running.
  2. Backup all the 7.0 existing folders in the Pentaho/design-tools folder to a temporary folder. 
  3. Browse to the unzipped /pentaho-ser-ee-upgrade/design-tools folder and copy all the new folders into your existing Pentaho/design-tools folder.
  4. Restart to verify that your design tools were upgraded.

You have now completed your Pentaho upgrade from 7.0 to 7.1.

For Customers Using Analyzer

Analyzer can be upgraded from Visualization API 2.0 to Visualization API 3.0. Before upgrading, please review the following information for more details: http://pentaho.github.io/pentaho-platform-plugin-common-ui/platform/visual/analyzer-viz-api

For Customers Using DI Ops Mart

Now that you have completed the upgrade to 7.1, you can reinstall the DI Ops Mart. Move the following .zip files into the Pentaho Server 7.1 pentaho-solutions/system/default-content folder.

  • pentaho-operations-mart-etl-7.1.0.0-12.zip
  • pentaho-operations-mart-operations-di-7.1.0.0-12.zip

For further instructions, see Install DI Ops Mart