Skip to main content
Pentaho Documentation

Upgrade from 6.1.x to 8.0

The upgrade process from 6.1.x to 8.0 assumes you manually installed your original BA Server or original DI Server using an archive installation. This process is similar whether you are upgrading the Pentaho Business Analytics (BA) Server or the Data Integration (DI) Server.

Important: This upgrade documentation describes how to upgrade from Pentaho 6.1.x to Pentaho 8.0. It assumes that you are upgrading to 8.0 on the same server as your current archive installation. We recommend that you read through this material completely before starting.

Get Started with the 6.1.x to 8.0 Upgrade

To perform this upgrade process, you need to know how to access the Pentaho Server as an Administrator from a command line. You must also perform the following prerequisites:

  1. Verify your current version of Pentaho Suite and PDI. Start with a working installation of at least Pentaho Suite 6.1.x or PDI 6.1.x.
  2. Verify your system components are current. Ensure that your system components, such as web browsers or repository databases, are up-to-date for Pentaho.
  3. Create backups of all the following Pentaho databases:
    BA Databases: DI Databases:
    • hibernate
    • quartz
    • jackrabbit
    • di_hibernate
    • di_quartz
    • di_jackrabbit

     

  4. For Linux installations only, verify Info-ZIP has been installed and configured. If needed, you can 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/. A BSD-style license is provided for most Linux and Unix variants.

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

  5. Verify no users are logged into the server. The upgrade process should be performed during off-business hours to minimize impact to your day-to-day operations.

  6. Make sure to get the correct version of Java for your system. See Components Reference for more details.

We recommend you review the following 7.0, 7.1,  and 8.0 system updates to understand how our products have changed since 6.1.x:

Get the Pentaho Upgrade and Utility Files 

The upgrade process involves utility and installation files you must download from the Pentaho Customer Support Portal.

Perform the following steps to download these files:

  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 8.0 GA Release in the 8.x list. 
  3. On the bottom of the Pentaho 8.0 GA Release page, browse the folders in the Box widget to find the files you need.

Available Update Files

The following BA and DI files are required to perform a complete Pentaho 8.0 update:

Component File Name
BA Server Upgrade Utility

biserver-ee-upgrade‐8.0.x.yy-dist

DI Server Upgrade Utility

pdi‐ee‐upgrade-8.0.x.yy-dist

Pentaho Server Installation

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

You will need two instances of the Pentaho Server installation if you are planning to upgrade both your BA Server and your DI Server.

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

Unzip the Downloaded Files

Perform the following steps to unzip the downloaded files:

  1. If needed, move the downloaded files to a temporary location on your current server.
  2. Unzip each downloaded file.

You are now prepared to begin your Pentaho 8.0 upgrade.

Upgrade the Pentaho Business Analytics Server

If you are not using the BA server, you can skip this section.

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

  1. Backup Your BA Server Configuration and Solutions Files
  2. Install the 8.0 Pentaho Server and Plugins
  3. Restore Your BA Server Configuration and Solutions Files
  4. Update the BA Server Configuration
  5. Start and Test the BA Server

Step 1: Backup Your BA 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.

Complete the following steps to back up yourconfiguration and solutions files:

  1. Stop the BA Server.
  2. Connect to the cmd line terminal for the BA Server.
  3. At the prompt, run the correct BAServerConfigAndSolutionsBackup utility for your operating system as shown in the following examples:

    Windows

    BAServerConfigAndSolutionsBackup "<path to your 6.1.x BA server>"
    

    Linux

    ./BAServerConfigAndSolutionsBackup.sh <path to your 6.1.x BA server>
    

    The backup utility has the following optional parameters:
    • pentaho_solutions_folder – use to specify the path to the pentaho-solutions directory if you manually installed it outside of the main pentaho directory structure.
    • pentaho_version – use to specify your BA version if a valid version cannot be automatically found during the backup process.

After the backup utility finishes, you can install a new instance of the Pentaho 8.0 software. 

Step 2: Install the Pentaho Server 8.0 and Plugins

After completing Step 1, you are ready to install the 8.0 Pentaho Server and related plugins.

Make sure to install the new instance of Pentaho on the same server yet leave your Pentaho 7.x instance "as is" while unpacking Pentaho 8.0 into a new directory. 

Pentaho Server Installation

Perform the following steps to install the 8.0 version of the Pentaho Server:

  1. Verify Java 8 is installed on the server machine. If you need to install Java 8, you can download the supported version of JRE or JDK from the Oracle site.
  2. Verify the PENTAHO_JAVA_HOME environment variable is set to the path of your Java installation. If you need to set this variable, use the SET command in Windows or the export command in Linux. If you are using a JRE, verify the JRE_HOME environment variable is also set to the correct location.
  3. Browse to the location where you unzipped the pentaho-server-ee-8.0.x.yy-dist file in the Available Update Files section.
  4. Execute the supplied install.bat or install.sh file.
  5. Agree to the end-user license agreement.
  6. Select the pentaho/server/pentaho-server directory as the location to store the extracted files.

Plugin Installation

The following -dist files mentioned in the Available Update Files section pertain to the Analyzer, Interactive Reports, and Dashboard Designer plugins:

  • paz‐plugin‐ee‐8.0.x.yy-dist
  • pdd‐plugin‐ee‐8.0.x.yy-dist
  • pir‐plugin‐ee‐8.0.x.yy-dist

If you use any of these plugins, browse to the location where you unzipped these distributions and perform the following steps for each file:

  1. Execute the supplied install.bat or install.sh file.
  2. Agree to the end-user license agreement.
  3. Select the pentaho/server/pentaho-server/pentaho-solutions/system directory as the location to store the extracted files.

Step 3: Restore Your BA Server Configuration and Solutions Files

After you have unpacked your Pentaho 8.0 bundle, restore your Pentaho files to your 8.0 instance with the restore utility.

Perform the following steps to apply the BAServerConfigAndSolutionsRestore utility:

  1. Delete all the content in the Pentaho Server 8.0 pentaho-solutions/system/default-content directory.
  2. Open a cmd prompt on the BA Server host machine.
  3. In the prompt, run the BAServerConfigAndSolutionsRestore utility to restore your data from the .zip files located in your user home directory as shown in the following examples.

    Windows

    BAServerConfigAndSolutionsRestore "<path to 8.0 pentaho server>"
    

    Linux

    ./BAServerConfigAndSolutionsRestore.sh <path to 8.0 pentaho server>
    

    If the directory path you specify is not within the main directory structure, use an optional pentaho_solutions_folder parameter to specify its location.

Step 4: Update the BA Server Configuration

After restoring your BA Server configuration and solution files, make the following .xml file changes before starting the server:

  • web.xml
  • Interactive Reporting plugin.xml
  • settings.xml
  • Security setup files

Web XML Files

Perform the following steps to modify the web.xml file:

  1. Open the web.xml file located here: pentaho-server/tomcat/webapps/pentaho/WEB-INF.
  2. Make the following filter class value and parameter value changes:
    Old Text
    <filter>
      <filter-name>Spring Security Filter Chain Proxy</filter-name>
      <filter-class>org.springframework.security.util.FilterToBeanProxy</filter-class>
      <init-param>
        <param-name>targetBean</param-name>
        <param-value>filterChainProxy</param-value>
      </init-param>
    </filter>
    New Text
    <filter>
      <filter-name>Spring Security Filter Chain Proxy</filter-name>
      <!--@deprecate FilterToBeanProxy in favour of the simpler and Spring Core provided DelegatingFilterProxy-->
      <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
      <init-param>
        <param-name>targetBeanName</param-name>
        <param-value>filterChainProxy</param-value>
      </init-param>
    </filter>
  1. In the same web.xml file, make the following listener value changes:
    Old Text
    <listener>
      <listener-class>org.springframework.security.ui.session.HttpSessionEventPublisher</listener-class>
    </listener>
    
    New Text
    <listener>
      <listener-class>org.springframework.security.web.session.HttpSessionEventPublisher</listener-class>
    </listener>
  1. Save and close the web.xml file.

Plugin XML File

Perform the following steps to modify the plugin.xml file:

  1. Open the plugin.xml file located here: pentaho-solutions/system/pentaho-interactive-reporting

  2. Search the plugin.xml file for the <content-generator id=”Iadhoc” type=”iadhoc”>  block.
  3. Below that add the following block:
    <content-generator id="iadhocasync" type="iadhocasync">
            <classname>com.pentaho.iadhoc.service.BackgroundJobAdHocGenerator</classname>
            <title>Adhoc Async Report Viewer</title>
    </content-generator>
  4. Save and close the plugin.xml file.

Settings XML and Security Setup Files

Perform the following steps to modify the settings.xml and security setup files:

  1. Open the settings.xml file located here: server/pentaho-server/pentaho-solutions/system/reporting/settings.xml
  2. Update the query-limit-ui-enabled setting to true and the query-limit setting to 0 as shown in the following example lines of code:
    <!-- Enabled or disabled row limit control on UI. No value means disabled.-->
    <query-limit-ui-enabled>true</query-limit-ui-enabled>
    <!-- The maximum number of rows that will be rendered in a report viewer.-->
    <query-limit>0</query-limit>
  3. Save and close the settings.xml file.
  4. If you modified any of the following system configuration files in the pentaho-solutions/system directory of your previous installation, these modifications must be applied to the same Pentaho 8.0 files:
  • jackrabbit/repository.xml
  • applicationContext-logging.xml.original
  • applicationContext-pentaho-security-jackrabbit.xml.original
  • applicationContext-pentaho-security-jdbc.xml.original
  • applicationContext-pentaho-security-ldap.xml.original
  • applicationContext-pentaho-security-memory.xml.original
  • applicationContext-spring-security-cas.xml.original
  • applicationContext-spring-security-jackrabbit.xml.original
  • applicationContext-spring-security-jdbc.xml.original
  • applicationContext-spring-security-ldap.xml.original
  • applicationContext-spring-security-memory.xml.original
  • applicationContext-spring-security-superuser.xml.original
  • applicationContext-spring-security.xml.original
  • pentahoObjects.spring.xml.original
  • pentahoServices.spring.xml.original
  • repository.spring.xml.original
  • log4j.xml – which is located at server/pentaho-server/tomcat/webapps/Pentaho/WEB-INF/classes/log4j.xml

The upgrade utility contains a set of spring configuration files in their original 6.1.0.11-R state. After the utility scripts run, determine the differences between your 6.1.x files and these originals, then apply these changes to the 8.0 configuration files.

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

  1. Remove the following directories and their contents. These plugins are not available in version 8.0.
    Plugin Path
    Mobile pentaho/server/pentaho-server/pentaho-solutions/system/pentaho-mobile-plugin
    Sparkl pentaho/server/pentaho-server/pentaho-solutions/system/sparkl

     

Previous Versions of a BA Server

If you are upgrading from a previous version BA server, you must update the connection pool parameter.

Perform the following step to update the connection pool parameter: 

  1. Navigate to the pentaho-server/tomcat/webapps/pentaho/META-INF directory and open the context.xml file with any file editor.
  2. Locate the section that contains the following line:
    factory="org.apache.commons.dbcp.BasicDataSourceFactory"
  3. Replace it with this line:
    factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
    
  4. Save and close the context.xml file.

Karaf Customizations

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

Password Encoding

Pentaho version 8.0 changed the password encoding from previous versions.

If you are using your own password encoding or you previously applied this version of encoding, this update is not necessary.

If you wish to use this version of password encoding, perform the following steps:

  1. Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system directory and open the pentahoObjects.spring.xml file with any text editor.
  2. Locate the line that contains: bean id="IPasswordService"
  3. Verify or modify the class= value with the following value:
    bean id="IPasswordService" class="org.pentaho.platform.util.KettlePasswordService" scope="singleton"/>
  1. Save and close the file.
  2. If you modified the class= value in Step 3, you must make the following modification to encrypt the Pentaho Admin password. In the same pentaho/server/pentaho-server/pentaho-solutions/system directory, open the defaultUser.spring.properties.xml file with any text editor.
  3. Locate the following lines:
    defaultAdminUserPassword=cGFzc3dvcmQ=
    defaultNonAdminUserPassword=cGFzc3dvcmQ=
  4. Replace the values in these lines with the following values:
    defaultAdminUserPassword=Encrypted 2be98afc86aa7f2e4bb18bd63c99dbdde
    defaultNonAdminUserPassword=Encrypted 2be98afc86aa7f2e4bb18bd63c99dbdde
  5. Save and close the file.

Documentation Version Link

The default URL of the online Pentaho documentation changes with each release. When upgrading, this URL parameter may need to be updated in the pentaho.xml file.

  1. Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system directory and open the pentaho.xml file with any text editor.
  2. Modify the following <documentation-url> line and replace the previous documentation value with the current documentation value:
    <documentation-url>https://help.pentaho.com/Documentation/8.1/Products/User_Console</documentation-url>
  3. Save and close the file.

CORS - Embedding CTools

If your Pentaho deployment requires the ability to embed CTools, you can modify the following settings.

  1. Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system directory and open the pentaho.xml file with any text editor.
  2. Modify or add the following CORS lines:
    <!--
    cors-requests-allowed:
    Flag indicating if cross-origin requests are allowed or not.
    accepted values are: true | false
    -->
    
    
    <cors-requests-allowed>false</cors-requests-allowed>
    
    
    <!--
    cors-requests-allowed-domains:
    Comma separated list of domains allowed to do cross-origin requests to the server.
    Example:
    http://domainA.com, http://localhost:1337
    -->
    
    
    <cors-requests-allowed-domains><!-- allowed domains here --></cors-requests-allowed-domains>
  3. If you are embedding CTools, add the following line (as shown above) and set the value to: true
    <cors-requests-allowed>true</cors-requests-allowed>
  4. Save and close the file.

Previously Customized Files

If you have previously customized any of the following items, verify your customizations have been merged:

  • server.xml
  • Startup and shutdown scripts
  • System listeners
  • Security configuration files

If your previous customizations have not been merged, incorporate them into their 8.0 files.

Step 5: Start and Test the Pentaho Server

You are now ready to start the BA Server.

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

After starting the server, check your Catalina and Pentaho logs in the server/pentaho-server/tomcat/logs directory for any errors. See the Installation and Upgrade Issues article to troubleshoot any errors that occur.

Test Your BA Server

You can use the following actions to verify the upgrade was successful:

  1. Clear the web browser cache and history.
  2. Navigate to your Pentaho URL and make sure the login screen appears.
  3. Log on to PUC and verify that you can run your old BA content.
  4. Verify that your schedules exist and are working properly.
  5. Make sure that your Pentaho plugins are installed and functional by performing the following tasks:
    • Open a report that requires no user prompts or parameters.
    • Create a test report for Interactive Reporting and a test report for Analyzer.
    • Open a dashboard in Dashboard Designer.
  6. Check your your Catalina and Pentaho logs in the server/pentaho-server/tomcat/logs directory for any errors.

For troubleshooting issues, refer to the Installation and Upgrade Issues article.

For Customers Using BA Ops Mart

If you are interested in installing and using BA Ops Mart, see Monitor System Performance Using Pentaho Operations Mart

Upgrade the Pentaho Data Integration Server

After you finish the prerequisite tasks located in Get Started with the 6.1.x to 8.0 Upgrade, you are ready to upgrade to Pentaho 8.0.

These sections will guide you through the Pentaho DI upgrade process:

  1. Backup Your DI Server Configuration and Solutions Files
  2. Install the 8.0 Pentaho Server 
  3. Restore Your DI Server Configuration and Solutions Files
  4. Update the DI Server Configuration
  5. Start and Test the DI Server

Step 1: Backup Your DI 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.

Complete the following steps to back up your configuration and solutions files:

  1. Stop your DI Server.
  2. Connect to the cmd line terminal for the DI Server. 
  3. At the prompt, run the DIServerConfigAndSolutionsBackup utility for your operating system as shown in the following examples:

    Windows

    DIServerConfigAndSolutionsBackup "<path to your 6.1.x DI server>"
    

    Linux

    ./DIServerConfigAndSolutionsBackup.sh <path to your 6.1.x DI server>
    

    The backup utility has the following optional parameters:
    • pentaho_solutions_folder – use to specify the path to the pentaho-solutions directory if you manually installed it outside of the main pentaho directory structure.
    • pentaho_version – use to specify your DI version if a valid version cannot be automatically found during the backup process.

After the backup utility finishes, you can install a new instance of the Pentaho DI 8.0 software.

Step 2: Install the 8.0 Pentaho Server 

After completing Step 1, you are ready to install the 8.0 Pentaho Server and related plugins.

Make sure to install the new instance of Pentaho on the same server yet leave your Pentaho 7.x instance "as is" while unpacking Pentaho 8.0 into a new directory. 

Perform the following steps to install the 8.0 version of the Pentaho Server:

  1. Verify Java 8 is installed on the server machine. If you need to install Java 8, you can download the supported version of JRE or JDK from the Oracle site.
  2. Verify the PENTAHO_JAVA_HOME environment variable is set to the path of your Java installation. If you need to set this variable, use the SET command in Windows or the export command in Linux. If you are using a JRE, verify the JRE_HOME environment variable is also set to the correct location.
  3. Browse to the location where you unzipped the pentaho-server-ee-8.0.x.yy-dist file in the Available Update Files section.
  4. Execute the supplied install.bat or install.sh file.
  5. Agree to the end-user license agreement.
  6. Select the pentaho/server/pentaho-server directory as the location to store the extracted files.

Step 3:  Restore Your DI Server Configuration and Solutions Files

After you have unpacked your Pentaho 8.0 bundle, restore your custom data to your 8.0 instance with the restore utility.

Perform the following steps to apply the DIServerConfigAndSolutionsRestore utility:

  1. Delete all the content in the Pentaho Server 8.0 pentaho-solutions/system/default-content directory.
  2. Open a cmd prompt on the DI Server host machine.
  3. In the prompt, run the DIServerConfigAndSolutionsRestore utility to restore your data from the .zip files in your user home directory as shown in the following examples. 

    Windows

    DIServerConfigAndSolutionsRestore "<path to your 8.0 pentaho server>"
    

    Linux

    ./DIServerConfigAndSolutionsRestore.sh <path to your 8.0 pentaho server>
    

Step 4: Update the DI Server Configuration

After restoring your DI Server configuration and solution files and enabling the DI Server, make changes to the following configuration files before starting the server:

  • web.xml
  • License manager
  • Security setup files

Web XML File

Perform the following steps to modify the web.xml file:

  1. Open the web.xml file located in the pentaho-server/tomcat/webapps/pentaho-di/WEB-INF directory.
  2. Make the following filter value changes:
    Old Text
    <filter>
            <filter-name>Pentaho Web Context Filter</filter-name>
            <filter-class>org.pentaho.platform.web.http.filters.PentahoWebContextFilter</filter-class>
        </filter>
    New Text
    <filter>
           <filter-name>Pentaho Web Context Filter</filter-name>
           <filter-class>com.pentaho.platform.web.http.filters.PentahoEnterpriseWebContextFilter</filter-class>
       </filter>    
  1. In the same web.xml file, make the following filter class value and parameter value changes:
    Old Text
    <filter>
      <filter-name>Spring Security Filter Chain Proxy</filter-name>
      <filter-class>org.springframework.security.util.FilterToBeanProxy</filter-class>
      <init-param>
        <param-name>targetBean</param-name>
        <param-value>filterChainProxy</param-value>
      </init-param>
    </filter>
    New Text
    <filter>
      <filter-name>Spring Security Filter Chain Proxy</filter-name>
      <!--@deprecate FilterToBeanProxy in favour of the simpler and Spring Core provided DelegatingFilterProxy-->
      <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
      <init-param>
        <param-name>targetBeanName</param-name>
        <param-value>filterChainProxy</param-value>
      </init-param>
    </filter>
  1. And then, make the following listener value changes:
    Old Text
    <listener>
      <listener-class>org.springframework.security.ui.session.HttpSessionEventPublisher</listener-class>
    </listener>
    
    New Text
    <listener>
      <listener-class>org.springframework.security.web.session.HttpSessionEventPublisher</listener-class>
    </listener>
  1. Save and close the web.xml file.

License Manager and Security Setup Files

Perform the following steps to modify the licenseManagerAdmin.js and security setup files:

  1. Open the licenseManagerAdmin.js file located in the pentaho-server/pentaho-solution/system/admin-plugin/resources/licenseManagerModule directory.
  2. Make the following changes to the context path:
    Old Text
    window.location = CONTEXT_PATH + "Home"
    New Text
    window.location = CONTEXT_PATH + "kettle/status"
  1. Save and close the licenseManagerAdmin.js file.
  2. If you modified any of the following system configuration files in the pentaho-solutions/system directory of your previous installation, these modifications must be applied to the same Pentaho 8.0 files:
  • jackrabbit/repository.xml
  • applicationContext-logging.xml.original
  • applicationContext-pentaho-security-jackrabbit.xml.original
  • applicationContext-pentaho-security-jdbc.xml.original
  • applicationContext-pentaho-security-ldap.xml.original
  • applicationContext-pentaho-security-memory.xml.original
  • applicationContext-spring-security-cas.xml.original
  • applicationContext-spring-security-jackrabbit.xml.original
  • applicationContext-spring-security-jdbc.xml.original
  • applicationContext-spring-security-ldap.xml.original
  • applicationContext-spring-security-memory.xml.original
  • applicationContext-spring-security-superuser.xml.original
  • applicationContext-spring-security.xml.original
  • pentahoObjects.spring.xml.original
  • pentahoServices.spring.xml.original
  • repository.spring.xml.original
  • log4j.xml – which is located at server/pentaho-server/tomcat/webapps/pentaho-di/WEB-INF/classes/log4j.xml

The upgrade utility contains a set of spring configuration files in their original 6.1.0.11-R state. After the utility scripts run, determine the differences between your 6.1.x files and these originals, then apply these changes to the 8.0 configuration files.

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

Previous Versions of a BA or DI Server

If you are upgrading from a previous version BA or DI server, you must update the connection pool parameter.

Perform the following step to update the connection pool parameter: 

  1. Navigate to the pentaho-server/tomcat/webapps/pentaho/META-INF directory and open the context.xml file with any file editor.
  2. Locate the section that contains the following line:
    factory="org.apache.commons.dbcp.BasicDataSourceFactory"
  3. Replace it with this line:
    factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
    
  4. Save and close the context.xml file.

Karaf Customizations

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

Password Encoding

Pentaho version 8.0 changed the password encoding from previous versions.

If you are using your own password encoding or you previously applied this version of encoding, this update is not necessary.

If you wish to use this version of password encoding, perform the following steps:

  1. Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system directory and open the pentahoObjects.spring.xml file with any text editor.
  2. Locate the line that contains: bean id="IPasswordService"
  3. Verify or modify the class= value with the following value:
    bean id="IPasswordService" class="org.pentaho.platform.util.KettlePasswordService" scope="singleton"/>
  1. Save and close the file.
  2. If you modified the class= value in Step 3, you must make the following modification to encrypt the Pentaho Admin password. In the same pentaho/server/pentaho-server/pentaho-solutions/system directory, open the defaultUser.spring.properties.xml file with any text editor.
  3. Locate the following lines:
    defaultAdminUserPassword=cGFzc3dvcmQ=
    defaultNonAdminUserPassword=cGFzc3dvcmQ=
  4. Replace the values in these lines with the following values:
    defaultAdminUserPassword=Encrypted 2be98afc86aa7f2e4bb18bd63c99dbdde
    defaultNonAdminUserPassword=Encrypted 2be98afc86aa7f2e4bb18bd63c99dbdde
  5. Save and close the file.

Documentation Version Link

The default URL of the online Pentaho documentation changes with each release. When upgrading, this URL parameter may need to be updated in the pentaho.xml file.

  1. Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system directory and open the pentaho.xml file with any text editor.
  2. Modify the following <documentation-url> line and replace the previous documentation value with the current documentation value:
    <documentation-url>https://help.pentaho.com/Documentation/8.1/Products/User_Console</documentation-url>
  3. Save and close the file.

CORS - Embedding CTools

If your Pentaho deployment requires the ability to embed CTools, you can modify the following settings.

  1. Navigate to the pentaho/server/pentaho-server/pentaho-solutions/system directory and open the pentaho.xml file with any text editor.
  2. Modify or add the following CORS lines:
    <!--
    cors-requests-allowed:
    Flag indicating if cross-origin requests are allowed or not.
    accepted values are: true | false
    -->
    
    
    <cors-requests-allowed>false</cors-requests-allowed>
    
    
    <!--
    cors-requests-allowed-domains:
    Comma separated list of domains allowed to do cross-origin requests to the server.
    Example:
    http://domainA.com, http://localhost:1337
    -->
    
    
    <cors-requests-allowed-domains><!-- allowed domains here --></cors-requests-allowed-domains>
  3. If you are embedding CTools, add the following line (as shown above) and set the value to: true
    <cors-requests-allowed>true</cors-requests-allowed>
  4. Save and close the file.

Previously Customized Files

If you have previously customized any of the following items, verify your customizations have been merged:

  • server.xml
  • Startup and shutdown scripts
  • System listeners
  • Security configuration files

If your previous customizations have not been merged, incorporate them into their 8.0 files.

Step 5: Start and Test the DI Server

You are now ready to start the DI Server.

Do not pause or stop the initial starting of the DI Server.

After starting the server, check your Catalina and Pentaho logs in the server/pentaho-server/tomcat/logs directory for any errors. See the Installation and Upgrade Issues article to troubleshoot any errors that occur.

Test Your DI Server

Ensure that the DI Server and the PDI Client (Spoon) are running, then use this list to verify that your content has been restored to the DI Server.

  • Open old jobs and transformations and ensure that they execute properly.
  • Create a new job or transformation and save it as you normally would.
  • Schedule a job or transformation and ensure that the schedule executes properly.
  • Ensure that existing schedules are still valid.
  • If you are using an enterprise repository, share a job or transformation between PDI users and verify that both can access it.
  • Physically restart the server and ensure that the DI Server are automatically started as services.

If the test fails, the PUCLogin.jsp and index.jsp files may have been corrupted during the upgrade process. If they are corrupted, these files must be replaced to resolve this issue, as shown in the following steps:

  1. To verify corruption has occurred, open the tomcat/webapps/pentaho-di/jsp/PUCLogin.jsp file to see if it is empty or has corrupted information.
  2. Retrieve the original PUCLogin.jsp from the pentaho-server-ee-8.0.x.yy-dist file and use it to replace the corrupted one in the tomcat/webapps/pentaho-di/jsp directory.
  3. Edit the new PUCLogin.jsp file to replace “Home” with “kettle/status”.
  4. Save and close the file.
  5. Open the tomcat/webapps/ROOT/index.jsp file to verify corruption has occurred.
  6. Retrieve the original index.jsp file and use it to replace the corrupted one in the tomcat/webapps/ROOT directory.
  7. Edit the new index.jsp file to replace “pentaho” with “pentaho-di”.
  8. Save and close the file.

 For troubleshooting issues, refer to the Installation and Upgrade Issues article.

For Customers Using DI Ops Mart

If you are interested in installing and using DI Ops Mart, see Install DI Operations Mart

Update Your Design Tools

After completing the upgrade to 8.0, perform the following steps to upgrade your Pentaho design tools on your workstations.

  1. Exit any of the design tools, if any are currently running.
  2. Backup all the 6.1.x existing directories in the Pentaho/design-tools directory to a temporary directory. 
  3. Browse to the location where you downloaded the following -dist files in the Available Update Files section:
  • pdi-ee-client-8.0.x.yy-dist
  • prd-ee-8.0.x.yy-dist
  • pme-ee-8.0.x.yy-dist
  • psw-ee-8.0.x.yy-dist
  • pad-ee-8.0.x.yy-dist
  1. If you have not already done so, unzip all the new design tools directories and install them into your existing pentaho/design-tools directory.
  2. Start your new design tools to verify they were upgraded to 8.0.
  3. Test the functionality of the design tools.

You have now completed your Pentaho upgrade from 6.1.x to 8.0.

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.

Upgrading from Visualization API 2.0 to Visualization API 3.0 invalidates any visualizations created with 2.0. If you have created any 2.0 visualizations you want to keep, do not upgrade to 3.0.