11.3 Creating Custom Report Definitions from Report Templates

A custom report definition generates a custom report. You can generate custom reports by cloning and customizing an existing template in the Report Editor.

For example, you can start with the Users Report template if you want to generate a custom report that displays information about two different entities linked by an attribute (for example, roles and users). User is the primary entity in the Users Report. You can clone and customize this report to include a secondary entity, such as Role, and display data on all roles that have been assigned to a user.

To create this custom report definition, perform the following steps:

On the ACDI’s Home page, click Manage > Report Editor.
Select Users Report from the Search for Report Template drop-down list.

The ACDI Report Editor creates a clone of the selected report and assign it a new Report ID, Display Name, and Description.
Click Save As and specify a new Template Name for this custom report. For example, Custom User Role Report.
In the Report properties tab,
1. (Optional) Click the Add Tag configuration icon to add tags like custom to your report. Tags enables you to organize similar types of reports into a custom Reports sub-menu.
2. You can keep the existing values from the original report template or modify them as required. For more information about the parameters. see Table 11-1.
To add the secondary entity role to this report,
1. Click Entities.
  
  The Entity [0] tab displays information about the root entity snapshot from the original template. The Query to filter objectClass:inetOrgPerson specifies that this entity displays information about users from the OpenText eDirectory snapshot.
2. Click the Duplicate icon to copy Entity [0]. Now perform the following steps to customize the Entity [1] properties:
  1. Set the Name of the entity to role.
  2. Click Query to filter icon and enter objectClass:nrfRole. OpenSearch uses this query to filter the roles of users.
  3. You can keep the existing values of The DateTime filter, The Entity Index, and Entity primary key.
  4. Specify values for other fields as desired. For more information about the parameters. see Table 11-2.
3. Now to create a link, you must first determine a common attribute between the snapshot (user) and role entities. For the snapshot (user) entity, nrfmemberOf is an attribute that contains DN of roles assigned to a user, including those assigned via nested child role assignment. So, for the role entity, the nrfmemberOf attribute acts as the source entity and the DN as the source attribute.
  
  Perform the following steps to create a relationship between the two entities:
  1. In Entity [0] (snapshot),
    
    Click the Add Relation configuration icon.
    
    Set the Source Attribute to nrfMemberOf, the Relationship type to many, and The link query type to term.
    
    Click The Destination Entity and select The Destination Entity Name as role, Destination Attribute as dn, and The relationship type as one.
  2. In Entity [1] (role),
    
    Click the Add Relation configuration icon.
    
    Set the Source Attribute to dn, the Relationship type to one, and The link query type as Term.
    
    Click The Destination Entity and select The Destination Entity Name as snapshot, Destination Attribute as nrfMemberOf, and The relationship type as many.
4. Click .
To add filters for the role entity, click Filters and then add one filter at a time. For example, if you want to filter roles by CN in the report result table:
1. Click (Add Filter configuration)
2. Set the Name of the filter to Role CN.
3. Set ID of the filter, The Attribute Name filter based on, and Sort Attribute to cn.
4. Select the Data source to be opensearch and the Entity filter belong to as role.
5. Specify values for other fields as desired. For more information about the parameters. see Table 11-3.
6. (Optional) You can include more filters in your report definition. To add more filters, repeat Step 6.a to Step 6.e.
To add an attribute or column for the role entity, click Result Table Attributes. For example, to add a Role info column that displays role CN, name and description, perform the following steps:
1. Click (Add Attribute configuration).
2. To create a field for the role entity,
  1. Select the Entity name as role and enable the Use attribute for entity object option.
  2. Go to the Attribute tab, specify the Alias name for the attribute as Role info and Name of the attribute as entity_role.
  3. Specify values for other fields as desired. For more information about the parameters. see Table 11-4.
3. To add role CN to the Role Info column,
  1. Click (Add Attribute configuration).
  2. Select the Entity name as role and disable the Use attribute for entity object option.
  3. Go to the Attribute tab, specify the Alias name for the attribute as Role CN and Name of the attribute as cn.
  4. Specify values for other fields as desired. For more information about the parameters. see Table 11-4.
  5. To add the role CN, name and description to Role Info attribute,
4. Repeat Step 7.c.a to Step 7.c.e to add role name and description to the Role Info column.
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.