Customize Pentaho products

Use these procedures to customize Pentaho web apps.

Most changes require a server restart.

Edits under tomcat/webapps can be overwritten by upgrades or redeploys. Reapply these changes after you update Pentaho.

Customize the Pentaho User Console (PUC)

PUC is the standard web application for the Pentaho Server.

Hide widgets on the Home page

The default Home page includes the Getting Started widget. You can hide it and other widgets.

1

Stop the Pentaho Server

Stop the server before you edit files.

2

Edit the Home page widget configuration

Open config.properties in a text editor.

Pick the file based on your deployment:

• Not deployed yet: /pentaho-platform/user-console/source/org/pentaho/mantle/home/properties/config.properties

• Already deployed: /pentaho-server/tomcat/webapps/pentaho/mantle/home/properties/config.properties

Update disabled-widgets to include the widget IDs you want to hide. Use getting-started to hide the Getting Started widget.

3

Disable the Brightcove embed (optional)

Open /pentaho-server/tomcat/webapps/pentaho/mantle/home/index.jsp.

Comment out the line that loads BrightcoveExperiences.js.

4

Start the Pentaho Server

Sign in to PUC and verify the Home page.

Turn off autocomplete on the sign-in page

PUC sign-in fields use browser autocomplete by default. You can disable it.

1

Stop the Pentaho Server

2

Update the PUC login page

Open /pentaho-server/tomcat/webapps/pentaho/jsp/PUCLogin.jsp.

Set the autocomplete attribute to off for:

• The username input

• The password input

3

Restart the Pentaho Server

Verify the sign-in page behavior in your browser.

Customize Pentaho Analyzer

Analyzer customization depends on what you’re changing.

Apply Analyzer-specific web client configuration

Use the global web client configuration file for runtime rules. This approach does not require a server restart.

File location:

• Pentaho Server: pentaho-server/pentaho-solutions/system/karaf/config/web-client/config.js

To target Analyzer only, scope rules to the application value pentaho/analyzer.

See Platform JavaScript APIs for rule syntax and supported values.

Deploy custom visualizations to Analyzer

You can add custom visualizations to Analyzer through the Karaf deploy folder.

See Deploying a visualization.