Reports

A report defines how the data collected by a query is presented.

The default report is a tabular report that reflects the structure of the query, with each attribute displayed in a separate column. All presentation components of a tabular report (the column headings, for example) can be customized. All graphical reports are defined using the Report Builder. In addition to the start and from date (query to and query from) parameters, values can now be displayed between the beginning of the page and start of the table in all reports.

Before using the Report Builder, create a query using the Query Builder. See Using the Query Builder.

The fastest way to create and view a report is by using the steps to Create a Report, then select the report from My Dashboard.

Move back and forth between menu screens using the Back and Next buttons. The back arrow in the web browser does not work for navigation between Guardium® screens.

Icons used in Reports

Use icons to select functions within Report Builder.

Table 1. Report Icons
Graphical icons Function
Icon, Ad-hoc process for Run Once now

Ad-hoc process for Run Once now

Icon, Refresh

Refresh

Icon, open in a new window

Open or run in a new window

Icon, add a report

Add a report

Icon, add to favorites

Add to favorites

Icon, modify

Modify or Edit the query for this report or Customize chart

Icon, delete

Delete

Icon, Data Mart builder

Data Mart Builder

Icon, clone

Clone

Icon, configure runtime parameters

Configure runtime parameters

Icon, configure report columns

Configure report columns

<--

-->

<--

Customize report

Find a Report for Editing

To access a report definition, select the Reports lifecycle icon Reports iconand then click Report builder.

Search for a report by choosing Domain, Query or Report title. The results display in the Report Search Results panel.

  • To locate a specific report, select that report from the Report Title list. The selected report displays immediately in the Report Search Results panel.

    For the remaining types of search, click the Search button after making entries in one or more fields, or just click the Search button to list all reports available for your Guardium account.

  • To list all reports that use a specific query, select that query from the Query list.
  • To list all reports for a specific chart type, select it from the Chart Type list.

To locate a specific report, select that report from the Report Title list. The selected report displays immediately in theReport Search Results panel.

If the search locates any reports, they display in the Report Search Results panel. Click any of the following buttons:

  • New - See Create a Report.
  • Clone - See Clone a Report.
  • Modify - See Modify a Report.
  • Roles - See Security Roles. Assign roles to reports in Report Builder. Assigning roles to reports while in Query Builder (Tracking) assign only the role to the Query, not the report.
  • Delete- See Remove a Report.
  • Comment - See Comments.
  • API Assignment - See API Assignment
  • Drilldown Control - See Modify the Drill-Down Reports menu for a Report.

Create a Report

  1. To access a report definition, select the Reports lifecycle icon Report lifecyle icon and then click Report builder.
  2. Click New to open the Create Report panel.
  3. From the Query list, select a query value to be used by the report (for example, Guardium Logins)
  4. Enter a unique name for the report in the Report Title field.

Customize the Report Presentation

Follow the step procedures to customize the report presentation.

  1. In the Report Column Descriptions panel,
    • Optionally override the Report Title. The default is from the report definition. You can modify the title on most subsequent panels.
    • Optionally override any Column Description (the column headings).
  2. Click Next to open the Report Attributes panel:
    • Mark the Tabular or Chart button.
    • Click Next to go to the Submit Report panel.
  3. Click Save to submit the report for creation.

Create a Graphical Report

Follow the step procedures to create a graphical report.

  1. Follow the previous steps in Customize the Report Presentation for Report Column Descriptions, Report Parameter Descriptions, and Report Attributes.
  2. In the Report Chart Type panel, select the Chart type and click Next. The choices are Area, Bar, Bar Area, Bar Line, Column, Date Area, Date Column, Date Line, Distributed Label Line, Individual Bar, Individual Column, Line, Pictogram, Pie, Polar, Speedo, and Stack Bar. Pie, Polar, Speedo, and Stack Bar are recommended. Choose one and click Next.

  3. If the Report Chart Type panel is not displayed, skip this step (all necessary data has been entered). Select the type of chart for the report from the Chart Type list.
  4. Click Next to open the Report Presentation Parameters panel.
    • Review the parameters, which varies for each type of chart.
    • Optionally override any of the default settings for the chart type selected.
  5. Click Next to continue to the Submit Report panel, and continue with the Submit Report Definition procedure.
  6. To view your graphical report, go to My Dashboards, and add your graphical report.
Note:

A refresh icon appears in all graphical reports next to the help icon.

Submit Report Definition

  1. Optionally add comments (see Comments).
  2. Optionally assign roles (see Security Roles).
  3. Click Save.

Modify a Report

  1. Find the report to be modified. Go to the Report Builder finder menu.
  2. Click Modify Edit or modify iconto open the Report Columns panel.
  3. Continue with Customize the Report Presentation.

Clone a Report

  1. Find the report to be cloned. Go to the Report Builder finder menu.
  2. Click Clone Clone iconto open the Report Columns panel.
  3. Enter a new name for the cloned report, in the Report Title box. You can enter the new name on any of the subsequent screens - the only requirement is that the new name must be entered before the cloned report can be saved.
  4. Continue with Customize the Report Presentation.

Remove a Report

Be aware that you cannot remove predefined reports, and you cannot remove reports that are used in Audit Processes.

  1. Find the report to be removed.
  2. Click Delete Delete icon to remove the report.

Report Size Limitation

Tabular reports are limited to 5,000 rows of output, but when included in a workflow process, any number of rows can be exported from the report task to a CSV or CEF file. See Building audit processes.

Limits

The limit for the buttons when viewing a report (generate PDF, generate CSV, and printable) is 30,000 rows. This is non-customizable.

The limit for the Populate From Query in Group and Alias Builder when run via Run Once Now is 5,000 rows. This is non-customizable.

The limit for the Populate From Query in Group and Alias Builder when run via Scheduling is 20,000 rows. This limit is customizable, via the CLI command, show/store populate_from_query_maxrecs.

Modify the Drill-Down Reports Menu for a Report

By default, the drill-down menu for a report includes all reports with run-time parameters that can be supplied by attributes from the report, which is given the usual security role restrictions. To disable or enable any reports on the drill-down menu for a report:

  1. Locate the report. Go to the Report Builder finder menu.
  2. Click Drilldown Control to open the report’s Drilldown Control panel.
  3. Mark the checkbox for any report to be disabled, or clear the checkbox for any report to be enabled.
  4. Click Apply. The system displays a message saying your changes were applied successfully.
  5. Click Done when you are finished.

API Assignment

By default, the Guardium application comes with setup data that links many of the API functions to reports; providing users, through the GUI, with prepared calls to APIs from reporting data. Use API Assignment to link additional API functions to predefined Guardium reports or custom reports.

For more information on using linked API functions, see the documentation on GuardAPI Input Generation.

  1. Locate the report. Go to the Report Builder finder menu.
  2. Click API Assignment to open the API Assignment panel; showing the current API functions that are mapped to the selected report.
  3. Click an API function to display a pop-up window of the current API to Report Parameter Mappings; showing the API parameters, if the API parameters are required, any default values, and if any of the report fields are currently mapped to those parameters.

    If there are no fields in the report that are linked to API parameters, it might be irrelevant to link an API function to a report. The mapping of API parameters to report fields can be accomplished through both the GUI and the Guardium CLI. For additional information on mapping API parameters to report fields, see Mapping GuardAPI Parameters to Domain Entities and Attributes in the GuardAPI Input Generation section.

  4. Click the greater-than sign '>' to add the selected API function to the current list of functions that are assigned to this report.
  5. Click Apply to save the changes.

Open Query for Editing from Report Portlet

  1. Open a report portlet for any report that is based on the query to be edited.
  2. Click Edit this Report's Query Modify icon in the tool bar. You must be authorized to modify the query that the report is based on.