Add logos to interactive reports

You can add logos to interactive reports by replacing the default logo file used by report templates.

This requires access to the Pentaho Server file system. If you do not have access, contact your administrator or Pentaho Support.

Before you start

  • Prepare a logo image in PNG format.

  • Back up the existing Logo.png and classic-engine.properties files.

  • Plan for a server restart if you change alignment settings.

circle-exclamation

Add a custom logo to an interactive report template

  1. In the User Console, go to Home.

  2. Select Create New > Interactive Report.

  3. In Select Data Source, select a data source.

  4. Select OK.

  5. Select the General tab.

  6. Select Select to open the template list.

  7. Select a template that shows the red Change Me! logo.

    Templates are stored here:

    <server_installation_folder>/pentaho-server/pentaho-solutions/system/pentaho-interactive-reporting/resources/templates
  8. Open the tenant image folder:

    <server_installation_folder>/pentaho-server/pentaho-solutions/system/pentaho-interactive-reporting/resources/images/pentaho/<tenantId>
  9. Rename the existing Logo.png to keep a backup.

    Example: Logo-orig.png

  10. Rename your custom logo file to Logo.png.

  11. Refresh the template.

  12. Confirm the new logo renders correctly.

Change logo alignment

You can set the logo alignment to left, right, or center.

  1. Open this folder:

  2. Open classic-engine.properties in a text editor.

  3. Find this property:

    org.pentaho.reporting.engine.classic.core.environment.pirTemplateLogoAlignment

  4. Set the value to left, right, or center.

    The default value is right.

  5. Restart the server.

Multi-tenancy support for logos

Each tenant can have its own Logo.png. The tenantId value is stored in the session.

The default tenant is /pentaho/tenant0. The default logo is stored here:

For multiple tenants, create one folder per tenant ID. Store that tenant’s logo in the folder as Logo.png.

Last updated

Was this helpful?