Cisco Prime Home User Guide, 5.1
Chapter 7: Reports
Downloads: This chapterpdf (PDF - 0.99 MB) | Feedback

Table of Contents


Built-In Reports

Running an Aggregate Report

Custom Reports

Reports Tab

Finding an Existing Report

Running an Existing Report

Custom Reports

Creating a Custom Report

Working with Sort Order

Working with Filters

Applying Parameters

Editing Parameters

Using Boolean Logic

Working with Advanced Syntax

Using Reports to Understand Your Network


Prime Home includes a customizable reporting tool with standard reports, exportability, and analysis. Reports can provide information about devices and subscribers across your entire installed base in a unified fashion. This information enables you to take preventive measures when support issues occur.

You can collect snapshot data and see just that moment in time, or you can continually export and aggregate data to study trends over time. Report results can be saved in comma-separated value (CSV) format and from there can be translated into graphs or spreadsheets, or opened with other tools such as Microsoft Excel or Crystal Reports.

Reporting is an optional, subscription-based product that is enabled with a license key.

Built-In Reports

Prime Home comes with five built-in reports:

  • Device Count by Firmware Version
  • Device Count by Manufacturer and Model
  • Device Count by Label
  • Subscriber Count by Label
  • Device Count by WAN Interface

These reports, called aggregate reports , cannot be edited or deleted, but the results can be exported in CSV format to Excel or any other spreadsheet application. Aggregate reports give you insight into the total subscriber/device base (see Figure 7-1).

Figure 7-1 Prime Home Reports Tab


Running an Aggregate Report

To run an aggregate report:

Step 1 On the Reports tab, select Aggregate Reports .

Step 2 From the Available Reports drop-down list, choose a report.

Step 3 Do one of the following:

  • View the results on your screen.
  • To export the results, click Save As CSV .


Custom Reports

Custom reports are reports that you design. Custom reports can be saved, edited, and deleted. The results of custom reports can be exported in CSV format and used as the basis for bulk operations.

Reports Tab

You can easily locate and run reports from the Reports tab. The Reports tab displays a list of previously defined custom reports (Figure 7-2).

Figure 7-2 Previously Defined Custom Reports


You can use the following controls on this tab:



Add a new custom report.


Delete an existing report.


Set the number of reports displayed on a page.


Go to the beginning of the list of reports.


Go backward one page in the list of reports.


Go forward one page in the list of reports.


Go to the end of the list of reports.


Refresh the list of reports.

Finding an Existing Report

To find a report:

Step 1 On the Reports tab, type all or part of the report name in the search field.

Step 2 Click .


Running an Existing Report

To run an existing report, click the report name. Prime Home displays the report results (Figure 7-3).

Figure 7-3 Wi-Fi Report Results


You can do the following with the report results:

  • Apply or remove labels to subscribers or devices found by the report—Choose a label from the Add or Remove section of the Labels menu.
  • Save the report results as a CSV file—Click Save as CSV .
  • Create a bulk operation for the subscribers or devices found by the report—Click New Bulk Operation. For more information about bulk operations, see Chapter10, “Managing Bulk Operations”
  • Print the report—Click
  • .
  • Edit the report definition—Click
  • .
  • Close the report and return to the Find Report window—Click
  • .

Custom Reports

Figure 7-4 indicates the tasks you need to complete when creating a custom report.

Figure 7-4 Custom Report Creation Process


As you build your report, Prime Home shows you the potential report results (Figure 7-5).

Figure 7-5 Edit Report Window


Creating a Custom Report

To create a custom report:

Step 1 On the Reports tab, click .

Step 2 In the Report Name field, enter a name for your report.

Step 3 Choose your data fields. These fields are the headings for the columns in your report.

a. From the Available Columns area, drag the field you want to see in the report and drop it into the Include these Columns area.

b. Drag additional fields into the Available Columns area.

Note To search the available columns, enter a keyword and click . To expand the editing area, click .

Step 4 (Optional) Define the sort order:

a. From the Available Columns area, drag the field you want to sort on and drop it in the Sorting area.

b. To sort on additional fields, drag each field to the Sorting area. Arrange the fields in the order in which you want to sort.

Step 5 (Optional) Set up filtering:

a. From the Available Columns area, drag the field you want to use for filtering the report and drop it in the Filter Criteria area.

b. Select a parameter to apply to the filter. The available parameters depend on the field included.

c. To filter on additional fields, drag over the fields and arrange them in the order in which you want to filter.

Step 6 Do one of the following:

  • Click Save to save the report and stay in the Edit Report window.
  • Click Save and Return to View to save the report and view the results on the Devices and Subscribers window.

After you save the report, it appears on the Find window.


Working with Sort Order

You can sort on one or more fields, you can order the fields to control the sort order, and you can choose an order for each field (ascending or descending.)


When you add a field to the Sorting area, the following options appear (Figure 7-6):

  • remove —Click to remove the field from the sorting area.
  • A-Z —Click to change the sort order from ascending to descending or vice versa.

Figure 7-6 Sorting Options


To change the sort order, drag the fields to represent the order in which you want the data sorted. The data is sorted on the top field first, then the next, and so on.

Working with Filters

Filtering enables you to limit the devices or subscribers found by a report. You filter the report results by adding criteria. Each available column has a set of parameters you can apply. You can create complex filters by grouping filter fields and using AND and OR.

Applying Parameters

You must apply a parameter to each filter criterion (Figure 7-7). The parameters can be a simple true or false, or you can specify a relationship (more than, less than, equal to) or set up a list of values.

Figure 7-7 Applying Parameters to a Filter Criterion


For example, if you want to filter on devices that have Content Filtering and Port Forwards enabled, you can create a list of those two items.

After you select a parameter and supply additional information, do one of the following:

  • Click Apply to apply the filter parameter.
  • Click Cancel to cancel the parameter.

Editing Parameters

To change a parameter after applying it, click edit (Figure 7-8). Move the pointer over the filter criterion to display the edit link.

Figure 7-8 Editing Filter Parameters


Using Boolean Logic

When you specify two or more filter criteria, the Boolean AND operator becomes available (Figure 7-9). To toggle between AND and OR, click the operator.

You can create complex, nested filters by grouping two or more criteria and applying AND or OR. To group two or more criteria, click Group . Drag additional criteria into the group.

Figure 7-9 Filter Criteria: Boolean Logic


Working with Advanced Syntax

You can view the query language statement for a report you create (Figure 7-10). You can edit this syntax or you can copy it and use it as a query for bulk operations.

Figure 7-10 Advanced Syntax Window


To view advanced syntax, click .

Using Reports to Understand Your Network

Reports can be used to export data that is maintained in Prime Home. This data can be used to study a wide variety of conditions, including:

  • Identifying potential problem access lines as indicated by SNR, attenuation, retrain, and data rate. This information can help reduce churn.
  • Identifying CPEs with open Wi-Fi security and excessive Wi-Fi devices. This information reduces calls to your CSRs and saves costs.
  • Studying device trends, which could include providing a snapshot of shipment trends during promotions or watching for information about which devices tend to churn more quickly than others. This data is useful when deciding on the value of higher- versus lower-end managed devices. It might also help indicate product longevity, based on a first-inform time analysis.

Examples of other trend reports include:

Number of managed devices by manufacturer, model, and firmware version

Distribution of wired versus wireless networks

Use of DSL versus Ethernet

  • Studying device trends in the home, which is also helpful for understanding up-sell potential.

Examples of in-home, managed device trends include:

Number of LAN devices per subscriber

Number of Wi-Fi versus Ethernet devices per subscriber

Percentage of subscribers using Wi-Fi security (and at what level of security)

Wi-Fi channel use

Port forward use

Parental control use

Number of new customers who came online in the past week

Number of customers with multiple PCs in their home

  • Examining speed breakdown of your installed base. This information can be correlated with network-side information and as a function of managed device manufacturer/model/version. Examples of speed breakdown reports include:

Downstream/upstream link speed


Noise margin

Retrain frequency and uptime

Average broadband speed

  • Investigating subscriber breakdown by device associated, advanced services enabled versus used, label, location, and first contact date.