Skip to main content
Pentaho Documentation

Configuration File Upgrade Steps for 5.0.3 through 5.0.6

How to Get Ready for Upgrade from 5.0.x to 5.1

A couple of the 5.0 patches between 5.0.3 and 5.0.6 contain some configuration files that have changed. As you work through the patch process, follow these instructions to update your configuration files so that you can successfully move from 5.0.6 to Pentaho 5.1.

If you have customized any of these files, you will have to manually merge them in order to successfully complete the upgrade.

Some items of note:

  • There were no configuration file changes between 5.0.4 and 5.0.5.
  • The web.xml file stayed the same from 5.0.3 all the way through 5.0.7.

Once you are all up-to-date through 5.0.6, you will be ready to proceed with the full upgrade to Pentaho 5.1.

Upgrade from 5.0.3 to 5.0.4

There is one configuration file that was updated between 5.0.3 to 5.0.4 that will need to be updated.

  1. Navigate to the .../pentaho-solutions/system folder and open the applicationContext-pentaho-security-ldap.xml file with a text editor.
  2. Replace the old ldapUserDetailsService bean with the new bean as shown.
    Old Bean:
    <ref bean="ldapUserDetailsService"/>
    
    New Bean:
    <pen:bean class=org.springframework.security.userdetails.UserDetailsService"/>
    
  3. Save and close the file.

Upgrade from 5.0.4 or 5.0.5 to 5.0.6

There are three files to update here:

  • pentaho-spring-beans.xml
  • GettingStartedDB-spring.xml
  • applicationContext-pentaho-security-superuser.xml

The sqlmetadataqueryexec.properties file is a new file for this version and does not need any changes.

pentaho-spring-beans.xml

  1. Navigate to the .../pentaho-solutions/system folder and open the pentaho-spring-beans.xml file with a text editor.
  2. Add this new bean just before the </beans> tag.
    <bean class="org.pentaho.platform.config.SolutionPropertiesFileConfiguration">
            <constructor-arg value="sqlmetadataqueryexec"/>
            <constructor-arg value="sqlmetadataqueryexec.properties"/>
            <pen:publish as-type="INTERFACES"/>
    </bean>
    
  3. Save and close the file.

GettingStartedDB-spring.xml

  1. In the .../pentaho-solutions/system folder, find and open the GettingStartedDB-spring.xml file with a text editor.
  2. Replace the old org.h2.tools.Server bean with the new bean as shown.
    Old Bean:
    <bean id="org.h2.tools.Server"
         class="org.h2.tools.Server"
         scope="singleton"
         factory-method="createTcpServer"
         init-method="start"
         destroy-method="stop">
         <constructor-arg value="-tcp,-baseDir,#[base.dir],-tcpAllowOthers,true,-tcpPort,#[tcp.port]" />
    </bean>
    
    New Bean:
    <bean id="org.h2.tools.Server"
        class="org.h2.tools.Server"
        scope="singleton"
        factory-method="createTcpServer"
        init-method="start"
        destroy-method="stop">
        <constructor-arg value="-tcp,-baseDir,#[base.dir],-tcpAllowOthers,-tcpPort,#[tcp.port]" />
    </bean>
    
  3. Save and close the file.

applicationContext-pentaho-security-superuser.xml

  1. In the .../pentaho-solutions/system folder, find and open the applicationContext-pentaho-security-superuser.xml file with a text editor.
  2. Replace the old superUserRoleListService bean with the new bean as shown.
    Old Bean:
    <bean id="superUserRoleListService" class="org.pentaho.platform.security.userroledao.superuser.SuperUserRoleListService">
        <constructor-arg value="SystemAdmin"/>
        <constructor-arg ref="singleTenantAdminAuthorityName" />
    
    New Bean:
    <bean id="superUserRoleListService" class="org.pentaho.platform.security.userroledao.superuser.SuperUserRoleListService">
        <constructor-arg ref="singleTenantAdminAuthorityName" />
        <constructor-arg ref="singleTenantAdminUserName" />
        <constructor-arg ref="singleTenantSystemAuthorities" />
    </bean>
    
  3. Save and close the file.

Next Steps

After you have finished with this section, you are ready to continue the 5.1 BA upgrade process.