Managing Report Instances
Revised: September 20, 2011, OL-24179-02
Introduction
The Cisco Service Control Application Reporter (SCA Reporter) installation includes report templates for a wide variety of reports, such as:
•Global, per package, or per subscriber hourly or daily usage volume per service
•Top server/clients/protocols/web hosts/e-mail senders/newsgroups
•Top P2P consumers/uploaders/downloaders/protocols
•Global, package, or subscriber bandwidth per service
Each report instance is based on a report template. You can create, select, duplicate, and delete report instances in the Templates view of the SCA Reporter. You can add frequently used reports to the Favorites view. When you select a report instance, its properties are displayed in the Properties view; you can specify values for the various report properties. For example, if you want to see global bandwidth per service, you can create a new report instance from the Templates view. The Properties view allows you to specify the desired services, traffic direction, and time frame (either start/end time or previous number of hours).
The exact procedure for defining a report instance depends on the report template selected. The example in this chapter is intended as a general guide to the process of creating and defining a new report instance.
•Creating a New Report Instance
•Modifying Existing Report Instances
•Configuring Report Instance Properties
•Duplicating an Existing Report Instance
•Renaming an Existing Report Instance
•Deleting a Report Instance
•Removing a Report Instance from Favorites
•Modifying a Report Chart Title
Creating a New Report Instance
Step 1 Do one of the following:
•In the Templates view, right-click a report template (for example, Global Monitoring > Global Bandwidth per Service versus Total Bandwidth).
•In the Templates view, double-click a report template. A popup menu appears, see Figure 4-1.
Figure 4-1 Templates Popup Menu
Step 2 From the menu, choose New.
The New Report wizard window appears, see Figure 4-2.
Figure 4-2 New Report Wizard
A report instance is added below the report template, see Figure 4-3.
Figure 4-3 Report Instance
The report instance is named Global Bandwidth per Service versus Total Bandwidth #1. (If you create another report instance from this report template, it will be named Global Bandwidth per Service vs Total Bandwidth #2, and so on. You can optionally rename report instances by entering a name in the Report name field.)
Step 3 Configure the report instance properties.
If any property has the value (not set), you must assign a value, see Figure 4-4.
Step 4 Click Next.
Figure 4-4 Report Instance Properties
Step 5 (Optional) Uncheck Execute the new report, see Figure 4-5.
Step 6 (Optional) Uncheck Add the new report to Favorites, see Figure 4-5.
Figure 4-5 Report Actions
Step 7 Click Finish.
A report instance is added below the report template.
The Properties view appears in the bottom right of the SCA Reporter window, displaying the basic and advanced report instance properties, see Figure 4-6.
Figure 4-6 Properties (Report Instance)
You can display all report instance properties by clicking (Show Advanced Properties).
Using the Reports View Toolbar
After a report is created, you can perform several actions on the active report using the Reports view toolbar.
For a description of the available actions, see the "Report Actions" section.
Adding a Report Instance to Favorites
If you have a report instance that you generate frequently, you can add it to the Favorites view. From Favorites view, you can quickly access, rename, and delete the instance as well as generate reports.
Step 1 In the Templates view, right-click a report instance.
A popup menu appears, see Figure 4-7.
Figure 4-7 Templates Popup Menu
Step 2 From the menu, select Add to Favorites. The report instance is added to the Favorites View, see Figure 4-8.
Figure 4-8 Favorites
Modifying Existing Report Instances
Step 1 Select a report instance. Do one of the following:
•Select an existing report view and, from the drop-down menu above the view, choose Go to report.
•Select a report instance from the Templates view.
•Select a report instance from the Favorites view.
The Properties view window displays the report instance properties.
Step 2 Edit a property. To edit the property, click on the row of the property and make changes.
The change is saved. The new value is used the next time the report instance is executed.
Configuring Report Instance Properties
The following is an example of assigning values to report instance properties.
Step 1 In the Templates view or Favorites view, choose (or create) a report instance.
The report instance is selected in the Templates view, and the Properties view displays the report instance properties.
Note If the property that you wish to modify does not appear, click (Show Advanced Properties).
Step 2 Click in the Traffic Direction property row and then click the icon that appears.
A drop-down menu of property values appears, see Figure 4-9.
Figure 4-9 Property Values Drop-Down Menu
If fewer than five items appear in the list, a drop-down menu appears. If five or more items exist, a list box appears.
Step 3 Select a value.
Step 4 Click in the Services to View property row and then click the icon that appears.
A checklist of property values appears, see Figure 4-10.
Figure 4-10 Property Values Checklist
Step 5 Check the services you want to view.
Step 6 Click (OK).
Step 7 Click in the Ending Before Date property row and then click the icon that appears.
A choose date and time dialog box appears, see Figure 4-11.
Figure 4-11 Choose Date and Time
Step 8 Select a date and time and click OK.
Step 9 Click (Execute).
The report is generated with the configured values.
Duplicating an Existing Report Instance
Duplicating an existing report instance is a useful way to create a new report instance similar to an existing report instance. It is faster to duplicate a report instance and then modify the duplicate, rather than to define the new report instance.
Step 1 In the Templates view, right-click a report instance. A popup menu appears, see Figure 4-12.
Figure 4-12 Templates Popup Menu
Step 2 From the menu, choose Duplicate.
The report instance is duplicated.
Renaming an Existing Report Instance
You can rename an existing report instance. This feature is useful when the same report is generated on a regular basis. You can include the date or other identifying information in the name of the report.
Step 1 In the Templates view or Favorites view, right-click a report instance. A popup menu appears, see Figure 4-13.
Figure 4-13 Templates Popup Menu
Step 2 From the menu, choose Rename.
The report instance is highlighted and you can edit its name.
Step 3 Enter a new name and press Enter.
The report instance is renamed and listed with the new name.
Deleting a Report Instance
You can delete report instances.
Step 1 In the Templates view or Favorites view, right-click a report instance.
You can also choose more than one instance. To choose several instances, hold down the Ctrl key while choosing the report instances, and then right-click.
A popup menu appears (Figure 4-14).
Figure 4-14 Popup Menu
Step 2 From the menu, choose Delete. The chosen report instances are deleted.
Removing a Report Instance from Favorites
Step 1 In the Favorites view, right-click a report instance. A popup menu appears, see Figure 4-15.
Figure 4-15 Favorites Popup Menu
Step 2 From the menu, choose Remove from Favorites.
The report instance is removed from the Favorites view.
Modifying a Report Chart Title
Step 1 In the Favorites view, right-click a report instance. A popup menu appears, see Figure 4-16.
Figure 4-16 Favorites Popup Menu
Step 2 From the menu, choose Properties.
The report chart instance is highlighted and you can edit its title.
Step 3 Enter a new title and press Enter.
The report chart instance is renamed and listed with the new title.
Step 4 To add the SCE as subtitle, configure the report chart instance properties.
Set the value of Show SCE on Title to true.
Step 5 Click (Execute).
The report is generated with the configured values.