3.16 Report_CallFailureCauses

Use this Knowledge Script to analyze the failure causes for calls matching criteria you specify. You can select more than one filter in the Search Criteria parameters.

NOTE:Unlike other modules, for the Call Data Analysis module, the Report agent pulls data from the Data Warehouse rather than from the AppManager repository. The Report agent uses Windows authentication to access the Data Warehouse.

Resource Object

Report agent

Default Schedule

By default, this script runs once.

Setting Parameter Values

Set the following parameters as needed:

Parameter	How to Set It
Data Source
Select data source	Select the data for your report by View Name, Data Warehouse, or Data Source.
Select time range	Select a Specific or Sliding date/time range from which the report should pull data. The default is Sliding.
Exclude these failure codes	Specify 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:Codes 0, 16, 31, 126, and 393216 are automatically excluded. They are normal termination codes. However, these codes may appear in events if the other side of the call has a failure code that has not been excluded.
Minimum duration	Specify the minimum duration filter for calls selected by the script. Calls with a duration of less than the minimum will not be included in the report, even if all other criteria are satisfied. The default is 0 seconds.
Search Criteria
Note for entering search criteria: If you specify only the wildcard () for a field (such as calling number), AppManager matches only those calls that have a value for that field. Calls for which that field has no value (i.e., is NULL) will not be matched. For example, if you specify in the Calling partition name parameter, the search matches only those calls that have some partition name configured. To match all calls (including calls that have no value for the selected field), leave the search criteria parameter blank.
Calling number	Specify the calling number you want to find.
Called number	Specify the called number you want to find.
Calling device name	Specify the name of the calling device you want to find.
Called device name	Specify the name of the called device you want to find.
Calling device IP address	Specify the IP addresses of the calling devices you want to find. Use one of the following formats: Single dotted-decimal IP address, such as 10.41.2.31 Dotted-decimal IP address that includes a wildcard, such as 10.41.., which would search for all IP addresses in the range of 10.41.0.0 to 10.41.255.255. Range of dotted-decimal IP addresses separated by a hyphen, such as 10.41.2.31-10.41.2.41. The first address indicates the beginning of the range; the second IP address marks the end of the range.
Called device IP address	Specify the IP addresses of the called devices you want to find. Use one of the following formats: Single dotted-decimal IP address, such as 10.41.2.31 Dotted-decimal IP address that includes a wildcard, such as 10.41.., which would search for all IP addresses in the range of 10.41.0.0 to 10.41.255.255. Range of dotted-decimal IP addresses separated by a hyphen, such as 10.41.2.31-10.41.2.41. The first address indicates the beginning of the range; the second IP address marks the end of the range.
Calling device location name	Specify the name of the calling device location you want to find. Use the location configured on the Communications Manager.
Called device location name	Specify the name of the called device location you want to find. Use the location configured on the Communications Manager.
Calling partition name	Specify the name of the calling partition you want to find.
Called partition name	Specify the name of the called partition you want to find.
Inbound trunk group name	Specify the name of the inbound trunk group you want to find.
Outbound trunk group name	Specify the name of the outbound trunk group you want to find.
Report Settings
Include parameter help card?	Set to y to include a table in the report that lists parameter settings for the report script. The default is y.
Include table?	Set to y to include a table of data stream values in the report. The default is y.
Include time details table?	Set to y to include the time details table in the report. The time details table presents a breakdown of the failure causes that occurred during each hour of the reporting period.
Include chart?	Set to y to include a chart of data stream values in the report. The default is y.
Select chart style	Define the graphic properties for the charts in your report. The default style is Pie.
Select output folder	Set parameters for the output folder. The default folder name is CallDataFailureCauses.
Add job ID to output folder name?	Set to y to append the job ID to the name of the output folder. The default is n. A job ID is helpful for making the correlation between a specific instance of a Report script and the corresponding report.
Select properties	Set miscellaneous report properties as desired. The default report name is Call Failure Causes.
Add time stamp to title?	Set to y to append a time stamp to the title of the report, making each title unique. The default is n. The time stamp is made up of the date and time the report was generated. Adding a time stamp is useful in order to run consecutive iterations of the same report without overwriting previous output.
Event Notification
Raise event if report succeeds?	Set to y to raise an event if the report is successfully generated. The default is y.
Event severity when report succeeds	Set the severity level, from 1 to 40, to indicate the importance of an event in which the report is successful. The default is 35.
Event severity when report has no data	Set the severity level, from 1 to 40, to indicate the importance of an event in which the report contains no data. The default is 25.
Event severity when report fails	Set the severity level, from 1 to 40, to indicate the importance of an event in which the report fails. The default is 5.

3.16.1 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 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 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 has been 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 has been preempted.
9	Preemption - circuit reserved for reuse	Indicates a call has been 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 may 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 want 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 indicated by the calling party is no longer assigned. The new called party number may optionally be included in the diagnostic field. If a network does not support this cause, 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 indicated 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 may want 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. May 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 has 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 has requested a bearer capability implemented by the equipment that generated this cause. However, bearer capability is unavailable at the present time. This problem may be due to 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 has 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 has 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 has 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 has 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 a 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 having the requested call identity has cleared.
87	User not member of Closed User Group (CUG)	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
88	Incompatible destination	Indicates the equipment sending this cause has received a request to establish a call that has low layer compatibility, high layer compatibility, or other compatibility attributes (such as data rate or DN subaddress), which cannot be accommodated. This call can 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 has been requested.
95	Invalid message, unspecified	Indicates the entity sending this cause has 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 has received a message that is 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 has 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 has 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 has 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 has not been 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 has received a message that procedures indicate is not a permissible message to receive at this time. The switch sending this cause is clearing the call because a threshold has been 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 has been initiated by the expiration of a timer in associated with error-handling procedures.
103	Parameter non-existent or not implemented - passed on (national use)	Indicates the equipment sending this cause has 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, this cause indicates the parameters were passed on unchanged.
110	Message with unrecognized parameter discarded	Indicates the equipment sending this cause has 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 may be displayed if the user failed to dial a 9 or an 8 for an outside line. In addition, this cause may 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.
126	Call split	A Cisco-specific code used by Communications Manager. 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 can help determine which calls were terminated as part of a feature operation.
127	Interworking, unspecified	Indicates an interworking call (usually a call to SW56 service) has ended. May 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.
262144 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 used by Unified Communications Manager. 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 can 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 was dropped from a conference by the new feature "drop any party/drop last party."