Reports
This chapter includes the following topics:
Introduction to Reports
The Reports page enables users and administrators to run reports on Cisco MXE 3500 activity.
To create a report:
Figure 15-1 Reports Page
Reports may include pre-defined criteria and/or custom report options. The Reports page defaults to the Job Custom Report view that allows users to select criteria for the report, which then returns Job Summary, Task Summary, and Tasks Type Summary information.
At the top of the Reports page, the Select Report drop-down allows you to choose from the predefined reports shown in Table 15-1 .
Table 15-1 Reports and Descriptions
|
|
|
Worker Summary |
Displays information on each worker defined, including the Host on which the worker runs, Limit and Expense for the worker, and information on the status of the worker in the current configuration. |
Worker By Id Statistics |
Displays information on workers including the Host, the name and ID number of the worker, and the number and total duration of tasks run by that worker. This report will not display information on workers that have been defined but have not yet been assigned tasks. |
Worker Id Health Statistics |
Displays information on workers including the Host, the name and ID number of the worker, and the total number of tasks run by each worker, the number that failed to complete successfully, and rate of failure as a percentage of total tasks run. This report is a text representation of the information displayed in the Health view of the Status page. This report will not display information on workers that have been defined but have not yet been assigned tasks. |
Worker Type Health Statistics |
Displays summary information by type of worker, the total number of tasks run per type, the number that failed to complete successfully, and rate of failure as a percentage of total tasks run. This report will not display information on workers that have been defined but have not yet been assigned tasks. |
Total Worker Hours Summary |
Displays summary information on the amount of work done by each type of worker calculated by comparing the start time and end time of each task run by the worker. |
Max Queue Length |
Displays the number of jobs submitted to the Cisco MXE 3500, but not executed over a given time interval (the number of pending jobs). |
Custom Report Options
When the Reports page is initially opened, the Job Custom Report options display. From the Select Report drop-down, select Job Custom Report or Task Custom Report.
The Query Builder Section lets you specify the search parameters for the custom report. See Figure 15-2.
Figure 15-2 Job Custom Report Settings
Figure 15-3 shows Task Custom Report Settings.
Figure 15-3 Task Custom Report Settings
Note
The Include Job Statistics section shown above adds an additional column to the Task Custom report. For each task record returned by the query, the value(s) of the selected job statistic(s) will also be selected if it exists. Not all workers support statistics data. Many only support a subset of the entire list.
Table 15-2 Query Builder Fields and Descriptions
|
|
|
| Field |
The Field drop-down allows you to define the type of data used as the selection criteria for the report. The value selected in this field will determine how Condition and Value are displayed. |
Job ID |
Selects records based on the Job Id created when the job is submitted. Every job submitted has a unique Job Id. The Job Id can be seen on the Job Status page. |
Job Submit Time |
Selects records based on the date and time the job was submitted. |
Title |
Selects records based on the Title value entered in the Title metadata field on the Submission page. Title information can also be viewed on any of the Status pages. |
Author |
Selects records based on the Author value entered in the Author metadata field on the Submission page. By default, the Author value will display the username of the Cisco MXE 3500 User logged in when the job was submitted. Author information can also be viewed in the Job view of the Status page. |
Completion Status |
Selects records based on their completion status: failed, succeeded, etc. |
Condition |
Defines the condition that must be met in order for the record to be selected. The values on this drop-down will be determined by the value selected for Field. Each Field value will cause the Condition options to be updated to match the type of information stored in that Field. |
Value |
Allows you to enter a numeric value, date, or text string to be compared against records in order for the selection to be made. Value is always a data entry field, but the format of the field will change to match each Field selection. Rows where no value is entered will be ignored when the report is run. |
Join |
Determines how rows of criteria will be compared with or against each other in selecting data from the database. Join values are always the same.
- And : Selects records meeting all criteria of rows connected by the Join.
- Or : Selects records meeting the criteria of any of the rows connected by the Join. Records are not required to contain values in more than one row.
The Custom Report views only allow simple Joins. Mixing Joins or defining multiple lines of criteria can return unexpected results. Currently, it is not possible to nest selection criteria. |
Setting Job Id Criteria
Job Id is a numeric value. When the Field drop-down is set to Job Id, the Condition and Value fields are modified to reflect values appropriate for numeric data.
Figure 15-4 shows Field Set to Job ID.
Figure 15-4 Field Set to Job Id
Table 15-3 Condition and Value Settings
|
|
|
Equal to: Selects only records that have a Job Id that exactly matches the Value entered to the right. |
Value should always be a Job Id number. |
Not equal to: Selects any record that does not match the Value entered to the right. All records other than the one identified by that Job Id will be included in the report. |
Greater than: Selects all records with Job Ids that are higher numbers than the Value entered to the right. Because Job Ids are assigned in sequence, this is a useful way to select a range of records. |
Less than: Selects all records with Job Ids that are lower numbers than the Value entered to the right. |
Setting Job Submit Time Criteria
Job Submit Time is the date and time that the job was submitted. When the Field drop-down is set to Job Submit Time, the Condition and Value fields are modified to reflect values appropriate for date and time.
Figure 15-5 shows the Field Set to Job Submit Time.
Figure 15-5 Field Set to Job Submit Time
Table 15-4 Condition and Value Settings
|
|
|
Equal to: Selects only records that have a Job Submit time that matches the Value entered to the right. |
Value is modified to accept a date and to include a tip about the format for how the date should be entered. The time information indicated in the format tip is shown in brackets, indicating that specifying the exact time that the job was entered is optional. Records will be selected correctly only if date criteria is entered. The format for date information will vary depending on the database in use. For Microsoft SQL Server databases, the mm/dd/yy format is used. For Oracle databases, enter dates in dd-mon-yy format, where mon is the three character abbreviation for the month. |
Not equal to: Selects any record that does not match the Value entered to the right. All records that were submitted at any other time will be included in the report. |
Greater than: Selects all records that were submitted after the Value entered to the right. |
Less than: Selects all records that were submitted before the Value entered to the right. |
Setting Title Criteria
Title is metadata entered when the job is submitted. When the Field drop-down is set to Title, the Condition and Value fields are modified to reflect values appropriate for text string data.
Figure 15-6 shows Field Set to Title.
Figure 15-6 Field Set to Title
Table 15-5 Condition and Value Settings
|
|
|
Equal to: Selects only records where the Title is an exact match of the Value entered to the right. |
The Value field allows you to type some or all of the Title to be used for selection. Values are case sensitive. When Contains, Starts with, or Ends with are used, it is not necessary to type wild card or other special characters in the Value filed. Necessary wildcards will be added automatically based on the Condition selected. |
Not equal to: Selects any record where Title does not match the Value entered to the right. Records with any other Title will be selected. |
Contains: Selects records where the Value entered to the right exists anywhere in the Title. This allows users to report on records when only part of the title is known or to report on records where all titles have a certain word or phrase in common. |
Starts with: Selects records where the Title starts with the Value entered to the right. All records that begin with the characters, word, or phrase entered in the Value field will be included in the report. |
Ends with: Selects records where the Title ends with the Value entered to the right. All records that end with the characters, word, or phrase entered in the Value field will be included in the report. |
Setting Author Criteria
Author is metadata entered when the job is submitted. By default the Author value on the Submission pages will be the username of the Cisco MXE 3500 user logged in when the job is submitted. When the Field drop-down is set to Author, the Condition and Value fields are modified to reflect values appropriate for text string data.
Figure 15-7 shows Field Set to Author.
Figure 15-7 Field Set to Author
Table 15-6 Condition and Value Settings
|
|
|
Equal to: Selects only records where the Author is an exact match of the Value entered to the right. |
The Value field allows users to type some or all of the Author to be used for selection. Values are case sensitive. When Contains, Starts with, or Ends with are used, it is not necessary to type wild card or other special characters in the Value field. Necessary wildcards will be added automatically based on the Condition selected. |
Not equal to: Selects any record where Author does not match the Value entered to the right. Records with any other Author will be selected. |
Contains: Selects records where the Value entered to the right exists anywhere in the Author field. This allows users to report on records when only part of the author's name is known or to report on records where authors share a common first or last name. |
Starts with: Selects records where the Author starts with the Value entered to the right. All records that begin with the characters or name entered in the Value field will be included in the report. |
Ends with: Selects records where the Author ends with the Value entered to the right. All records that end with the characters or name entered in the Value field will be included in the report. |
Setting Completion Status
Figure 15-8 shows Field Set to Completion Status.
Figure 15-8 Field Set to Completion Status
In the empty field, enter a number (0-6) that corresponds with the following:
- 0: Not Complete
- 1: Succeeded
- 2: Failed
- 3: User Stopped
- 4: Condition Not Met
- 5: Preempted
- 6: System Stopped
Understanding Reported Information
Table 15-7 shows report results. The data displayed varies by report.
Table 15-7 Report Data and Descriptions
|
|
|
Report contains |
Displays the total number of jobs included in the report. |
Id |
Displays the Job Id. |
Submit Time |
Displays the earliest start time for all jobs included in the report. |
Completion Time |
Displays the last completion time of all jobs included in the report. |
Priority |
1-100. 1 is highest. 100 is lowest. |
Title |
Job Title entered at the time of job submission. |
Author |
Author value entered at the time of job submission. By default, the Author value will display the username of the Cisco MXE 3500 User logged in when the job was submitted. |
Task Count |
Displays the total number of tasks included in the report. Tasks that were submitted but did not start because another task in the job failed will not be included in the task count. |
Completion Status |
- 0: Not Complete
- 1: Succeeded
- 2: Failed
- 3: User Stopped
- 4: Condition Not Met
- 5: Preempted
- 6: System Stopped
|
Running Predefined Reports
All of the predefined reports are run by selecting the desired report from the Select Report drop-down and clicking the Run Report button.
Figure 15-9 shows the Select Report Drop-Down.
Figure 15-9 Select Report Drop-Down
Filename Requirements
The Filename can be entered as a standard path, beginning with a lettered drive, or can be entered as a UNC name.
The location selected for the report output:
- must exist
- must include a filename and extension, usually.CSV
- must be accessible to the IUSR account used by the web server
- must be accessible to the user in order to retrieve the file
Worker Summary Report
The Worker Summary Report displays information on:
- Each enabled worker
- The Host on which the worker runs
- Limit and Expense for the worker
- The status of the worker in the current configuration
Figure 15-10 shows the Worker Summary Report.
Figure 15-10 Worker Summary Report
Table 15-8 Report Headings and Descriptions
|
|
|
Host |
Displays the Host that the worker is running on. |
Type |
Displays the type of worker identified in this row of the report. |
Limit |
Displays the Limit set for the worker on the listed Host. Limit is the maximum number of workers that will run on a Host concurrently, and is set on the Host Administration page. |
Status |
Displays the status of the worker at the time that the report was run.
- Online: The worker is available to receive task assignments from the ECS.
- Offline: The worker is not available to receive task assignments form the ECS.
|
Expense |
Displays the Expense set for the worker on the Host Administration page. The Expense is the work required by the worker expressed in relation to the overall Capacity of the Host. |
VideoChannel |
Displays the Channel value set for Live capture workers in the Host Administration page. Only Live capture workers will display a channel value. |
Worker by Id Statistics Report
This Worker by Id report displays information on:
- Workers running on the Host
- The number of tasks run by the worker
- Total duration of tasks run by that worker
This report will not display information on workers that have been enabled but have not yet been assigned tasks.
Figure 15-11 shows Worker By Id Statistics Report.
Figure 15-11 Worker By Id Statistics Report
Table 15-9 Report Headings and Descriptions
|
|
|
Host |
Displays the Host that the worker is running on. |
Type |
Displays the type of worker identified in this row of the report. |
Id |
Displays the unique ID number of the worker. |
Total Tasks |
Displays a count of the total number of tasks assigned to the worker. |
Total Time |
Displays the total amount of work done by the worker, measured in seconds. |
Worker ID Health Statistics Report
The Worker Id Health Statistics Report displays information on:
- The total number of tasks run by each worker
- The number of tasks that failed to complete
- The rate of failure as a percentage of total tasks run.
This report is a text representation of the information displayed in the Health view of the Status page.
Note This report will not display information on workers that have been enabled but have not yet been assigned tasks.
Figure 15-12 shows Worker Id Health Statistics Report.
Figure 15-12 Worker Id Health Statistics Report
Table 15-10 Report Headings and Descriptions
|
|
|
Host |
Displays the Host that the worker is running on. |
Type |
Displays the type of worker identified in this row of the report. |
Id |
Displays the unique ID number of the worker. |
Failed Tasks |
Displays a count of the number of tasks for this worker (by Host) that failed to complete successfully. |
Total Tasks |
Displays a count of the total number of tasks assigned to the worker. |
Percent |
Displays a rate of failure calculated from the number of failed tasks compared to the total task assignments. |
Worker Type Health Statistics Report
The Worker Type Health Statistics report displays:
- Total number of tasks run per type
- The number that failed to complete successfully
- The rate of failure as a percentage of total tasks run
Note This report will not display information on workers that have been enabled but have not yet been assigned tasks.
Figure 15-13 shows the Worker Type Health Statistics Report.
Figure 15-13 Worker Type Health Statistics Report
Table 15-11 Report Headings and Descriptions
|
|
|
Type |
Displays the type of worker identified in this row of the report. |
Failed Tasks |
Displays a count of system-wide failures for this type of worker. |
Total Tasks |
Displays a count of the total number of tasks assigned to the worker system-wide. |
Percent |
Displays a rate of failure calculated from the number of failed tasks compared to the total task assignments. |
Total Worker Hours Report
The Total Worker Hours report displays high level summary information on the amount of work done by each type of worker as measured in total time elapsed.
Figure 15-14 shows the Total Worker Hours Report.
Figure 15-14 Total Worker Hours Report
Table 15-12 Report Headings and Descriptions
|
|
|
Worker Name |
Lists workers by name. |
Days |
Displays the number of 24 hour days worth of work completed by all instances of the worker displayed to the left. |
Hours |
Displays the number of hours less than a full day completed by all instances of the worker displayed to the left. |
Minutes |
Displays the number of minutes less than an hour completed by all instances of the worker displayed to the left. |
Seconds |
Displays the number of seconds less than a minute completed by all instances of the worker displayed to the left. |
Total Time |
Displays the total amount of work done by the worker, measured in seconds. |
Max Queue Length Report
Displays the maximum number of queued jobs in the Cisco MXE 3500 system over the given start and stop time interval measured every given time interval. Queued jobs are jobs that have been submitted but have not yet run (pending).
For example, if you configure the report to look at the queue length during regular business hours (9 to 5) for a day, your start and stop values are:
- Start: Month, Day, Year 09:00:00
- Stop: Month, Day, Year 17:00:00
Your time interval is whatever you want it to be, but the smaller it is, the more data that will processed (the more expensive the query will be to run on the database server). If you use:
Time Interval: 00:05:00, then the queue will be examined at every 5-minute interval over the configured 8-hour period or:
(Twelve 5-minute intervals per hour * 8 hours) + 1 at stop time = 97 data points (09:00:00, 09:05:00 … 17:00:00)
If you configure the query to run over time when the Cisco MXE 3500 system has been idle or the value is too large, the interval times are less likely to hit pending jobs. If the interval value is too small, the query will be very expensive and return many duplicate results.
Figure 15-15 shows the Max Queue Length Report Page.
Figure 15-15 Max Queue Length Report Page
Table 15-13 Report Settings and Descriptions
|
|
|
Start Time |
Start date/time of the job |
Stop Time |
Stop date/time of the job |
Time Interval |
The time slice of the report |
Viewing Report Output in Excel
This section includes the following topics:
Saving the Report
Output from the reports can also be saved to a tab delimited text file. This allows the report to be opened for use in other applications, such as Word® or Excel®. The report will always display in the browser window, even if it is also saved to a file.
Procedure
Step 1 Click Select Report, and choose the desired report. The report displays.
Step 2 Click Save. Figure 15-16 shows the Save Report As Pop-Up.
Figure 15-16 Save Report As Pop-Up
Step 3 Enter the file name and file extension (such as.txt), and click Save. A “Report Saved” message displays.
Viewing the Report in Excel
Use this procedure from your Windows desktop to view a report by using Excel.
Procedure
Step 1 Browse to the location where you saved the file.
Note The file is saved to your current Profile Space profile directory in a subdirectory named Reports. See also: Profile Spaces.
Step 2 Right-click the file, and select Open.
Step 3 From the list of available applications, select Microsoft Excel. The file will open with report data displayed in an Excel spreadsheet. Headings are not included in the exported output.
Step 4 Using standard Excel functionality, sort data as needed.
Feedback