Skip to main content
Pentaho Documentation

Post-upgrade Tasks

Parent article

After you upgrade your Pentaho Server to version 9.0, there are some items and tasks you must perform to ensure your Pentaho configuration is ready to use.

Delete temporary files created by the upgrade installer

The Pentaho Server Upgrade Installer creates files in the temporary folder for both Windows and Linux. Examine your temporary folder and delete any compressed and uncompressed files related to the Pentaho installation. The exact file path to the temporary folders depends on your configuration and username.

For example:

  • Windows

    \Users\username\AppData\Local\Temp

  • Linux

    /tmp

You can find the exact path for your configuration in the post-upgrade log file generated by upgrade installer.

Under Windows, for example, you can safely delete the following compressed and uncompressed files:

  • \Users\username\AppData\Local\Temp\pentaho-server-ee-9.0.0.0-xxx-patch
  • \Users\username\AppData\Local\Temp\I1580164747\InstallerData\Disk1

Spring security files

When you upgrade to version 9.0, the upgrade installer makes changes to your spring security configurations. The installer automatically updates the spring security path, specified in the namespace header in these configuration files:

  • pentaho-solutions/system/applicationContext-spring-security.xml
  • pentaho-solutions/system/applicationContext-spring-security-cas.xml
  • pentaho-solutions/system/repository-spring-security.xml
The old spring security path is:
http://www.springframework.org/schema/security/spring-security-4.1.xsd

The new spring security path is:

http://www.springframework.org/schema/security/spring-security-4.2.xsd

Verify the context XML file layout

The upgrade process makes structural changes to parameters and the factory bean name value in the context.xml user configuration file. If the context.xml is not updated to the version 9.0 requirements, errors appear in the log files.

NoteIf you are upgrading from the base versions of 7.1.x or 8.0.x, there are known changes to this file structure.

Regardless of which version you upgrade from, verify that your context.xml file matches the following example:

<Context path="/pentaho" docbase="webapps/pentaho/">
  <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"/>

  <Resource name="jdbc/Audit" 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/Quartz" auth="Container" type="javax.sql.DataSource"
            factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0"
            maxWait="10000" username="pentaho_user" password="password" testOnBorrow="true"
            driverClassName="org.postgresql.Driver" url="jdbc:postgresql://localhost:5432/quartz"
            validationQuery="select 1"/>

  <Resource name="jdbc/PDI_Operations_Mart" 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/pentaho_operations_mart" 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/live_logging_info" 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?searchpath=pentaho_dilogs"
            validationQuery="select 1"/>

  <Resource name="jdbc/SampleData" auth="Container" type="javax.sql.DataSource"
            factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0"
            maxWait="10000" username="pentaho_user" password="password"
            driverClassName="org.hsqldb.jdbcDriver" url="jdbc:hsqldb:hsql://localhost/sampledata"
            validationQuery="select 1"/>

  <Resource name="jdbc/SampleDataAdmin" auth="Container" type="javax.sql.DataSource"
            factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxActive="20" minIdle="0" maxIdle="5" initialSize="0"
            maxWait="10000" username="pentaho_admin" password="password"
            driverClassName="org.hsqldb.jdbcDriver" url="jdbc:hsqldb:hsql://localhost/sampledata"
            validationQuery="select 1"/>

</Context>

Password encoding

Pentaho version 8.0 changed the password encoding from previous versions. When upgrading from a base version of 7.1.x or 8.0.x, the following updates are required.
NoteThis update is not necessary if:
  • You are upgrading from version 8.1 to 9.0.
  • You are using your own password encoding or you previously applied this version of encoding

Perform the following steps:

Procedure

  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> above, 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.

Procedure

  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/9.0</documentation-url>

  3. Save and close the file.

CORS (for embedding CTools)

The upgrade installer does not modify the pentaho.xml file. If you had CTools installed in your previous version of Pentaho, open the pentaho.xml file with any text editor and verify that your customizations were carried forward to version 9.0.

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

Procedure

  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

The upgrade installer does not modify any of the following user customization files. If you have previously customized any of the following files, verify that your customizations were carried forward to version 9.0.

You can also edit these files to add customizations for any new features you want to add to your Pentaho installation.

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

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

Update your design tools

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

Procedure

  1. Exit any of the design tools, if any are currently running.

  2. Back up and rename all the 7.x or 8.x existing directories in a separate, temporary directory.

  3. Browse to the location where you downloaded the following -dist files in the Available update files section:

    • pdi-ee-client-9.0.x.yy-dist
    • prd-ee-9.0.x.yy-dist
    • pme-ee-9.0.x.yy-dist
    • psw-ee-9.0.x.yy-dist
    • pad-ee-9.0.x.yy-dist
  4. If you have not already done so, unzip all the new design tools directories and install them into a pentaho/design-tools directory.

  5. Start your new design tools to verify they were upgraded to 9.0.

  6. Test the functionality of the design tools.

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: Moving to Visualization API 3.0 in Analyzer.

For customers using Ops Mart

If you installed an Ops Mart as part of the previous Pentaho 7.x or 8.x upgrade, you do not have to reinstall it.

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

Install drivers for data sources

After upgrading to version 9.0 of the Pentaho Server, you can install the drivers for the data sources you want to access. To conserve memory and storage resources, these drivers are not automatically installed. If you plan to use Hadoop clusters in your Pentaho configuration, you can install the specific data source drivers manually or through PDI. For instructions see Set up the Pentaho Server to connect to a Hadoop cluster.