Cisco Unity System Administration Guide (With IBM Lotus Domino), Release 4.0(4)
Reports

Table Of Contents

Reports

Overview: Reports

About Report Data

Generating Reports

Viewing and Printing Reports

Subscribers Report

Subscriber Message Activity Report

Distribution Lists Report

Failed Login Report

Transfer Billing Report

Outcall Billing Report

Administrative Access Activity Report

Event Log Report

Port Usage Report

System Configuration Report

Unresolved References Report

Call Handler Traffic Report


Reports


Overview: Reports

You can use Cisco Unity reports to gain information about subscribers and system activity. Some Cisco Unity reports provide information about subscribers and system activity over a period of time. Others offer a "snapshot" of a particular Cisco Unity entity as it stands at the time you run the report.

See the following sections in this chapter to learn more about using Cisco Unity reports:

About Report Data—This section provides information about how Cisco Unity gathers and stores report data, and which settings you can change to ensure that your reports contain the data you need.

Generating Reports—This section details how to generate, view, and print Cisco Unity reports.

See the following sections in this chapter for information on specific reports:

Subscriber Reports

Subscribers Report—This report includes profile and account information about each subscriber.

Subscriber Message Activity Report—This report shows when subscriber messages were left and when they were accessed.

Distribution Lists Report—This report shows the owner, members, and creation date of public distribution lists.

Failed Login Report—This report shows details of failed attempts to log on to subscriber accounts (by phone) and to the Cisco Unity Administrator.

Transfer Billing Report—This report provides information about call transfers from call handlers and subscribers; this information can be used for billing purposes.

Outcall Billing Report—This report provides information about outgoing calls made by Cisco Unity for message notifications; this information can be used for billing purposes.

System Reports

Administrative Access Activity Report—This report shows details of all changes entered into the Cisco Unity Administrator; this information can be used as an audit trail of commands entered by system administrators.

Event Log Report—This report provides information from the Windows application log.

Port Usage Report—This report shows activity on each port; this information can be used to determine when to add new ports.

System Configuration Report—This report provides information on system resource allocation.

Unresolved References Report—This report shows any call handlers that were left in an invalid state when the Cisco Unity Administrator was not used to delete subscriber accounts.

Call Handler Traffic Report—This report shows how many calls are routed through a particular call handler and how callers are choosing to exit that handler.

About Report Data

The Cisco Unity reports that provide information about subscribers and system activity over a period of time contain log-based data. For example, the Call Handler Traffic report shows how many calls are routed through a particular call handler and how callers are choosing to exit that handler during the time period that you specify. Other Cisco Unity reports offer a "snapshot" of subscriber or system data as it stands at the time you run the report, and therefore they reflect the current status of a particular Cisco Unity entity.

Cisco Unity automatically gathers and stores data that is used in log-based reports every 30 minutes. You specify how long Cisco Unity stores the data in the Cleanup Interval for Logger Data Files in Days field on the System > Configuration > Settings page. For example, if you have set this field to three, a log-based report will reflect activity only for the last three days, even if you specified more than three days in the time range for the report.


Note The raw data within files in the Event logs is stamped with time stamps recorded in GMT (Greenwich mean time) rather than in the local time of the Cisco Unity server. The time stamps for the Event log files themselves, however, are in the local time of the Cisco Unity server. Using GMT for the time stamps of the raw data provides for an accurate comparison of events when Cisco Unity servers are not all in the same time zone. The Cisco Unity reports convert the GMT time stamps to local time.


By default, Cisco Unity deletes report files every seven days. To change how often reports are deleted, adjust the settings for the Cleanup Interval for Report Files in Days field on the System > Configuration > Settings page.

Generating Reports

When you generate a report, you can specify some or all of the following:

The subscribers, administrators, or distribution lists to include in the report

The date and time range to include

The sort order for the data in the report

You also choose to save the report either as a web page or as a comma-delimited file:

Web page

An HTML file. You use a web browser to view and to print the report. In some cases, a report may be too large to be viewed in a web browser.

Comma-delimited file

A text file (also known as a comma separated or CSV file). Each row in the report appears on a separate line, and values are separated by commas. Select this format if you want to view or print the information in another application, for example, a spreadsheet program.


The best time to generate reports is when the system is not busy: after regular business hours when Cisco Unity is not processing many calls, or when there are no other processes running (for example, before or after a full backup). Note that for large systems, reports that offer a "snapshot" of subscriber or system data may take a significant amount of time to run.

In the current release of Cisco Unity, reports cannot be scheduled in advance, and if you turn off Cisco Unity while there are reports in the report queue, the reports will be deleted.

Viewing and Printing Reports

When a report has completed, the name of the output file is displayed on the Reports page of the Status Monitor. To access the report file, all Cisco Unity administrators must have full read/write access and all Domain Users must have read rights to the CommServer\Reports directory located on the Cisco Unity server (these access levels are set by default). To have read rights, an administrator or user must either be a member of the domain that Cisco Unity is in or be associated with a domain that is trusted by the domain that Cisco Unity is in.

All reports contain a report header followed by columns of data. If, for example, you generate a report for all subscribers, the subscriber name is included above the data associated with the subscriber.

To View a Report


Step 1 Monitor the completion status of the report in the Reports page of the Status Monitor. When the report has completed, note the name of the report output file.

Step 2 Go to the CommServer\Reports directory. Locate the report output file to be viewed.

Step 3 If the report is in Web page format, the browser will start automatically and display the information. If the report is in comma-delimited format, you may be required to choose an application in which to display the information.


To Print a Report


Step 1 View the report, as described in the "To View a Report" procedure.

Step 2 On the File menu, click Print.


To View the Status of a Report

The ability to view report status is controlled by class of service.


Step 1 Go to http://<Cisco Unity server name>/status, or double-click the desktop shortcut to the Status Monitor.

Step 2 Click Reports.


Subscribers Report

Use the Subscribers report to get a list of Cisco Unity subscribers. You can generate the report for an individual subscriber or for all Cisco Unity subscribers.

The Subscribers report includes the following information:

First Name, Last Name

The name of the subscriber for whom the report was generated.

Note that the distribution list selection option is not supported in this release.

Alias

The subscriber short name.

Location

The Cisco Unity location.

Domain

The Windows domain name assigned to a subscriber. This field contains no data when the report is run on a Domino mailstore.

Billing ID

The billing ID of a subscriber.

Class of Service (COS)

The class of service assigned to a subscriber.

Extension

The primary phone extension assigned to a subscriber.

Alternate extensions are not listed.

Inbox Size

The total size, in kilobytes, of all e-mail, voice, and fax messages stored for the subscriber.


Subscriber Message Activity Report

Use the Subscriber Message Activity report to diagnose voice message problems reported by a subscriber (for example, voice messages are not being sent or received, or the message waiting indicator is not being turned on or off properly). You generate this report for an individual subscriber only.

The Subscriber Message Activity report includes the following information:

Date and Time

The date and time that the subscriber took action on the message.

Source

Either the computer or the phone that generated the message activity.

Action Taken in Response to Message

The activity that took place in regards to voice messages (for example, New Message, Message Read, Save, Delete, Mark New, Login, and Logoff).

The actions MWI On Requested and MWI On Completed indicate, respectively, that Cisco Unity sent a request to the phone system to turn on the MWI and received a request-completed confirmation. In cases where the phone system does not provide a confirmation, Cisco Unity assumes the request was successful.

Number of New Messages

The number of new voice messages in the subscriber mailbox.

Sender's Name and DTMF

The name and extension of the message sender, if known.

Date and Time Message Arrived

The date and time that the message arrived in the mailbox.

Dial Out Number

The number to which a message notification was sent.

Dial Out Result

The result of the outgoing call for the message notification. Possible results include:

Busy—The dialed number was busy.

Connected—The called party answered the phone.

Failure—The call failed.

Port Disabled—All ports for outgoing calls were disabled.

Port Unavailable—No ports were available for the outgoing call.

RNA (Ring No Answer)—The dialed number did not answer.

Release—The result is unknown. This typically happens for notifications sent to pagers.

Unknown—The result is unknown.


Distribution Lists Report

Use the Distribution Lists report to get a listing of all public distribution lists and, optionally, the members in each list. You can generate the report for a selected public distribution list or for all public distribution lists.

If you want the report to include the names of distribution list members, check the List All Members For Each Distribution List check box.

The Distribution Lists report includes the following information:

Creation Date

The date that the public distribution list was created.

List Alias

The short name of the public distribution list.

Count

The number of subscribers and other public distribution lists that are members of the public distribution list.

Distribution List Name

The name of the public distribution list.

Owner First and Last Name

The subscriber or public distribution list that owns the public distribution list.

If the List All Members check box is checked, this column also includes the names of subscribers and other public distribution lists that are members of the public distribution list.

Member List

This column is not used.


Failed Login Report

The Failed Login report includes information about failed phone user logons as well as failed Cisco Unity Administrator logons. Use the Failed Login report to identify patterns of invalid logons, which would indicate that an individual is trying to gain unauthorized access to Cisco Unity. The report also identifies accounts that have been locked because the maximum number of invalid logons has been exceeded.

You can generate the Failed Login report for all subscriber accounts. Additionally, you can indicate whether to show all failed logon attempts (expand the report) or show only the last failure for each subscriber.

Note that including the Failed Login report for the Cisco Unity Administrator logons requires that auditing be enabled in system security policies. Cisco Unity setup enables auditing by default.

The Failed Login report includes the following information about failed phone user logons:

Subscriber/User Name

The display name of the subscriber whose account experienced the failed logon.

Note that the select option to choose a subscriber is not supported for this release.

Alias

The short name of the subscriber whose account experienced the failed logon.

Caller ID (Phone Number Called From)

The calling number, if known, from which the logon was attempted.

Subscriber DTMF

The unique DTMF access code that callers dial to access this account.

Date and Time

The date and time of the failed logon.

Maximum Failures Exceeded

Whether the failed logon exceeded the maximum number allowed; if so, the account is locked.

Failure Number

A running total of failed logons by subscriber or by day, depending on how the report is sorted.

Source

Indicates either Standard when a subscriber uses normal Cisco Unity password security, or Enhanced when a subscriber uses enhanced phone security to log on.


The Failed Login report also includes the following information about failed Cisco Unity Administrator logons:

User Name

The logon name assigned to the subscriber.

Computer

The name of the workstation, if known, from which a subscriber attempted to log on.

User Domain

The Windows domain name assigned to a subscriber.

Event ID

The Windows event ID that was generated when the logon failed.

Date and Time

The date and time of the failed logon.

Failure Number

A running total of failed logons by subscriber or by day, depending on how the report is sorted.


Transfer Billing Report

Use the Transfer Billing report to obtain information about calls that are transferred from a subscriber account or from a call handler. You can use this report for billing purposes or to keep track of transfers to long distance phone numbers. You can generate the report for all subscribers, or all billing IDs, or for a single distribution list or single call handler. Note that the single subscriber, single billing ID, distribution lists, and all call handler selection options are not supported in this release.

Only those subscribers with call transfer data appear on the report.

The Transfer Billing report includes the following information:

Name

The name of the Cisco Unity entity (such as subscriber, call handler, or interview handler) from which the call was transferred.

Extension

The extension of the Cisco Unity entity (such as subscriber, call handler, or interview handler) from which the call was transferred.

Billing ID

The billing ID of the Cisco Unity subscriber from which the call was transferred.

If the Cisco Unity billing ID for a subscriber is blank (the Billing ID field on the Subscribers > Account screen), then 0 (zero) is listed as the value for this field on the report.

Note that other entities from which calls are transferred, such as call handlers, directory handlers, and interview handlers, do not have billing IDs.

Date

The date that the transfer occurred.

Time

The time that the transfer occurred.

Dialed Number

The number that the call was transferred to.

Transfer Result

The result of the call. Possible results include:

Connected—The called party answered the phone.

Busy—The dialed number was busy.

RNA (Ring No Answer)—The dialed number did not answer.

Released—The result is unknown.


Outcall Billing Report

Use the Outcall Billing report to obtain information about outbound calls made by Cisco Unity for message notifications. This report also provides information about outbound calls that Cisco Unity makes to subscriber extensions when subscribers use their phones as the recording and playback device for the Media Master. You can use this report for billing purposes, or to keep track of message notifications sent to long distance phone numbers. You can generate the report for subscribers, billing IDs, or for a distribution list.

Note that the Dial Time option is not supported in this release.

The Outcall Billing report includes the following information.

Name

The name of the Cisco Unity entity (such as subscriber, call handler, or interview handler) that made the call.

Extension

The extension of the Cisco Unity entity (such as subscriber, call handler, or interview handler) that made the call.

Billing ID

The billing ID of the Cisco Unity subscriber from which the call was transferred.

If the Cisco Unity billing ID for a subscriber is blank (the Billing ID field on the Subscribers > Account screen), 0 (zero) is listed as the value for this field on the report.

Note that other entities from which calls are transferred, such as call handlers, directory handlers, and interview handlers, do not have billing IDs.

Time

The time that Cisco Unity made the call.

Delivery Device

The notification device that the message was sent to, which can be a home phone, work phone, spare phone, or pager. When the phone is used as the recording and playback device for the Media Master, the word "TRAP" (Telephone Record And Playback) is listed as the delivery device.

Dialed Number

The phone number of the delivery device.

Result

The result of the call. Possible results include:

Busy—The dialed number was busy.

Connected—The called party answered the phone.

Failure—The call failed.

Port Disabled—All ports for outgoing calls have been disabled.

Port Unavailable—No ports were available for the outgoing call.

RNA (Ring No Answer)—The dialed number did not answer.

Release—The result is unknown. This typically happens for notifications sent to pagers.

Unknown—The result is unknown.

Call Time (Seconds)

The length of the call, in seconds.


Administrative Access Activity Report

Use the Administrative Access Activity report to track which system administrators changed values in Cisco Unity during a specified period and the changes they made. You can generate this report for all administrators. The option to select a single administrator is not supported in this release.

The Administrative Access Activity report includes the following information:

Date and Time

The date and time that the administrator created, deleted, or updated data for a Cisco Unity entity (such as subscriber, call handler, or interview handler).

Administrator's Short Name

The administrator short name.

Administrator's First and Last Name

The name of the administrator.

DTMF ID

The extension assigned to the administrator.

Administrative Action

Whether the administrator action created, updated, or deleted data for a Cisco Unity entity.

Object

The type of Cisco Unity entity (such as subscriber, call handler, or interview handler) that the administrator created, deleted, or updated.

Name

The name of the Cisco Unity entity (such as subscriber, call handler, or interview handler) that the administrator created, deleted, or updated.

Field (Property)

The name of the field from the page in the Cisco Unity Administrator that was changed in creating, updating, or deleting data for a Cisco Unity entity.

Value

The new value for the changed field.


Event Log Report

Use the Event Log report to list events from the Windows application log. You can generate the report for all application events on the Cisco Unity server, or for the events that apply only to Cisco Unity. Note that Cisco Unity writes events only to the Windows application log; it does not write events to the system or security logs. If you generate a report for all application events, you can identify the Cisco Unity events as those events that begin with "CiscoUnity" or "AV" (for example, "CiscoUnity_LogMgr").

You can also view application events by using the Windows Event Viewer (on the Windows Start menu, click Programs > Administrative Tools > Event Viewer). For more information on Windows events, refer to the Windows Event Viewer Help.

The Event Log report includes the following information:

Date and Time

The date and time that the event occurred.

Type

The Windows event type.

Source

The component that caused and logged the event.

Message (Msg) ID

The event ID.

Computer

The server on which the event occurred.

More Info

A message that contains additional information about the event.


Port Usage Report

You can use the Port Usage report to determine if the voice messaging system is running close to capacity, and indicate a specific port or ports to include in the report. Enter port numbers or ranges of numbers separated by commas (for example, 1,2,4-8) in the Ports to Show field. Note that this report fails if the specific port numbers or ranges that are entered are not valid (for example, do not enter a port range of 10-50 if there are only 48 ports on the system.)

As an alternative to the Port Usage report, we recommend using the Port Usage Analyzer, available in Tools Depot. For more information, refer to the Port Usage Analyzer Help.

The Port Usage report includes the following information:

Port Number

The Cisco Unity port number.

Unit of Time

The unit of time by which data is broken down for the time period that you specified in the Date Range. Depending on the length of the time period, data is broken down into hours, days, and weeks.

Date Range

The range of dates for which data is included.

Time

The specific hour or date(s) by which data is broken down for the time period that you specified in the Date Range.

Ports

The ports included in the report.

Number of Calls

The number of calls processed by the port per hour, day, or week for the time period specified.

Length of Calls

The total length, in milliseconds, of all calls on the port per hour, day, or week for the time period specified.

Average Length of Calls

The average length, in seconds, of all calls on the port per hour, day, or week for the time period specified.

Percent Utilization

The percentage of available time that a port was in use per hour, day, or week.

Note that we recommend that the value of Percent Utilization not exceed 80 percent of the ports used for incoming calls during peak usage.

Average Calls Per Hour

The average number of calls per hour for each port.

Average Calls Per Day

The average number of calls per day for each port. This information is provided only on the row that contains the summary for the week.


System Configuration Report

Use the System Configuration report to get information about the Cisco Unity server and software. You also can view this information in the Cisco Unity Administrator on the Configuration pages.

The System Configuration report includes the following information:

Serial Number

This field is not applicable to the current version of the report.

OEM Code

This field is not applicable to the current version of the report.

Product

The name of the software product and version number.

Number of Voice Ports

The number of voice ports licensed for the Cisco Unity system.

Languages

The number of language licenses.

Available Licenses and Total Licenses

The available and total number of Cisco Unity licensed features, such as Digital Networking.

Leading Silence for Recordings

The length of silence, in seconds, allowed at the beginning of a recording. When the leading silence is longer than specified, Cisco Unity stops recording and discards the recording.

Trailing Silence for Short and Long Recordings

The length of silence, in seconds, allowed at the end of recordings that are 30 seconds or less and of recordings that are more than 30 seconds. When the trailing-silence limit is reached, Cisco Unity assumes the recording is finished and stops recording.

Minimum Length for a Recording

The minimum length of a recording, in seconds. When a recording is shorter than the minimum length, it is discarded.

Computer and Windows Domain Name

The Cisco Unity server name on the network and the Windows domain name.

Total Hard Drive Space, Total Used Hard Drive Space, and Total Free Space

The total size of all hard disks, the total amount of space in use, and the total free space on the Cisco Unity server.

Additional Settings

The report contains additional information about the Cisco Unity server and software, such as integration type, Cisco Unity Assistant licensing, and the Text to Speech engine.

(Note that in version 3.1 and earlier, the Cisco Unity Assistant was known as the ActiveAssistant, or AA.)


Unresolved References Report

Use the Unresolved References report to locate primary call handlers (those call handlers that are associated with a subscriber account), other call handlers, and interview handlers that are left unresolved because of the improper deletion of a subscriber account. The problem occurs when a subscriber is deleted by using Lotus Domino or Windows administrator applications without first deleting the subscriber by using the Cisco Unity Administrator.

If the report finds a problem with a call handler, directory handler, or interview handler, run the Cisco Unity Database Walker utility (DbWalker), available in Tools Depot, to repair the problem.

The Unresolved References report includes the following information:

Handler Name

The name of the unresolved handler.

Handler/Access ID

The extension (if any) associated with the handler.

Handler Type

The type of handler found to be in an unresolved state. The type can include call handlers, interview handlers, the directory handler, or primary call handlers.

Owner

The owner of the handler.

Message Recipient

The message recipient associated with the handler.


Call Handler Traffic Report

Use the Call Handler Traffic report to track the number of calls routed by call handlers, and how callers chose to exit the handlers.

This report can only be run for all call handlers. Note that the option to select a single call handler is not supported in this release.

There are four ways a caller can exit a call handler: by hanging up, by choosing a one-key dialing option, by dialing an extension that transfers the call to another call handler (or subscriber), or by being routed automatically by the after-greeting action specified in the call handler.

The Call Handler Traffic report includes the following information:

Start Time

The specific hour or date(s) by which data is broken down for the time period that you specified in the Date Range.

Total Calls

The total number of calls routed to the call handler.

Method Callers Use to Exit a Call Handler

The total number of times each exit method is used by callers. Callers can exit a call handler by hanging up, pressing a one-key dialing option, dialing an extension that transfers the call to another call handler (or subscriber), or by being routed to another call handler (such as the Goodbye call handler) as specified by the after-greeting action.

Key

The number of calls in which the caller exited the call handler by pressing a one-key dialing option. The report includes a tally for each key.

DTMF ID

The number of calls in which the caller exited the call handler by dialing a valid extension to transfer to another call handler (or subscriber).

Invalid DTMF ID

The number of calls routed to the default Error call handler because the caller dialed an invalid extension.

After Greeting Action

The number of calls routed according to the after greeting action specified for the call handler.

Hang-Up

The number of calls in which the caller exited the call handler by hanging up.