Skip to main content
Pentaho Documentation

Customize Pentaho Analyzer

You can customize Pentaho Analyzer in the following ways.

Properties File

Giving Analyzer reports a configuration that fits your needs involves editing the analyzer.properties file. The following actions are examples some of the settings you can change:

  • Enabling your logo to appear in PDF output.
  • Specifying the maximum number of rows when drilling-down in a report.
  • Defining a specific value for blank cells.
  • Changing the default chart options.

The complete list of properties that you can change are in the file comments, and you can find the file here: /server/pentaho-server/pentaho-solutions/system/analyzer/analyzer.properties.

Changes take effect after you restart the Pentaho Server.

PDF Settings

There are a number of ways that you can customize the appearance of your company's PDFs that are exported from Analyzer. For example, Analyzer PDF exports can be personalized with a company logo and a cover page, or you can change the default font used to generate PDFs.

PDF Logo and Cover Page Customization

You will need to replace a couple of image files in order to customize the cover page and company logo for your Analyzer PDF exports. These image files need to placed in the /pentaho-solutions/system/analyzer/resources/ directory. You then need to update analyzer.properties with the names of these images given to the keys below. If the file names are left blank, then no images are used.

  • PDF cover image: renderer.pdf.cover.image
  • PDF logo image: renderer.logo.image

Set Default Fonts for PDF Export

When displaying data in Analyzer, your reports will use the default browser fonts. However, the PDF export function may not have the same fonts available to it when creating a PDF from your Analyzer report, resulting in output that doesn't look the same way in PDF format as it does in the browser. The default font for PDFs is Helvetica, but you can specify any TrueType font or collection to replace it. Follow the instructions below to specify a different font for PDF exports.

If you have localized your schema in a language that uses a multi-byte character set (most Asian languages fit into this category), this process is required to make PDF output appear without errors.

  1. Stop the Pentaho User Console and Pentaho Server.
  2. Navigate to the /pentaho/server/pentaho-server/pentaho-solutions/system/analyzer/ directory and open the analyzer.properties file with any text editor.
  3. Uncomment the renderer.pdf.font.path line.
    renderer.pdf.font.path=C:/WINDOWS/Fonts/MSGOTHIC.TTC,1
    
  4. Replace the value of this line with the TrueType font or collection that you want to use as the default. If you are specifying a collection, you must put a ,1 after the font name, as shown in the above example. This does not apply to individual fonts (TTF files).
    renderer.pdf.font.path=/usr/share/fonts/truetype/freefont/FreeSans.ttf
    
  5. Save and close the file, and restart the Pentaho Server.

Your PDF exports from Analyzer should have the font you specified.

Collapse Business Group Folders in the Available Fields List

By default, all the Business Group Folders in the Available Fields list are expanded. You can change this setting to a collapsed view by editing the analyzer.properties file.

  1. Stop the Pentaho Server.
  2. Navigate to the analyzer.properties file, located at: /server/pentaho-server/pentaho-solutions/system/analyzer/analyzer.properties
  3. Open the file with any text editor and locate the following lines in the file:
    # On opening the field list, collapse the business groups/folder
    # by default. Default: false
    Report.field.list.collapse=false
  4. Change the Report.field.list.collapse value to true as follows:
    # On opening the field list, collapse the business groups/folder
    # by default. Default: false
    Report.field.list.collapse=true
  5. Save and close the analyzer.properties file.
  6. Restart the Pentaho Server.
  7. Restart Analyzer. The list of available Business Group folders are collapsed, as shown in the example below:
    Analyzer_Business-Groups_Collapsed.png

Sort Options in the Available Fields List

The Available fields list in Analyzer can be sorted using the View toggle with the following sorting options:

UI Label Description Sort Option
By Category Sorts by folder names. cmdViewCategory
Measure - Level - Time Sorts by the type of field. cmdViewType
A > Z Sorts by field names without any folders. cmdViewName
Schema Sorts in the same order thant is defined in the Mondrian schema file. cmdViewSchema

The default sort used in an Analyzer report is based on the following priority:

  1. A sort specified in an URL takes the highest priority.
  2. The last sort option is automatically remembered when a report is reopened.
  3. Next comes the annotation value specified on the report's cube in the Mondrian schema file.
  4. A system wide setting in analyzer.properties file.
  5. Last, the default value of cmdViewCategory.

Specify with an URL

The sort option can be set in the URL by adding a "fieldListView" query parameter at the end of the URL. For example, you can do something like this in a codeblock in HTML or XML.

http://localhost:8080/pentaho/api/repos/xanalyzer/editor?&showFieldList=true&showFieldLayout=true&catalog=SampleData&cube=Quadrant%20Analysis&autoRefresh=true&debug=true&

Specify with Annotation

To specify the sort option using an annotation, add a Cube-level annotation called "AnalyzerFieldListView" in your Mondrian schema file. This annotation must be the first child element under a cube as shown here.

<Cube name="Quadrant Analysis">

    <Annotations>

              <Annotation name="AnalyzerFieldListView">cmdViewName</Annotation>

    </Annotations>

    <Table name="Quadrant_Acuals" />

    <DimensionUsage name="Region" source="Region" />

    <DimensionUsage name="Department" source="Department" />

    <DimensionUsage name="Positions" source="Positions" />

Specify through the Properties File

This sort option is specified by setting the cmdViewType for the "report.field.list.view" property.

# Default field list view mode used to sort the available field

# list in the editor.  Possible values include: cmdViewCategory,

# cmdViewType, cmdViewSchema and cmdViewName

# This can also be overriden on a cube level with the annotation

# AnalyzerFieldListView

report.field.list.view=cmdViewType

Set Discrete Axis for Line, Area, and Scatter Charts

Line, Area and Scatter charts in Analyzer and custom charts in VizAPI 3.0 provide Time and Number dimensions and associated hierarchic members on a continuous scale axis. However, if you prefer the Time and Number dimensions in Line and Area visualizations on a discrete axis, and to disable the Time and Number dimensions in Scatter visualizations, perform either or both of the following procedures to edit the global mapping configurations:

Set Time Dimensions to Discrete Axes in Analyzer

  1. Navigate to the /pentaho/server/pentaho-server/pentaho-solutions/system/karaf/config/web-client system directory and open the config.js file with any text editor.
  2. Locate the Example Rule 9 - Disable hierarchical dates strategy code block, as shown in this example:
    
    // Example Rule 9 - Disable the continuous date strategy, to revert
    // to the old behavior (Before 8.1) that represents Time dimensions in a discrete axis.
    /*
    {
      select: { module: "pentaho/visual/role/adaptation/EntityWithTimeIntervalKeyStrategy" },
      apply: { isBrowsable: false }
    },
    */ 
    
  1. Remove the /* marker and the */ marker to uncomment the EntityWithTimeIntervalKeyStrategy command.     
  2. Save and close the file, then refresh the browser.

Your line and area visualizations will display Time dimensions on a discrete axis and the scatter visualization will not be able to provide Time dimensions. 

Set Number Dimensions to Discrete Axes in Analyzer

  1. Navigate to the /pentaho/server/pentaho-server/pentaho-solutions/system/karaf/config/web-client system directory and open the config.js file with any text editor.
  2. Locate the Example Rule 10 - Disable the continuous number strategy code block, as shown in this example:
    // Example Rule 10 - Disable the continuous number strategy, to revert
    // to the old behavior (Before 8.2) that represents Number dimensions in a discrete axis.
    /*
    {
      select: { module: "pentaho/visual/role/adaptation/EntityWithNumberKeyStrategy" },
      apply: { isBrowsable: false }
    },
    */ 
    
  1. Remove the /* marker and the */ marker to uncomment the EntityWithNumberKeyStrategy command.     
  2. Save and close the file, then refresh the browser.

Your line and area visualizations will display Number dimensions on a discrete axis and the scatter visualization will not be able to provide Number dimensions

Localization

Perform the following steps to create localized message bundles for Pentaho Analyzer:

  1. If the Pentaho Server is currently running, shut it down.
  2. Make a copy of the messages.properties file in /pentaho-solutions/system/analyzer/resources/; name the copy according to the standard locale naming scheme defined earlier in this section.
    cp messages.properties messages_fr.properties
  3. Translate the content of the new message bundle into the locale defined in its file name.
  4. Edit the messages_supported_languages.properties file in /pentaho-solutions/system/analyzer/resources/ and add the new locale.
    fr=Francais

You now have a translated Analyzer message bundle for the Analyzer interface, not the OLAP data sources you use with Analyzer. For schema localization, refer to Localization/Internationalization of Analysis Schemas. To localize all web-based components on the Pentaho Server, refer to Localize the Pentaho Server.

Assign Chart Colors

Clarify visualizations by assigning specific chart colors to data objects.

Learn more

Custom Action Links to JavaScript Functions

Configure Analyzer with custom action links that call out to JavaScript functions.

Learn more

Third-Party Visualizations

Integrate third-party visualization into the Pentaho Analyzer.

Learn more