1.9 Managing the Report Repository

This section provides instructions about managing the Repository in Identity Reporting page.

1.9.1 Viewing the Report Definitions

When you click Repository in the left navigation menu, the Repository shows the list of reports that have been imported into Identity Reporting.

For each report definition, the list shows the report name and description, as well as any tags that have been specified for the report. The reports that ship with the product include one version with both historical and current state information and one version with only current state information. The reports that include only current state information include “Current State” in the report name.

The Repository includes a special report called Template. This report is included as a subreport within other reports added to the system. It displays a header and footer in any report with which it is included. You cannot delete this report and you should not run it by itself. In addition, this report does not show a check box next to it in the list, because it cannot be included in bulk actions. When you edit the Template item, you do not see the Output Format, Default Notifications, Schedule, and Run Now controls.

Identity Reporting ships with a set of predefined reports. Import these into . After you import them, the reports are included in the list on the Repository page. You can define a new report by copying one of the predefined report definitions and giving it a new name.

For details about the predefined reports, see NetIQ Identity Reporting: User’s Guide to Running Reports.

You cannot create a new report from scratch on the Repository page. To create a new report definition from scratch, design the report layout outside of Identity Reporting, and use the Import facility to import the report into Identity Reporting.

Identity Reporting stores all report definitions, report schedules, and completed reports in the Identity Information Warehouse. These objects are stored in tables within the idm_rpt_cfg schema in the SIEM database.

1.9.2 Modifying a Report Definition

Click the name of the report definition in the list on the Repository page.

Alternatively, you can mouse over the report definition (or select the check box beside the name) and click Edit.

When you edit a report definition, a page displays to allow you to make changes to the definition.

The fields at the top of the page allow you to modify the name, description, tags, comments, and output format (PDF or CSV) for the report. Use tags to organize reports according to common words or phrases that suggest how the reports are related. Tag names share a common namespace for all users, so specify tag names that make sense for all users. Tag names cannot be localized.

You can specify one or more tags for a report definition. If you specify multiple tags, separate them with commas. Defined tags are shown in the list displayed on the Repository page, and in the Detail dialog box for a report listed on the Completed and Running Reports page. In the list displayed on the Repository page, the tags are alphabetized to allow for sorting.

NOTE:The next time you edit the report definition, the tags appear in alphabetical order, regardless of how they were originally entered. The tags are also alphabetized in the Repository list, even if you did not alphabetize them when you first entered them.

The other fields on the page are organized into the following sections:
- Criteria
- Default Notifications
- Schedule

To edit the criteria for the report, open the Criteria section and make changes as necessary.

The Criteria section does not appear unless the imported definition included one or more report parameters.

The number of fields displayed in the Criteria section and the way these fields behave depend on how they were specified in the original report definition object imported into Identity Reporting.

Identity Reporting supports the following data types for criteria fields:

String
String with Options
Date
Integer
Boolean
Lookup

The control displayed for each data type varies depending on how the parameter is defined in the report definition. For multivalued options, a multi-select control is displayed, but a single value control is displayed for a parameter that only accepts a single value.

Some criteria fields are required by the report definition, but others are optional. If you do not provide a value for a required field, the user interface displays an error message.

The following criteria parameters are available with most of the reports installed with Identity Reporting:

Parameter	Description
Data Source	Defines the data source on which you want to report. This parameter is required for all reports. To run a report on multiple data sources, copy the report and then select the desired data source when you define the report criteria for the copied reports. For information about copying a report, see Creating a Custom Report Definition Based on an Existing Definition. For a data source to be available for reports, you must first add it on the Data Sources page. For more information, see Managing Data Sources.
Language	Defines the target language for the report.
Date Range	Allows you to define a range of dates for the data included in the report. The following choices are available: Current Day Previous Day Week to Date Previous Week Month to Date Previous Month Custom Date Range
From Date	Allows you to specify a fixed start date for the report data. This parameter is only enabled if you selected Custom Data Range for the Data Range parameter.
To Date	Allows you to specify a fixed end date for the report data. This parameter is only enabled if you selected Custom Data Range for the Data Range parameter.
Limit Results	Controls the maximum number of rows that will be included in the report data.

If a report definition includes one or more fields for defining dates, such as Date Range, From Date, and To Date, be aware that the date range you specify affects the data returned with the report, not the dates on which the report is run. Therefore, if a report is run monthly, do not define a custom date range that fixes the dates in the From Date and To Date fields. It does not make sense for a monthly scheduled report to report on a fixed date range (such as 3/10/2017 - 3/17/2017). To report on a fixed date range, schedule the report to run only once. For a monthly report, use one of the relative date range settings included in the Date Range field, such as Month to Date. This ensures that the data in the report is updated each month.

Some criteria fields support automatic completion, which allows you to type several characters and then select an item from a list of possible choices. For example, an Identity Vault user(s) field might allow you to type the first few characters of a user’s name and then select the user from a list of users whose names contain the characters you have typed.

Some reports allow you to define the display name order used by other criteria fields that support the auto complete feature. For example, a report definition might include a Name order field that lets you specify the name order pattern used for the Identity Vault user(s) criteria field. The Name order field allows you to select one of the following name order patterns:

To edit the e-mail settings associated with the report definition, open the Default Notifications section and make changes as necessary.
To add a new schedule for the report definition, click the Add button on the far right side of the Schedule section.
1. Provide a name for the schedule in the Schedule Name field.
  
  The name for a schedule must be unique within the report definition, but does not need to be unique within Identity Reporting as a whole.
2. (Conditional) If you want the name of the report definition to be added to the beginning of the schedule name, select the Prepend Report Definition Name field.
  
  This option allows you to see which report has been scheduled with each schedule instance in the Calendar page. This option is enabled by default.
3. Click in the Start Date field to display a simplified calendar for selecting dates.
4. Select the date in the calendar on which you want to initiate the first run of the report.
5. Select the approximate time of day for each run in the Time of day field. The time of day is based on the clock on the server where the report is executed. The actual execution time depends on server activity.
6. In the Frequency field, type the repeat interval (a number that specifies how often the report will run) and select the time period for report runs, such as Month(s), Week(s), or Day(s).
7. Click in the End date field to display the calendar. Select the date in the calendar after which no more runs should occur. Note that the last report run may not actually occur on this date. For example, if you choose October 15 as the start date, and specify a repeat interval of two weeks and an end date of November 1, the report will be run on October 15 and October 29. In this case, October 29 is the last run.
8. If you want Identity Reporting to execute a data collection procedure prior to report generation, select the Attempt data collection before scheduled run check box.
  
  The report runs at its scheduled time, regardless of whether the data collection completed successfully.
To edit an existing schedule, open the Scheduled Run section for the schedule you want to edit and make any changes you like.
To save the report definition and schedule, click Save.
To queue a report to run immediately, click Run Now.

1.9.3 Creating a Custom Report Definition Based on an Existing Definition

To create a new report definition by making a copy of an existing report definition, mouse over the report definition (or select the check box next to the name) and click Copy.

The interface displays the report definition editing page with a message indicating that the new report was created. The name of the new report definition has a number appended to the name of the original report used for the copy operation.

After the editing page appears, you can make changes to the definition just as you would to any other report definition in the repository. Because the default report name is not very informative, change the name to something more meaningful.

1.9.4 Running a Report on Demand

To queue a report to run immediately from the Repository list view, mouse over the report definition (or select the check box next to the name) and click Run Now.

Startup process requires extra time before reports can be generated When you first start Identity Reporting, wait 5 minutes before running a report. The startup process consumes a lot of memory, leaving less memory for the report generation. If you do not wait 5 minutes, you might encounter memory errors.

1.9.5 Deleting a Report Definition

To delete a report definition, mouse over the report definition (or select the check box next to the name) and click Delete.

1.9.6 Performing Bulk Actions

To run (or delete) several reports at once:

Select the check box to the left of each report definition you want to run or delete.
Select the operation (Run Now or Delete) in the Bulk Actions drop-down list.
Click Apply.

Bulk actions apply to the current page only. If you select several items on one page, then navigate to the next page to select some additional items, a subsequent attempt to perform a bulk action such as Run Now or Delete only applies to the second set of items you selected. The previous selections are retained and still appear selected if you navigate back to the first page. However, the bulk action is not performed on these items.

1.9.7 Searching for Report Definition

To search for a report definition in the Repository:

Type a search string in the Search text field.

The search facility allows you to pass in search strings for any of the following items:

Filter Value	Description
Name	Performs a contains search. The search is case insensitive, and it uses the locale of the user.
Description	Performs a contains search. The search is case insensitive, and it uses the locale of the user.
Tags	Performs an exact string search. The search is case insensitive. Pass in a single tag only.

You can enter one or more words in the Search field, with or without quotes:

If you enter multiple words without quotes, the search results include reports that contain all of the words anywhere in the Name or Description, or that have all of the words as tags (that match exactly).

For example, suppose you enter the following:
```
identity users
```
In this case, the following report definitions are in the results:
- Reports with a Name containing the words identity and users anywhere in the string
- Reports with a Description containing the words identity and users anywhere in the string
- Reports with Tags having both identity and users as exact tags
If you enter multiple words surrounded by double quotes, the search results include reports that include the entire phrase anywhere in the Name or Description, or that have a tag that matches the entire phrase.

For example, suppose you enter the following:
```
"identity users"
```
In this case, the following report definitions are in the results:
- Reports with Name containing the phrase identity users.
- Reports with Description containing the phrase identity users.
- Reports with a Tag that exactly matches identity users.

Click Search.

You can clear the current search criteria and refresh the display by clicking Repository on the left navigation menu, or by emptying the Search field and clicking the Search button again.

1.9.8 Sorting the List of Reports

To sort the list of reports, click the header for the column on which you want to sort.

The pyramid-shaped sort indicator shows you which column is the new primary sort column. When the sort is ascending, the sort indicator is shown in its normal, upright position. When the sort is descending, the sort indicator is upside down.