Skip to main content
Hitachi Vantara Knowledge

Creating reports

The Custom Reports feature lets you use Pentaho Analyzer to create reports using Visualization Suite as the data source to create custom visualizations. The custom visualizations help provide your organization with additional operational insights. This article provides reference information that helps you understand how to create and export your reports to Visualization Suite.


After Visualization Suite has been set up to generate custom reports, you can create analysis reports and custom dashboards. The first step is determining the data that you want to analyze; for example, if your site needs to determine whether there is sufficient parking space near a local community event center, you can specify an entity type to use to collect traffic over different times of the day and peak periods, such as holidays.

After you determine the data to collect for reporting, you will establish a data source in the Pentaho User Console. The data source is configured to pull data from your Visualization Suite instance. Data is transferred into Pentaho Data Integration (PDI), then stored in PostgreSQL, and becomes available for visualization.

Once the data source is specified, you can identify the attributes you want to use for your custom report. For example, you can add Day of week and count attributes, and the format of the report (such as a line chart) in the Pentaho User Console. For report layout examples, see Visualizations for Analyzer.

The report that you create in the Pentaho User Console will be listed in the Custom Dashboards panel within Visualization Suite, as shown in the following image.


About the data fields

When entity types are flagged for Custom Dashboards, Visualization Suite adds select database columns to the PostgreSQL database in Pentaho. All columns shown in the Properties tab of each flagged entity type are transferred through Pentaho Data Integration and populated in PostgreSQL.

In the following example, the identifier for each attribute (key1, key2) listed in the Properties tab of Visualization Suite are listed in the Available fields list of the Pentaho User Console as Key1 attribute and Key2 attribute within the report layout.


If you want to create visualizations for the facial recognition alert events from Hitachi Live Face Matching, for instance, Custom Dashboards must be enabled on that entity type. Once enabled, all available fields for the Live Face Matching entity type then become available in Pentaho for creating visualizations (see Entity type management for more information about enabling Custom Dashboards).

In addition to the crime and event attributes, the following metadata fields are shown in the events_and_crimes table.

Column nameDescriptionRange
idEvent IDN/A
descriptionEvent descriptionN/A
source_id N/A
addressEvent addressN/A
nameEvent nameN/A
geohash N/A
latLatitude of the eventN/A
lonLongitude of the eventN/A
timestampTime data in UTC recorded timeN/A
yearTimestamp yearN/A
monthTimestamp month1-12
month_descTimestamp month descriptionJanuary, February, March, April, May, June, July, August, September, October, November, December
month_desc_shortTimestamp month description--abbreviations of the monthJan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec
dayTimestamp day1-31
day_of_weekTimestamp day of week1-7 (1 is Sunday and 7 is Saturday)
day_of_week_descTimestamp day of week descriptionSunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
day_of_week_desc_shortTimestamp day of week description - abbreviations of the days of the weekSun, Mon, Tue, Wed, Thu, Fri, Sat, Sun
hourTimestamp hour0-23
minuteTimestamp minute0-59
secondTimestamp second0-59

Before you begin

  • Within Entity Type Management, verify that the Enable Custom Dashboard option is selected so that it is available on the Pentaho sever. If it is not selected, then data for your custom Dashboard report will not be available.
  • Confirm that an entity type to use for data collection exists.
  • When creating custom reports, you will create a data source in the Pentaho User Console. Access to the Pentaho User Console requires administrator privileges.
  • For complete prerequisite and setup information, see Setting up custom dashboards.
Recommended Tutorials

For additional background information before working with the Pentaho User Console, dashboard, and reports, refer to the following recommended tutorials:

  • Tour of the Pentaho User Console -
  • Get Started with Analyzer Reports -
  • Get Started with Dashboard Designer -
  • Organize reports or dashboard with Pentaho User Console Home Browse Files. The Browse Files perspective helps you keep your files and folders organized and makes them easier for you to find and work with. See

Creating custom reports

For this procedure, you will create a data source in the Pentaho User Console from which you can specify the attributes you want to use for your custom report. Once the data source exists, you will create and configure your report, then verify the report is visible from the Custom Dashboards menu of Visualization Suite.

Example data for creating a custom report (to collect information about a public use center) is used in certain steps.


  1. Create a Data Source.

    1. Navigate to the following URL: http://{OVF IP}:8080/pentaho/Login

      NoteAccess to this URL assumes that Pentaho related customization and settings have been applied.
    2. Log in to the Pentaho User Console with administrator privileges.

    3. Create a data source: File Manage Data Source.

    4. Click New Data Source to launch the Data Source Wizard and specify the following.

      • A Name for the Data Source (for example, City People Counter)
      • A Type for the Data Source - select Database Table(s)
      • A database connection - select PostgreConnection
      • Check the box next to the type of data source for which you will be creating a report (Reporting only or Reporting and Analysis)
    5. Click Next.

    6. For the Select Tables option, select the advanced schema.

    7. Select the database table for the Entity Type that you created at step 1 from the Available Tables list and click > to move it to the Selected Tables list.

      The database table name should match the name of the Entity Type (for example, City People Counter).
      NoteIf you do not see the name of the database table that you want to use in the list, the likely cause is that in Entity Type Management, the Enable Custom Dashboard option is not selected. The selection of this option is required for this procedure.
    8. Select the Fact Table for the report, then click Finish.

      The data source is created.
    9. You can keep the default report format or you can customize it. Make a selection, then click OK.

      • If you chose to customize the report format, refer to the Pentaho documentation for setting details.
      • If you chose to keep the default report format, select the data source for the report, then click Close.
  2. Create a new report.

    1. From the Pentaho User Console, select File New Analysis Report.

    2. Select the data source you created at step 1.

    3. Click OK.

    4. Drag and drop the table attributes that you want to include the report.

      • The Level attributes typically correspond with Measures.
      • Key1, Key2, etc. attributes in Pentaho relate to the entity type ID property fields within Visualization Suite's Entity Type Management.
      • For report layout examples, see Visualizations for Analyzer.
    5. Click the Save As icon from the menu bar, and give the report a name and specify a location. Then, click Save.

      If you want to save the report to a folder, the folder must be created beforehand. You can also create a folder later, then copy and paste your report into it:
      1. From Browse Files, click New Folder.
      2. Name the folder, then click OK.
  3. Verify that you can view the custom Dashboard in Visualization Suite.

    1. Log in to Visualization Suite.

    2. Click Dashboard Custom Dashboards and verify that the custom report you created at step 2 is listed.