10.2 Creating a New Custom Report Definition

Using the NetIQ Users Report as an example, let us understand how this report definition has been created.

The NetIQ Users Report definition is based on eDirectory snapshots from the ACDI Snapshot Service, which are stored in OpenSearch. The report relies on the report-default index in OpenSearch to retrieve the required user data. The report definition includes predefined values for entities, filters, and result table attributes to display in the report result.

To create this report definition, perform the following steps:

  1. On the ACDI’s Home page, click Manage > Create New Report.

  2. To add a root entity to the report, click Entities and perform the following steps:

    1. Click (Add Entity configuration).

    2. In the Entity [0] tab,

      1. Click Query to filter icon and enter objectClass:inetOrgPerson. OpenSearch uses this query to filter the user data.

      2. Set the Name of the entity to snapshot, The DateTime filter to initDateStamp, and Entity primary key to dn.

      3. To add mandatory attributes, click (Add Attribute configuration) and enter the Attribute name. For example, enter dn to retrieve the Distinguished Name of the user entity from OpenSearch.

      4. Specify values for other fields as desired. For more information about the parameters. see Table 10-2.

    3. (Conditional) If you want to add secondary entities, click Add Entity configuration icon and repeat Step 2.a to Step 2.b.d.

  3. Click the Report properties tab,

    1. Specify values for display parameters such as Display Name, Description, and Color that will display on the report card.

      ACDI automatically assigns a unique Report ID to each report.

    2. Set The Main index name to report-default and The Main Entity name to snapshot. This serves as the data source for the report definition you want to create.

      NOTE:The Main Entity name field displays a list of entities created via Entities for selection. Make sure you first create the required entity.

    3. Specify values for other fields as desired. For more information about the parameters. see Table 10-1.

  4. To add filters, click Filters and then add one filter at a time. For example, perform the following steps to add the Container filter:

    1. Click (Add Filter configuration)

    2. Set the Name of the filter to Container.

    3. Set ID of the filter, The Attribute Name filter based on, and Sort Attribute to parent.

    4. Select the Data source to be opensearch and the Entity filter belong to as snapshot.

    5. Specify values for other fields as desired. For more information about the parameters. see Table 10-3.

    6. (Optional) You can include more filters in your report definition. To add more filters, repeat steps 4a to 4e.

  5. To add an attribute or column that is displayed in the report result table, click Result Table Attributes. For example, perform the following steps to add the Snapshot time column:

    1. Click (Add Attribute configuration).

    2. In the Attribute [0] tab,

      1. Specify the Name of the attribute as datestamp and Alias name for the attribute as Snapshot time.

      2. Specify values for other fields as desired. For more information about the parameters. see Table 10-4.

  6. Click the Save icon.

    The Save icon remains disabled until all fields have been validated without errors. You can click on the Validator icon to display a list of existing errors in your report definition.