Pentaho Upgrade

Available Update Files

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

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 7.x or 8.0 to 8.1 upgrade.

Pentaho Server Installation

Perform the following steps to install the 8.1 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.1.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.1.x.yy-dist
• pdd‐plugin‐ee‐8.1.x.yy-dist
• pir‐plugin‐ee‐8.1.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.

Version 7.0 Specific Upgrade

If you are upgrading specifically from 7.0, you must perform the following configuration changes in order to complete the upgrade process. Note that these properties already exist in version 7.1 and later.

<filter-mapping>
    <filter-name>Proxy Trusting Filter</filter-name>
    <url-pattern>/i18n</url-pattern>
</filter-mapping>

    <!-- To use the current vizAPI set the value of this property to `2.0`; to enable the beta vizAPI, along with the upgraded visualizations, set the value to `3.0`. To use the current vizAPI set the value of this property to `2.0`; Note: Reports saved with vizAPI v3.0 stock visualizations won't render if v2.0 vizAPI is selected, and will fallback to the Pivot Table. -->
  <viz-api-version>2.0</viz-api-version>

Version 7.x Upgrade

If you are upgrading from Pentaho version 7.x, perform the following steps:

1. Update the context.xml file according to your Pentaho Server or DI Server version.
2. Ensure the database connection information in the jackrabbit/repository.xml file is properly carried over from the 7.x version of this file to the 8.1 version. If the 8.1 version differs from 7.x or 8.0, you must match these files manually.

3. Update the path to the pentaho.log file in the tomcat/webapps/pentaho/WEB-INF/classes/log4j.xml file.

4. Remove the following directories and their contents. These plugins are not available in version 8.1.

   Plugin	Path
   Mobile	pentaho/server/pentaho-server/pentaho-solutions/system/pentaho-mobile-plugin
   Sparkl	pentaho/server/pentaho-server/pentaho-solutions/system/sparkl
   client-config-folder-enabler	pentaho/server/pentaho-server/pentaho-solutions/system

Update the context.xml file for your Pentaho Server or DI server

Because of version changes for the Tomcat web application server, apply the following connection pool parameter changes to the META-INF context.xml file for the resource connections to the Pentaho Server or DI server. Depending upon the version of Pentaho Server or DI server you are upgrading, you must modify this file to reflect the database connection and network setting information for each of your resource connection types.

<Resource name="jdbc/Hibernate" auth="Container" type="javax.sql.DataSource"
            factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0"
            maxWait="10000" username="hibuser" password="password"
            driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/hibernate"
            validationQuery="select 1"/>

<Resource name="jdbc/Hibernate" auth="Container" type="javax.sql.DataSource"
            factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0"
            maxWait="10000" username="hibuser" password="password"
            driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/hibernate"
            validationQuery="select 1" jdbcInterceptors="ConnectionState" defaultAutoCommit="true"/>

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"/>

4. Save and close the file.
5. 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 file with any text editor.
6. Locate the following lines:

   defaultAdminUserPassword=cGFzc3dvcmQ=
   defaultNonAdminUserPassword=cGFzc3dvcmQ=

7. Replace the values in these lines with the following values:

   defaultAdminUserPassword=Encrypted 2be98afc86aa7f2e4bb18bd63c99dbdde
   defaultNonAdminUserPassword=Encrypted 2be98afc86aa7f2e4bb18bd63c99dbdde

8. 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.1 files.

Test Your Server

You can use the following actions to ensure your content has been restored to the 8.1 Pentaho Server:

1. Clear your web browser cache and history.
2. Navigate to your Pentaho URL (the default URL is http://localhost:8080/pentaho) and ensure the login screen appears.
3. Log on to PUC and try to run your old BA content.
4. Verify your schedules exist and are working properly.
5. Ensure 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 application server log.

If you have upgraded to 8.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:

• Log on and try to access the kettle/status page.
• Check 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.