Skip to main content
Pentaho Documentation

Maintain the BA Server Manually

Overview

The BA 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 default console 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 BA 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/config.properties file.
  3. If you have manually deployed and want to hide widgets at a later time, navigate to biserver-ee/tomcat/webapps/pentaho/mantle/home/properties/config.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.
    disabled-widgets=getting-started,recents,favorites
    
  5. Locate the bi-server/tomcat/webapps/pentaho/mantle/home 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='http://admin.brightcove.com/js/BrightcoveExperiences.js'></script>
    
  7. Start the BA 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 BA Server.
  2. Navigate to the /biserver-ee/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. Navigate to the /data-integration-server/tomcat/webapps/pentaho-di/jsp directory and open that PUCLogin.jsp file with any text editor.
  6. 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">
    
  7. Save and close the PUCLogin.jsp file.
  8. Restart the BA Server.

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

Remove Sample Data from the BA 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 BA Server.
  2. Delete the samples zip file from the /pentaho/server/biserver-ee/pentaho-solutions/system/default-content directory. If you performed a manual WAR build and deployment, then the file path is /pentaho/server/biserver-ee/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/biserver-ee/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:
    <!-- [BEGIN HSQLDB DATABASES] -->
        <context-param>
            <param-name>hsqldb-databases</param-name>
            <param-value>sampledata@../../data/hsqldb/sampledata</param-value>
        </context-param>
    <!-- [END HSQLDB DATABASES] -->
    
  5. Remove the hsqldb-starter section from the /pentaho/WEB-INF/web.xml file:
    <!-- [BEGIN HSQLDB STARTER] --> 
    <listener> 
    <listener-class>org.pentaho.platform.web.http.context.HsqldbStartupListener</listener-class> 
    </listener> 
    <!-- [END HSQLDB STARTER] -->
    
  6. Remove the SystemStatusFilter:

    This 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.

    <filter>
        <filter-name>SystemStatusFilter</filter-name>
        <filter-class>com.pentaho.ui.servlet.SystemStatusFilter</filter-class>
        <init-param>
            <param-name>initFailurePage</param-name>
            <param-value>InitFailure</param-value>
            <description>This page is displayed if the PentahoSystem fails to properly initialize.</description>
        </init-param>
    </filter>
    
  7. Remove the filter mapping for the SystemStatusFilter:
    <filter-mapping>
        <filter-name>SystemStatusFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    
  8. Save and close the web.xml file.
  9. Delete the /pentaho/server/biserver-ee/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 and the environment settings it needs to run, and SQL scripts to initialize a new repository.
  10. Restart the BA Server.
  11. Log on to the 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 BA Server instance is now cleaned of samples and development/testing pieces, and is streamlined for production.

Enable JPivot in the User Console

We recommend that you use Pentaho Analyzer for analytic reporting. However, you can enable JPivot on the BA Server if you need to by following these steps.

JPivot was deprecated in Pentaho 5.0 and is no longer supported by Pentaho Customer Support.

  1. Shut down the BA Server if it is currently running.
  2. Navigate to /pentaho/server/biserver-ee/pentaho-solutions/system/pentaho-jpivot-plugin-legacy/plugin.xml file and delete file.
  3. Rename the file called /pentaho/server/biserver-ee/pentaho-solutions/system/pentaho-jpivot-plugin-legacy/plugin.xml.enabled to /pentaho/server/biserver-ee/pentaho-solutions/system/pentaho-jpivot-plugin-legacy/plugin.xml and save it. You can either turn off the deprecation message for JPivot, or restart the BA Server at this point.

Turn Off Deprecation Message for JPivot - Optional

  1. Shut down the BA Server if it is currently running.
  2. Navigate to the /pentaho-solutions/system/pentaho-jpivot-plugin-legacy/settings.xml and open the file.
  3. Change the Boolean value as shown and save the file.
    From:
    <show-deprecation-warning>true</show-deprecation-warning>
    
    To:
    <show-deprecation-warning>false</show-deprecation-warning>
    
  4. Restart the BA Server.

The JPivot plug-in is enabled in the User Console and the deprecation message is turned off.

Change the Location of the Server Log File

For Windows:

If you used the install wizard to install Pentaho Business Analytics, the pentaho.log is written to the C:/WINDOWS/system32 directory. To change the location of the pentaho.log file, you must edit the log4j.xml available at /pentaho/server/biserver-ee/tomcat/webapps/pentaho/WEB-INF/classes/.

Modify the location as shown in the sample below, using the appropriate path to your installation of Pentaho Business Analytics.

<param name="File" value="C:/Program Files/pentaho/server/biserver-ee/logs/pentaho.log"/> 
<param name="Append" value="true"/>

For Linux:

If you are using Linux, the log4j.xml file is found at /home/pentaho/pentaho/server/biserver-ee/tomcat/webapps/pentaho/WEB-INF/classes/.

Modify the location as shown in the sample below, using the appropriate path to your installation of Pentaho Business Analytics.

<param name="File" value="home/pentaho/server/biserver-ee/logs/pentaho.log"/> 
<param name="Append" value="true"/>

Change the Quartz Misfire Threshold

With Quartz, sometimes scheduled jobs, transformations, or reports might try to run several times when they are manually stopped and restarted, instead of running only once. This is typically caused by the misfireThreshold property in Quartz being set at too high of a number.

These steps show how to reset the misfireThreshold to a lower numerical value.

  1. Stop the BA Server.
  2. Locate the biserver-ee/pentaho-solutions/system/quartz directory.
  3. Open the quartz.properties file with any text editor.
  4. Find the property shown below and change the default to a smaller number, such as 5000. The default value represents the number of milliseconds.
    org.quartz.jobStore.misfireThreshold = 60000
    
  5. Save and close the quartz.properties file.
  6. Restart the BA Server.

Set System Max Row Limit for Interactive Reports

You can prevent too many resources from hitting your database server at once by setting a system-wide maximum row-limit for Pentaho Interactive Reports. Your users can still define their own design-time row limits in PIR, but they will never be able to go over the maximum number of rows that you have specified while designing their reports.

  1. Shut down the BA Server.
  2. Locate the biserver-ee/pentaho-solutions/system/pentaho-interactive-reporting directory.
  3. Open the settings.xml file with any text editor.
  4. Find the <query-limit> tag and change the default number of 1000 within the tags to the maximum number of rows desired.
    <!-- The maximum number of rows that will be rendered in a report on PIR edit and
    view mode. A zero value means no limit. -->
    <query-limit>1000</query-limit>
    
  5. Save and close the settings.xml file.
  6. Start the BA Server.

If you are migrating content from a previous version, you will need to add the <query-limit> tag to your settings.xml for PIR.

Increase the CSV File Upload Limit

You may find that you need to increase the size of the upload limit for your CSV files. These steps guide you through this process.

  1. Go to /biserver-ee/pentaho-solutions/system and open the pentaho.xml file.
  2. Edit the XML as needed (sizes are measured in bytes):
    <file-upload-defaults>
          <relative-path>/system/metadata/csvfiles/</relative-path>
    
          <!-- max-file-limit is the maximum file size, in bytes, to allow to be uploaded to the server -->
          <max-file-limit>10000000</max-file-limit>
    
          <!-- max-folder-limit is the maximum combined size of all files in the upload folder, in bytes. -->
          <max-folder-limit>500000000</max-folder-limit>
    
    </file-upload-defaults>
    
  3. Save your changes to the file.
  4. In the User Console, go to Tools > Refresh System Settings to ensure that the change is implemented.
  5. Restart the User Console.

Change the Staging Database for CSV Files

Hibernate is the default staging database for CSV files. Follow these instructions if you want to change the staging database.

  1. Go to /pentaho-solutions/system/data-access and open the settings.xml file with any text editor.
  2. Edit the settings.xml file as needed. The default value is shown in the sample below.
    <!-- settings for Agile Data Access -->
    <data-access-staging-jndi>hibernate</data-access-staging-jndi>
    
    This value can be a JNDI name or the name of a Pentaho Database Connection .
  3. Save and close the file.
  4. Restart the User Console.

Change the Port Numbers for the BA Server

Follow the instructions below to change the port through which the BA Server runs:

  1. Stop the BA Server.
  2. Navigate to the /pentaho/server/biserver-ee/tomcat/conf/ directory.
  3. Open the server.xml file with any text editor, and search for the value for Define a non-SSL HTTP/1.1 Connector. Change the port number in the connector port element below from 8080 to your preferred port number.
    <!-- Define a non-SSL HTTP/1.1 Connector on port 8080 -->
        <Connector port="8080" maxHttpHeaderSize="8192"
                   maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
                   enableLookups="false" redirectPort="8443" acceptCount="100"
                   connectionTimeout="20000" disableUploadTimeout="true" />
    
  4. Save and close the server.xml file.
  5. Navigate to the /tomcat/webapps/pentaho/WEB-INF/web.xml directory and open the web.xml file with any text editor.
  6. Change the fully-qualified-server-url entry to match the new port number you specified in server.xml.
    <context-param>
        <param-name>fully-qualified-server-url</param-name>
        <param-value>http://localhost:8080/pentaho/</param-value>
    </context-param>
    
  7. Save and close the web.xml file.
  8. Restart the BA Server.

Change the Web Application Name or Port

The Pentaho BA Server and web application default port number is 8080. The default web application name is pentaho, which is the name of the .war file archive, the name of the directory that your application server creates, and also part of the URL structure for all content in the User Console.

If you need to change the User Console application name to something else, or if your Web application server is running on a port other than 8080, follow these instructions for either JBoss or Tomcat.

Change the Web Application Name on Tomcat

These instructions only work on Tomcat servers that are configured to accept context.xml overrides built into deployed .war files. Some Tomcat deployments may not have this feature turned on. You can change the Tomcat configuration on your own, or consult your Tomcat documentation to learn about other methods of changing a web application context. Use the XML snippet in these instructions in whichever configuration file you end up creating or modifying.

Follow these instructions to change the web application context for a Pentaho .war file that you deployed to a Tomcat server.

  1. After deployment is successful, delete the original pentaho.xml file.
  2. Navigate to the META-INF directory and open the context.xml file in a text editor.
  3. In the context.xml file, change the pentaho references in the Context path tag to your preferred context name:
    <context path="/pentaho" docbase="webapps/pentaho/">
            
  4. Save and close the file.
  5. While still in the WEB-INF directory, open the web.xml file.
  6. Edit the pentaho.xml file found there, and change the fully-qualified-server-url entry to match the context name you specified previously, and your Tomcat port number.
    <context-param>
        <param-name>fully-qualified-server-url</param-name>
        <param-value>http://localhost:5150/example/</param-value>
    </context-param>
    

Change the Web Application Name on JBoss

Follow these instructions to change the Web application context for a Pentaho.war file that you deployed to a JBoss server.

  1. After deployment is successful, delete the original pentaho.xml file.
  2. Open the jboss-web.xml file with any text editor.
  3. Add the following text inside of the jboss-web section, replacing example with your new context name:
    <context-root>example</context-root>
    
  4. Save and close that file, then open the web.xml file and modify the fully-qualified-server-url entry to match your new context name and port number.
    <context-param>
        <param-name>fully-qualified-server-url</param-name>
        <param-value>http://localhost:5150/example/</param-value>
    </context-param>
    
  5. Save and close the file.