Configure Content Reports

Info: Content reports in Bloomreach Content require a standard or premium license. Contact Bloomreach for licensing details.

Overview

This page describes how to configure the Content reports application in Bloomreach Content.

The Content reports application provides reports on content usage and management within the CMS.

Configuration

All Content reports configuration is stored in the repository at:

/hippo:configuration/hippo:frontend/cms/hippo-reports

Each node under this path represents either a report or a report group. The node order determines the display order of reports within their group. To add or remove reports from the dashboard, add or remove the corresponding report configuration nodes.

Each report is rendered by a CMS plugin. Specify the plugin class using the plugin.class property in the report configuration node. The wicket.id property assigns the report to a group. Valid values for wicket.id include:

• service.reports.mydocuments
• service.reports.teamdocuments
• service.reports.totals
• service.reports.buzz

Some reports use facet navigation to retrieve data. All facet navigation nodes used by reports are located under /hippo:reports.

You can customize reports using configuration parameters and translations. Manage translations for reports with repository resource bundles. By convention, if a report is configured at:

/hippo:configuration/hippo:frontend/cms/hippo-reports/team-custom-report

the corresponding translation data is at:

/hippo:configuration/hippo:translations/hippo:reports/team-custom-report

Use clear and recognizable names for reports, such as 'team-recently-created' for a report listing recently created documents in the 'team' group.

Generic Report Configuration Properties

All reports support the following configuration properties:

• background
  Renders a grey background gradient behind the report.
  Possible values: true, false
  Default: false
• height
  Height of the report in pixels.
  Default: 340
• title.color
  Title color.
  Possible values: normal, highlighted, alert
  Default: normal
• title.size
  Title size.
  Possible values: normal, large
  Default: normal
• width
  Width of the report as a fraction (between 0 and 1) of the dashboard width.
  Default: 0.333

Report-Specific Configuration

This section describes configuration properties and translation keys for each report type.

Google Analytics Report

The Google Analytics report displays a column chart of unique website visitors, using data from Google Analytics.

Configuration options:

• days
  Number of days to display on the chart.
  Default: 7
• plugin.class
  Value: com.onehippo.cms7.reports.plugins.ga.GAPlugin

Translation keys:

• title
  Report title

This report uses account details configured at:

/hippo:configuration/hippo:modules/googleAnalyticsConfiguration/hippo:moduleconfig

Set the following properties:

• hippogoogleanalytics:username
  Google Analytics account username
• hippogoogleanalytics:privateKey
  Google Analytics account password
• hippogoogleanalytics:tableId
  Google Analytics Data Export API table ID. Retrieve this value from the Google Analytics Data Export API query explorer.

For setup instructions, see Add Google Analytics tracking to your site and the CMS.

Document List Report

The Document List report displays a list of documents from a hippo:resultset node. Typically, the documents are retrieved from a hippofacnav:facetnavigation node, which determines the documents and their order.

Configuration options:

• auto.expand.column
  Name of the column that should expand to fill remaining space. If omitted, all columns use fixed widths.
• columns
  Multi-valued string property listing column names to display. Names are case-sensitive.
  Possible values: createdBy, creationDate, lastModificationDate, lastModifiedBy, name, publicationDate
• facet.path
  Absolute path to a node with a hippo:resultset child node containing the documents to display. All occurrences of $user in the path are replaced with the current user's name.
• page.size
  Number of documents per page. Ignored if paging is disabled.
  Default: 10
• paging
  Enables or disables paging.
  Default: true
• plugin.class
  Value: com.onehippo.cms7.reports.plugins.documentlist.DocumentListPlugin

Translation keys:

• title
  Report title
• no-data
  Message displayed when no documents are available

Chart Report

The Chart Report displays either a column, pie, or bar chart. Chart data is sourced from a chart store. Two types of chart stores are supported:

• Facet chart store: Uses hippo:count values from a hippofacnav:facetsavailablenavigation node.
• Query chart store: Executes a query per sector to determine chart values.

Generic configuration options:

• chart.type
  Chart type.
  Possible values: pie, column, bar
• plugin.class
  Value: com.onehippo.cms7.reports.plugins.chart.ChartPlugin

Facet chart store configuration:

• store.class
  Value: com.onehippo.cms7.reports.plugins.chart.FacetChartStore
• facet.path
  Absolute path to a hippofacnav:facetsubnavigation node. Each child node of type hippofacnav:facetsubnavigation represents a chart column or pie sector. The hippo:count property determines its size. All occurrences of $user in the path are replaced with the current user's name.
• hide.untranslated.labels
  Hides facet names that are not translated.
  Possible values: true, false
  Default: false
  Not used for pie charts.

Query chart store configuration:

• store.class
  Value: com.onehippo.cms7.reports.plugins.chart.QueryChartStore
• sector.names
  Multi-valued string property listing sector or column names.
• sector.queries
  Multi-valued string property with XPath queries for each sector. All occurrences of $user in a query are replaced with the current user's name. The number of sector names must match the number of queries.

Translation keys:

• title
  Report title
• no-data
  Message displayed when all sectors have a value of zero
• <facet name>
  Each facet name from a facet chart store can be translated. Untranslated names display as-is unless hide.untranslated.labels is set to true.
• <sector name>
  Each sector name from a query chart store can be translated. Untranslated names display as-is.

Positioning the Content Reports Icon

The Content reports application is loaded from the configuration node:

/hippo:configuration/hippo:frontend/cms/cms-static/reportsPerspective

The node's position among its siblings determines the icon's placement in the CMS. By default, the Content reports icon appears above the Admin perspective.

Adjusting Existing Reports

Document list reports and some chart reports use data from a hippofacnav:facetnavigation node. You can adjust these reports by modifying the underlying faceted navigation configuration. The path to the facet navigation node is set in the report's facet.path property.

For example, to exclude specific users (such as an 'importer' user used by automated processes) from the 'top authors' report, add a filter to the relevant faceted navigation configuration:

/hippo:reports/facet-createdby:
  hippofacnav:filters: hippostdpubwf:createdBy != importer
copy

For more configuration options, see Configure Faceted Navigation.