This topic describes the components of a NAM report and what you can do with them.
If you are ready to start using NAM reports, see NAM workflow to walk through some typical analysis procedures.
Finding the right report
- You can browse the Reports menu (NAM Server ► Reports ► ...) to look for a report by category:
- You can open the NAM Server dashboard to get quick access to important general reports:
Don't forget to use the Favorites tab of the dashboard to get instant access to your favorite reports.
- You can search for the topic or data you want to see:
- You can open NAM Server ► Tools ► DMI ► Manage reports to browse or search through all reports (standard or customized) and access report-related commands such as scheduling and mailing.
If you're working on a tablet device, see Mobile APM for help on maximizing your experience.
When you start using NAM Server, open a report and have a look at the report menu:
A typical report menu shows the following options.
Updates the current report display (if there is applicable new data).
To refresh your report automatically, select a refresh interval from the Autorefresh menu in the upper right of the report.
Opens the current report definition for editing in DMI.
- If you are totally new to NAM Server reports, you should probably stay away from the DMI editor until you are familiar with using existing reports. The dashboard is a great place to start browsing standard reports and familiarizing yourself with their capabilities.
- If you feel you are ready to edit existing reports or create new ones, try New report for a quick intro to making a report.
Saves the report definition (query conditions). Those conditions are used to regenerate the report with fresh data every time you reopen the same report.
- If you have not edited the report definition, you don't need to save it.
- If you want to save a copy of the current report definition and then edit the copy, choose Save, give it a different name (so you don't overwrite the current report definition), and then open the copy for editing. (Functionally, this is Save As.)
Save as PDF
Creates a snapshot of the current report in PDF format that you can view offline, send to someone else, or print.
- You may need to allow popups in your browser.
- If your report has multiple tabs, you need to make a different PDF for each tab.
Export report data
Dumps the current report's data to a new browser window in comma-separated values (CSV) format. You can copy and paste the data from there into another application.
Any filters you apply to the report are reflected in the exported data. (For example, if you filter a 100-row table down to 5 rows, only those 5 rows will be exported, not the entire unfiltered table.)
Export report definition
Dumps the report definition (in XML format) to a new browser window. To use it, save the definition as an XML file
You can copy, edit, and paste the definition to another report server. For more information, see Export Import.
Send by e-mail
Sends a static copy of the currently displayed report. Enter your e-mailing instructions in the pop-up window. You can select a recipient from the drop-down list of available recipients or type an e-mail address in the To field. The report will be sent as an attachment in PDF format.
Important: This option is active only if SMTP mail server information has been configured and enabled. See Mailer setup for more information.
Turns the section edit menus on or off.
Keyboard shortcut: CTRL+ALT+SHIFT+E
Set time zone
Enables you to select a server time zone from a menu.
Set as home page
Links the current report to the Home breadcrumb at the top of the NAM Server screen.
Enter full screen
Hides the NAM Server menu bar and displays the day/night toggle control:
Keyboard shortcut: CTRL+ALT+SHIFT+F
Shows report-specific help.
Get link to report
Select Get link to report from a report menu to open a Link to the report window and generate a link to the report.
Click Copy in the Link to the report window to copy the link to your clipboard and share it with others.
- The link can be accessed by a user with the right to write reports.
- The link is valid for 7 days or until a lack of disk space forces deletion.
In addition to a report menu, every report section (by default) has a section-specific menu for every report section:
A typical report section menu shows these options:
Export section data
To export report data in CSV (comma-separated values) format, choose Export data from the section context menu.
The CSV data is displayed in a new browser window from which you can copy and paste it to another application (a text editor, for example).
Most NAM Server reports have multiple sections. If you want to refine a report, you can modify any or all of its sections.
To open a single report section for editing, choose Edit section from the section context menu.
Offers a screen of display options applicable to a chart section.
There are keyboard shortcuts for quick access to some report features.
Hides or displays the section context menu icons for all sections on the report.
Hides or displays report debug information (such as a report time stamp) in the footer.
Hides or displays the top menu bar. While in full screen mode (top menu bar hidden), you can also use these buttons
to switch between the day (white background) and night (dark background) display modes.
Click any column header to sort a table by that column. Click the same header again to reverse the sort order.
The sort-by column and the sort direction are indicated by a triangle icon in the column header:
In this example, the table is sorted by Client IP address and in ascending order:
To instead sort by user name, you would just click the User name header.
Use the Find box at the bottom of a table to filter the table on the selected column.
The simplest filter is a string search. You can search on a full or partial string, and you can asterisks as wildcards.
j*pi*r would all match on jupiter.
Be sure to select the column before clicking the Find button.
Filtering items by numeric value
You can enter an exact value (for example, 0 to show just the rows with the value 0 in that column) or you can use relational operators:
> Xmeans all values greater than X.
>= Xmeans all values greater than or equal to X.
< Xmeans all non-negative values less than X.
<= Xmeans all non-negative values less than or equal to X.
For example, to filtered the table to show only the rows where the value in the Availability column (selected in the list) is greater than 90.
To remove the filter, click Reset.
To specify a range, use two values separated by a hyphen. In this example, we show all rows where the value in the Availability column is between 90 and 95.
Using suffixes to indicate units
You can use suffixes for numerical values.
80k is equivalent to
You can not use relative percentages. Bad example:
>0.85% is not valid.
Including special characters
Use a backslash “\” as an escape character before the following special characters:
- space, if it occurs at the beginning or end of the search string
- asterisk (
- backslash (
- ampersand (
- vertical bar (
For example, to search for the user name
lab\dtwlib4m you must type
lab\\dtwlib4m with a double backslash in the Find field to avoid a search error.
Use '|', '&', and '~' as OR, AND, and NOT operators to filter on multiple terms.
Customizing the reports menu
If you have write access to the NAM Server files, you can edit an XML file to create a custom report menu.
There are three basic steps required:
- Editing the custom menu
- Hiding the standard reports menu
- Reloading the menu configuration
Editing the custom menu
On the NAM Server, in the
config\menu folder, open
customMenu.xml-example in a text editor and review how the menu is defined by this XML structure.
<Menu xmlns='http://www.compuware.com/CAS/customMenu'> <MenuSection label="My Reports"> <MenuEntry reportName="Application Health Status"/> <MenuGroup label="EUE Overview" label_zh-cn="EUE 概述"> <MenuEntry reportName="Applications" /> <MenuEntry reportName="Tiers" /> <MenuEntry reportName="Sites" /> </MenuGroup> <MenuEntry reportName="Synthetic Overview"/> <MenuGroup label="Network Analysis"> <MenuEntry reportName="Network Overview - Sites"/> <MenuEntry reportName="Network overview" label="Network overview"/> <MenuEntry reportName="Network Link Overview" /> <MenuEntry reportName="VoIP Overview" /> </MenuGroup> </MenuSection> </Menu>
To customize the menu structure, you need to edit that file and save it as
customMenu.xml in the same folder.
Hiding the standard reports menu
After you edit and save the custom menu in the XML file as described above, you must decide whether to also show the standard Reports menu or hide it.
- Open the NAM Server menu.
- In the Tools section, select Admin console.
- In the Administration console, in the Configuration management column, click General properties editor.
- Find MENU_REPORTS_HIDDEN and set it to true.
If it does not exist on your system yet, you will need to add it and set it to true.
Reloading the menu configuration
After the menu is edited and saved in the right folder, and after you have set MENU_REPORTS_HIDDEN to true or false, you must tell the NAM Server to read this information from the configuration files and apply it.
- Open the NAM Server menu.
- In the Tools section, select Admin console.
- In the Administration console, in the Diagnostics column, click Commands console.
- Find MENU RELOAD and click it to run it.
This reads your changes from the file.
You can see NAM Server lower-level reports through links incorporated in some entity names (such as software service names) and in numeric data in some report columns (such as the Unique users or Errors columns).
Such links are easy to find by moving the mouse pointer over the report table: if a given name or number is underlined while the cursor is hovering over it, it is a link to another report. For example:
- A software service name may link to a server report.
- A server name may link to an operations reports.
- A module name may link to a task report.
- A region name may link to an area report.
- An area name may link to a site report.
- A count of users, clients, or hosts may link to a user report.
- A count of errors may link to an errors report.
The drilldown reports enable you to modify the level of detail on your report. For example, if you choose the Software Services report from the top menu, then click the name of a software service in the Software service column, and then, already on the lower level report, click a particular server name in the Server column, you will get the Operations report for a selected server and, at the same time, also for the selected software service.
Opening drilldown links in a new tab
In some columns, when you hover over a drilldown link, the browser right click context menu will not display the option to open the link in a new tab or window. In such cases, press the
[Ctrl] key when clicking the link to open the report in a new tab, or press the
[Shift] key to open it in a new window.
The Metric charts reports are available in a number of contexts and differ according to context.
Metric charts show measurements for a selected entity, such as a software service or a tier. Charts are used to enable quick comparison and analysis of the selected data.
Depending on the context and analyzer type, these reports can consist of several sections such as:
- Custom metrics
Some of these sections are additionally divided into tabs showing:
- The most significant metrics and their values for the current day (Metric charts report)
- The most significant metric baselines and their values for the current day (Metric baselines report)
- The most significant metrics with their baseline values for the current day (Metrics with baselines report)
A single chart may display more than one metric.