Field Reference for Reports

To view the field description for the customizable data fields for Prime Infrastructure reports, see the Field Description for Prime Infrastructure Reports.

This section provides field descriptions for pages found under the Reports menu in Cisco Prime Infrastructure.

Report Launch Pad

The following topics contain field descriptions for reports found in Reports > Report Launch Pad.

Report Launch Pad > Report Type > New

Table 1. Report Launch Pad > Report Type > New Field Descriptions

Field

Description

Settings

Create reports in current and each sub Virtual Domains

Select this check box if you want to create reports not only in current virtual domain but also for each sub virtual domains. Click the View sub Virtual Domains link to view details about the virtual domains such as the name of the virtual domain, email address, and the time zone.

If this check box is enabled and the report is not scheduled, the report template is created and saved in all the subdomains but the report is not run. If the Create reports in current and sub Virtual Domains check box is checked, and the report is scheduled, then the report is scheduled in all the subdomains and is run at the scheduled time.

If this check box is enabled, you can only save the report. All other options (such as run, run and save, save and export, save and email) are not visible in the report details page. This means that the reports can only be created and scheduled to run in sub domains.
Note 

You can only send a file of size up to 25 MB when the File Destination is selected as Email Option.

There should be a sufficient time interval (at least 30 minutes) between the report creation and report execution as the report creation time varies between different systems.

Report Title

Enter a report name. This report title is suffixed with _VirtualDomainName if you select the Create reports in current and each sub Virtual Domains check box. The VirtualDomainName is the name of the virtual domain for which the report has been generated.

Report By

Choose the appropriate Report By category from the drop-down list. The categories differ for each report.

Report Criteria

The field allows you to sort your results depending on the previous Report By selection made. Click Edit to open the Filter Criteria page and select the required filter criteria.

Reporting Period

Do one of the following:

  • Select the Select a time period radio button and choose the period of time from the drop-down list.

  • Select the From radio button and enter the From and To dates and times. You can type a date in the text box or click the calendar icon to choose a date. Choose the hours and minutes from the drop-down lists.
    Note 

    For a client sessions report, the reporting period must not exceed 31 days while determining the From and To dates.

Schedule

Scheduling

Check the Enable check box to run the report on the set schedule.

Export Format

Choose CSV or PDF as the file format to use when exporting the report results after a report is run. The default file locations for CSV and PDF files are as follows:

/localdisk/ftp/reports- for scheduled reports

/localdisk/ftp/reportsOnDemand- for on demand reports

Destination

Choose your destination type (File or Email or Sftp). Enter the applicable file location or the email address. You can also store the scheduled reports in the destination SFTP server. To configure the SFTTP server, go to Administration > System > System Settings, then choose General > Reports , and enter the required details in the External Server Settings field.

If you checked the Create reports in current and each sub Virtual Domains check box, the Email to default Contact in each Virtual Domain radio button appears instead of the Email radio button. You can click the View Contacts link to view the email IDs for the various virtual domains.

To set the mail server setup for emails, choose Administration > Settings> System Settings, then choose Mail Server Configuration from the left sidebar menu to open the Mail Server Configuration page. Enter the SMTP and other required information.

If an email address is not specified for a subVirtual Domain then the email address of the current Virtual Domain is used if it is specified for the current Virtual Domain.

Start Date/Time

Enter a date in the provided text box or click the calendar icon to open a calendar from which you can choose a date. Choose the time from the hours and minutes drop-down lists. The report begins to run on this data and at this time.

The time referred to here is the Prime Infrastructure server time and not the local time of the browser or local desktop.

Note 
If you generate a report for older records (e.g. 4 months old) or if the report is generated based on the weekly aggregated table then the generated report will have only one entry per week.

If you selected the Create reports in current and each sub Virtual Domains check box then the Use Virtual Domain time zone check box appears. Select this check box if you want to use the time zone of the virtual domain as the time zone of the report. Click the View time zones link to view the timezones of the various virtual domains.

Recurrence

Select the frequency for the report to be run from the following options:

  • No Recurrence—The report runs only once (at the time indicated for the Start Date/Time).

  • Hourly—The report runs on the interval indicated by the number of hours you enter in the Entry text box.

  • Daily—The report runs on the interval indicated by the number of days you enter in the Every text box.

  • Weekly—The report runs on the interval indicated by the number of weeks you enter in the Every text box and on the days specified by the selected check boxes.

  • Monthly—The report runs on the interval indicated by the number of months you enter in the Every text box.

Report Launch Pad > Report Type > New Customize

Table 2. Report Launch Pad > Report Type New Customize Field Descriptions

Field

Description

Custom Report Name

Choose the report you intend to customize from the drop-down list.

Note 
The Available data fields and Data fields to include column heading selections might change depending on the report selected.

Available data fields / Data fields to include

Use the Add and Remove buttons to move the highlighted fields between the Available data fields and Data fields to include columns.

Fields that appear in blue font in the Data fields to include column are mandatory fields for the report selected in the Custom Report Name field.

Change order buttons

Use the Move Up and Move Down buttons to determine the order of the columns in the results table. The higher the column heading appears in the Selected Columns list, the farther left it appears in the results table.

Data field sorting

Indicate your sorting preference (Ascending or Descending). Determine how the report data is sorted.

You can select four data fields for which you can specify sorting order. Use the Sort by and Then by drop-down lists to choose each data field for sorting.

For each sorted data field, choose whether you want it sorted in Ascending or Descending order.

Only reports in table form (rather than graphs or combined) can be sorted. Only fields that can be sorted appear in the Data field sorting drop-down lists.

The Sortable fields displayed in the Create Custom Report page list all sortable fields irrespective of the data fields that are in the Data fields to include pane. The report is sorted based on the data field selected even if that column is not displayed in the report.

Scheduled Run Results

The following table describes the fields on the Reports > Scheduled Run Results page.

Table 3. Scheduled Run Results Field Descriptions

Field

Description

Report Category

Choose the appropriate report category from the drop-down list or choose All.

Report Type

Choose the appropriate report type from the drop-down list or choose All. The report Type selections change depending on the selected report category.

From / To

Type the report start (From) and end (To) dates in the text boxes or click the calendar icons to select the start and end dates.

Report Generation Method

Choose one of the report generation method from the following options:

  • Scheduled

  • On-demand Export

  • On-demand Email

Saved Report Templates

The following table describes the fields on the Reports > Saved Report Templates page.

Table 4. Saved Report Templates Field Descriptions

Field

Description

Report Category

Choose the appropriate report category from the drop-down list or choose All.

Report Type

Choose the appropriate report type from the drop-down list or choose All. The report Type selections change depending on the selected report category.

Scheduled

Choose All, Enabled, Disabled, or Expired to filter the Saved Report Templates list by scheduled status.