4.13 CDR_CallFailures

Use this Knowledge Script to monitor call detail records (CDRs) retrieved from the primary Communications Manager for calls that ended with an abnormal termination code.

This script raises an event if the number of failed calls exceeds the threshold you set. In addition, this script generates a data stream for the number of failed calls.

This script provides the following features:

Monitoring. In monitoring mode, this script checks the CDR tables at each specified interval for new records that match your query. In the first iteration of the job, this script finds the last record in the CDR table and checks back one interval from there. In subsequent iterations, this script checks for new records that match the query in each interval.
Troubleshooting. In troubleshooting mode, this script runs once and checks the CDR tables for calls whose disconnect time is within the range you select in the Select call disconnect time range parameter.

To run this script in troubleshooting mode, select Run once on the Schedule tab.
Diagnosing. In diagnostic mode, this script works in conjunction with NetIQ Vivinet Diagnostics to diagnose VoIP quality problems detected monitoring. If the Maximum number of failed calls threshold is exceeded, then, by default, this script launches Action_DiagnoseVoIPQuality, a Knowledge Script that in turn launches Vivinet Diagnostics to generate a diagnosis of the problem.

To turn off diagnostic mode, click the Actions tab, select Action_DiagnoseVoIPQuality, and click Delete. Turning diagnostic mode off or on does not affect the events raised by this script.

4.13.1 Prerequisites

Run the SetupSupplementalDB Knowledge Script to create the CiscoCM supplemental database that will house the call detail records.
Run the CDR_RetrieveCallRecords and CDR_RetrieveConfigData Knowledge Script to populate the database.

For more information, see Section 4.47.1, Understanding the CiscoCM Supplemental Database.

4.13.2 Resource Object

CiscoCM_CDRMgmt

4.13.3 Default Schedule

By default, this script runs every five minutes.

4.13.4 Setting Parameter Values

Set the following parameters as needed:

Parameter	How to Set It
General Settings
Job Failure Notification
Event severity when job fails	Set the event severity level, from 1 to 40, to indicate the importance of the failure of the CallFailures job. The default is 5.
Include call details?	Select Yes to include call details in the events raised by this script. Leave this parameter unchecked to suppress call details. The default is unselected. If you select Yes, an event includes the following details: Originating Device Name Originating IP Address Calling Party Number Originating Media Cap - Payload Capacity Destination Device Name Destination IP Address Original Called Party Number Final Called Party Number Originating Cause Destination Cause
Raise event if no records found?	Select Yes to raise an event if there are no CDRs to monitor. Note that we do not mean there are no CDRs with abnormal termination codes, but that there are no CDRs at all. The default is unselected.
Event severity when no records found	Set the event severity level, from 1 to 40, to indicate the importance of an event in which no CDRs were found. The default is 25.
Query Filters Despite the number of calls AppManager might find that match the filters you select, an event displays only the first 50 calls.
Ignore unknown cause codes?	Select Yes if you want to ignore CDRs with cause codes of Unknown. The default is unselected.
Exclude these failure codes	Enter a list of termination codes (separated by commas) that are not to be considered failures. See Termination Codes for a list of available codes. NOTE:CiscoCM automatically excludes Codes 0, 16, 31, and 393216. They are normal termination codes. However, these codes might appear in events if the other side of the call has a failure code that has not been excluded.
Minimum duration	Set this parameter to filter out records whose call duration is less than the specified value. Accept the default of 0 to ignore the filter for minimum call duration.
Maximum duration	Set this parameter to filter out records whose call duration is less than or equal to the specified value. Accept the default of 0 to ignore the filter for maximum call duration.
Calling directory number	Specify the number of the calling directory you want to find in the CDRs. Wildcard characters are acceptable. Leave this parameter blank to search for any calling directory number.
Directory number connector	Set this parameter ONLY if you specify both a Calling directory number and a Called directory number. Your selection indicates how the script will connect the two parameters: AND or OR. The default is AND.
Called directory number	Specify the number of the called directory you want to find in the CDRs. Wildcard characters are acceptable. Leave this parameter blank to search for any called directory number.
Originating device name	Set this parameter to query for those calls whose originating device name matches the specified value. Wildcard characters are acceptable. Leave this parameter blank to search for any originating device name.
Device name connector	Set this parameter ONLY if you specify both an Originating device name and a Destination device name. Your selection indicates how the script will connect the two parameters: AND or OR. The default is AND.
Destination device name	Set this parameter to query for those calls whose destination device name matches the specified value. Wildcard characters are acceptable. Leave this parameter blank to search for any destination device name.
Troubleshooting
Select call disconnect time range	Select a Specific or Sliding date/time range for which the query should search for data. The default time range is fixed at 24 hours. NOTE:This parameter is valid only when you select Run once on the Schedule tab.
Monitor Failed Calls
Event Notification
Raise event if number of failed calls exceeds threshold?	Select Yes to raise an event if the number of calls that failed with an abnormal termination code exceeds the threshold. The default is Yes.
Threshold - Maximum number of failed calls	Specify the maximum number of calls that can fail before an event is raised. The default is 0 calls.
Event severity when number of failed calls exceeds threshold	Set the event severity level, from 1 to 40, to indicate the importance of an event in which the number of failed calls exceeds the threshold. The default is 15.
Data Collection
Collect data for number of failed calls?	Select Yes to collect data for charts and reports. If enabled, data collection returns the number of calls that failed with an abnormal termination code during the monitoring period. The default is unselected.

4.13.5 Termination Codes

Use this list of termination codes (also known as call release cause codes) to complete the Exclude these failure codes parameter.

Termination Code	Description	Explanation
0	No error	No error.
1	Unallocated (unassigned) number	Indicates the called party cannot be reached because, although the called party number is in a valid format, it is not currently allocated (assigned).
2	No route to specified transit network (national use)	Indicates one of the following: The equipment sending this code has received a request to route the call through a transit network that it does not recognize. The equipment does not recognize the transit network either because the transit network does not exist or because the transit network exists but does not serve the equipment that is sending the code. The prefix 0 is invalid for the entered number.
3	No route to destination	Indicates one of the following: The called party cannot be reached because the network through which the call was routed does not service the desired destination. This cause is supported on a network-dependent basis. A 1 was dialed when not required. Redial without the 1.
4	Send special information tone	Indicates one of the following: The prefix 1 is not required for this number. The called party cannot be reached for reasons of a long-term nature. The special information tone should be returned to the calling party.
5	Misdialed trunk prefix (national use)	Indicates the erroneous inclusion of a trunk prefix in the called party number.
6	Channel unacceptable	Indicates a called user cannot negotiate for a B-channel other than that specified in the SETUP message.
7	Call awarded and being delivered in an established channel	Indicates the user has been awarded the incoming call and the call is being connected to a channel (such as packet mode or X.25 virtual calls) already established to that user for similar calls.
8	Preemption	Indicates a call was preempted.
9	Preemption - circuit reserved for reuse	Indicates a call was preempted because the circuit is reserved for reuse.
16	Normal call clearing	Indicates normal call clearing has occurred.
17	User busy	Indicates the called party is unable to accept another call because the user busy condition has been encountered. Code 17 might be generated by the called user or by the network. In the case of user-determined user busy, it is noted that the user equipment is compatible with the call.
18	No user responding	Indicates a called party does not respond to a call establishment message with an alerting or connect indication within the allotted prescribed period of time (before timer T303 or T310 has expired).
19	No answer from user (user alerted)	Indicates the called user has provided an alerting indication, but not a connect indication within a prescribed period of time (before timer T301 has expired).
20	Subscriber absent	Indicates one of the following:· A mobile station has logged off. Radio contact is not obtained with a mobile station. A personal telecommunications user is temporarily not addressable at any user-network interface.
21	Call rejected	Indicates one of the following: The equipment sending this cause does not wish to accept the call, although it could have accepted the call because it is neither busy nor incompatible. May be generated by the network, indicating the call was cleared due to a supplementary service constraint.
22	Number changed	Indicates the called party number specified by the calling party is no longer assigned. The new called party number might optionally be included in the diagnostic field. If a network does not support this cause, then cause #1 shall be used.
26	Non-selected user clearing	Indicates the user has not been awarded the incoming call.
27	Destination out of order	Indicates the destination specified by the user cannot be reached because the interface to the destination is not functioning correctly. The term "not functioning correctly" indicates a signal message was unable to be delivered to the remote party, as in the following examples: Physical layer or data link layer failure at the remote party User equipment off-line
28	Invalid number format (address incomplete)	Indicates one of the following: The called party cannot be reached because the called party number is not in a valid format or is not complete. The user should be returned a Special Intercept Announcement.
29	Facility rejected	Indicates one of the following: The network cannot provide the requested facility. A user in a special business group, such as a Centrex, dialed an undefined code.
30	Response to STATUS ENQUIRY	Indicates one of the following: This cause is included in the Status Message when the reason for sending the Status Message was the previous receipt of a Status Enquiry message. A user from outside a basic business group, such as a Centrex, has violated an access restriction feature.
31	Normal, unspecified	Used to report a normal event only when no other cause in the normal class applies.
34	No circuit/channel available	Indicates no appropriate circuit or channel is available to handle the call.
38	Network out of order	Indicates the network is not functioning correctly and the condition is likely to last a relatively long time. Immediately re-attempting the call is not likely to be successful.
39	Permanent frame mode connection out of service	Indicates a permanent connection was terminated, probably due to equipment failure.
40	Permanent frame mode connection operational	Indicates a permanent connection is operational again. The connection was previously terminated, probably due to equipment failure.
41	Temporary failure	Indicates the network is not functioning correctly and the condition is not likely to last a long time. The user might wish to attempt another call almost immediately. May also indicate a data link layer malfunction locally or at the remote network interface, or a call was cleared due to protocol error(s) at the remote network interface.
42	Switching equipment congestion	Indicates the switching equipment generating this cause is experiencing a period of high traffic.
43	Access information discarded	Indicates the network is unable to deliver user information (such as user-to-user information, low-level compatibility, or sub-address) to the remote users as requested.
44	Requested circuit/channel not available	Indicates the other side of the interface cannot provide the circuit or channel indicated by the requesting entity.
46	Precedence call blocked	Indicates the remote device that was called is busy.
47	Resource unavailable, unspecified	Indicates one of the following: No other cause in the resource unavailable class applies. The original destination is unavailable. Invoke redirection to a new destination.
49	Quality of Service not available	Indicates the network cannot provide the requested Quality of Service. This might be a subscription problem.
50	Requested facility not subscribed	Indicates this facility is unavailable because the user has not subscribed to it.
53	Service operation violated	Indicates the user has violated the service operation.
54	Incoming calls barred	Indicates the user will not accept the call delivered in the SETUP message.
55	Incoming calls barred within Closed User Group (CUG)	Indicates the network does not allow the user to receive calls.
57	Bearer capability not authorized	Indicates the user requested a bearer capability implemented by the equipment that generated this cause. However, the user is not authorized to use it. This common problem is caused by incorrect Telco provisioning of the line at the time of installation.
58	Bearer capability not presently available	Indicates the user requested a bearer capability implemented by the equipment that generated this cause. However, bearer capability is unavailable at the present time. This problem might occur because of a temporary network problem or a subscription problem.
62	Inconsistency in designated outgoing access information and subscriber class	Indicates an inconsistency in the designated outgoing access information and subscriber class.
63	Service or option not available, unspecified	Indicates a service or option is not available. Used only when no other cause in this class applies.
65	Bearer capability not implemented	Indicates the equipment sending this cause does not support the requested bearer capability.
66	Channel type not implemented	Indicates the called party reached an unsupported channel type.
69	Requested facility not implemented	Indicates the network (or node) does not support the requested bearer capability and therefore cannot be accessed at this time.
70	Only restricted digital information bearer capability available (national use)	Indicates the calling party requested an unrestricted bearer service. However, the equipment sending this cause supports only the restricted version of the requested bearer capability.
79	Service or option not implemented, unspecified	Indicates a service or option was not implemented. Used only when no other cause in this class applies.
81	Invalid call reference value	Indicates the equipment sending this cause received a message with a call reference not currently in use on the user-network interface. This value applies only if the call reference value is 1 or 2 octets long and is not the global call reference.
82	Identified channel does not exist	Indicates the equipment sending this cause received a request to use a channel not active on the interface for a call.
83	A suspended call exists, but this call identity does not	Indicates suspended call exists but the call's identity does not.
84	Call identity in use	Indicates a call identity is in use.
85	No call suspended.	Indicates no call is suspended.
86	Call having the requested call identity has been cleared	Indicates the call, with the requested call identity, has cleared.
87	User not member of Closed User Group (CUG)	Indicates the call was not completed, probably because of one the following reasons: The dialed number is incorrect The user is not authorized to use (or has not subscribed to) the requested service User is using a service the remote device is not authorized to use
88	Incompatible destination	Indicates the equipment sending this cause received a request to establish a call with low layer compatibility, high layer compatibility, or other compatibility attributes (such as data rate or DN subaddress) that cannot be accommodated. This call might be returned by a switch to a CPE when trying to route a call to an incompatible facility, or one without a data rate.
90	Destination number missing and DC not subscribed	Indicates the call was not completed, probably due to one of the following reasons: The dialed number is incorrect The user is not authorized to use (or has not subscribed to) the requested service User is using a service the remote device is not authorized to use
91	Invalid transit network selection (national use)	Indicates an invalid transit network selection was requested.
95	Invalid message, unspecified	Indicates the entity sending this cause received an invalid message. Used when no other cause in this class applies.
96	Mandatory information element is missing	Indicates the equipment sending this cause received a message missing an information element that must be present in the message before the message can be processed.
97	Message type non-existent or not implemented	Indicates one of the following: The equipment sending this cause received a message type it does not recognize. Either the message is not defined or it is defined and not implemented by the equipment sending this cause. A problem with the remote configuration or with the local D-channel.
98	Message not compatible with the call state, or the message type is non-existent or not implemented	Indicates one of the following: Message received is not compatible with the call state Message type is non-existent or not implemented
99	An information element or parameter non-existent or not implemented	Indicates the equipment sending this cause received a message that includes information elements not recognized because either the information element identifier is not defined, or it is defined but not implemented by the equipment sending the cause. However, the information element is not required for the equipment sending the cause to process the message.
100	Invalid information element contents	Indicates the equipment sending this cause received an information element it has implemented. However, one or more fields of the information elements are coded in such a way (such as truncated, invalid extension bit, invalid field values) that the information element was not implemented by the equipment sending this cause.
101	The message not compatible with the call state	Indicates one of the following: The equipment sending this cause received a message procedure indicating it is not a permissible message to receive at this time. The switch sending this cause is clearing the call because a threshold was exceeded for multiple protocol errors during an active call.
102	Call terminated when timer expired; a recovery routine executed to recover from the error	Indicates a procedure was initiated by the expiration of a timer in association with error-handling procedures.
103	Parameter non-existent or not implemented - passed on (national use)	Indicates the equipment sending this cause received a message that includes parameters not recognized because the parameters are defined but not implemented by the equipment sending the cause. The parameters were ignored. In addition, if the equipment sending this cause is an intermediate point, then this cause indicates the parameters were passed on unchanged.
110	Message with unrecognized parameter discarded	Indicates the equipment sending this cause discarded a received message that includes a parameter that is not recognized.
111	Protocol error, unspecified	Reports a protocol error event only when no other cause in this class applies. This cause might display if the user failed to dial a 9 or an 8 for an outside line. In addition, this cause might be returned in the event of certain types of restrictions as to number of calls.
122	Precedence level exceeded	Indicates users attempted to make a call with a higher level of precedence than the highest precedence level authorized for their line.
123	Device not preemptable	Indicates one of the following: The dialed number is non preemptable. That is, the dialed number registers as busy and has no call waiting, no call forwarding, and no alternate party designations. The dialed number has a higher precedence level (or priority) than the dialing number and cannot be preempted.
125	Out of bandwidth	Indicates not enough bandwidth was found to connect a call to the destination location.
127	Interworking, unspecified	Indicates an interworking call (usually a call to SW56 service) ended. This might also be seen in the event of a non-specific rejection by a long distance carrier.
129	Precedence out of bandwidth	Indicates not enough bandwidth was found to connect a precedence call to the destination location.
162144 0x40000	Conference full	A Cisco-specific code. Indicates a conference is at full capacity and can accept no new callers.
393216 0x60000	Call split	A Cisco-specific code. Indicates a call was terminated during a transfer operation because it was split off and terminated (not part of the final transferred call). This code might help determine which calls were terminated as part of a feature operation.
458752 0x70000	Drop any party/drop last party	A Cisco-specific code. Indicates a call dropped from a conference by the new feature "drop any party/drop last party."