Guest

Cisco PGW 2200 Softswitch

Call Reporting

  • Viewing Options

  • PDF (443.6 KB)
  • Feedback
Cisco PGW 2200 Softswitch Call Reporting Feature Module

Table Of Contents

Cisco PGW 2200 Softswitch Call Reporting Feature Module

Feature Description

Call-Specific Alarms

Benefits

Prerequisites

Related Documents

Supported Standards, MIBs, and RFCs

Provisioning Tasks

Provisioning Examples

Creating Customized Messages for Call Reporting

Dial Plan Examples

Provisioning the Result Type

MML Command Reference

NUMAN-ADD:CRPTMESG—Add a Customized Message (Release 9.7(3), Patch S25P25)

NUMAN-RTRV:CRPTMESG—Retrieve a Call Reporting Message (Release 9.7(3), Patch S25P25)

NUMAN-ED:CRPTMESG—Edits a Call Reporting Message (Release 9.7(3), Patch S25P25)

NUMAN-DLT:CRPTMESG—Deletes a Call Reporting Message (Release 9.7(3), Patch S25P25)

Software Changes for This Feature

Alarms

Call Report Alarm

Measurements

Result Type Definitions

Result Type

Obtaining Documentation, Obtaining Support, and Security Guidelines

Glossary


Cisco PGW 2200 Softswitch Call Reporting Feature Module


Document Release History

Publication Date
Comments

May 24, 2009

Initial release of document


Feature History

Release
Modification

9.7(3), Patch S25P25

The Call Reporting feature was introduced.


This document describes the Call Reporting feature. The feature is described in the following sections:

Feature Description

Supported Standards, MIBs, and RFCs

Provisioning Examples

Dial Plan Examples

MML Command Reference

Software Changes for This Feature

Obtaining Documentation, Obtaining Support, and Security Guidelines

Glossary

Feature Description

This feature is introduced in Release 9.7(3), Patch S25P25 of the Cisco PGW 2200 Softswitch.

The Call Reporting feature enables the Cisco PGW 2200 Softswitch to generate an alarm if a caller dials a particular number. You specify the number as a digit string (for example, the emergency number 999 in the United Kingdom, or 911 in the United States). In response to such an alarm, a security team can capture the alert and respond appropriately.

The Call Reporting feature also enables the Cisco PGW 2200 Softswitch to report call details by way of SNMP to a network element management system such as the Cisco Media Gateway Controller Node Manager (CMNM). Also, you can provision the Call Reporting feature by using the Cisco Voice Services Provisioning Tool, as an alternative method to an MML command session.

Call-Specific Alarms

The Call Reporting feature enables the Cisco PGW 2200 Softswitch to generate an alarm when it detects a specific trigger. The feature introduces the new dial plan result, CALL_REPORT. When it receives a call that triggers the dial plan result, the Cisco PGW 2200 Softswitch generates a new SNMP trap. For the dial plan result, you can configure a predefined text string (for example, "Emergency"), which the Cisco PGW 2200 Softswitch can include in the SNMP trap, along with some call details (such as the calling and called numbers).

The CALL_REPORT dial plan result is triggered in Pre-analysis and B-number analysis.

Benefits

This feature provides the following benefits:

The Cisco PGW 2200 Softswitch can generate an alarm when it receives a specific type of call.

The Cisco PGW 2200 Softswitch can report call details to a network management system through SNMP traps.

Prerequisites

The Cisco PGW 2200 must be running Cisco MGC software Release 9.7(3), Patch S25p25. Prerequisites for this release can be found in the Release Notes for the Cisco Media Gateway Controller Software Release 9.7(3) at

http://www.cisco.com/en/US/partner/docs/voice_ip_comm/pgw/9/release/note/rn973.html

Related Documents

This document contains information that is strictly related to this feature. The documents that contain additional information related to the Cisco Media Gateway Controller (MGC) are at

http://www.cisco.com/en/US/products/hw/vcallcon/ps2027/tsd_products_support_series_home.html

Supported Standards, MIBs, and RFCs

This section identifies the new or modified standards, MIBs, and RFCs that are supported by this feature.

Standards

No new or modified standards are supported by this feature.

MIBs

New MIBs are available for this feature. There are new MIB objects. You can find a list of the new MIB objects in the "Measurements" section. For more information on the MIBs used in the Cisco MGC software, see Cisco PGW 2200 Softswitch MIBs at

http://www.cisco.com/iam/PGW_MIBS/index.html

RFCs

No new or modified RFCs are supported by this feature.

Provisioning Tasks

Information about provisioning is available in the Cisco Media Gateway Controller Software Release 9 Provisioning Guide in the following sections:

Planning for Provisioning

http://www.cisco.com/en/US/partner/docs/voice_ip_comm/pgw/9/provisioning/guide/R9PlnPrv.html

MML Basics

http://www.cisco.com/en/US/partner/docs/voice_ip_comm/pgw/9/provisioning/guide/R9MMLCfg.html

Provisioning Examples

The Call Reporting feature creates a new configuration file named crptMessage.dat. This file contains the customized data that is included in a call detail record. You can dynamically configure the crptMessage.dat file to define a string (for example, crptmesg), which you can include in the call details by provisioning the CALL_REPORT result type.

This section provides a provisioning example for this feature. Additional provisioning examples for the Cisco MGC software can be found in the Cisco Media Gateway Controller Software Release 9 Provisioning Guide.

Creating Customized Messages for Call Reporting

This section presents sample MML commands that show how you can create a customized message for the Call Reporting feature.


Note Before the Cisco PGW 2200 Softswitch can insert crptmesg in data word 2, you must define crptmesg by issuing the appropriate MML commands.


To specify a message string that will be associated with crptmesg, you can issue the MML command numan-add two ways. If you issue the command with the "index" parameter, the command adds a string at the record position given by the index, if that position is empty. The range for the number of index positions is 1 through 65,535. If you issue the numan-add command without the "index" parameter, the command appends the defined string at the end of a list of string records.

The following sample command shows how to issue the numan-add command with the "index" parameter.

mml> numan-add:crptmesg:index=1, msgstr="Emergency Call" 

The following sample numan-add command shows how to issue the command without the "index" parameter.

mml> numan-add:crptmesg:msgstr="Emergency Call" 

The following sample numan-dlt command shows how to delete a message string associated with crptmesg.

mml> numan-dlt:crptmesg:msgstr="Emergency Call" 

The following sample numan-rtrv command shows how to display messages associated with crptmesg that were set previously.

mml> numan-rtrv:crptmesg: 

The following sample numan-ed command shows how to change the message associated with crptmesg and the index 1.

mml> numan-ed:crptmesg:index=1, msgstr="Fire Alarm"

Dial Plan Examples

This section provides a sample MML command that shows how to modify the dial plan for this feature. You can find additional examples of dial plan provisioning for the Cisco MGC software in the Cisco Media Gateway Controller Software Release 9 Dial Plan Guide.

Provisioning the Result Type

For the Call Reporting feature, the Cisco PGW 2200 Softswitch can derive the CALL_REPORT result type in either the Pre-analysis stage or the B-number stage of dial plan analysis.

The following MML sample command provides an example of how you can provision the result type for the Call Reporting feature in the Pre-analysis stage of dial plan analysis:

numan-add:resultset:custgrpid=''1111'', name=''pre-ana-callreport'' 

numan-add:resulttable:custgrpid=''1111'', setname=''pre-ana-callreport'', 
name=''callreport'', resulttype=''CALL_REPORT'', dw1=''1'', dw2=''Emergency'' 

numan-add:cpc:custgrpid=''1111'',cpcvalue=50,setname=''pre-ana-callreport'' 

MML Command Reference

This section documents new, modified, or deleted Man-Machine Language (MML) commands. All other MML commands are documented in the Cisco Media Gateway Controller Software Release 9 MML Command Reference.

NUMAN-ADD:CRPTMESG—Add a Customized Message (Release 9.7(3), Patch S25P25)

Purpose:

Adds a customized Call Reporting message.

Syntax:

numan-add:crptmesg:index=1,msgstr="Emergency Call"

Input Description:

index—Identifies the defined string. The Cisco PGW 2200 Softswitch associates the index with the corresponding message string when it sends a trap to the SNMP manager.

msgstr—The character string that constitutes the customized message.

Example:

The following sample MML command adds the customized message, "Emergency Call":

mml>numan-add:crptmesg:index=1,str="Emergency Call"

NUMAN-RTRV:CRPTMESG—Retrieve a Call Reporting Message (Release 9.7(3), Patch S25P25)

Purpose:

Retrieves a call reporting messages.

Syntax:

numan-rtrv:crptmesg:"all"
numan-rtrv:crptmesg:index=1

Input Description:

CRPTMESG—The call reporting message represented as a character string.

Example:

The following sample MML command retrieves all customized messages that have been created by the operator issuing the numan-add:crptmesg MML command.

mml> numan-rtrv:crptmesg:"all"

The following sample MML command retrieves the customized message associated with the specified index.

mml> numan-rtrv:crptmesg:index=1

NUMAN-ED:CRPTMESG—Edits a Call Reporting Message (Release 9.7(3), Patch S25P25)

Purpose:

Enables you to modify a call reporting message.

Syntax:

numan-ed:crptmesg:index=1,msgstr="Fire Alarm"

Input Description:

CRPTMESG—The call reporting message represented as a character string.

Example:

The following sample MML command modifies a customized message.

mml> numan-ed:crptmesg:index=1,msgstr="Fire Alarm"

NUMAN-DLT:CRPTMESG—Deletes a Call Reporting Message (Release 9.7(3), Patch S25P25)

Purpose:

Enables you to delete a call reporting message.

Syntax:

numan-dlt:crptmesg:index=1,msgstr="Fire Alarm"

Input Description:

CRPTMESG—The call reporting message represented as a character string.

Example:

The following sample MML command deletes a customized message:

mml> numan-dlt:crptmesg:index=1,msgstr="Fire Alarm"


Note You can execute the command numan-dlt:crptmesg only if you did not provision crptmesg when you created the CALL_REPORT result type in the result table.


Software Changes for This Feature

The following sections contain software changes related to this feature:

Alarms

Measurements

Dial Plan Examples

Alarms

This section lists the alarms that are added, modified, or deleted for this feature. For information on the other alarms for the Cisco MGC software, see the Cisco Media Gateway Controller Software Release 9 Messages Reference Guide.

Call Report Alarm

The Call Reporting feature introduces the following new alarm to the Cisco PGW 2200 Softswitch software.

Call Report

Description

The Call Reporting message string that you want to be reported when the alarm is triggered.

Severity

Informational

Cause

This alarm is triggered by the result type you provision in the dial plan.

SNMP Trap Type

6 (Call Report alarm)

Action

None.

Measurements

The following new MIB objects are added to the CISCO-TRANSPATH-MIB (tp.my file). They enable the Cisco PGW 2200 Softswitch to support the Call Reporting feature. See the Cisco Media Gateway Controller Software Release 9.7(3) MIBs.

CISCO-TRANSPATH_MIB (tp.my file)

tpCallObject OBJECT IDENTIFIER ::= { tpRecords 6 }

tpCallDescription OBJECT-TYPE

SYNTAX DisplayString (SIZE (0.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The description of the call reported"

::= {tpCallObject 1}

tpCallSeverity OBJECT-TYPE

SYNTAX INTEGER (1.. 3)

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The severity of the call reported"

::= {tpCallObject 2}

tpIncomingTG OBJECT-TYPE

SYNTAX INTEGER (1.. 9999)

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

        "The name (or ID) of the incoming trunk group."

::= {tpCallObject 3}

tpCircuit OBJECT-TYPE

SYNTAX INTEGER (1.. 65535)

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The cic of the call reported"

::= {tpCallObject 4}

tpProtocol OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 99))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The protocol of the call reported"

::= {tpCallObject 5}

tpRawCGPN OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The original calling party number of the call reported"

::= {tpCallObject 6}

tpFinalCGPN OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The final calling party number of the call reported"

::= {tpCallObject 7}

tpDisplayName OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The display name of the call reported"

::= {tpCallObject 8}

tpSIPFrom OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The From tag of the call reported"

::= {tpCallObject 9}

tpSIPContact OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The Contact tag of the call reported"

::= {tpCallObject 10}

tpSIPPAssertedID OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The PAssertedID tag of the call reported"

::= {tpCallObject 11}

tpCallID OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The call ID of the call reported"

::= {tpCallObject 12}

tpH323ID OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The H323 ID of the call reported"

::= {tpCallObject 13}

tpH323GK OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The H323 GK of the call reported"

::= {tpCallObject 14}

tpIncomingIP OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The incoming IP of the call reported"

::= {tpCallObject 15}

tpIncomingMediaIP OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The incoming media IP of the call reported"

::= {tpCallObject 16}

tpOrigCDPN OBJECT-TYPE

SYNTAX DisplayString (SIZE (1.. 255))

MAX-ACCESS not-accessible

STATUS current

DESCRIPTION

"The original called party number of the call reported"

::= {tpCallObject 17}

...

callReport NOTIFICATION-TYPE

OBJECTS

{

tpAlarmCatId,

tpAlarmCatName,

tpAlarmTime,

tpCallDescription,

tpCallSeverity,

tpIncomingTG,

tpCircuit,

tpProtocol,

tpRawCGPN,

tpFinalCGPN,

tpDisplayName,

tpSIPFrom,

tpSIPContact,

tpSIPPAssertedID,

tpCallID,

tpH323ID,

tpH323GK,

tpIncomingIP,

tpIncomingMediaIP,

tpOrigCDPN

}

STATUS current

DESCRIPTION

"xxxx"

::= {tpTraps 6}

Result Type Definitions

This section defines a new result type that is introduced to support the Call Reporting feature.

Result Type

For the Call Reporting feature, you must create a new result type named CALL_REPORT to indicate that a call should be reported to the management station. When a call triggers the CALL_REPORT result type, the Cisco PGW 2200 Softswitch generates a new SNMP trap. When you configure the dial plan result, you can define a text string (for example, "Emergency"), which the Cisco PGW 2200 Softswitch can pass in the SNMP trap. Also, the Cisco PGW 2200 Softswitch can pass other call details (such as calling and called numbers) that are identified by the new MIB objects that have been added to the CISCO-TRANSPATH-MIB (tp.my file) to support this feature.

Table 1 Result Type Definitions 

Result Number
Result Type
Data Word 1
Data Word 2
Data Word 3
Data Word 4
Analy-sis Points
Result Type Valid For
Intermediate
End Point
A-digit analysis
B-digit analysis
Cause
Pre-analysis

87

CALL_REPORT

Call severity

0: Minor

1: Major

2: Critical

Predefined text that you configure to be sent as part of the SNMP

0 (not used)

0 (not used)

X

   

X

 

X


Obtaining Documentation, Obtaining Support, and Security Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Glossary

I

Table 2 Acronym Expansions

Acronym
Expansion

CMNM

Cisco Media Gateway Controller Node Manager

MGC

Media Gateway Controller

MIB

Management Information Base

MML

Man-Machine Language

PGW

PSTN Gateway

RFC

Request For Comments

SNMP

Simple Network Management Protocol

VSPT

Voice Services Provisioning Tool