Configuration

ForgeRock Identity Reporting allows reporting administrators to customize the reporting experience with a few general, system-wide configurations. Administrators also have the option to import report bundles that contain single or multiple report definitions, allowing for simple migration from one environment to the next.

report configuration

Report Template

The Report Template section of the configuration allows an administrator to view, upload or remove a branding image used for PDF reports. Supported image formats are jpeg and png.

Upload New Logo:

  1. At the top of the dashboard page, in the navigation bar, select Report Template under Configure menu.

  2. Select Browse to open the Choose File dialog box and select an image to upload. The supported image formats are jpeg and png.

  3. Once a valid image has been selected, it will appear in the Selected Logo area for validation

  4. Select Upload to complete the upload process. The new logo will appear in the Current Logo area.

Delete Current Logo:

  1. At the top of the dashboard page, in the navigation bar, select Report Template under the Configure menu.

  2. Select Delete Current Logo. The image will disappear from the Current Logo area.

Email

The email section of the configuration allows an administrator to modify the contents of the email notification that is sent out with every scheduled report.

report email template configuration

Modify Email Notification:

  1. At the top of the dashboard page, in the navigation bar, select “Email” under the Configure menu.

  2. On the Email Template Configuration page, fill in each of the required fields. Additional details on the available fields are given below:

    • Subject. (Required) Subject of email notification

    • Type. (Required) Content-Type of email body can be set to text/HTML or text/plain

    • Body. (Required) Body of email notification

Report Bundle

The Report Bundle section of the configuration allows an administrator to import sets of pre-configured report definitions. The following guidelines can be used when creating bundles:

  • Report bundles are required to be .json files that contain a “reportDefinitions” array in a JSON string

  • The “reportDefinitions” array will contain one or more JSON objects that represent individual report definitions

  • Each object can specify all attributes available to a report definition (See Creating New Resource Definitions; however, they require the name and SQL attributes at a minimum. The data_source attribute may also be used to reference data sources that have already been created in the environment.

  • If a data_source is not specified in the object, the report definition will still be created in the system with an empty data source. This report definition will not generate reports until it has been manually updated and an appropriate data source is selected.

report bundle

Upload Report Bundle:

  1. At the top of the dashboard page, in the navigation bar, select “Report Bundle” under Configure

  2. Select Browse to open the Choose File dialog box and select an image to upload. The bundle must be a .json file and contain valid JSON syntax

    report bundle upload
  3. Once a valid bundle has been selected, contents will be loaded into the preview area for validation. The administrator will be able to navigate among multiple report definitions using the Previous and Next buttons.

  4. Select Upload to complete the upload process.