Feedback
Contents
- Reports
- Available Reports page
- Stock report templates
- List of stock templates
- Create Save As version of stock template
- Historical and Real Time templates
- Custom templates
- Reports and Report Definitions
- Report management
- About imported reports
- Import a report
- Upgrade Stock Report Template
- Run a report
- Filter page
- Complete Basic Filters tab
- Edit Advanced Filters tab
- Filter a report for Anonymous block and stored procedures
- Set default filter
- Report Viewer
- Report Editor
- Save
- Save As
- Create Save As version of report
- Create report from scratch
- Rename a report
- Export a report
- Localization
- Export a Category
- Delete a report
- Report views
- Grids
- Charts
- Gauges
- Report permalinks
- Views Editor
- Export report to Excel using permalinks
- Import report into Excel
- HTML permalink
- XML permalink
- Grid Editor
- Field Properties
- Grouping
- Add Header
- Current Fields and Available Fields
- Access field thresholds
- Add/Edit Thresholds page
- Threshold images
- Report summaries
- Chart Editor
- General Settings
- Series settings
- Axis Settings
- Summary
- Gauge Editor
- Export to Excel
- Export reports to Excel for SSL users
- Reports and time zones
- Reports and Daylight Savings Time
Reports
Reports show data returned by Report Definitions. This data is extracted by database queries and can be displayed in various Report Views—as grids, charts, and gauges.
Cisco provides stock templates to use with Unified Intelligence Center. You can import the stock reports from the Cisco web site and customize them to suit your business requirements. Stock reports have one default grid view. Some stock reports also have a chart view.
Users with the Report Designer User Role can click the Reports drawer to open the Available Reports page.
Note
All actions on the Reports interface are based on user role and on the user's object permissions for reports and for categories.See also: Troubleshooting Reports.
- Available Reports page
- Stock report templates
- Reports and Report Definitions
- Report management
- About imported reports
- Import a report
- Run a report
- Filter page
- Report Viewer
- Report Editor
- Create Save As version of report
- Create report from scratch
- Rename a report
- Export a report
- Localization
- Export a Category
- Delete a report
- Report views
- Views Editor
- Export to Excel
- Reports and time zones
Available Reports page
The Available Reports page opens when you click the Reports drawer.
If you have the Report Designer user role, access this page to create reports and report categories, and to manage reports, using the context menu that opens when you right-click a report.
Reports are contained in categories and sub-categories, which are represented by folder icons. The reports within the categories are represented by page icons. Unified Intelligence Center is installed with one root report category (folder) named Reports. After installing the stock report, you can see the Audit Trial report under . You can rename the Reports category. You can delete a report only if you are a member of the System Configuration Administrator user role.
Actions from the Available Reports page:
- Import Report—opens the Import Report page.
- Refresh—updates both the page and the tree under the Reports drawer to reflect changes anyone has made to add, modify, import, or delete reports or report categories.
- Work with Categories Possible actions are:
- Drag and drop—You can drag and drop reports and sub-categories.
- Create—creates reports.
- Manage—manages reports with right-click functions, including running the report, editing the report, and creating new views for the report.
- Help—opens online help for the page.
Related Tasks
Stock report templates
Stock report templates display data that has been saved in the Unified ICM/CC database. After installing Unified Intelligence Center, you can import stock templates using the Import functionality and customize the stock reports based on your requirements. It is also possible to import other report templates that are populated by other databases and to set a data source for those templates, but the stock templates are designed to present Unified ICM/CC data.
Make Save As copies of the installed stock templates and work with your Save As copies.
You cannot perform the following actions with the installed stock templates:
- Change the data source.
- Edit the report definition, using Report Editor.
- Delete the default grid view.
- Edit (using Report Editor).
- Create additional views (grids, charts, and gauges).
- Set thresholds for fields.
- Set drilldowns for fields (Premium license only).
- Hide, move, rename, or in any way modify fields that display by default in the grid view.
Based on your User Role and Permissions, you can perform the following actions with stock templates:
- List of stock templates
- Create Save As version of stock template
- Historical and Real Time templates
- Custom templates
List of stock templates
These are the stock report templates that can be imported and customized for the current release. This includes templates from Unified CCE Release 7.x , 8.x, and Audit Trail template.
Report Template
Shows
Agent Historical All Fields
All data for the agents in the selected skill groups for the selected interval.
Default grid view.
Agent Not Ready Detail
Agent availability in a logon session. Default grid view.
Agent Real Time
Each agent's currently active skill group, state, and call direction within each media routing domain into which the agent is logged.
Default grid view.
Agent Skill Group Historical All Fields
Activity for selected agents for a selected interval, sorted by skill group.
Default grid view.
Agent Skill Group Real Time All Fields
Current agent status within the specified skill group(s).
Default grid view.
Agent State Real Time Graph
A pie chart showing the current total count of agents in different agent states.
Default pie chart view only.
Agent Team Historical All Fields
All the available report team data from the Agent_Skill_Group_Interval database table for each selected team during the time period selected.
Default grid view.
Agent Team Real Time
The current status of the selected agent team(s) and the current agent states of each agent within the selected agent team(s).
Default grid view.
Agent Team State Counts Real Time
Real-time agent team information on number of agents assigned to a team, number of agents logged on, number of agents in different states, and number of agents available to receive incoming tasks.
Default grid view.
Call Type Abandon/Answer Distribution Historical
The number of answered and abandoned calls for separate intervals for the report's time period, broken out into summaries.
Default grid view.
Call Type Historical All Fields
The status of call types for the selected time period.
Default grid and pie chart views.
Call Type Skill Group Historical All Fields
Shows the interval status of skill groups by call type for the selected time period.
Call Type Real Time All Fields
The current status of call types.
Default Grid and Gauge views.
Enterprise Service Historical All Fields
All the available Enterprise Service Historical All Fields report data in the Service_Interval database table so that you can select which data you want for a customized enterprise-service historical report.
Default grid view.
Peripheral Service Historical All Fields
Peripheral service historical report data.
Default grid view.
Peripheral Service Real Time All Fields
Available peripheral-service real-time data.
Default grid view.
Enterprise Skill Group Historical All Fields
All selected enterprise skill groups, listing all the available skill-group historical report data for the selected interval.
Default grid view.
Enterprise Skill Group Real Time All Fields
The current status of the selected enterprise skill groups.
Default grid view.
Peripheral Skill Group Historical All Fields
A Consolidated call and skill group statistics, gathered in interval increments.
Default Grid and chart views.
Peripheral Skill Group Real Time All Fields
The current status of the selected skill groups.
Default grid view.
IVR Ports Performance Historical
The performance of IVR ports for the selected time period. It presents a table of half-hour counts of IVR ports in-service, ports idle, and the time HH:MM:SS (hours, minutes, seconds) that all ports were busy.
Default grid view.
Audit Trail
This feature allows you to view the sequence of audit records of each transaction or action that is performed on a Cisco Unified Intelligence Center server.
User to Object report
All the entities of the user.
Object to User report
All the users or entity names that shares the object.
Default grid view.
Create Save As version of stock template
ProcedureAfter you have downloaded and imported the necessary stock templates into Unified Intelligence Center, you can create a Save As Version of the stock template for further customization. After you import the necessary templates into Unified Intelligence Center, create a Report Category for your Save As versions:
The right-click options are now extended and include Edit Views, which opens the Views Editor.
Select the Grid and click Edit to open the Grid Editor, where you can move, rename, and set thresholds for report fields.
Historical and Real Time templates
The stock Unified ICM/CC templates that are used with Unified Intelligence Center are either Historical or Real Time "All Fields" templates.
All Fields refers to the fact that, for the databases that are queried to populate the template, every field in the database is available to be included in the grid view or to be charted or gauged.
These Available fields are listed in the Grid Editor.
Historical report template
- Receives data from the UCCE Historical data source.
- Is populated with interval data. The interval at which the database tables are refreshed can be a 15-minute or a 30-minute interval. This interval is set in the Unified ICM Configuration Manager.
- Has a default refresh rate of 15 minutes. Refresh Rate is configurable in the Report Definition Properties page in a Save As version of the report.
- Has an upper limit of 8,000 rows. The row limit is not configurable. The Report Viewer indicates when the row limit has been reached and when more data is available. You can adjust the filter and rerun the report to see additional data.
Real time report template
- Receives data from the UCCE Realtime Data Source.
- Is populated with current data that is passed by the Peripheral Gateways to the Unified ICM Router and then saved to real-time database tables. By default, real time data is forwarded to the router every 15 seconds. Old real-time data is constantly overwritten by new real-time data.
- Has a default refresh rate of 15 seconds. Refresh Rate is configurable in the Report Definition Properties page in a Save As version of the report.
- Has an upper limit of 3,000 rows. Row limit is not configurable. The Report Viewer indicates when the row limit has been reached and when more data is available. You can adjust the filter and rerun the report to see additional data.
Reports and Report Definitions
All reports are based on report definitions.
Report definitions contain the dataset that is obtained for a report. This includes the query type (stored procedure, anonymous block, SQL query), the fields, the filters, the formulas, the refresh rate, and the key criteria field for the report
Only users who have a Premium license can view, create, or edit report definitions.
Note
Localization of report definition and value list is supported.Related Information
Report management
To manage reports from the Available Reports page, use the context menu that appears when you right-click a report.
The options available to you depend on your User Role and permissions.
Related References
Related Information
About imported reports
This page opens when you click Import Report on the Available Reports page.
Report Designers can use this function to import stock reports and the related help files that are saved locally, into Cisco Unified Intelligence Center. The report that you want to import must be stored in a ZIP file along with the help content. The format for storing the report and help content is as shown below:
In the above figure, under the UCCE80_RT.zip file, you find the Stock folder under which there is a UCCE folder. In the UCCE folder there are different reports. For example, the Agent Real Time report has its corresponding help content in the Agent Real Time folder. Within the Agent Real Time folder, there are different locales. Each locale can contain one property file with localized strings pertaining to that report.
Each report help folder has a size limit of 3 MB. If the size exceeds this limit, the system does not load the help content.
If there are multiple reports that uses the same datasource, then all the reports can be grouped together in a zip file and imported at once. You can also place reports in different folders and zip them together for logical separation. In this case, the import utility creates categories for each folder and imports the respective reports to those categories.
For example:
Note
- During the import, the software checks to see if any prerequisite objects needed by the report(such as Value Lists) already exist. If they do not, the import will create them. If they already exist, you are prompted to use the existing file or to overwrite it. Note that overwriting the existing value list will impact other report definitions which are based on same value list. However, the collections created out of the existing value list will not be impacted.
- This allows users from one system to write a report that uses a certain Value List (for example, the Skill Groups Value List), and then export the report and import it into another system that has another (different) Skill Groups Value List. There is no need to create a new Value List or to edit the report.
- With Report or Report definition import, the existing value lists will be overwritten only if the version associated with new one is different.
- Reports are language-independent. The report templates and their generated output depends on the locale you select for Unified Intelligence Center.
Related Tasks
Related References
Import a report
Procedure
Step 1 To import a report from your computer (a Report zip file that is saved locally), click Browse and navigate to select the template ZIP file.
Note You can import multiple reports in a *.zip file.
Step 2 Navigate to, and click the radio button for, the category or subcategory in which you want to place the report. Step 3 Click Import. Step 4 If you get the warning "One or more underlying report definitions do not exist and need to be created. Please select a data source and Click Import to continue", select the Data Source from the drop-down menu.
Note It is important to select the correct and appropriate data source for the imported report. If a report is associated with the wrong data source, you see an error when you try to run the report. Step 5 Click Import. Step 6 Click Refresh on the Reports page to see the imported report.
Note
- Data from imported reports are extracted from the zip file and saved as configuration data in the Unified Intelligence Center database.
- If your Available Reports page already contains a report template with the same name as the report you are importing, you see a prompt asking if you want to overwrite it.
Related References
Upgrade Stock Report Template
ProcedureIn case there is a new version of the existing stock report template, perform the following procedure to update it:
Step 1 Open Report Manager and click on Import Report. Step 2 Choose the zip file that contains the updated stock report template. Step 3 Click Import. This upgrades your existing stock report template, its associated stock report definition, and any value lists that were part of the original stock template.
Note
- During the report import, the software checks to see if any previously installed versions of the same report, report definition or value lists exist. If they exist, you see a warning to overwrite them. If you select Overwrite, the report, its associated report definition and value lists are overwritten. If you select Cancel, the operation is canceled.
- A report definition and value list is overwritten only when their versions are different, regardless of which one is smaller. They are also overwritten when the new version has a version number and the old version has a blank value or vice versa. If the old version and the new version do not have a version number, they are not overwritten.
- You cannot overwrite a stock report with a custom report. Stock reports are overwritten only by using different versions of the same stock report.
- If you have any custom reports using the previous version of stock report definition, those custom reports are impacted by the upgrade. Unified Intelligence Center attempts to minimize the impact by associating the custom reports’ fields (in all types of views it has – grid, charts, gauge) to the newly upgraded stock report definition fields. If there are any changes to the fields of the new stock report definition that Unified Intelligence Center cannot handle, re-associate them to the custom report by using respective view editors. For example, use grid editor for a grid view, chart editor for chart views, and gauge editor for gauge view.
Run a report
There are several ways to run a report. You can:
- Right-click a report from the Available Reports page and select Run.
- Click the report name from the dashboard or the Reports page.
If the report designer has selected to bypass the filter dialog on the Report Editor page, the report opens immediately.
If the report designer does not select to bypass the filter dialog, selecting a report to view opens the Filters page for that report.
After you select to run and filter a report, the report displays in the Report Viewer.
Filter page
The Filter page opens:
- Before the report generates—Right-click the report and click Run. You do not see the filter page if the report designer selected Bypass Filter on the Report Editor page.
- After the report generates—Click the Filter button in the Report Viewer for the generated report. Do this to refine the filter values for a generated report.
Filter parameters are based on whether:
- The report is based on a simple query or on an anonymous block or stored procedure.
- You are running a real time or an historical report.
You can:
- Create a default filter to persist the filtering criteria so that the filter can be reused every time the report runs.
- Bypass the filter so that the filter page does not display and the report runs with the default filter.
- Create a default filter, so that when you run the report, it always opens to the default filters you have defined.
- Complete Basic Filters tab
- Edit Advanced Filters tab
- Filter a report for Anonymous block and stored procedures
- Set default filter
Related Tasks
Complete Basic Filters tab
ProcedureFollow these steps to complete the basic filters tab for a report based on a simple query. The filter tabs for reports based on queries are populated by all fields in the query. If you run the report without selecting filters, the report returns all data.
Reports based on Anonymous Blocks and Stored Procedures have a different filter interface.
Use this tab to filter a report before you run the report. You also use this tab to edit the default filter for a report.
Note
The system takes the start day of the week as defined on the User List Edit page and User List Create page by the creator or modifier of the report. The system also displays the start day of the week in the footer only when you select Last Week or This Week from the Relative Date Range drop-down list.
Step 1 To filter a real-time report, skip to step 3. Step 2 To filter an historical report, select date/time ranges for Historical Reports as follows: Relative Date Range:
- From the Relative Date Range drop-down menu, select from Today, Yesterday, This Week, Last Week, This Month, Last Month, Year to Date, or Last Year.
- Check Only show results that are within a specific time period to check or uncheck days. By default, all days of the week are checked. This check box only appears if one of the following is selected in the Relative Date Range drop-down menu: This Week, Last Week, This Month, Last Month, Year to Date, or Last Year. If you do not check this box, the report shows all values from 12:00 a.m. of the first date in your range through 11:59 p.m. of the last date in the range.
Absolute Date Range:
- In the From and To fields, click the calendar icons to select a start and end date.
- Check Only show results that are within a specific time period to enter a start and end time. If you do not check this box, the report shows all values from 12:00 a.m. of the first date in your range through 11:59 p.m of the last date in the range.
- Check Only show results that are on certain days of the week to check/uncheck days. By default, all days of the week are checked.
Step 3 Select a filter for the report. Filters criteria are based on the Key Criteria field in the Report Definition and can be Value Lists or Collections, based on your permissions.
To filter by a Value List:
To filter by a Collection:
- Select one or more collection from the Choose Collection pane. You can use the search function to search for collections from the list. The Selected panel displays all the values that belong to the collections you have selected from the list. Note that deselecting collections from Choose Collection pane will not move values from selected to available. If you want to move values from Selected to Available or vice versa use the middle arrow keys. The maximum values you can select is 500. Use the search function in Available as well as Selected pane to find the values from each pane.
The number of values available and the number of values selected is displayed at top of Available and Selected panes respectively. The number of values is displayed in red if the Selected pane has more than 500 values.
Note
- If you have administrator privileges, Available panel displays all values, whereas the Collection list displays only the collections shared to you.
- If you do not have value list permission, Available panel displays only the values that are part of the collections shared to you. Similarly the collections list displays only the collections shared to you.
- A Value List or Collection displays in the Basic Filters tab only if you have Execute permissions.
- Once the number of values in Selected pane reaches or goes beyond 500, new values can not be added to this pane from Choose Collection pane.
- Most stock reports are filtered by Value Lists or Collections that are associated with the Key Criteria Field that has been specified on the Report Definition Properties tab.
- If no Key Criteria field has been specified in the Report Definition, you cannot filter the report. You can, however, run the report. Having no filters means the report pulls in a large amount of data.
Step 4 Click the Advanced Filters tab to review and select additional filtering criteria. Step 5 If you are running the report, click Run to generate the report. If you are editing the default filter, click Save.
Edit Advanced Filters tab
ProcedureFor reports defined as Database Queries, this second tab on the Filter page lets you further refine the results in a report.
This tab is a list of the fields that have Available in Filter checked in the Edit Field Properties tab. It shows the field name, display name, and description.
Select one or more of these fields and then click Edit to indicate any value or a filtered value.
Filter criteria depend on the field type (Date, Decimal, Value List, String, or Boolean).
Step 1 Select one or more of the fields in the Advanced Filter tab, and then click Edit to indicate any value or a filtered value. Filter criteria depend on the field type (Date, Decimal, Value List, String, or Boolean).
- For type Date, click Edit to specify any value or to filter by selecting either Relative Date Range or Absolute Date Range. For both Relative and Absolute date ranges, you can indicate a specific time period and certain days of the week.
- For type Decimal, click Edit to specify any value or to select an Operator from Equal To, Not Equal To, Less Than, Less Than or Equal To, or Greater Than and then entering a value; for example, Operator = Greater Than and Value = 16.5.
- For type String, click Edit to specify any value or to filter by selecting an Operator from Equal To, Not Equal To, or Matches Pattern and then enter a value for the string; for example, Operator = Matches Pattern and Value = Team Green. If you select Pattern as the Operator, you must specify an SQL pattern to match the string field. The system appends the wild card character % automatically to the beginning and end of the string. You can also use any SQL wild card pattern in between the string.
- For type Boolean, click Edit to specify any value or to filter by selecting an Operator and then selecting True or False.
- If the advanced filter field is a Value List, click Edit to specify any value or to filter by moving one, all, or some items in the list to the Selected column.
Step 2 Run the report. The report pulls data for the Collection/Value List objects selected on the Basic tab, filtered by the values you set for the additional (Advanced) fields.
For example, if your Basic Filter is an Agent Team collection, and you add an Advanced Filter for Agent Name Equal to <a certain string>, then the report shows only agents in the team whose name contain that string.
Note The field for the Advanced Filter must be moved from the Available panel to the Current panel in the Grid Viewer in the Grid Editor.
Filter a report for Anonymous block and stored procedures
ProcedureFilters for reports whose Report Definitions are anonymous blocks or stored procedures have a different filter interface than filters for reports whose Report Definitions are simple queries. The filter tabs for reports based on Anonymous Blocks and Stored Procedures are populated by parameters.
There is no Advanced Filters tab for these reports.
In the filter the screen without relative date functionality, but takes dates as input, you have to enter each component manually. The relative date functionality allows you to specify date ranges such as yesterday, tomorrow, last week. This options prevents frequent entry of dates especially when reports are used in dashboards/schedules and permalinks where frequent operator intervention is not expected.
Unlike queries, stored procedures and anonymous block SQL cannot be filtered by adding additional WHERE clauses to the base query. For this reason, relative date filtering has to be enabled specifically by modifying the parameter the parameter display names. For more information, see Enable relative date filter filtering for Anonymous and Stored procedures.
Follow these steps to filter a report before you run the report or to edit the default filter for a report.
Step 1 Select/ the date/time ranges as follows: Relative Date range:
- From the Relative Date Range dropdown, select from Today, Yesterday, This Week, Last Week, This Month, Last Month, Year to Date, or Last Year.
- In the From and To Fields, enter a starting and ending date range.
- Check the Only show results that are on certain days of the week check box to select the days of the week.
- Select the day/days of your choice
Absolute Date range:
- In the From and To fields, click the calendar icons to select a starting and ending date range.
- Check Enter Time check box. In the From and To Fields, enter a starting and ending date range.
- Check the Only show results that are on certain days of the week check box.
- Select the day/days of your choice.
Step 2 Select a filter. The filter options are the parameters created in the Report Definition. A parameter is associated with a Value List.
If the anonymous or stored procedure do not meet these conditions. Follow step 3 to 5.
Step 3 Enter a Start Date value. Step 4 Enter an End Date value.
Note Because the dates are parameters, the system cannot validate that Start is earlier than End. Step 5 Follow step 2.
Related Tasks
Set default filter
ProcedureYou can create a default filter for a report and save that filter so that the report always generates according to that filter (until you change the filter).
Combining this feature with Bypass Default Filter allows for consistent report generation among report users.
Step 1 Open the Available Reports page (Reports drawer) and navigate to the report for which you want to set a default filter. Step 2 Right-click the report and select Edit. The Report Editor page opens.
Step 3 Click Edit Default Filter. The filter page for the report opens.
Depending on the report you select, it might open the Basic Filters tab or the Basic Filters Tab for Anonymous Block/Stored Procedure.
The tab opens and is similar to when you run a report. It has no Run button, but has a Save button.
Step 4 Select the filter you want for the report. For example, if the filter offers a collection or a Value List of Call Types, select only one or two Call Types. Step 5 Click Save. Every time the report runs, the filter opens to your default settings. You can change them for that instance of the report.
Related References
Report Viewer
When a report runs, it opens in the Report Viewer. This page is a container that manages the report execution. Its content varies, based on which view (data presentation) of a report is displayed—a grid, a chart, or a gauge. You can change the report view on this page.
If the report view is a grid. you can review the field definitions for its template in the help topic for that template.
The menu bar across the top of the Report Viewer has these selections:
Save
Saves the report.
Save As
Opens the Save As dialog box and makes a new copy of the report.
Auto Refresh
Allows you to enable or disable auto refresh for data displayed in this window. When the Auto Refresh check box is checked, the system refreshes data in this window in real time. If this check box is unchecked, the data available when you opened this window remains static unless you refresh it.
While in this window, if you press Refresh or the F5 button, the system refreshes the data in the window, but does not alter the checked or unchecked state of the Auto Refresh check box.
Edit
Launches a page where you can edit the currently-selected view.
Prints the report.
Filter
Opens the filter page so that you can change the filter values (such as date/time and values) for the report. See Filtering Reports.
SQL
Opens a window with a read-only display of the SQL query on which the report is based.
Refresh
Sends a request to the server to refresh the report dataset.
Note Pop Out
Opens the report in a new, separate browser display window. The popout has no Unified Intelligence Center edit or toolbar functions.
Click x to close the popout.
Note The Auto Refresh check box allows you to enable or disable auto refresh for data displayed in this window. When the Auto Refresh check box is checked, the system refreshes data in this window in real time. If this check box is unchecked, the data available when you open this window remains static unless you refresh it using the F5 button. If the corresponding check box is checked in the parent window, the system checks the box in the pop-up window as well. You can modify this by unchecking the box. Refreshing the data in this window does not change the status of the Auto Refresh check box.
Export
Launches the Export page, where you can export the report grid to a Microsoft Excel file.
In case of Chart or Gauge view, the system prompts you to download or save the Report Chart or Gauge as an image (.jpg). Select a location where you want to save the image and click OK.
Note When you Export a report, the footer does not appear in the exported charts and gauges.
Views
If there is more than one view associated with this report template, use the drop-down menu to select the view you want to display.
If the resolution of your screen is too low and you are unable to see the Views drop-down list, you can select, drag, and narrow the width of the left panel (the Drawers).
The date formats have been localized for the following languages:
- English (UK) - dd/mm/yyyy
- Danish - dd/mm/yyyy
- Polish - yyyy/mm/dd
- Dutch - dd/mm/yyyy
- Brazilian Portuguese - dd/mm/yyyy
- Spanish - dd/mm/yyyy
Note Help
Opens a drop-down menu where you can select help for Unified Intelligence Center reporting or for the fields in the report template.
Related Tasks
Report Editor
Right-click any report for which you have the appropriate permissions and select Edit to open the Report Editor page. Use this page to review the information for a stock report or to edit the information for a custom report.
Table 1 Fields on the Report Editor page Field
Explanation
Report Description
This field displays a description for the report.
Version
The field displays the version of report currently deployed in Unified Intelligence Center.
Note Version can be composed of decimal point like X.Y. Version should not start or end with a decimal point. Valid version number examples: 8.9 or 11.15.
Author
The field displays the name of template provider that has created the entity.
Report Definition
This field displays Report Definition for the report.
Default View
From the drop-down menu, select the default view to display when users run the report.
Note After the report has generated, users can change the view. For example, if the default view is a grid, and a gauge has been developed for the report, users can change the generated report to show the gauge view. Online Help
Displays the location of the online help topic for the stock report template.
You can either provide the URL of the online help file or you can attach the online help file:
- URL
The URL of the online help zip file from where online help is attached to Unified Intelligence Center.
- Select Help File
The individual online help file or a zip file on your local system. Choose an online help file or a zip file that you want to attach and click Upload Help File.
Note The maximum file size of the online help zip file is 2 MB. Unified Intelligence Center supports multiple folders within an online help zip file. You can have the html and htm files in any folder. It is not mandatory to have the html and htm files in the parent folder of the zip file. Unified Intelligence Center also supports uploading of individual html and htm files. The validation of the zip file fails when the zip file contains other files apart from html and htm files.
Bypass Filter Dialog
Check this box so that the report runs directly and users are not prompted to filter the report.
Note Permissions
Use these boxes to view or change user permissions for My Group.
Note My Group refers to the report owner's default group. If this default group is All Users group, the options to set permissions for non-administrative users is disabled. Only administrative users can set permissions for the All Users group.
Actions on Report Editor page:
- Edit Default Filter opens the filter page for the report, where you can review the basic and advanced filters that are defined in the Report Definition.
- Edit Views opens the Views Editor.
- Save
- Save As
- Cancel closes the page without saving your changes.
- Refresh updates the page to show changes another user has made.
Related Tasks
Save
Saves the report if it is valid.
A report is not valid to save if:
- The report description contains invalid characters such as symbols and punctuation marks.
- You did not select a valid view.
Save As
Actions on this page:
Use this page to save an existing report with a new name, description, report category, and permissions.
Table 2 Fields on the Save As dialog box Field
Explanation
Report Name
The new name for the report
Description
Enter a description for the report.
Save To
Navigate to, and click the radio button for, the category or subcategory in which you want to place the report.
Permissions
Note My Group refers to the report owner's default group. If this default group is All Users group, the option to set permissions for non-administrative users is disabled. Only administrative users can set permissions for the All Users group.
Create Save As version of report
Procedure
Step 1 From the Available Reports page, locate and select the report that you want to "Save As" (clone). Step 2 Right click on the report and Select Edit to open the Report Editor page. Click Save As. OR
Right click on the report and Select Save As.
Step 3 Enter a name. Step 4 Enter a description . Step 5 Save the report in the selected category or subcategory. Step 6 Set the permissions for My group. If your default group is All users, the option to set permissions is disabled. The report is saved to the Available Reports page, where you can right-click to manage it.
Note My Group refers to the report owner's default group. If this default group is the All Users group, the option to set permissions for non-administrative users is disabled. Only administrative users can set permissions for the All Users group.
Related Tasks
Create report from scratch
Procedure
Step 1 Right-click a category or sub-category on the Reports page and select Create Report. This opens a naming dialog box. Step 2 Enter a name for the report. Step 3 Enter a description for the report. Step 4 From the Report Definition drop-down menu, select the Report Definition on which this report will be based. This drop-down menu shows the following information:
Step 5 Specify the default permissions for this report for members of your User Group.
Note My Group refers to the report owner's default group. If this default group is All Users group, the options to set permissions for non-administrative users is disabled. Only administrative users can set permissions for the All Users group.
Step 6 Click OK to open the Report Editor. Step 7 Complete fields on the Report Editor. Step 8 Click Save from the Report Editor page to save the new report. The report is saved to the Available Reports page, where you can right-click to mange it.
Related Tasks
Related References
Rename a report
Right-click a report and select Rename to open a dialog box prompting you for the new name.
Type a new name. Then click OK.
You see a message if you:
Enter a duplicate name (the same name as an existing report).
Leave the Rename To field blank.
Type a name that contains invalid characters (symbols or punctuation marks other than an apostrophe).
Export a report
A Report Designer with Write permissions can export a custom report for troubleshooting or so that it can be archived or imported to another server in ZIP format. You cannot export stock reports.
The following items are exported:
- Report
- Report Definition
- Value Lists
- Views—including custom grids, charts, and gauges
- Values defined for it in Report Editor (default view, online help, etc)
- Thresholds
- Permissions
- Drilldowns
- Online help content with the directory structure. If there is no help file associated with the given report, an empty directory structures is exported.
For example, if you want to export the Agent Team report, the structure in which the system exports the help files is as shown in the following figure:
The following items are not exported:
To export a report:
- Right-click a report and select Export to open the Export Report dialog box, which gives you the option to rename the report. You can change the name but do not change the file extension.
- Click OK to open the Windows file download dialog box.
- Click Save and navigate to the location where you want to save the report ZIP file.
Localization
Whenever a report is exported, nonlocalized strings of the reports and all associated entities such as Report and Report Definition are added to the locale.properties file of the master locale. The master locale is the current locale of the user during the export.
The following Unified Intelligence Center entities and the corresponding keys are eligible for localization:
- Report
- Grid
- Chart
- Gauge
- Report Definition
- Value List
NoteOnly from the keys, Unified Intelligence Center replaces all the spaces with an _ (underscore).
Export a Category
ProcedureA Report Designer with Write permission for a report category can export a report category.
Note
Exporting of the root (Reports) category is not allowed.You can export a report category along with its reports into a zip with all the hierarchy information.
Step 1 Right-click on a report category and select Export. Unified Intelligence Center displays a download dialog box for downloading the zip files for each data source.
Step 2 Select Save File to save the zip files. Step 3 Click OK. The zip files are downloaded.
When you export a report category, the reports that point to the same data source are zipped together in separate zip file. For example, a separate zip file Report_Zip_One is created for Report_1, Report_2, and Report_3 that point to Data_Source_1. Report_Zip_Two is created for Report_5, Report_6, and Report_7 that point to Data_Source_2.
The folder structure of the exported report category zip files is same as that is in Unified Intelligence Center.
Note
- While Unified Intelligence Center downloads of the zip files, do not navigate to other tabs because the download will not succeed if you navigate to other tabs.
- Unified Intelligence Center does not export the empty categories and also the reports and categories for which the logged in user does not have permission to access.
- If you choose to export an empty category, then Unified Intelligence Center returns an error message "There are no reports in the Category to Export" and the export fails.
Delete a report
Click Yes to delete.
Click No to cancel.
Note
- Reports are referenced by views and schedulers.
- When you delete a report that has views or schedules, a message reminds you to delete those views/schedules before you delete the report.
- You can delete a report only if you have the user role of a System Configuration Administrator.
Report views
Report views are the presentation containers in which a report dataset can appear. There are three types of views: Grids, Charts, and Gauges.
You cannot run a report that has no views. All stock reports and any custom reports that you create have at least one view. When a report has only one view, you cannot delete that view.
The default view for each report is defined in the Report Editor.
You can create and edit Views in the Views Editor.
Grids
All stock report templates are installed with one default grid view. The Report Editor displays the name of the default grid, which you can access through the Grid Editor .
Grids are tabular presentations of the data in rows and columns. You can modify the stock grids by moving, adding, and deleting columns and by adding and renaming column headings and regrouping columns under those heading.
By default, all Cisco stock reports have a grid view. You can create additional grid views for the stock reports.
For custom reports, a default grid is created from the SQL query in the Report Definition.
You can also create Charts and Gauges to view the same report data in graphical format from the Grid Editor.
Charts
Pie
Pie charts present quantities as proportions of a whole. The circle (pie) represents 100% of the data, with each quantity represented as a wedge of the appropriate size.
Pie charts take decimal/numeric fields only.
Column
Column (Bar) charts display discontinuous events and show the differences between events rather than trends. Column charts can be oriented vertically or horizontally and can be stacked vertically or clustered side-by-side.
Line
Line charts show continuous quantities over time against a common scale. They are good for showing trends.
The type of chart and the properties for that chart are defined in the Chart Editor.
Some stock templates are installed with stock charts.
Create and edit charts from the Chart Editor.
NoteUsers can localize the legend labels and axis titles in column chart and line chart by enclosing square brackets around resource bundle key string.
Related References
Gauges
Gauges display the status of a single report metric (number); for example Agents Logged On or ASA. They are not intended to display multiple metrics or complex inter-relationships.
A gauge in Unified Intelligence Center is similar in function and in appearance to the speedometer in your automobile. The gauges you design in Unified Intelligence Center are semi-circular graphics with a moving needle.
Gauges show a visual indicator that a value is within a normal range.
The needle tracks an essential metric or status, just as your speedometer tells you how fast you are moving.
Create and edit gauges from the Gauge Editor.
Related References
Report permalinks
Report permalinks are used to provide direct permanent content links to reports through an Excel, HTML or XML file. You can use this feature for those report views where the default filter is set and the Bypass filter checked. For reports that do not fall in this category, the permalink feature does not work.
The types of permalinks are:
- HTML permalinks—supports grid, gauge, and chart views.
- XML permalink—used to generate XML data to be used by downstream processes rather than a web page or to populate a spreadsheet. This permalink supports only the grid view.
- Excel permalink—supports only the grid view.
- Dashboard permalink.
Permalinks allow you to embed a report so that it can be accessed directly. The person accessing it does not need to log in to the Unified Intelligence Center application.
Only the report designers who have write access to the report and can edit Views can access and distribute permalinks.
Time zone considerations for Report permalink
The system considers the time-specific data in the default filter as local to Cisco Unified Intelligence Center server time zone. The system then converts this time to data source time zone when the filter query is formed.
Similarly, the system considers all time-specific table data it fetches from the data source as local to data source time zone. The system then converts this time to Unified Intelligence Center server time zone before displaying the date and time in the report data.
However, if the data source does not have a time zone set, then the time zone considered is the Unified Intelligence Center server. For more information see Reports and time zones
Related References
Views Editor
This page opens when you right-click a report and select Edit Views.
It lists the available views that are currently associated with a report and allows you to create new views or edit existing views.
Each view is a layout presentation of the data that is defined in the Report Definition to populate the report. Unified Intelligence Center support three view types: Grids, Charts, and Gauges. By default, all stock reports except the Agent State Real Time Graph, have one grid view. You can create your own grid views and can create gauges and charts for the report dataset.
Table 3 Fields on the Available Views panel Field
Explanation
View Name
The name of the view.
Type
Description
The description entered for the view.
Enable Links
Indicates if the access to report using permalink is allowed or blocked
Excel Link
The permalink to view real-time reports in Microsoft Excel.
HTML Link
The permalink to view real-time reports in any supported browser.
XML Link
The permalink to create custom report views using technologies like XSLT.
Actions on the Views Editor page:
- Export report to Excel using permalinks
- Import report into Excel
- HTML permalink
- XML permalink
- Grid Editor
- Current Fields and Available Fields
- Access field thresholds
- Add/Edit Thresholds page
- Threshold images
- Report summaries
- Chart Editor
- Gauge Editor
Export report to Excel using permalinks
ProcedureYou can also export real-time reports and reports that have filters embedded to Excel using the report permalinks.
Step 1 Open the Reports Manager. Step 2 Right-click the report that you want to export to Excel and select Report Info. Step 3 In the Report Info dialog box, copy the URL from the Excel Link field to your clipboard. Step 4 Open Microsoft Excel and from the Data menu, choose Import. Step 5 In the New Web Query dialog box, paste the URL in the Address field. Step 6 Click Go. Excel displays the report preview.
Step 7 Click Import. Excel prompts you to choose the insertion point for the imported data.
Step 8 Select the cell in the spreadsheet that you want to make the top left corner of your new report. Step 9 Click OK. The Cisco Unified Intelligence Center Report data is imported into Excel.
Note Microsoft Excel 2007 has a 'refresh rate' parameter in the Connections menu, which governs how frequently the report data needs to be fetched. See the Excel documentation for details.
You can now filter or format the report to your requirements.
Related References
HTML permalink
HTML permalink provides a direct link to the Report Viewer that bypasses the main interface and logs into Unified Intelligence Center. The report has the same look and feel as the reports that are displayed using pop-up functionality in Report Viewer in Unified Intelligence Center.
Note
The permalink status (Enable or Disable) is preserved during the export of a report and is retained during report import. In case of importing older version reports (stock or customer), the permalinks are enabled by default for the views of the imported report.XML permalink
XML permalink provides a direct link to generate an XML structure corresponding to a report view, thereby bypassing the main interface and logging into Cisco Unified Intelligence Center. The generated XML structure can be used by other applications to create custom report views using technologies like XSLT.
The generated XML has the following types of tags:
- Report—This is the root tag with attribute name, the value which is the report view name.
- Row—For every record in the report, there is a row tag in XML. It has an attribute index, which takes integer values starting from 0. This tag represents the sorting order of the records, if you sort the corresponding report view.
- Header—This tag is present if there are super headers in the report view. There are two attributes to this tag - name and index. The name attribute corresponds to Super Header name and the index attribute corresponds to the position of the Super Header in the report view, with the index starting from 0.
- Column—For every field in the report view, there is a column tag with two attributes—name and index. The name attribute corresponds to the field name and the index attribute corresponds to the position of the field in the report view. The text content of the column tag is the value of the field. If the field value is null, this tag is empty.
An example of a sample report having a super header:
Branch Details
Call Type
Call Type ID
Orig Branch
Orig Branch Code
032Bethlehem
5240
0032_MainQueue
9994
035Bethlehem
3479
0035_MainQueue
5628
The corresponding XML structure for the report is as follows:
<report name="sample grid view"> <row index="0"> <header index="0" name="Branch Details"> <column index="0" name="Orig Branch">032Bethlehem</column> <column index="1" name="Orig Branch Code">5240</column> </header> <column index="1" name="Call Type">0032_MainQueue</column> <column index="2" name="Call Type ID">9994</column> </row> <row index="1"> <header index="0" name="Branch Details"> <column index="0" name="Orig Branch">035Bethlehem</column> <column index="1" name="Orig Branch Code">3479</column> </header> <column index="1" name="Call Type">0035_MainQueue</column> <column index="2" name="Call Type ID">5628</column> </row> </report>Grid Editor
This page opens when you select a grid view from the Views Editor and then click Edit.
Use this page to edit an existing grid or to create a new grid view for a report dataset.
Note
The system takes the start day of the week as defined on the User List Edit page and User List Create page by the creator or modifier of the report. The system also displays the start day of the week in the footer only when you select Last Week or This Week from the Relative Date Range drop-down list.Panels on this page:
Available Fields—This panel shows fields that are collected from the database, that are available to use in the report, and that are checked as Allow to show if Invisible in the Report Definition Fields tab.
The fields in the Available Fields panel include the Current fields (fields that appear in the current grid view), and other fields that are eligible to be used in the report view.
In a stock template, if you add Available fields to the Current panel so that they appear in the grid, and if those fields do not have footers defined for them, the summary row of the report does not show column summaries\totals for those fields. To add a footer to a field, open the Report Definition, locate the field in the Fields tab, and click Edit Field Properties.
Current field order in the grid—This panel shows fields that are currently used in the grid view of the report, the order in which they appear, and any headers under which they are grouped.
Fields in this list appear as columns in the report. You can reorder and rename these fields, and set thresholds for them. You can also remove them so they are no longer visible in the report.
Note
For custom reports, the Available panel and the Current field panel show identical fields. The Report Designer must move fields from Current to Available to remove them from the grid view.
To:
Do This:
View the properties of a Current (visible) Field
Right-click a field and select Properties to open a page where you can set Field Properties.
Manage thresholds for a Current (visible) field
Right-click a field and select Thresholds.
Move a Current (visible) field so it is no longer visible in a report.
Right-click a field and select Remove Selected. If the field is a superheader (has other fields under it), you see a confirmation message. Click Yes at the confirmation message.
To add the field back, select it in the Available Fields panel and move it back to the Current field order in the grid panel.
If you remove all fields from the Current panel, the generated report shows no data.
Note To regain the default Current panel, re-import the report, or move fields from the Available panel back into the Current panel. Move a field from the Available panel to the Current panel.
Click (highlight) GridHeaders at the top of the Current panel.
Select the field you want to move in the Available panel.
Click > to move the field over. It is placed at the bottom of the Current panel. Locate it; then use the up arrow to move it to where you want it to display in the grid.
Note The Available panel shows the default (database) name. The Current panel shows the display name. If you move an Available field that is already present in the Current panel, the Active Other field in the Current panel becomes highlighted. You cannot have the same field more than once in the Current panel. Reorder Current Fields (Up and Down)
Use the up and down arrows to the right of the Current field order in the grid panel.
Actions on this page:
- Grouping—opens the Grouping dialog box.
- Save—saves your changes to the grid view and closes the page.
- Save As—opens a dialog box where you can enter a name for the changes you have made to the grid view.
- Cancel—cancels entries you have made and closes the page.
- Add Header—opens the Add Header dialog box.
- Remove Selected—removes a field from the Current panel so that it no longer appears in the report. The field remains in the Available panel.
- Help—opens the online help topic for this page.
Related Tasks
Field Properties
This page opens when you right-click a Current (visible) field in the Grid Editor and select Properties.
Default Name
Displays the name of the field as it appears in the database (as protected text).
New Display Name
Enter a new name for the field.
Note This does not change the name of the field in the Available panel.
Field Width
The number of pixels the field can occupy in the grid. The default is 70. The minimum is 10, and the maximum is 500.
Note If the report cannot split a continuous text with no space, then it auto-adjusts the field width to display the entire text in one line irrespective of the field width configured. But if the report is scheduled as a PDF, the field width is not auto-adjusted and the extra text is truncated.
Note For a report scheduled as a PDF, the field width is not auto-adjusted for a continuous text with no space. If the header cell exceed the field width, it overlaps with adjacent columns. In other cells, extra text is truncated. To fix this issue, adjust the field width.
Actions on this page:
Related References
Grouping
Use this page to indicate the format you want for the report groups and whether you want to show summaries for groups.
Number of Groups
Select an option to indicate if you want zero, one, two, or three groups in the report.
Unique Value Vertical Alignment
Select Top, Middle, or Bottom to specify where you want the name of the group to display in the report column.
Show Summary Only
Check the Show Summary Only check box if you want to see only the summary. The Show Summary Only check box is available for all the fields.
Grouped By
Choose a value from the Grouped By drop-down list. The report data is grouped by this value.
If you choose a date or date and time value from the drop-down list, select one of the following options:
- None
The report data is grouped by the value and not by day, week, or by month.
- Daily
The report data is grouped by day.
- Weekly
The report data is grouped by week.
- Monthly
The report data is grouped by month.
Show Summary
Check the Show Summary check box to include a summary row in the report for the grouping. For example, if you group by Agent Team and check the Show Summary check box, a row of summary data for each team is displayed. When you check the Show Summary Only check box, the Show Summary check box becomes unavailable.
Sorted By Choose a value from the Sorted By drop-down list. The report data is sorted by this value.
Actions on this page:
Add Header
You can add a "superheader" (a header of headers) to the Current field panel to group report columns that have a logical relationship to each other.
Held Tasks
Avg Hold Time
In the example below, the Header Incoming Hold Tasks appears above, and groups, the Held Tasks and Avg Hold Time fields.
To organize related columns into a grouping:
- Click Add Header. Enter a name for the header and click OK. The header appears as a folder icon in the Current field panel.
- Move Available fields into this header by selecting them and clicking the > or by using drag and drop.
To organize fields within a Header, use the up and down arrows to the right of the Current field order in grid panel.
To delete a Header, right-click the Header and select Remove Selected. Select Yes to confirm the deletion.
To rename a Header, right-click the header icon and select Rename. Complete the Rename To: field; then click OK.
Current Fields and Available Fields
For every report, the Grid Editor shows a panel named Available Fields and a panel named Current Field order in the grid.
When you create custom reports, both panels contain the identical list of database fields.
For Cisco stock reports:
- The Available panel includes all the fields that the SQL query is pulling from the database, including those fields that display by default when you run the report. The Available panel is inclusive of the Current panel.
- The Current panel includes all fields that appear in the default grid view of the generated stock report. The vertical list of Current fields represents their left-to-right orientation in the grid. The second field from the top of this list is the second field from the left in the report grid. You can change the fields in the Current panel as follows:
- You can remove a field. (Select it and use the < to move to the Available panel.)
- You can move a field. (Select it and use the up/down arrow keys to move it up or down the list
- You can rename a field. (Right-click it and select Properties.) If you rename the field in the Current list, the field retains it original name when you move it back to the Available list.
- You can set a threshold for a field so that it appears in a certain format in the generated report. (Right-click it and select Properties.)
- You can create a Header and group it with related fields.
Related References
Access field thresholds
ProcedureWhen you set a threshold for a field in a report grid, you are configuring that field to display in a distinctive format when its value matches, exceeds, or does not meet a criterion that you set.
For example, you can configure a field so that it always appears as bold or as red in the generated report grid when it is greater than or equal to a certain value.
Step 1 Open the Reports page and right-click the report for which you want to set a threshold. Step 2 Select Edit Views. Step 3 Select a view of type Grid; then click Edit. This opens the Grid Viewer in the Grid Editor. Step 4 Right click a field in the Current Fields panel. Step 5 Select Thresholds. This opens a page that shows a list of thresholds that are available for this field. The page is blank if no thresholds exist.
Each available threshold has a bullet at the far left. The name of the threshold indicates the criteria on which it is based—for example, Greater Than: 50.
Note There is no limit to the number of thresholds you can define for a field.
Note The thresholds will not be displayed in a grouped field.
Actions on this page:
To add a threshold, click Add.
To edit a threshold, select the bullet to the left of its name and click Edit.
To delete a threshold, select the bullet to the left of its name and click Delete. This displays a confirmation message. Click Yes to complete the deletion.
OK—closes the Available Thresholds page.
Add/Edit Thresholds page
Complete the Add/Edit Threshold page as follows:
Value
Description
Type
Click the drop-down menu to select a type.
The available types are Always, Equal To, Not Equal To, Greater Than, Greater Than or Equal To, Less Than, Less Than or Equal To, and Between.
The Types you can select depend on the field. For example, you cannot select the type Greater Than for the Agent Name field.
Selecting any type other than Always displays a field where you must enter a value to which the field must be compared.
When you select a field that is text (string), a Regular Expression check box is displayed. Check Regular Expression if you want the threshold to include all strings that contain a text value.
For example, if you set a threshold for Supervisor must be equal to R* and check Regular Expression, the threshold applies to Ralph, Roger, Roy, and Riley.
If you do not check Regular Expression, the threshold applies only to a Supervisor whose name is R.
Bold
Check Bold or leave it unchecked.
Text Color
Click the box to open a color palette. Clicking a color selects that color for the text and closes the palette.
Background Color
Click the box to open a color palette. Clicking a color selects that color for the report cell and closes the palette.
Text Substitute
To mask the field value with text other than one of the default types when the threshold condition is met, enter that text here. For example, if you selected Less Than as the type, you might want the text to say Warning.
Image Substitute URL
To mask the value of the field with an image instead of text, enter the image URL or path.
For example: cues_icons/Status_criticalerror_icon.gif
Actions on this page:
Related References
Threshold images
Images that can be used to represent field thresholds appear below. To insert the image, add the full path and filename (cues_icons/status_criticalerror_icon.gif) in the Image Substitute field on the Add/Edit Thresholds page.
Note
The image names are context-sensitive.
FileName
Image
cues_icons/Status_criticalerror_icon.gif
cues_icons/Status_error_icon.gif
cues_icons/Status_warning_icon.gif
cues_icons/Status_success_icon.gif
cues_icons/wizard_check.gif
cues_icons/wizard_error.gif
images/Help24T.gif
images/Stop24T.gif
images/Enable.gif
images/Kubrick/alert_informational_2009_256.png
NoteIf a report with a threshold image that references an external URL is scheduled as a PDF, it displays the image only if the Unified Intelligence Center server can connect to the external URL. Similarly, if the same report is opened in the browser or scheduled as an inline HTML, it displays the image only if the client machine can connect to the external URL.
Report summaries
You can control whether and how a custom report is grouped and summarized by configuring its Grouping in Grid Editor.
Even if you select Show Summary on the Grouping page to include one or more summary rows in the report, values appear in the summary only if the fields have a default footer value.
Some fields that are defined in the Current field order in the grid panel in Grid Editor have default footer values. When you generate the report, the report summary row displays the footer values for these fields, which can be Count, Total, Min, Max, or Custom Formula.
If you create a custom report, the summary row does not show values until you create footers for its fields.
If you move an Available field into the Current field order in the grid panel, the summary for that column is empty unless you define its footer value.
To define a footer value for a report field:
Related References
Related Information
Chart Editor
General Settings
Table 5 Fields on General Settings page Field
Description
Chart Type
Options are Pie Chart (the default), Column Chart, and Line Chart.
Once you save a chart, you cannot change its chart type.
Chart Name
Enter the name of a new chart or edit the name of an existing chart.
Chart names are required and must be unique for all views of a report.
Chart Description
Enter text that identifies the purpose of the report.
Accessible Mode
Check this box to add fill patterns (stripes and dots) to chart colors and make them easier to distinguish.
Dynamic Dataset
Note Not available for pie charts.
Line and column charts use Dynamic Dataset OR Use Report Footer, but not both.
For line and column charts, check this to transform data into a summarized format. The following example shows a summarizing agent call volume:Once transformed, the data can be easily graphed and analyzed using a line or column chart.
You can create dynamic datasets with decimal/numeric values only.
Use Report Footer
Note Line and column charts can use Dynamic Dataset or Use Report Footer, but not both.
Check this if you want the repeated data in the chart to be grouped or collapsed by the field's footer. As a best practice, check this to consolidate data so that the chart is less cluttered and easier to analyze.
Note A pie chart cannot have more than 50 wedges. If your dataset and chart editor selections generate a pie chart with more than 50 wedges, you see an error. Selecting Use Report Footer reduces the number of wedges.
For pie charts, the data is grouped by the Label field.
For line charts, the data is grouped by the Horizontal Axis field.
For column charts, the data is grouped by the Horizontal Axis field for vertical charts or by the Vertical Axis for horizontal charts
There are repeated values for Fruit Name. The Use Report Footer collapses these repeated values into single rows, and uses the footers defined in the other columns.With Use Report Footers enabled, the original rows are collapsed by distinct Fruit Names. The Fruit Price column shows a count (3 prices for Apple, 2 for Peach) since that is its footer function, and the Fruit Weight column shows the average weight for each fruit.
Note To set the footer for a Save As or custom Report Definition:
Legend: Show Legend
A legend provides text labels explaining the meaning of each data series and its associated color, pattern or data point marker.
Checking this box configures the chart to show a label and enables these two fields:
- Legend Placement Select where the legend should appear in the chart view. The options are Right and Bottom. Right is preferable, as it does not add to the total height of the chart.
- Maximum Legend Label Length Enter a value (in number of characters) for the length of the chart label. Use a short legend length to eliminate wrapping.
Data Change Effect
Data Change Effect enables animation in the chart. Animation occurs the first time the chart draws and at every refresh. It has these options:
- Type—Select a type of animation for the chart. The options are Interpolate, Zoom, Slide, and None.
- Duration—Enter a value in milliseconds for the duration of the interval between the animation transitions.
Note
- Modifying the default value for Duration (milliseconds) can cause the chart to appear to be constantly refreshing.
- The default Refresh Rate for a Real Time report is 15 seconds. The default Data Change Effect is 1000 ms. These two values work well together.
- If you change the Data Change Effect to 10000 ms (10 sec), then by the time the Chart Effect is finishing, the Chart refresh rate is ready to begin again. This makes the chart appear to be constantly refreshing.
- If you want to modify the default Data Change Effect value, modify the Report Refresh Rate.
Column Chart Settings
Note Unavailable for Pie Charts and Line Charts.
Column Chart Settings are:
- Column Type—Select the type of display. The options are Clustered or Stacked columns.
- Column Orientation—Enter the orientation of the columns. The options are Horizontal or Vertical.
Note The selection of Column Orientation (Vertical or Horizontal) determines the layout of the Series Settings and Axis Settings pages.
Line Chart Settings
Check this to interpolate the display of a line chart such that a continuous line appears if there is a gap in the data. Protected for pie charts and column charts.
Actions from this page:
Series settings
This wizard page opens when you click Next at the General Settings page of the Chart Editor.
Series settings differ by chart type, column chart orientation, and Dynamic Dataset selections made on the General Settings page.
Table 6 Pie chart series Field
Description
Data Field
From the drop-down menu, select a data field for the series.
The options are the numeric fields only. You cannot create a pie chart from date or text values.
Label Field
From the drop-down menu, select a label field for the data field.
Each label corresponds to its field name, but you can edit the label.
Label Position
From the drop-down menu, select a label position. The options are Callouts, Inside Wedges, Inside Wedges + Callouts, Outside Wedges, and None.
Note For pie charts, this option displays labels inside the wedges or adds callouts. Pie chart wedges do not have both labels and callouts. If the pie slice is big enough, you see a label inside the wedge. If the slice is too small to enter a label, you see a callout for that label only. Label Format
From the drop-down menu, select Value with Percent Inside Parenthesis, Percent with Value Inside Parenthesis, or Percent Only.
Table 7 Line and column chart series, Dynamic Dataset not enabled Field
Description
Axis: Type and Fields
This panel appears on the right if you select a vertical orientation on the General Settings page. It appears on the left if you select a horizontal orientation.
Select one Type from the drop-down menu. The options are Numeric, Date/Time, or Text.
Then select one or more fields for that Type.
On a column chart, this field becomes the Series Descriptions/Legend Labels field on the Axis Settings page.
A line chart shows a line for each field. A column chart shows a column for each field.
Note The type of field that you select (Numeric, Date/Time, or Text) determines the Axis Type on the Axis page. Axis: Field
This panel appears on the right if you select a vertical orientation on the General Settings page. It appears on the left if you select a horizontal orientation.
Select one field.
Note The type of field that you select (Numeric, Date/Time, or Text) determines the Axis Type on the Axis page.
Table 8 Line and column chart series, Dynamic Dataset enabled Field
Description
Dynamic Column Field
From the drop-down menu, select the field for the column headings of the chart. For example, select Agent to generate a chart with a column heading for each agent.
Dynamic Row Field
From the drop-down menu, select the field that defines the rows. For example, select Date to see a row for each date.
Dynamic Data Field
From the drop-down menu, select the value for the data that populates the chart.
Actions from this page:
Axis Settings
This wizard page opens when you click Next at the Series Settings page of the Chart Editor for Line Charts and Column Charts. There is no Axis Settings page for pie charts.
Note
- The layout of the Axis Settings page is based on your selection of Vertical or Horizontal on the General Settings page.
- The Axis Types on this page are based on the data types you selected on the Series Settings page.
Table 9 Fields on Axis Settings page Field
Description
Series Descriptions/ Legend Labels
This field is always at the top of the fields on the Axis Settings page.
It shows the label for the Axis field you selected on the Series Settings page. You can edit the label. For example if you selected the field CTDelayAbandTime, you can edit the label to show Call Type Delay.
Axis Type
There are two Axis Type fields on this page: one for Horizontal Axis and one for Vertical Axis. Axis Type option(s) are determined by the data type of the field:
- If the field is a Text data type, the Axis Type is Category, and it is protected.
- If the field is a Date/Time data type, the Axis Type is Date/Time, and it is protected. Axis Type of Date/Time exposes these additional settings:
- Data Units Select from Milliseconds, Seconds, Minutes, Hours, Days, Weeks, Months, Years
Note - Data Interval—Enter the interval between data units.
- Display in Local Time—If you check this box, the time zone displayed for this user is the local time zone that you have specified in the User Setting window. However, if your browser's time zone setting is different from what you have set in the User Settings window, then the time displayed in the browser window has the browser time zone name appended to the displayed time.
Note Cisco recommends that you always open Unified Intelligence Center in a browser that is in the same time zone as that specified in the User Settings window.
- If the fields is a Numeric data type, the Axis Type options are Linear or Log (Logarithmic). For a stacked column chart, Log is often the best selection when there is a wide range in the returned values.
Axis Title
Enter text for the Axis.
Axis Minimum
Enter a minimum value for the axis range.
Axis Maximum
Enter a maximum value for the axis range.
Axis Minor Tick Interval
Enter a value to determine the spacing of the minor ticks.
Axis Major Tick Interval
Enter a value to determine the spacing of the major ticks.
Maximum Label Precision
Use this field with Decimal (%) values such as Service Level to configure the digits that appear after the decimal point.
For example, with a value of 3, you see 0.000. 0.400, 1.000. With a value of 1, you see 0.0, 0.4, 1.0.
Note Increasing the value of the Maximum Label Position does not add decimals to the value. Setting it to 5 does not make the value of 10.25 display as 10.25000. Auto adjust
If this is selected, the system estimates the range and adjusts the beginning and end of the axis to meet the data range.
Base at zero
With this selected, if all values are positive or negative, the chart bases the axis at zero.
Note Base at zero does not have any effect if Auto Adjust is disabled. Actions from this page:
Gauge Editor
To set footer for Save As or Custom Report Definition:
This page opens from the Views Editor when you select to create or edit a gauge. Use the fields on the Gauge Editor to create a new gauge or to edit an existing gauge. The changes that you make are reflected immediately in the gauge graphic.
A gauge displays a single number, and that number is the footer value of one of the fields in the Report Definition.
Note
If the field does not have a footer, you see an error saying that the footer value is null or is not a number when you run the report. You need to set the footer for the field.
- Open the Report Definition and click the Fields tab.
- Locate the field for the gauge and select Edit Formatting.
- Select a footer value from the drop-down menu.
Note
Footer values are Sum, Avg, Count, Min, Max, and Custom Formula. Some footer values do not make sense for some fields, and do not result in useful gauges. For example, setting a gauge field to Agent Name and setting the Agent Name footer value to Avg does not result in a useful gauge.
Table 10 Fields on the Gauge Editor Field
Explanation
Field
From the drop-down menu, select the field from the report definition that the gauge tracks. You can select only one field.
Note Not all of the fields in the drop-down list make useful gauges or have pre-defined footer values. Name
Enter the name for the gauge. This is the name that displays as the report view. The name must be unique among all gauge views for the report.
Range
Enter minimum and maximum values to set the range for the gauge.
Number of scale markers
Check the types of markers (ticks) you want to display on the gauge.
Note If the gauge has a small range and a large number of scale markers, the markers might overlap. Scale options
Check one, any, all or none of Show Labels, Show Half Ticks, and Show Quarter ticks.
You can also define threshold values for the gauge so that ranges of the gauge are filled with different colors when events or activities are greater or less than values you define. If you do not set thresholds, the gauge is black and white.
Thresholds are listed in order of severity. The most severe threshold is at the far right of the gauge.
Note
- Configure thresholds so that the most severe threshold is at the far right of the gauge. This prevents thresholds from overlapping and being overwritten. For example, if a major problem occurs when a value is less than 30, it cannot be a warning if the value is less than 20. In this case, a value of 19 triggers the major threshold and it does not display it as a warning.
- You cannot make Warning a higher severity than Critical.
- The highest "less than" threshold value should not be higher than the lowest "higher than" threshold value.
To display thresholds on the gauge, complete the thresholds fields as follows:
- Level: Check one, several, all, or none of the following:
- For each Level, select a Direction: Options are Greater than and Less than.
- For each Level, select a Value. Values must be numbers.
Note
- You cannot specify a range for a Normal threshold. Any values in the bottom range that are not specified display as Normal (green). For example, if you set a Warning to be greater than 20 and your minimum range is 0, then 0–19 display as green.
- The sample gauge updates along with your changes unless there is an error in your settings. Once you resolve the error, the sample gauge updates. The Save buttons are also disabled until any errors are resolved.
- If you do not see the change immediately, click elsewhere on the page.
Each gauge that you design and save becomes available in the Views Editor.
To see the gauge, run the report and select the Gauge from Report Viewer, or create a Save As for the report's Gauge View and add it to a dashboard. (See Add a Report under Dashboards help.)
Actions on this page:
- Save As—creates a new gauge based on the opened gauge. You must enter a new name for the Save As version of the gauge.
- Save and Close—saves the gauge, closes the Gauge Editor, and returns you to the Views Editor.
- Save—saves the gauge and keeps the page open so that you can refine the values.
- Refresh—refreshes the page to show any changes to this gauge.
- Cancel—cancel changes and closes the Gauge Editor.
- Help—opens online help.
- X on the tab heading—closes the page.
Related Tasks
Related References
Export to Excel
Procedure
The report grid is exported exactly as it is displayed in Unified Intelligence Center, with thresholds applied. The only exception is data shown in HH:MM:SS format. You can export this data as integer values to use in Excel formulas.
Click the Export icon.
If
Then
Excel is not installed on the system where you launched the browser to sign in to Unified Intelligence Center
You see an error message.
Excel 2003 is installed on the system
The Excel report document opens in a new browser window.
Excel 2007 is installed on the system
A dialog box opens, giving you the option to Open or Save.
Click Open to open the Excel report document in a new browser window.
Click Save and follow the prompts to download and save the file.
Export reports to Excel for SSL users
Procedure
Step 1 Go to . Step 2 In the Registry Editor window navigate to the folder HKEY_CURRENT_USER > Software> Microsoft > Windows > CurrentVersion > Internet Settings Step 3 Right Click Internet Settings and select . Step 4 Rename the New value#1 as BypassSSLNoCacheCheck. Step 5 Double click on BypassSSLNoCacheCheck to open the Edit DWORD Value dialog. Step 6 In the value data field enter value 1 and Click OK. Step 7 Close and Restart Excel. You do not need to restart windows.
For more information on these settings, see http://support.microsoft.com/kb/815313.
Related Tasks
Related References
Reports and time zones
Server
A time zone is defined during installation by the person who runs the installation wizard.
This is the server time zone. It does not affect reports. The server administrator can view and can change the server time zone using these CLI commands: show timezone and set timezone.
Data source
The data source time zone is defined when the data source is configured. It is the time zone of the database. Reports use this time zone.
User
The user's time zone is set on the User Information Page.
When a user in New York is asked by a colleague to review a report run in the China office, the user accesses the User Information page to change the time zone to match the colleague's, and then runs the report using the same absolute date range.
Time zone considerations
The system considers the time-specific data that the user enters as local to user's time zone. The system then converts this time to a data source time zone when the filter query is formed.
The system considers the time specific-data that it fetches from data source as local to data source. It then converts this time to the user time zone before displaying the date and time in the report data.
If the user or data source does not have a time zone set, then the time zone considered is the Unified Intelligence Center server. The system performs these conversions only after the time zone normalization at data source level has occurred.
Consider the following example where the user enters the date and time value in the filter as 1/1/201012:00:00 AM. Depending on the time zone setting, the system converts the time zones in the filter query as shown below:
filter value = 1/1/2010 12:00:00 AM
Data source Time zone
Data source Time zone
When set (+2 GMT)
When not set (Add Cisco Unified Intelligence Center server Timezone)
User Time zone
When set (+11 GMT)
Thursday, December 31, 2009 3:00:00 PM EET
Original Time – User Time zone offset (+11 GMT) + Datasource Time zone (+2 GMT)
To Original Time, -9 ( -11 +2) hrs added
Thursday, December 31, 2009 6:30:00 PM IST
Original Time – User Time zone offset (+11 GMT) + Cisco Unified Intelligence server Time zone (+5.30 GMT)
From Original Time, 5.30 ( –11 +5.30) hrs subtracted
User Time zone
When not set (Subtract Cisco Unified Intelligence Center server Time zone)
Thursday, December 31, 2009 8:30:00 PM EET
Original Time – Cisco Unified Intelligence server Time zone(+5.30 GMT) + Datasource Time zone offset ( +2 GMT)
From Original Time, 3.30 (– 5.30 +2) hrs subtracted
Friday, January 1, 2010 12:00:00 AM IST
To Original Time, 0 (– 5.30 +5.30) hrs added
The following example shows a database with date and time values as 1/1/2010 12:00:00 AM. Depending on your time zone setting, the system converts and displays the time zones in the report data as shown below:
Database value = 1/1/2010 12:00:00 AM
User Time Zone
User Time Zone
When set (+2 GMT)
When not set (Add CUIC server Time zone)
Data source Time zone
When set (+11 GMT)
Thursday, December 31, 2009 3:00:00 PM EET
Original Time – Datasource Time zone offset (+11 GMT) + User Time zone (+2 GMT)
To Original Time, -9 ( -11 +2) hrs added
Thursday, December 31, 2009 6:30:00 PM IST
Original Time – Datasource Time zone offset (+11 GMT) + CUIC server Time zone (+5.30 GMT)
From Original Time, 5.30 ( –11 +5.30) hrs subtracted
Data source Time zone
When not set (Subtract CUIC server Time zone)
Thursday, December 31, 2009 8:30:00 PM EET
Original Time – CUIC Server Time zone(+5.30 GMT) + User Time zone offset ( +2 GMT)
From Original Time, 3.30 (– 5.30 +2) hrs subtracted
Friday, January 1, 2010 12:00:00 AM IST
To Original Time, 0 (– 5.30 +5.30) hrs added
Related Tasks
Related References
Reports and Daylight Savings Time
Report fields that show date/time take this value from the database time zone that was entered in the Timezone field of the Data Source.
The data source time zone value is automatically updated when the daylight savings time change occurs.
If you generate a report that spans dates before and after the daylight savings time change, the date/time fields for days before daylight savings time reflect that time. The date/time fields for days after daylight savings time reflect the daylight savings time.
Related Tasks
