3.15 Report_CallDetail_H323Gateway

Use this Knowledge Script to display details for calls that match criteria you specify for a selected H.323 gateway. Call details can include time, calling number, and called number. Any criteria parameter you leave blank is not included in the search.

If you have Cisco Communications Manager Express gateways, run CCME_GetConfig to ensure the Data Collection process has access to configuration information when processing call detail records. Without the configuration information, the Data Collection process cannot determine the IP address of the Communications Manager Express phone and you will not be able to use the Originating IP Address and Terminating IP Address selection parameters in this Report script.

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.

3.15.1 Resource Object

Report agent

3.15.2 Default Schedule

By default, this script runs once.

3.15.3 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.

Minimum duration

Specify a minimum duration 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.

Type 0 to indicate no limit.

Maximum duration

Specify a maximum duration for calls selected by the script. Calls with a duration of greater than the maximum will not be included in the report, even if all other criteria are satisfied.

Type 0 to indicate no limit.

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.

Originating gateway name

Specify the name of the originating gateway you want to find.

Terminating gateway name

Specify the name of the terminating gateway you want to find.

Originating IP address

Specify the IP addresses of the originating gateways 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.

For calls through the gateway from the PSTN, this search criterion returns the actual IP address of the gateway. For calls through the gateway from Communications Manager Express phones, this search criterion returns the IP address of the Communications Manager Express phones. If this IP address cannot be determined from Communications Manager Express configuration information, this search criterion returns no information.

Terminating IP address

Specify the IP addresses of the terminating gateways you want to find. You can 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.

For calls through the gateway to the PSTN, this search criterion returns the actual IP address of the gateway. For calls through the gateway to Communications Manager Express phones, this search criterion returns the IP address of the Communications Manager Express phones. If this IP address cannot be determined from Communications Manager Express configuration information, this search criterion returns no information.

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.

Call Details to Include in Report

Call duration

Select to include call duration in the call details for each call in the report. The default is checked.

Call type

Select to include call classification type in the call details for each call in the report. The default is unselected.

For more information, see Reviewing Call Classification Types.

Originating gateway disconnect cause code

Select to include the disconnect cause code in the call details for each originating gateway call included in the report. The default is checked.

Terminating gateway disconnect cause code

Select to include the disconnect cause code in the call details for each terminating gateway call included in the report. The default is checked.

Call ID

Select to include the call ID in the call details for each call in the report. The default is unselected.

The call ID is a globally unique identifier (GUID) that identifies the call. AppManager uses the call ID from the h323-conf-id field received in the RADIUS records; all H.323 call legs belonging to the same call will have the same h323-conf-id.

Gateway, Port, and IP Information

Originating gateway name

Select to include the name of the originating gateway in the call details for each call in the report. The default is unselected.

Originating gateway voice port

Select to include the port number of the originating gateway voice port in the call details for each call in the report. The default is unselected.

Originating IP address

Select to include the IP address of the originating gateway or Communications Manager Express phone in the call details for each call in the report. The default is unselected.

Inbound trunk group name

Select to include the name of the inbound trunk group in the call details for each call in the report. The default is unselected.

Terminating gateway name

Select to include the name of the terminating gateway in the call details for each call in the report. The default is unselected.

Terminating gateway voice port

Select to include the port number of the terminating gateway voice port in the call details for each call in the report. The default is unselected.

Terminating IP address

Select to include the IP address of the terminating gateway or Communications Manager Express phone in the call details for each call in the report. The default is unselected.

Outbound trunk group name

Select to include the name of the outbound trunk group in the call details for each call in the report. The default is unselected.

Quality Metrics

Originating gateway ...

Select to include the following originating gateway metrics in the call details for each call in the report. The default is unselected.

  • Codec type

  • MOS

  • R-value

  • ICPIF Voice Quality

  • Packets sent

  • Packets received

  • Packets lost

  • Packets early

  • Packets late

  • Delay

Terminating gateway ...

Select to include the following terminating gateway metrics in the call details for each call in the report. The default is unselected.

  • Codec type

  • MOS

  • R-value

  • ICPIF Voice Quality

  • Packets sent

  • Packets received

  • Packets lost

  • Packets early

  • Packets late

  • Delay

Remote Session Protocol and IP Addresses

Originating gateway session protocol

Select to include the protocol being used on the originating VoIP legs of a call. Cisco voice gateways set this information to “cisco” for the H.323 protocol.

Originating gateway remote gateway IP address

Select to include the IP address of the originating gateway’s terminating gateway in the call details for each call in the report. The default is unselected.

For a call coming in through the voice gateway to an IP phone registered to a Communications Manager, the remote gateway IP address is that of the Communications Manager.

Originating gateway remote gateway port

Select to include the port number of the originating gateway’s terminating gateway in the call details for each call in the report. The default is unselected.

For a call coming in through the voice gateway to an IP phone registered to a Communications Manager, the remote gateway port is that of the Communications Manager.

Originating gateway remote media IP address

Select to include the IP address of the originating gateway’s remote media in the call details for each call in the report. The default is unselected.

The remote media address is the IP address to which media is streamed.

For a call coming in through the voice gateway to an IP phone registered to a Communications Manager, the remote media IP address is that of the phone.

Originating gateway remote media port

Select to include the port number of the originating gateway’s terminating media in the call details for each call in the report. The default is unselected.

For a call coming in through the voice gateway to an IP phone registered to a Communications Manager, the remote gateway port is that of the phone.

Terminating gateway session protocol

Select to include the protocol being used on the terminating VoIP legs of a call. Cisco voice gateways set this information to “cisco” for the H.323 protocol.

Terminating gateway remote gateway IP address

Select to include the IP address of the terminating gateway’s originating gateway in the call details for each call in the report. The default is unselected.

For a call leaving the voice gateway from an IP phone registered to a Communications Manager, the originating gateway IP address is that of the Communications Manager.

Terminating gateway remote gateway port

Select to include the port number of the terminating gateway’s originating gateway in the call details for each call in the report. The default is unselected.

For a call leaving the voice gateway from an IP phone registered to a Communications Manager, the originating gateway port is that of the Communications Manager.

Terminating gateway remote media IP address

Select to include the IP address of the terminating gateway’s remote media in the call details for each call in the report. The default is unselected.

The remote media address is the IP address to which media is streamed.

For a leaving the voice gateway from an IP phone registered to a Communications Manager, the remote media IP address is that of the phone.

Terminating gateway remote media port

Select to include the port number of the terminating gateway’s originating media port in the call details for each call in the report. The default is unselected.

For a call leaving the voice gateway from an IP phone registered to a Communications Manager, the remote media port is that of the phone.

Report Settings

Maximum number of calls to return

Specify the maximum number of calls to include in the report. The default is 1000 calls.

NOTE:No matter how many calls you choose to include in the call details section of the report, the report will also include a small table that indicates how many calls actually met your search criteria. This number may, and probably will, exceed the number of calls you choose to return.

Order rows by?

Select one of the following call detail options as the criterion for sorting the rows in the report:

  • Ascending Time (oldest to most recent)

  • Descending Time (most recent to oldest)

  • Longest Duration (longest to shortest)

  • Shortest Duration (shortest to longest)

  • Calling Number

  • Called Number

  • Orig Gateway Name. If you select this option, also check the Originating gateway name parameter under the Gateway and Port information folder of this script.

  • Term Gateway Name. If you select this option, also check the Terminating gateway name parameter under the Gateway and Port Information folder of this script.

  • Inbound Trunk Group. If you select this option, also check the Inbound trunk group name parameter under the Gateway and Port information folder of this script.

  • Outbound Trunk Group. If you select this option, also check the Outbound trunk group name parameter under the Gateway and Port information folder of this script.

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.

Select output folder

Set parameters for the output folder. The default folder name is CallDetail_H323Gateway.

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 Cisco H.323 Gateway Call Details.

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 successfully generated. 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 cannot be generated. The default is 5.