Skip to main content

Pentaho+ documentation has moved!

The new product documentation portal is here. Check it out now at


Hitachi Vantara Lumada and Pentaho Documentation

Manage the Pentaho Server

Parent article

The Pentaho Server has options that must be set manually, outside of the Administration page of the User Console. You can do any or all of these tasks depending on your needs.

Disable Home perspective widgets

The User Console default Home perspective contains the Getting Started widget, which has easy instructions and tutorials for evaluators. The directions below show you how to hide not only the Getting Started widget, but also other Home perspective widgets, as needed:


  1. Shut down the Pentaho Server, if it is currently running.

  2. If you have not deployed yet, navigate to the /pentaho-platform/user-console/source/org/pentaho/mantle/home/properties/ file.

  3. If you have manually deployed and want to hide widgets at a later time, navigate to the /pentaho-server/tomcat/webapps/pentaho/mantle/home/properties/ file.

  4. Find the line that starts with disabled-widgets= and type in the ID of the widget getting-started. You can also disable the Recents and Favorites widgets using the same method, as shown here. Save and close the file.

  5. Locate the /pentaho-server/tomcat/webapps/pentaho/mantle/home directory and open the index.jsp file with any text editor.

  6. Find this line and comment it out, then save and close the file.

    <script language='JavaScript' type='text/javascript' src=''></script>
  7. Start the Pentaho Server and log in to the User Console.


You now have a Home page that is scrubbed of the specified widget(s).

Turn autocomplete off for web app login screen

The User Console's login settings have autocomplete turned off by default; if you need to, here is how to manually disable the autocomplete.


  1. Stop the Pentaho Server.

  2. Navigate to the /pentaho-server/tomcat/webapps/pentaho/jsp directory and open the PUCLogin.jsp file with any text editor.

  3. Find the following two sections of text and change the autocomplete entry to off, as shown:

    <input id="j_username" name="j_username" type="text" placeholder="" autocomplete="off">
    <input id="j_password" name="j_password" type="password" placeholder="" autocomplete="off">
  4. Save and close the PUCLogin.jsp file.

  5. Restart the Pentaho Server.


Autocomplete for user names and passwords is now disabled for the User Console login screen.

Remove sample data from the Pentaho Server

By default, Pentaho provides a sample data source and a solution directory filled with example content. These samples are provided for evaluation and testing. Once you are ready to move from an evaluation or testing scenario to development or production, you can remove the sample content. Follow the instructions below to completely remove the Pentaho sample data and solutions:


  1. Stop the Pentaho Server.

  2. Delete the file from the /pentaho-server/pentaho-solutions/system/default-content directory.

    If you performed a manual WAR build and deployment, then the file path is: /pentaho-server/pentaho-solutions/system.
  3. Edit the /pentaho/WEB-INF/web.xml file inside of the deployed pentaho.war.

    As laid down by the Pentaho graphical installer and archive packages, this path should be /pentaho-server/tomcat/webapps/pentaho/WEB-INF/web.xml. If you performed a manual WAR build and deployment, then you must adjust the path to fit your configuration.
  4. Remove the hsqldb-databases section from the /pentaho/WEB-INF/web.xml file:

  5. Remove the hsqldb-starter section from the /pentaho/WEB-INF/web.xml file:

    <!-- [BEGIN HSQLDB STARTER] --> 
    <!-- [END HSQLDB STARTER] -->
  6. Remove the SystemStatusFilter:

    NoteThis is not part of the Pentaho samples; it provides error status messages that are only useful for development and testing purposes, and should be removed from a production system.
            <description>This page is displayed if the PentahoSystem fails to properly initialize.</description>
  7. Remove the filter mapping for the SystemStatusFilter:

  8. Save and close the web.xml file.

  9. Delete the /pentaho-server/data/ directory.

    This directory does not exist if you installed Pentaho with the installation wizard. It contains a sample database, control scripts for that database, the environment settings it needs to run, and SQL scripts to initialize a new repository.
  10. Restart the Pentaho Server.

  11. Log in to the Pentaho User Console with the administrator user name and password and go to the Browse Files page.

    1. In the Folders pane, expand the Public folder and click to highlight the folder containing the Steel Wheels sample data. Click Move to Trash in the Folder Actions pane and confirm the deletion.

    2. Highlight the folder containing the Pentaho Operations Mart sample data. Click Move to Trash in the Folder Actions pane and confirm the deletion.


Your Pentaho Server instance is now cleaned of samples and development/testing pieces, and is streamlined for production.

Enable JPivot in the User Console

It is a best practice to use the Pentaho Analyzer for analytic reporting. However, if you choose to enable JPivot on the Pentaho Server for analytic reporting, then perform the following steps.
NoteJPivot is not supported by Pentaho Customer Support.


  1. Stop the Pentaho Server.

  2. Navigate to server/pentaho-server/pentaho-solutions/system/karaf/etc directory and open the plugin.xml file with any text editor.

  3. Add pentaho-marketplace\ to the featuresBoot property.

  4. Save and close the file.

  5. Delete the Karafe cache directory: server/pentaho-server/pentaho-solutions/system/karaf/caches.

  6. Start the server.

    The Marketplace perspective is activated in PUC.
  7. In the PUC console select Home Marketplace and install the JPivot plugin.

    A confirmation box opens informing you that the JPivot plugin was installed successfully.
  8. Download the jsf-api-1.1_02.jar file from and place it in the server/pentaho-server/tomcat/webapps/pentaho/WEB-INF/lib directory.

    CautionBe aware that a security vulnerability exists regarding the jsf-api-1.1_02.jar file. See
  9. Restart the server.


The JPivot plug-in is now available in the User Console.

Advanced topics

The following topics help to extend your knowledge of the Pentaho Server beyond basic management: