Set up reports

A dashboard report provides a format for the data supplied by a Data Dictionary. You can generate reports in interactive mode or snapshot mode. Once you create a Report, you can include it in a Dashboard.

To create a report, the following general steps are used:

  1. Provide information about the report, including a name and description, as well as a data dictionary.
  2. Select fields from the data dictionary you want to include in the report.
  3. Choose a design and specify design options.
  4. Choose a filter.

Getting started with a dashboard report

  1. On the Main menu, select Dashboard design > Report. A list of existing reports displays.
  2. Select the Add button icon green plus sign to create a new report. A new document opens and the Description tab displays.

Web Dashboard add report screen with empty fields

On the Description tab, enter values for the following fields:

Field Description
Name A unique identifier for the Report object.
Description A user-friendly label of your Report to be displayed across the GUI. The description can be internationalized (translated into the language defined for each user) using Internationalization tab.
Data dictionary

Select the data dictionary you want to use to retrieve data from the Sentinel database.

Version Version number of the object. Sentinel increments this number when the object is saved. Sentinel increments the correction number when the object is saved. This version number is used during XML export/import.

(Optional) Click More Details for access to advanced report configuration settings.

Field Description
Comment Add a comment to the report. The report users will be able to read this comment.
Rows per page The number of lines displayed on each page of the report.
Page layout Layout used for exporting to PDF.
Execution mode

Select the mode to execute the report:

  • Interactive: (Default value ) Query the database each time the report is displayed. Use interactive mode when you require a real-time view of the data.
  • Snapshot: Allows you to display reports based on a large amount of data in just a few seconds. In snapshot mode, Web Dashboard records a history of the data at set intervals. A typical use case would be to display a Dashboard every morning based on the data loaded during the night. You can use a specific Task to generate the snapshot Dashboard, which is persisted in form of an XML file. When a snapshot Dashboard is displayed, the data is read from the XML.
Entity The container with which the Report is associated.
Automatic filter validation Allows you to enable automatic refresh of reports and dashboards when you select a value from the filter pop-up. The filter pop-up should be fixed on the right or left side of the screen.

This option is enabled if the Display automatic filter validation checkbox check box from Administration > System preferences > Ergonomy is selected.

Show filter first

Use this parameter when there are one or more user prompt filters. In this case, the prompt is shown first when the Report is displayed, enabling the user to set the filter values.

Show comment on display Displays the comments when the Report is executed.

Add fields to a report

  1. Select the Field Selection tab to display a list of the fields you can include in the Report.

    Web Dashboard reports screen displaying field selections
  2. Select the fields you want to include in the Report. Any fields not selected will not be included in the Report.
  3. Field names are truncated if too long, but a tooltip always displays the full names of the fields.
  4. (Optional) If there are too many fields on the tab, use the text entry field at the top of the tab to filter the list. The filter is case-insensitive.
  5. (Optional) Add a calculated field. See Calculated field.

Design your report.

  1. Click the Design tab.
  2. Specify the various design options for your report. See Specify report design options.


  3. Web Dashboard reports screen with design tab selected

Calculated field

A calculated field contains a combination of functions, fields, and constants. For example, you can calculate the sum of two fields or divide a field by a constant.

  1. Use the add calculated buttons and to add calculated fields.
  2. Complete the following fields:
  3. Field Description
    Field name A unique identifier for the Field.
    Description A user-friendly name for the Field. This value will be displayed in the Report design tab.
    Field group The group with which the calculated field is associated. The default group is Calculated fields.
    Add Create a new calculated field.
    Operand type

    Select from the following types of calculated fields:

    • Function
    • Constant
    • Filled
    Type Select from a list of data types to be associated with a certain field.
    Value

    Select from a list of possible values for a file. Values listed here depend on the Operand Type selected above.

    Edit Modify the configuration of a calculated field by clicking the Edit button.
    Delete Removes the selected calculated field.
    Copy Left-click a calculated field to display the Copy option. By choosing this option, a copy of the selected calculated field is created. A unique name will be associated with the new field.

Related Links