Report explorer

Applies to NAM 2019

In the NAM Server navigation menu, select DMI > Report explorer to open the Report explorer.

The Report explorer is a report management tool for NAM administrators. Use it to analyze NAM reports in terms of popularity and system load, and to manage your reports accordingly. In addition, you can manage favorites, home pages, and shared links for multiple users or user groups, and analyze usage for users and user groups.

Report maintenance

Report usage and performance

User activity and access

Report queuing priority and penalty points

Filters, find, and perspectives

Using filters

In the left column, set any combination of filters to focus on your current interest.

Filters are persistent:

  • You can select a user in the Users filter, for example, and then switch to other perspectives with focus remaining (where applicable) on the selected user.
  • If you don't see what you expect to see, make sure you have cleared filters you no longer need. There is a Clear all filters button at the bottom of each filter section.

Using find

Use the Find search box (and column selection list) at the bottom of the table to filter the table in a number of ways. For example, in the reports perspective:

  • To show reports that were run at least once during the report time range, enter >0 (greater than zero), select Hits >> Total, and select Find.
  • To show reports that were not run at all during the report time range, enter ~>0 (not greater than zero), select Hits >> Total, and select Find.
  • To show reports that match a Boolean condition, enter true or false in the box, select the conditional column, and select Find.

Using perspectives

In the upper-right of the table, switch perspective to a different perspective of your reports.

Managing reports

For basic report management activities, use the reports perspective (the default setting).

  • To move a report to a different dashboard section, select the report in the Report column and select Move this report to different section. A Section panel lists available sections. Select the section to which you want to move the report.
  • To edit a report definition, select the report in the Name column and select Open report definition.
  • To export a report definition to XML, select the report in the Report column and select Export report definition.
  • To delete a report, select the report in the Report column and select Delete this report.
  • To manage reports by dashboard section, select Show details at the bottom of the table, then click an entry in the Dashboard section column and select a menu option:
    • Show reports from this dashboard section
    • Delete this dashboard section
    • Export definitions of all reports in this section
      For additional activities related to dashboard sections, switch to the dashboard sections perspective.

Additional report procedures:

Explore reports table

Select Show details at the bottom of the table to display additional columns (and select Hide details to return to the default columns)

Select ... at the bottom of the table to open a menu of additional commands:

  • Show favorites only - to list only the reports that have been favorited.
  • Show home pages only - to list only the reports that have been set as a home page.
  • Show unused only - to list only the reports that have not been used.
  • Move reports - to move all listed reports to another section. The Section panel opens for you to select the target section.
  • Favorite reports and Unfavorite reports - see Managing favorites for details.
  • Allow access to reports and Block access to reports - see Managing report access for details.

Managing dashboard sections

To manage reports by dashboard section, use the dashboard sections perspective.

  • To list reports in a dashboard section, select that section in the Dashboard sections filter and select Show details at the bottom of the Explore dashboard sections table.

  • To delete one dashboard section and all reports in that dashboard section, select the dashboard section and select Delete this dashboard section.

    Caution

    This command deletes the selected dashboard section and all reports in that dashboard section. If you don't want to delete reports in the dashboard section, move them somewhere else before you delete the dashboard section.

  • To export the definitions of all report in a dashboard section, select a dashboard section and select Export definitions of all reports in this section.

  • To delete all listed dashboard sections and all reports in the listed dashboard sections, select Delete selected sections from the ... menu under the table.

    Caution

    This command deletes all listed dashboard sections and all reports in those dashboard sections. For example, if you delete three dashboard sections with 10 reports in each dashboard section, you delete 30 reports with those sections. If you don't want to delete the reports in the listed dashboard sections, move them somewhere else before you delete the dashboard sections.

  • To see statistics for dashboard sections, select Show details at the bottom of the Explore dashboard sections table.

Explore dashboard sections table

The dashboard sections perspective lists all your dashboard sections, which are the sections displayed on the All dashboard reports tab of the NAM Server dashboard.

Select Show details at the bottom of the table to display additional columns (and select Hide details to return to the default columns)

Managing favorites

Favorited reports are displayed on the Favorites tab of the NAM Server dashboard.

In the reports perspective, icons indicate that a report has been favorited NAM: Report explorer: favorited or unfavorited NAM: Report explorer: unfavorited.

  • A black star is a direct favorite (the report has been favorited for at least one selected user).
  • A gray star is an inherited favorite (the report was not favorited by any selected user but is favorited for at least one of their groups).
  • A crossed-out star is an unfavorited report (it was unfavorited by at least one selected user and not favorited by any other users or their groups).

Select an icon to see a count.

User favorites

Switch to the reports perspective to manage user favorites:

  • To see which users have favorited a report, select the Favorites total for that report and then select Show users favoriting this report. A panel is displayed to list all users who favorited the selected report.
  • To favorite a report for selected users, select the users in the Users filter, select the Favorites total for that report, and select Favorite this report for selected users.
  • To unfavorite a report for certain users, select the users in the Users filter, select the Favorites total for that report, and select Unfavorite this report for selected users.
  • To unfavorite a report for all users, clear all selections in the Users filter, select the Favorites total for that report, and select Unfavorite this report for all users. If this option is not displayed, the selected report has not been favorited for any user.

Group favorites

  • To list all groups for which a selected report is a favorite, select the Favorites total for that report and select Show groups favoriting this report.
  • To favorite a report for certain groups, select the groups in the Groups filter, select the Favorites total for that report, and select Favorite this report for selected groups.
  • To unfavorite a report for selected groups, select the groups in the Groups filter, select the Favorites total for that report, and select Unfavorite this report for selected groups.
  • To unfavorite a report for all groups, clear all selections in the Groups filter, select the Favorites total for that report, and select Unfavorite this report for selected groups. If this option is not displayed, the selected report has not been favorited for any group.

Managing home pages

When you select Set as home page from a report menu, NAM links the current report to the Home breadcrumb at the top of the NAM Server screen.

In the reports perspective, the icon NAM: Report explorer: home page indicates a report that has been set as a home page.

  • A black home icon indicates a report set as home page by at least one selected user.
  • A gray home icon is inherited: the report was not set as home page by any selected user, but it is set as the home page for at least one of their groups.

Select the icon to see a count.

User home pages

Switch to the user home pages perspective to displays all pages that someone has selected as their home page.

Select Show details at the bottom of the table to display additional columns (and select Hide details to return to the default columns)

  • To see which users have a report set as their home page, switch to the reports perspective, select a Home pages total for a report, and select Show users with this report as home page.
  • To set a certain report as the home page for selected users, select the users in the Users filter, switch to the reports perspective, select the report, and select Set as home page for selected users from the pop-up menu.
  • To set a report so that it is not the home page for any user, switch to the reports perspective, select the report name, and select Reset home page to default for all users. If this option is unavailable, no one has made the selected report their home page.

Group home pages

To set a report as the home page for certain groups, select the groups in the Groups filter, switch to the reports perspective, select the report, and select Set as home page for selected groups.

To explore group home pages, switch to the group home pages perspective, which displays all pages that have been selected as the home page for a group (and therefore the home page for everyone assigned that group).

Select Show details at the bottom of the table to display additional columns (and select Hide details to return to the default columns)

In to the group home pages perspective:

  • To open a group home page, select the home page and select Go to this home page.
  • To remove a home page selection for a group, select the home page and select Delete this home page.

When you select Get link to report from a report menu, NAM stores an image of the report and generates a link you can share with others. Images and links are valid for up to 10 days or until storage space runs out.

The reports perspective displays the icon NAM: Report explorer: shared to indicate a report that has been shared. Select the icon to see a count of how many people have shared that report.

The shared links perspective displays all such shared links. Use it to see what pages people are sharing (a possible indicator of popular reports) and to find and delete unneeded shared links (to clean up storage).

Use the shared links perspective to manage shared links:

  • To open a shared link, select the Link ID for that shared link and select Go to this shared link.
  • To list only unused shared links, select Show unused links. An unused shared link was shared but no one used the link to view the linked report.
  • To list only the shared links to a certain report, select that report in the Report column and select Focus on this report.
  • To list links shared by a certain user, select that user in the User name column and select Focus on this user.
  • To delete one shared link, select the Link ID and select Delete this shared link.
  • To delete all links shared by a certain user, select that user in the User name column and select Delete all shared links created by this user.
  • To delete all shared links to a certain report, select that report in the Report column and select Delete all shared links for this report.
  • To delete all displayed shared links, select Delete selected shared links. This deletes all shared links currently displayed. Links not currently displayed due to filtering will not be deleted.

Managing users

Switch to the users perspective to review user activity and identify users putting the most load on the system. By default, the Explore users table shows active users.

Select Show details at the bottom of the table to display additional columns (and select Hide details to return to the default columns)

  • To list all users (including inactive users), select Show inactive users. (To list only active users again, select Show only active users.)
  • To see details on one user, select the user's Login.
  • To list all reports created or modified by a user, select Show details at the bottom of the table.
    • Select the user in the Creator column to select Show reports created by this user.
    • Select the user in the Modifier column to select Show reports last modified by this user.
  • To manage user favorites, see Managing favorites
  • To manage user home pages, see Managing home pages
  • To manage user access to reports, see Managing report access

Managing groups

Expand the Groups filter on the left and select one or more groups to issue group-specific commands.

Managing report access

Switch to the reports perspective and set one or more filters (Users, Groups, or Roles) to manage access to certain reports.

Note

Certain user roles always have access to all reports.

  • System administrator
  • Reporting administrator
  • Reporting power user

Report explorer will display a message to let you know if you try to block access to people who have any of those roles (either assigned directly to them or inherited through group membership). In this case, the only way to block their access to reports is to remove those roles from their accounts (again, either directly or by changing their group membership) and then block their access.

If a menu option is unavailable:

  • Make sure you have set the relevant Users, Groups, or Roles filters to indicate who you want to manage access for.
  • The option may already apply to the selected users, groups, or roles.
    For example, if a user already has access a report, the option to give access to that user is not displayed.
  • To list all reports that certain users, groups, or roles have access to, set the filters to select those users, groups, or roles.
    • The open lock icon indicates that the report can be accessed by the selected users, groups, or roles.
    • The closed lock icon indicates that the report cannot be accessed by the selected users, groups, or roles.
  • To block or allow access to a single report:
    1. Select the users, groups, or roles in the filters. This action will apply to all users, groups, or roles that match your filters.
    2. Select the report and select the Block access... or Allow access... option from the menu.
      Repeat this step as needed per report.
  • To block or allow access to multiple reports:
    1. Filter the Explore reports table to list the reports you want to manage. This action will apply to all reports that match your filters.
    2. Select the Block access... or Allow access... option from the menu at the bottom of the table.
      The Users panel is displayed. You can switch the perspective for this panel to Groups or Roles as needed.
    3. Select a user, group, or role and select the Block access... or Allow access... option from the menu.
      Repeat this step as needed per user, group, or role.

Data access permission (DAP)

A report that is DAP-ready is indicated by a shield icon in the report perspective of the report explorer.

Use the Data access permission page (Security > Data access permission) on the NAM Server to enable data access permission of NAM reports for NAM Server users and user groups.

When data access permission is enabled, you can use the Users (Security > Users) and User groups (Security > User groups) pages on your NAM Server to set data access rights for users and user groups based on the Filtering dimension you selected (Application or Software service) for data access permission.

Report queue priority and penalty points

For general information on the report queue, see Report queue.

Penalty points are assigned to resource-intensive reports and to users who run resource-intensive reports.

  • Reports with higher penalty points get a worse position in the queue for generating reports when multiple reports are generated at the same time.
  • Users with higher penalty points get a worse position in the queue for generating reports when many users generate reports at the same time. (This does not apply to users who have been assigned the Reporting user - high load user role. Those users skip queueing based on penalty points.)

The reports perspective shows the following related statistics:

  • Report generation time - average time it takes to generate the report. Select Show details to see statistics for average, maximum, and total report generation time.
  • Penalty points - processing time and resource consumption may add penalty points to a report, which affects how this report will be queued when multiple reports are being requested simultaneously. Efficient reports get priority (unless the user is assigned the Reporting user - high load role). Select Show details to see statistics for average, maximum, and total report penalty points.
  • Wait time in queue - how long a report waits before processing starts. Select Show details to see statistics for average, maximum, and total report wait time in queue.
  • Avg user rank - rank relative to other users.

Ideally, the penalty points, wait time, and average user rank will be zero, indicating that there are no resource-intensive reports affecting the performance of the NAM Server.

Analyzing reports

To analyze report, you can start with general report indicators in the reports perspective:

  • To see which reports are responsible for the most or least of something, select a column heading to sort on that column.
  • To see which reports people like, share, and set as their home page, check the icons in the reports perspective:
    • NAM: Report explorer: favorited - The star icon indicates a report that has been favorited. Select an icon to see a count.
    • NAM: Report explorer: unfavorited - The star icon with a line through it indicates a report that has been unfavorited. Select an icon to see a count.
    • NAM: Report explorer: home page - The home icon indicates a report that has been set as a home page.
    • NAM: Report explorer: shared - The link icon indicates a report that has been shared (someone selected Get link to report from that report's menu). Select an icon to see a count.

For a deeper analysis of a report, you have a couple more options:

  • Click a report and select Analyze this report in DMI performance diagnostics to open the DMI performance report on the selected report.
  • Click a report and select Analyze this report to display the Report explorer report analysis described below.

Report explorer report analysis

The Report explorer report analysis displays a Report generation time chart and a Report usage table.

  • To focus the analysis, set the Users, Groups, and Roles filters.
  • Watch the breadcrumbs at the top of the analysis page to keep track of which report you are analyzing and which filters are set.

Report generation time is a chart of how many times the report was used and how much time it took to generate the report. To compare report generation time to other metrics, change the perspective setting (vs) for this chart:

  • hits: average generation time, canceled hits, processed hits
  • penalty points: average generation time, average penalty points
  • user rank: average generation time, average user rank
  • queue wait time: average generation time, average wait time in queue
  • modifications: average generation time, number of modifications
Analysis tip

If generation time or penalty points increases for a report, switch to the modifications perspective here to see whether changes to the report may have been the cause.

Report usage is table of report usage with perspectives for a summary or individual hits.

  • Use the Find box and the associated list to filter this table by various criteria.
  • The summary perspective displays cumulative totals. Select a time to:
    • Show individual hits: switches to the individual hits perspective for the selected time.
    • Analyze report usage within time range: focuses the analysis on the selected time.
    • Analyze section performance in DMI query performance report: opens the DMI query performance report, Section tab, in a new browser tab for a section-by-section performance analysis of the selected report.
  • The individual hits perspective displays statistics on each hit for the report. Select a User name or NAM Server to focus your analysis on the selected user or NAM Server.