Building and Managing Reports

Table of Contents

Create Reports

For information about CommCell Views, see CommCell Views.

Prerequisites

  • You must have the Developer License to use Build Your Own Reports. For more information, see License Requirements - Metrics Reports.
  • Your user account must be assigned to a user group that has the Report Management capability and is associated at the CommCell level with the CommCell computer that hosts the Web Server where the report is built.
  • If you want to build reports based on data from the SRM database, you must enable data cataloging for reports. For instructions, see the following:

Create a Table

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. At the top of the page, click New Report .

    The Build New Report page appears.

  5. Under Configure, in the Report Name box, enter a name for the report.
  6. In the Description box, enter a description of the information that will appear in the report.

    The text that you enter here will appear in the space below the report name on the Reports page.

  7. From the Select Data Sources list, select the data source where you want to run the report queries.

    You can select multiple data sources of the same type. To add other data sources to the list, see Add Data Sources.

  8. From the Select Database list, select the database where you want to run the report queries.

  9. To use tables or a SQL view, click the down arrow, and then select one of the following.

    • Table
    • View

  10. Next to Select Table/Select View, select the table or view that you want to use to generate the report.

    The table or view that you selected appears in the Query For Table Data box.

  11. To use your own query instead of a table or SQL view, in the Query For Table Data box, type your query.

  12. Click Verify Query.

    A message appears that says that the query verified successfully.

  13. If you don't want to add a chart, go to the Report Preview step.

Create a Chart

  1. If you want to add a chart, under Configure, select Chart.

    The Chart section appears at the bottom of the page.

  2. In the Chart Name box, enter a name for the chart.

  3. Next to Select View, select the type of chart that you want to include in the report.

    • Vertical Bar
    • Horizontal Bar
    • Line
    • Pie
    • Table

      This option displays a table of summary information instead of a chart.

  4. To include a summary table for data that appears in the chart, click Include Chart Summary Table.

  5. To use the existing table query for the chart, select Use Existing Table Query.

  6. To use your own query, select Create Custom Query, and then type your query in the box.

  7. Click Refresh Columns.

    Under Group-by and Value, column types appear in the Available list . Under Value, Count is automatically selected.

  8. Under Group-By, in the Available list, select a column type, and then click the right arrow button [>]. You can select only two column types. Selecting two column types allows you to create a stacked bar chart.

  9. In the Group-By Label box, type a label name for the column type.

  10. To change the column type, under Value, in the Available list, select a column type, and then click the right arrow button [>].

    The column type that you selected replaces Count. You can select only one column type.

  11. To include aggregate information in the Value, select Aggregates, and then next to the column type, select an aggregate type.
  12. In the Value Label box, enter a label name for the column type.

Preview and Save the Report

  1. Next to Report Preview, click the Generate Preview button .

    A sample of the report appears in the Report Preview section.

    Optionally, if you created a chart, you can configure the chart options as follows:

    • To display the bars in ascending or descending order, click Chart Toggle.
    • To change the color of the bars, click one of the color samples.
    • To change the view type, click a view type button.
      • Horizontal Bar Chart
      • Vertical Bar Chart
      • Pie Chart
      • Line Chart
    • To sort the contents in the table columns, click the column heading.
  2. At the top of the Build a New Report page, click Save.

    A message appears that asks if you want to continue editing.

  3. Click No.

    The Reports page appears with your report added to the list.

Share Reports

All users in the Master group can view all reports. To make a report visible for other users:

  1. At the top of the Build a New Report page, click Actions > Share Report.

    The Share Backup Schedule dialog box appears.

  2. In the Available Users/Groups list, select the groups and users that you want to be able to view the report, and then click the right arrow button [>].

    The groups and users that you selected move to the Selected Users/Groups list.

  3. Click OK.

Add Data Sources

You can add other CommServe databases or other types of databases to the data sources list.

  1. Next to Select Data Sources, click the Add Data Source button .

    The Add Remote CommCell/Remote Database dialog box appears.

  2. To add another CommServe database, select Add Remote CommCell.
    1. In the CommCell Host Name box, enter the name of the CommServe computer.
    2. In the Username and Password boxes, enter your login credentials for the CommServe Console on the CommServe computer.
    3. Your user account must be a member of the Master group in the CommServe computer that hosts the Web Console

  3. To add another type of database, select Remote Database.
    1. In the Database Type list, select the type of database that you want to add.
    2. In the Data Source Name box, type the name that you want to be displayed in the Select Data Sources list.
    3. In the Host box, type the name of the computer where the database resides.
    4. The default port number is automatically entered in the Port box.
    5. If you do not use the default port number, in the Port box, type the correct port number.
    6. Configure the database name.
      • For Oracle databases, in the Database/Instance Name box, type the TNS name for the database that you want to add.
      • For other types of databases and instances, in the Database/Instance Name box, type the name of the data base or instance that you want to add.
    7. In the Username and Password boxes, type your login credentials for the database or instance that you want to add.

  4. Click Save and Connect.

Supported Database Types

  • Oracle
  • SQL
  • MySQL

Limit User Access to Reports

You can limit the report information that users see by including some additional lines in both built-in queries and custom queries. When you include these lines, users who view the report will see data only from the CommCell clients that they have access to.

  1. In the Query For Table Data box, add lines that query from the UMUsers table, as shown in the following example:

    select C.name, C.net_hostname from APP_Client C, UMUsers U 
    where  dbo.isClientVisible(U.id,c.id, 0,0,0,0) = 1 
    and U.login ='<loginName>'

  2. Click Verify Query to test that the query works with user security.

View Reports

You must have the Report Management capability and a CommCell client association in order to view reports.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. Click the name of a report.

    The report appears in your Web browser.

Tag Reports

Use tags to organize the Reports page into categories that make sense for you. You can group reports based on any categories that you choose to create. Reports that are not tagged appear under the Untagged category. Tags created with Service Pack 7b or earlier are deleted when you install Service Pack 8. You must create new tags after you install Service Pack 8.

  1. Hover over the report icon, and then click the down arrow button .
  2. Click Tag.

    The Tag List dialog box appears.

  3. To add the report to an existing category, in the Add Tag box, select or type the name of a category that already appears in the Reports page, and then click Add.

    A tag is added for the category that you specified.

  4. To create a new category, in the Add Tag box, type the name of a category, and then click Add.

    A tag is added for the category that you specified.

  5. To delete the report from an existing category, next to the category name, click the delete button .

    The category tag is removed from the list.

  6. If you want all users to see the report in the categories that you specified, select Apply Tag changes to all users.
  7. Click Save.

    The report appears in the categories that are specified in Tags dialog box.

Edit Reports

You must be in the Master user group to edit reports.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. Hover over the report icon, and then click the down arrow button .
  5. Click Edit.

    The Edit Report page appears.

  6. Make changes to any of the settings, as needed.
  7. Click Actions > Save.
  8. Click No.

Delete Reports

You must be in the Master user group to delete reports.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. Hover over the report icon, and then click the down arrow button .
  5. Click Delete, and then click Yes.

    The report is removed from the Reports page.

Share Reports

You can also share reports from the Reports page.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. Hover over the report icon, and then click the down arrow button .
  5. Click Share.

    The Share Backup Schedule dialog box appears.

  6. In the Available Users/Groups list, select the groups and users that you want to be able to view the report, and then click the right arrow button [>].

    The groups and users that you selected move to the Selected Users/Groups list.

  7. Click OK.

Exporting and Importing Report Templates

If your CommCell computer is not connected to the Internet, or if some of your users access the Web Console using a different Web Server, you can still use and build reports by exporting and importing report templates.

Perform the following process to export and import report templates:

  1. On a computer that is connected to the Internet, either build a report or download a report from Download Center or Software Store. For information on building a report, see Create Reports. For information on downloading reports, see Download Reports from Software Store.
  2. Export the report template as an XML file. For instructions, see Export Report Templates.
  3. E-mail the XML file to a user with access to the CommCell computer.
  4. The user must import the XML file, or if you built a report, the user must save the XML file. For instructions, see Import Report Templates.

    Users can import report templates from the Worldwide or CommCell level, but the data that appears in reports is based on the data sources that are set in the report template.

Prerequisites

Your user account must be:

  • Assigned to a user group that has the Report Management capability.
  • Associated with the CommCell computer that hosts the Web Console.

Export Report Templates

You can either build a report or download a report from Download Center or Software Store, and then save it as an XML file to distribute to offline CommCell computers or remote users.

  1. Build a report or download a report from Software store.
  2. Log into the Web Console.
  3. Click Reports.

    The Worldwide Dashboard appears.

  4. At the top of the page, click Reports.
  5. Click the report.
  6. At the top of the page, click Actions > Export Template.
  7. Save the XML file.
  8. E-mail the report to a user or post it to a shared location on your network.

Import Report Templates

Import a report template in XML format to view the report on your Dashboard.

  1. Log into the Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. Go to the appropriate Dashboard.
    • To make the report available to all CommServe computers, go to the Worldwide Dashboard.
    • To make the report available to one CommServe computer, go to the CommCell Dashboard.
  4. At the top of the page, click Reports.
  5. Import the template.
    • At the Worldwide Reports level, click Import Template .
    • At the CommCell Reports level,  click Actions > Import Template.
  6. Specify the location where the report XML file is saved, and then click Open.

    The report template appears in the Edit Report page.

  7. Modify any settings, as needed.
  8. Click Save, and then click No.

    The report appears on the Reports page.

Publish Reports to Download Center

You can make reports that you build or download available to other users in your organization by publishing the reports to the Download Center on Web Console. You can publish a report directly after building the report, or you can publish any report that appears on your Web Console.

Prerequisites

Your user account must be:

  • Assigned to a user group that has the Report Management capability.
  • Assigned to a user group with the Download Center Management capability.
  • Associated with the CommCell computer that hosts the Web Console.

Publishing Reports

  1. For the report that you want to publish, go to the Edit Report page.
  2. At the top of the page, click Actions > Publish Report.

    The report appears in Download Center.

Deploy Reports for Offline Data Collection

If there are multiple CommServe computers in your Private Metrics Reporting environment, you can deploy any report that you create for offline data collection. Once deployed, your report is saved as a custom report query on the Private Metrics Reporting Server and downloaded by each CommServe computer. The query then collects and sends data back to the Private Metrics Reporting Server. When you view your report at the Worldwide level on Web Console, you see data from all CommServe computers in your environment. You can deploy a report for offline data collection directly after building the report, and you can deploy many other reports that appear on your Web Console for offline data collection.

About This Task

Columns created using the XML data type are not supported in reports deployed for offline data collection. If the report that you created contains an XML column, the query fails to execute and no data appears in the report.

Procedure

  1. For the report that you want to deploy, go to the Edit Report page.
  2. Under Configure, click Offline Data Collection via Metrics.
    • To collect report data for both version 9 and version 10 CommCell computers, select both Version 9 and Version 10.
    • To collect report data for only version 9 CommCell computers, select Version 9.
    • To collect report data for only version 10 CommCell computers, select Version 10.
  3. At the top of the page, click Actions > Deploy.

    The Save As Metrics Query dialog box appears.

  4. Set the number of days to retain collected data, and then click Yes.

    Data for the deployed report does not appear immediately. You must wait for the data collection process to complete before you can view report data. If you want to expedite the data collection process, use the Upload Now option in the CommServe computer where data is collected. For instructions, see Upload Data Now.

Advanced Settings

In all reports that you build, you can set the data refresh interval, report timeout, and hide the Data Source column. For instructions, see Advanced Settings.

Filter Table Data

Using the filter button, you can search for a specific piece of information in each column. Any entry that contains the search criteria that you enter appears in the table.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. Click on a report name.

    The report appears.

  5. Under Data, click the Filter button.
  6. In the boxes under the column headings, type your search criteria. For more information on entering filter criteria, see Filter Options.
  7. Press the ENTER key.

Filter Options

You can use the following operators to filter the data that appears in tables.

Operator Description Support
= equal to alphabetic and numeric values
< less than numeric values only
> greater than numeric values only
<= less than or equal to numeric values only
>= greater than or equal to numeric values only
&& and alphabetic and numeric values
|| or alphabetic and numeric values
!= not equal to alphabetic and numeric values
NOT LIKE not like

The string value must be surrounded by single quotes. Otherwise, the filter fails.

alphabetic and numeric values

Include and Exclude Columns

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. Click the Choose Columns button.

    By default, only the first 10 columns appear.

  5. Select the columns that you want to include in the table, and clear the columns that you want to exclude from the table.
  6. If you want to see the columns that you selected every time you view the report, then click Edit, configure the columns, and then click Save.

Add a V9 CommServe Computer to Report Data

In order to view data from V9 CommServe computers in Create Reports, you must make the v9 CommServe computer visible to the v10 Web Console. On the v10 CommServe computer that hosts the Web Console, configure the nAllowOlderClients additional setting in the CommServe Computer. For instructions, see Installing Clients from Previous Releases in the CommCell.

Set the Data Refresh Interval

Use the Data Refresh Interval setting to specify the amount of time that report data is cached on the Metrics Reporting Server. Once the Data Refresh Interval limit is reached, new report data is collected from the data sources. By default, the Metrics Reporting Server temporarily caches the report data for 15 minutes. If you want to collect the newest report data immediately, click the Refresh Now button.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. At the top of the page, click Settings .
  5. Click the Advanced Settings tab.
  6. In the Data Refresh Interval box, type the number of minutes that you want the system to wait before checking for new report data.
  7. Click Save Settings.

Set the Report Timeout

Use the Report Timeout setting to specify the amount of time reports are allowed to generate before timing out. For example, if a report contains a lot of data, then it might take a few minutes to generate. If reports take a long time to generate, you might want to increase the timeout length to allow the report generation more time to complete.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. At the top of the page, click Settings .
  5. Click the Advanced Settings tab.
  6. In the Report Timeout box, type the maximum number of minutes that you want the system to wait before timing out during the report generation.
  7. Click Save Settings.

Refresh the Report Data

Use the Refresh Now button to view the latest report data immediately, instead of waiting for the specified Data Refresh Interval. The Refresh Now operation forces the Metrics Reporting Server to delete all of its cached report data, and then collect new data from the data sources.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. At the top of the page, click Settings .
  5. Click the Advanced Settings tab.
  6. Click Refresh Now.

    The local cache of report data is deleted and new report data is retrieved from the CommServe computer.

Export to CSV

You can generate a CSV file of all tables in the report.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. Click the name of a report.
  5. Click Export > CSV.

    A copy of the report is downloaded to your computer. The download process might take some time, depending on the size of data in your report.

  6. When the download is complete, save or open the file.

Export to MHTML

You can export the entire report to MHTML.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. On the Reports page, click the name of a report.
  5. Click Export > MHTML.

    A copy of the report is downloaded to your computer. The download process might take some time, depending on the size of data in your report.

  6. When the download is complete, save or open the file.

Export to PDF

You can export the entire report to PDF.

  1. Log on to Web Console.
  2. Click Reports.

    The Worldwide Dashboard appears.

  3. At the top of the page, click Worldwide Reports.
  4. Click the name of a report.
  5. Click Export > PDF.

    A copy of the report is downloaded to your computer. The download process might take some time, depending on the size of data in your report.

  6. When the download is complete, save or open the file.