Cisco PGW 2200 Softswitch Release 9.8 Dial Plan Guide
Chapter 4. Provisioning Dial Plans with MML
Downloads: This chapterpdf (PDF - 861.0KB) The complete bookPDF (PDF - 5.97MB) | Feedback

Provisioning Dial Plans with MML

Table Of Contents

Provisioning Dial Plans with MML

Dial Plan Parameters

Adding a Dial Plan

Adding a Component to a Dial Plan

Deleting a Component from a Dial Plan

Deleting a Digit String Range

Deleting All Three B-digit Tree Entries

Deleting the B-digit Tree with 4 and Not Deleting 444 and 445

Deleting the 444 and 445 B-digit Trees and Not Deleting 4

Deleting Only the 444 B-digit Tree

Deleting a Dial Plan

Changing a Component in a Dial Plan

Deleting the Contents of a Dial Plan

Retrieving a Component in a Dial Plan

Updating Changes in a Dial Plan

Migrating Dial Plans Dealing with SCREENING Entries

Migration For Customers Without SCREENING Entries

Migration For Customers With SCREENING Entries

Adding Dial Plan Components

Adding Carrier Selection (CARRIERTBL)

Adding a Digit Modification (DIGMODSTRING)

Adding a Service (SERVICE)

Adding a Result (RESULTTABLE)

Adding the RETRY_ACTION Result Type

Adding the MGCPDIALPKG Result Type

Adding the BCMOD Result Type

Adding the HLCMOD Result Type

Adding an A-Digit Tree (ADIGITTREE)

Adding a B-Digit Tree (BDIGITTREE)

Adding Numbering Plan Indicator Data (ANPI and BNPI)

Adding Nature of Address Data (NOA)

Adding a LINEXLATE Table to the Dial Plan for Configurable NOA Mapping

Provisioning the LINEXLATE Table

Adding a Location (LOCATION)

Adding a Cause (CAUSE)

Adding Screening Lists (SCREENING)

A-Number Screening File Formats

B-Number Screening File Formats

Importing or Exporting Screening Data

Adding an AWHITE List

Adding an ABLACK List

Adding a BWHITE List

Adding a BBLACK List

Adding a Ported Number Table (PORTTBL)

Adding a Term Table (TERMTBL)

Adding a Dial Plan Selection (DPSELECTION)

Adding A-Number Dial Plan Selection (ANUMDPSEL)

Provisioning CODEC Capabilities (CODECSTRING)

Provisioning the CODEC Capabilities

Route Holiday Provisioning

Provisioning Overdecadic Status

Provisioning Advice of Charge

Provisioning the Charge Holiday List

Adding an Entry to the Charge Holiday List

Editing an Entry in the Charge Holiday List

Deleting an Entry From the Charge Holiday List

Retrieving Entries From the Charge Holiday List

Charge Holiday Provisioning Examples

Provisioning the Charge List

Provisioning the Charge Result Type

Adding an Entry in the Charge List

Editing an Entry in the Charge List

Deleting an Entry from the Charge List

Retrieving Entries From the Charge List

Charge Provisioning Examples

Provisioning the Tariff List

Adding an Entry in the Tariff List

Editing an Entry in the Tariff List

Deleting an Entry in the Tariff List

Retrieving Entries From the Tariff List

Provisioning Charge Origin

Provisioning the CHARGEORIGIN Result Type

Adding an Entry in the Charge Origin List

Editing an Entry in the Charge Origin List

Deleting an Entry From the Charge Origin List

Retrieving Entries From the Charge Origin List

Importing a Charge Origin List

Charge Origin Provisioning Examples

Provisioning AOC PRI Supplemental Services

Charge Origins (Optional)

Trunk Group or Signaling Path Property

A-Number Result

CLI Charge Origin Table

Charge Destinations

Holiday Table (Optional)

PRI Charge Table

PRI Tariff Table

Activation Type for AOC Supplementary Services—AOCInvokeType

Default Tariff for AOC Supplementary Service—AOCDefaultTariffId

Default Charging Unit Duration for AOC-D Supplementary Service— AOCDMinPeriodicTimerDuration

PRI AOC Supplementary Services Activation

Combined Charge and Meter Pulse Messaging Provisioning

Provisioning Percentage Based Routing

Provisioning the Conditional Result

Provisioning the Percentage Route

Creating Conditional Route Examples

Editing Conditional Route Examples

Deleting Conditional Route Examples

Retrieving Conditional Route Examples

Provisioning an Intermediate COND_RTE Result Type

Creating Percentage Based Route Examples

Editing Percentage Based Route Examples

Deleting Percentage Based Route Examples

Retrieving Percentage Based Route Examples

Provisioning Conditional Routing

Provisioning the COND_ROUTE Result Type

Provisioning the Route Holiday List

Adding an Entry to the Route Holiday List

Editing an Entry in the Route Holiday List

Deleting an Entry From the Route Holiday List

Retrieving Entries From the Route Holiday List

Route Holiday Provisioning Examples

Provisioning Calling Party Category

Provisioning Transmission Medium Requirements

Provisioning Transit Network Selection

Provisioning Bearer Capability Based Routing

Provisioning the Bearer Capability Based Routing

Provisioning the Announcement

Provisioning the Tone and Announcement Database Table

Provisioning the ANNOUNCEMENT Result Type

Provisioning an ATM Profile

Adding an ATM Profile to routeAnalysis.dat

Adding ATM Profiles to the Result Table

Provisioning Tech Prefix Capabilities

Adding the Tech Prefix

Removing the Tech Prefix

Provisioning Advanced Screening Capabilities

Provisioning CLI IP Address

Adding CLI IP Address to a Customer Group

Deleting CLI IP Address with Subnet Mask from a Customer Group

Editing CLI IP Address

Provisioning CLI Prefix

Adding CLI Prefix to a Customer Group

Deleting CLI Prefix from a Customer Group

Editing CLI Prefix

Provisioning H.323 ID

Adding H.323 ID to a Customer Group

Deleting H.323 ID from a Customer Group

Editing H.323 ID

Provisioning Results of Various Result Types

Provisioning the CC_DIG Result Type

Provisioning Country Codes

Provisioning the Result Set

Provisioning the BdigTree

Provisioning the NEW_DIALPLAN Result Type

Provisioning the A_NUM_DP_TABLE Result Type

Provisioning the INC_NUMBERING Result Type

Provisioning Examples for Various Result Types

Importing Dial Plan Information

Enabling Dial Plan Selection for Incoming Trunk groups

Enabling Dial Plan Selection for Incoming SIP Trunk Group

Enabling Dial Plan Selection for Incoming EISUP Trunk Group

Determining Which IP Address to Use for Dial Plan Selection

Configuring the MGC to Use IP Packet Source Address for Dial Plan Selection

Configuring Cisco PGW 2200 Softswitch to use IP from SDP INVITE for Dial Plan Selection

Verifying Your Changes

Verifying Incoming Trunk Group Calls

Verifying Incoming Calls that Do Not Have a Presentation Number

Verifying Incoming Calls that Do Not Have an NOA Presentation Number

Verifying Incoming Calls that Do Not Have an NPI Presentation Indicator

Verifying Incoming Calls that Do Not Have a PN Presentation Indicator

Verifying Your Changes

Provisioning Call Limiting

Provisioning Call Limiting for an A-number

Provisioning Call Limiting for a B-number

Provisioning the OVERRIDE_CALLIM Result Type for Number Analysis

Dial Plan Examples

Scaling Dial Plan Elements

Provisioning Call Reporting

Provisioning Calling Name Delivery

Provisioning Full Number Translations

Provisioning Global Titles

Provisioning Domain Based Routing

Provisioning Generic Call Tagging

Provisioning Conditional A-Number Digit Modification

Adding Digit Modification String Data

Adding A-Number Modification Result Table Data

Adding A-Number Digit Tree Data

Enabling A-Number Normalization

Provisioning E911 Mapping

Adding an E911PROF Result Type

Collecting E911PROF Data

Mapping Methods

Mapping Method 1: ESRK Delivery

Mapping Method 2: CBN and ESRD Delivery


Provisioning Dial Plans with MML


Revised: January 20, 2011, Cisco MGC Software Release 9.5(1)

This chapter describes how to provision dial plans using Man-Machine Language (MML) commands. The procedures described in this chapter allow you to create, add, modify, and delete dial plan components. It also describes how to verify the actions taken with dial plan components and gives tips that can help you solve dial plan provisioning problems.

The Cisco PGW 2200 Softswitch uses information from the dial plans to perform number analysis and call processing.

This chapter includes the following sections:

Adding a Dial Plan

Migrating Dial Plans Dealing with SCREENING Entries

Adding Dial Plan Components

Provisioning Overdecadic Status

Provisioning Advice of Charge

Combined Charge and Meter Pulse Messaging Provisioning

Provisioning Percentage Based Routing

Provisioning Conditional Routing

Provisioning Calling Party Category

Provisioning Bearer Capability Based Routing

Provisioning the Announcement

Provisioning an ATM Profile

Provisioning Tech Prefix Capabilities

Provisioning Advanced Screening Capabilities

Provisioning Results of Various Result Types

Provisioning Examples for Various Result Types

Importing Dial Plan Information

Provisioning Call Limiting

Scaling Dial Plan Elements

Provisioning Call Reporting

Provisioning Calling Name Delivery

Provisioning Full Number Translations

Provisioning Global Titles

Provisioning Domain Based Routing

Provisioning Generic Call Tagging

It is recommended that you provision dial plan components in the following order:


Note The order in which you provision dial plan tables is important. Many tables refer to other tables that must be defined first.

1. Create the dial plan file (unique CustGrpID).

2. Provision Digit Modification.

3. Provision the Service.

4. Provision the Result and Result Sets.

5. Provision the A-numbers and B-numbers.

6. Provision calling party category (CPC).

7. Provision transmission medium requirement (TMR) analysis.

8. Provision B-number nature of address (NOA) and numbering plan indicator (NPI) analysis.

9. Provision transit network selection (TNS).

10. Provision North American Numbering Plan (NANP) B-number normalization.

11. Provision the Location value.

12. Provision the Cause value.

13. Provision the A and B Whitelist and Blacklist screening files.

Dial Plan Parameters

Once you have filled in the dial plan worksheets you must configure the Cisco PGW 2200 Softswitch to implement your dial plan. When configuring the Cisco PGW 2200 Softswitch, you can use the dial plan worksheets and either the MML commands listed in this chapter or the VSPT procedures listed in Chapter 3 "Provisioning Dial Plans with the Cisco VSPT".

Table 4-1 describes the configuration parameters that apply to each dial plan you define.

Table 4-1 Dial Plan Parameter Descriptions 

MML
Component Name
MML
Parameter Names
Description

DIALPLAN

 

Selects the customer-created dial plan.

 

OVERDEC

Indicates the overdecadic status only when adding a dial plan.

ADIGTREE

 

Selects the A-digit tree table.

SETNAME

MML name of the result set.

DIGITTOPRESENT

Indicates the number of digits to skip (forward
or backward) during analysis, if not set to 0.

CALLSIDE

Indicates if the call side is originating or terminating.

DIGITSTRING

All the digits in a calling number or called number. Cannot use with NEXTNODE, DIGIT, or INDEX.

BDIGTREE

 

Selects the B-digit tree table.

SETNAME

MML name of the result set.

DIGITTOPRESENT

Indicates the number of digits to skip (forward
or backward) during analysis, if not set to 0.

CALLSIDE

Indicates if the call side is originating or terminating.

DIGITSTRING

All the digits in a calling number or called number. Cannot use with NEXTNODE, DIGIT, or INDEX.

RESULTTABLE

 

Selects the Result table.

NAME

MML name of the result.

RESULTTYPE

Indicates the type of result.

DW1

First data word.

DW2

Second data word.

DW3

Third data word.

DW4

Fourth data word.

NEXTRESULT

Next result name.

SETNAME

MML name of the result set.

DIGMODSTRING

 

Selects Digit String Modification table.

NAME

MML name of the digit modification string.

DIGSTRING

The digit string.

ANOA

 

Selects calling number Nature of Address (NOA) table.

NOAVALUE

The NOA value.

NPIBLOCK

The NPI block value.

SETNAME

MML name of the result set.

ANPI

 

Selects calling number Numbering Plan Indicator (NPI) table.

NPIBLOCK

The NPI block.

BLOCKVALUE

The NPI block value.

SETNAME

MML name of the result set.

BNOA

 

Selects called number NOA table.

NOAVALUE

The NOA value.

NPIBLOCK

The NPI block value.

SETNAME

MML name of the result set.

BNPI

 

Selects called number NPI table.

NPIBLOCK

The NPI block.

BLOCKVALUE

The NPI block value.

SETNAME

MML name of the result set.

CAUSE

 

Selects the Cause table.

CAUSEVALUE

The cause value.

LOCATIONBLOCK

The cause location block.

SETNAME

MML name of the result set.

LOCATION

 

Selects the Location table.

LOCATIONBLOCK

The location block.

SETNAME

MML name of the result set.

BLOCKVALUE

The location block value.

SERVICE

 

Selects the Service table.

NAME

MML name of the service.

RESULTSET

 

Selects the result set in the Result Set table.

NAME

MML name of the result set.

AWHITE

 

Selects the A-digit tree white list.

CLI

Sets calling line identity (CLI) for A-digit tree white list.

ABLACK

 

Selects the A-digit tree black list.

CLI

Sets the CLI for the A-digit tree black list.

BWHITE

 

Selects the B-digit tree white list.

CLI

Sets the CLI for the B-digit tree white list.

SVCNAME

MML name of the previously defined service.

BBLACK

 

Selects the B-digit tree black list.

CLI

Sets the CLI for B-digit tree black list.

SVCNAME

MML name of the previously defined service.

PORTTBL

 

Selects the Ported Number table.

DIGITSTRING

The called number.

ROUTENUMBER

The routing number.

TERMTBL

 

Selects the Number Termination table.

DIGITSTRING

The called number.

ROUTELISTNAME

The route list name.

ACHORIGIN

 

Selects the A-number charge origin.

CUSTGRPID

The customer group ID.

CLI

Sets calling line identity (CLI) for A-digit tree white list.

CORIGIN

The call origin.

DEFRESULTSET

 

Selects the default result set.

RESULTTYPE

Indicates the type of result.

DW1

First data word.

DW2

Second data word.

DW3

Third data word.

DW4

Fourth data word.

DPSEL

 

Selects the dial plan.

NEWDP

The new dial plan ID.

ANUMDPSEL

 

Selects the A-number dial plan.

CLI

The calling party number.

RTEHOLIDAY

 

Selects the route holiday.

DATE

The holiday date.

HDAY

The holiday day.

CPC

 

Selects the calling party category.

CPCVALUE

The CPC value.

SETNAME

MML name of the result set.

TMR

 

Selects the transmission medium requirement.

TMRVALUE

The TMR value.

SETNAME

MML name of the result set.

TNS

 

Selects the transit network selection.

TNSVALUE

The TNS value.

SETNAME

MML name of the result set.

CLIPREFIX

 

Selects the CLI prefix.

CLISETNAME

The CLI prefix set name.

CLIPREFIX

The CLI prefix.

CUSTGRPID

The Customer group ID.

CLIIPADDRESS

 

Selects the CLIP address.

CUSTGRPID

The Customer group ID.

IPADDR

The IP Address.

SUBNETMASK

The Subnet mask.

CLISETNAME

The CLI prefix set name.

H323IDDIVFROM

 

Selects the H323 ID, Division header, or From field.

CUSTGRPID

The Customer group ID.

H323IDDIVFROM

H323 ID, Division header, or From field.

CLISETNAME

The CLI prefix set name.


To add, modify, or delete the contents of a dial plan table, an active provisioning session is required.

An open provisioning session is not needed to access the AWHITE, ABLACK, BWHITE, BBLACK, PORTBL, TERMTBL, ANUMDPSEL, ACHGORIGIN, CLIPREFIX, CLIIPADDRESS, H323IDDIVFROM, ANNOUNCEMENT, and SCRIPT tables.

When performing a deploy or copy, dial plan files from the provisioning directory are copied to the active directory. The active directory for dial plan files is /opt/CiscoMGC/dialPlan.

All TIDs, with the exception of DIALPLAN, require a customer group ID and a name. The DIALPLAN requires only a customer group ID.

The DIALPLAN cannot be edited.

The DIALPLAN can be retrieved to determine all of the dial plans currently configured.

Provision the routes and the digit modification string table before result and digit tree tables.

When an index is added to a table, the missing indexes are also added with default values. For example, if index 10 is added to the A-digit tree table, and indexes 4 through 9 are missing, they are added with default values.

When an index is deleted from a result or digit tree table, all the elements in the index are zeroed. When an index is deleted from routes or the digit modification string table, all the elements in the index are made 'x'. When an index is deleted from any table and if there are no indexes with non-default values following this index, all the indexes following this index are deleted.

The modify command is not supported for result sets, since modifications are performed at the result table level.

The modify command is not supported for the service table.

When an entry is added to the result table, the corresponding entry is added to the result set table.

When an entry is deleted from the result set table, the corresponding entries are deleted from the result table.

Index is no longer required to perform any operations on the result table, service table, or digit modification table.

The result set cannot be modified for a result table.

The following TIDs: DIALPLAN, RESULTTABLE, DIGMODSTRING, NOA, NPI, CAUSE, LOCATION, SERVICE, and RESULTSET support retrieving all entries in their respective table by specifying "all". For example:

numan-rtrv:resultset:custgrpid="T001","all"
 
   

The TIDs adigtree and bdigtree allow retrieving all entries in the table by either not specifying a digitstring or by specifying an empty digitstring. For example:

numan-rtrv:adigtree:custgrpid="T001",digitstring=""
 
   

Configuring a result set as the default result set replaces the previous result set.

The default result set can have only one of the following result types: BLACKLIST, ROUTE, or CAUSE.

Adding a Dial Plan

The dial plan component is used to add dial plan component parameters. You can enter MML commands for a dial plan in a text file and then pass the text file as a batch to MML.


Caution Consider using dial plan text files for initial provisioning only. When you pass a dial plan text file to MML, all existing dial plan data is replaced by the data in the text file. When provisioning a large dial plan, break the dial plan into smaller pieces rather than loading the entire dial plan as a single batch file. Validation of the dial plan requires a fairly large amount of swap space.

To add a dial plan component, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:dialplan:custgrpid="t100"
 
   

This command adds the dial plan component and the required custgrpid parameter.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the dial plan you added is present.

Step 3 Repeat steps 1 and 2 for each dial plan you want to add.


Adding a Component to a Dial Plan

The dial plan you added in the previous procedure is a file labeled CustGrpId.dialPlan, where the customer group ID is four alphanumeric characters.

For more information on dial plan component parameters, see Chapter 1 "Dial Plan and Routing."

To add any component to a dial plan, you also use the NUMAN-ADD command. For example, to add a route component to the dial plan results, you would complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:resulttable:custgrpid="t777",resulttype="route",setname="setone", 
name="resultone",dw1="rtlistone"
 
   

This command adds a ROUTE result type with the name "resultone" to the dial plan results.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the route component you added to the dial plan is present.

Step 3 Repeat steps 1 and 2 for each route component you want to add to the dial plan.


Deleting a Component from a Dial Plan

To delete a component from a dial plan, you must enter the command NUMAN-DLT.

For example, to delete a resultset component from a dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-dlt:resultset:custgrpid="t001",name="setone"
 
   

This command deletes the resultset component "setone" from the dial plan.


Caution As a convenience, for the adigtree and the bdigtree components, the "NUMAN-DLT" command allows you to delete all of the numbers starting with a digit string. Here is an example command:

numan-dlt:bdigtree:custgrpid="t001",callside="originating",digitstring="starting digits"

Here are two options for the numan-dlt:bdigtree commands. The numan-dlt:adigtree command has similar usage.

Delete all of the numbers starting with a specified digit string from the B digit tree.

numan-dlt:bdigtree:custgrpid="t001",callside="originating",digitstring="404"

or

numan-dlt:bdigtree:custgrpid="t001",callside="originating",digitstring="404", 
partial="NO"
 
   

These two MML command examples delete all of the numbers starting with a "404" digit string from the B digit tree within the dial plan t001, including the number 404.

Delete only the specified number from the B digit tree

numan-dlt:bdigtree:custgrpid="t001",callside="originating",digitstring="404", 
partial="YES"
 
   

This MML command example deletes only the number 404 from the B digit tree within the dial plan t001.


Note For the numan-dlt:adigtree and the numan-dlt:bdigtree commands, use the partial parameter carefully. Setting the partial parameter value to "YES" deletes only the specified number from the digit tree. Setting the partial parameter value to "NO" deletes all of the numbers starting with a specified digit string from a digit tree. The default value for the partial parameter is "NO".

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the resultset component you deleted is no longer present.

Step 3 Repeat Step 1 and 2 for each resultset component you want to delete from the dial plan.


Deleting a Digit String Range

When deleting digit strings from a dial plan, one or more digit strings can be deleted. Depending on the software revision installed and the platform configuration, deleting a digit string can have different results. The following examples provide different examples for deleting one or more digit strings from a dial plan.

The following digit strings have been provisioned in the dial plan:

numan-add:bdigtree:custgrpid="dp1",callside="originating",digitstring="4",setname="set1"
numan-add:bdigtree:custgrpid="dp1",callside="originating",digitstring="444",setname="set2"
numan-add:bdigtree:custgrpid="dp1",callside="originating",digitstring="445",setname="set3"

Deleting All Three B-digit Tree Entries

You can use either of the following MML commands, with or without the partial parameter enabled, to delete all the B-digit tree entries that begin with a 4.

mml> numan-dlt:bdigtree:custgrpid="dp1",callside="originating",digitstring="4"
MGC-02 - Media Gateway Controller 2005-01-26 09:49:06.330 EST
M  COMPLD
   "bdigtree:WARNING: All partial matching digit tree are removed"
   ;

or

mml>numan-dlt:bdigtree:custgrpid="dp1",callside="originating",digitstring="4",partial="no"
MGC-02 - Media Gateway Controller 2005-01-26 09:49:06.330 EST
M  COMPLD
   "bdigtree:WARNING: All partial matching digit tree are removed"
   ;

Deleting the B-digit Tree with 4 and Not Deleting 444 and 445

You can use the following MML command, with the partial parameter enabled, to delete only the specified B-digit tree entry.

mml> 
numan-dlt:bdigtree:custgrpid="dp1",callside="originating",digitstring="4",partial="yes"
MGC-02 - Media Gateway Controller 2005-01-26 09:34:27.832 EST
M  COMPLD
   "bdigtree"
   ;

Deleting the 444 and 445 B-digit Trees and Not Deleting 4

You can use either of the following MML commands, with or without the partial parameter enabled, to delete all the B-digit tree entries that contain 44.

mml> numan-dlt:bdigtree:custgrpid="dp1",callside="originating",digitstring="44"
MGC-02 - Media Gateway Controller 2005-01-26 09:49:06.330 EST
M  COMPLD
   "bdigtree:WARNING: All partial matching digit tree are removed"
   ;
 
   

or

mml> 
numan-dlt:bdigtree:custgrpid="dp1",callside="originating",digitstring="44",partial="no"
MGC-02 - Media Gateway Controller 2005-01-26 09:49:06.330 EST
M  COMPLD
   "bdigtree:WARNING: All partial matching digit tree are removed"
   ;

Deleting Only the 444 B-digit Tree

You can use the following MML command to delete only the specified B-digit tree entry.

mml> numan-dlt:bdigtree:custgrpid="dp1",callside="originating",digitstring="444"
MGC-02 - Media Gateway Controller 2005-01-26 09:34:27.832 EST
M  COMPLD
   "bdigtree"
   ;

Deleting a Dial Plan

To delete a dial plan, all dependencies to files outside the dial plan must be removed. The dial plan consists of tables and sections contained inside data files, which are named after the customer group ID. The customer group ID is a primary key that links the dial plan to sigpaths, trunk groups, call screenings, and result sets. Therefore, all dependencies must be removed before deleting a dial plan from the system.

The following dependencies are checked before dial plan deletion is allowed.

Any awhite list configured for this dial plan

Any ablack list configured for this dial plan

Any bwhite list configured for this dial plan

Any bblack list configured for this dial plan

Any reference to this dial plan by other dial plans

Any ANumDPSelection table in the database

Any trunk groups or sigpaths related to this dial plan.

If any of the preceding dependencies exist to this dial plan, the deletion of the dial plan is rejected. The whole dial plan file can be deleted only if there are no dependencies.


Step 1 At the MML prompt, enter the command:

mml> numan-dlt:dialplan:custgrpid="T001"
 
   

Step 2 Verify the dial plan has been deleted by entering the command:

mml> numan-rtrv:dialplan:custgrpid="T001"
 
   

Changing a Component in a Dial Plan

To change a component in a dial plan, you must enter the command NUMAN-ED.

For example, to change a setname component in an NPI value in a dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-ed:npi:custgrpid="t777",npiblock=1,setname="settwo"
 
   

This command changes the setname to "settwo" in the NPI value in the dial plan.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the setname component you changed now reads "settwo" as changed.

Step 3 Repeat steps 1 and 2 for each setname component you want to change in the dial plan.


Deleting the Contents of a Dial Plan

In the MGC software Release 9.5(2), a parameter, contentonly, was added. When contentonly is set to "true", deletion of the contents of a dial plan (for example, cleans all dial plan sections except the service and dpselection section of the dial plan file) without first deleting dial plan dependencies is permitted. This allows dial plan contents to be changed, even though dependencies may exist, and then restored before deploying the provisioning changes.


Step 1 At the MML prompt, enter the command:

mml> numan-dlt:dialplan:custgrpid="T003",contentonly="true"

Note If contentonly is set to "false" (the default), all dependencies must be eliminated before the dial plan can be deleted.

Step 2 Continue to provision the dial plan.

Step 3 When complete, deploy the provisioning changes by using the prov-dply command.


Retrieving a Component in a Dial Plan

To retrieve information on any component in a dial plan, you must enter the command NUMAN-RTRV.

For example, to retrieve an element in a dial plan, complete the following step:


Step 1 At the MML prompt, enter the command:

mml> numan-rtrv:bdigtree:custgrpid="t777",callside="originating"
 
   

This command retrieves an element from the Bdigtree in the dial plan.

To verify the command was executed successfully, observe that information for the component(s) changed in the command is returned in the response. Repeat the command as necessary.


Updating Changes in a Dial Plan

As a result of current dial plan loading mechanisms used with the multiple dial plan functionality in this release, the chg-dpl command that manually invokes reloading of a dial plan has been removed.

Migrating Dial Plans Dealing with SCREENING Entries

Migration For Customers Without SCREENING Entries

There is no migration issue for new dial plans (dial plans without SCREENING entries). The additional dial plan file, GLBL.dialplan is automatically added to your system starting with MGC software Release 9.4(1).

Migration For Customers With SCREENING Entries

If you have multiple dial plans with duplicated sets of screening data in the TimesTen database, the difference in the records in the database is the customer group id that links the record to a specific dial plan.

Complete the following procedure to migrate your dial plan data for global screening use.


Step 1 Using an active Cisco PGW 2200 Softswitch system, login.

Step 2 Using the prov-export command, export the screening data from each dial plan.

prov-exp:all:dirname="save-config-2"

Note If you have dial plans T001 and T002 using T001.bwhite and T002.bwhite screening, after prov-export you will have 2 files, T001.Bwhite and T002.Bwhite.

Step 3 Copy T001.bwhite to GLBL.bwhite as follows:

cd /opt/CiscoMGC/etc/cust_specific/save-config-2 
cp T001.bwhite GLBL.bwhite 
more GLBL.bwhite 

Step 4 Import GLBL.bwhite as follows:

prov-add:files:name="bwhitefile",file="GLBL.bwhite",action="import" 
numan-rtrv:bwhite:custgrpid="GLBL",cli="x" 
 
   

Step 5 Modify the screening type dw1 to "dw3" for one resulttable in T001 dial plan.

Step 6 Make a test call from a test phone with the CLI listed in GLBL.bwhite.

Step 7 Modify the screening type dw1 to "dw3" for one resulttable in T002 dial plan.

Step 8 Make a test call from a test phone with the CLI listed in GLBL.bwhite.

Step 9 Modify all screening type dw1 to "3" for both T001 and T002 dial plan as follows:

Edit both T001.bwhite and T002.bwhite:

vi T001.bwhite or vi T002.bwhite 
:1,$s/1 /2 /g to replace all 1s in the first column to 2s 
 
   

Step 10 Save your changes and quit the editor as follows:

:wq! 
 
   

Step 11 Import both T001.bwhite and T002.bwhite back and verify they are empty afterward by using the following MML commands:

prov-add:files:name="bwhitefile",file="T001.bwhite",action="import" 
prov-add:files:name="bwhitefile",file="T002.bwhite",action="import" 
numan-rtrv:bwhite:custgrpid="T001",cli="x" 
numan-rtrv:bwhite:custgrpid="T002",cli="x" 
 
   

Step 12 Make a test call from a test phone with the CLI listed in GLBL.bwhite.



Caution Configuration of the Cisco PGW 2200 Softswitch software requires that the system software be shut down. In a simplex system, calls cannot be processed during system shut down. In a continuous service system, your system loses the ability to maintain calls during a critical event while the system software on one of the Cisco PGW 2200 Softswitch hosts is shut down.

Adding Dial Plan Components

Adding Carrier Selection (CARRIERTBL)

Carrier selection is used during Pre-analysis, as described in the "Transit Network Selection Analysis" section. You can use either the PROV-ADD MML command to create the list or you can use the Voice Services Provisioning Tool (VSPT) to import a carrier selection file.

To create the carrier selection list and add Carrier IDs, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> prov-add:carriertbl:carrierid="222",rtoption="carrier",rtlistname="list1"
 
   

where,

CARRIERID is a unique 2-digit through 5-digit number (enclosed in straight quotes) to identify the selected carrier. Leading zeros are significant. For example, 022 is not the same as 22.

RTOPTION identifies the selected route option:

1 = Route on called number (default)
2 = Blocked
3 = Route on Carrier ID

RTLISTNAME is a unique route list name for this routing trunk group number. You can enter as many as 20 alphanumeric characters enclosed in straight quotes. Hyphens (-) can be used; however, a specific value is not allowed unless the RTOPTION parameter is set to "CARRIER" (as shown).

This command adds a single row and a single Carrier ID to the Carrier Selection list.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify a new row has been added to the Carrier Selection list.

Step 3 Repeat steps 1 and 2, as necessary, to add new rows and new Carrier IDs to the Carrier Selection list.


Adding a Digit Modification (DIGMODSTRING)

The Digit Modification is accessed by the results to yield a string of numbers (digits) to apply to an A-number or B-number. Its target identifier (TID) is DIGMODSTRING.

To add a DIGMODSTRING list and add digit strings, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:digmodstring:custgrpid="t100",name="digname1",digstring="1045"
 
   

This command adds the digit string "1045" to the DIGMODSTRING list in the dial plan.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the DIGMODSTRING list and the digit string you entered are now present.

Step 3 Repeat steps 1 and 2 for each digit string you want to add to the DIGMODSTRING list.



Tip An implied index, which contains a single string of digits to be applied to the calling number or called number, is used to access the DIGMODSTRING list.

Adding a Service (SERVICE)

Service contains user-defined services for screening. Its TID is SERVICE.

To add a service list and add service names, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:service:custgrpid="t001",name="Washington"
 
   

This command adds a service with the service name "TollLine" to the dial plan.


Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service names.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the service with the service name that you entered is present.

Step 3 Repeat steps 1 and 2 for each service name you want to add to the service list.



Tip The service list acts with the results to provide service names.

Adding a Result (RESULTTABLE)

Results are used with number analysis. It could, for example, point to screening or to an SCP/STP index. Its TID is RESULTTABLE.

To add a RESULTTABLE to the dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:resulttable:custgrpid="t001",resulttype="SCREENING",dw1="1",dw2="Herndon", 
name="resultone",setname="setone"
 
   

This command adds a RESULTTABLE and a result set with a result type of "SCREENING," dataword1 value of "1," dataword2 value of "Herndon," a name of "resultone," and a result set name of "setone."

Step 2 At the MML prompt, enter the command:

mml> numan-add:resulttable:custgrpid="t001",resulttype="ANNOUNCEMENT",dw1="100",dw2="1", 
dw3="rtlist1",name="resulttwo",setname="settwo"
 
   

This command adds another result set to the RESULTTABLE with a result type of "ANNOUNCEMENT," dataword1 value of "100," dataword2 value of "1," dataword3 value of "rtlist1," a name of "resulttwo," and a result set name of "settwo."

Step 3 At the MML prompt, enter the command:

mml> numan-add:resulttable:custgrpid="t001",resulttype="IN_TRIGGER",dw1="1",dw2="1", 
dw3="rtlist1",name="resultthree",setname="setthree"
 
   

This command adds a third result set to the RESULTTABLE with a result type of "IN_TRIGGER," dataword1 value of "1," dataword2 value of "1," dataword3 value of "rtlist1," a name of "resultthree," and a result set name of "setthree."

Step 4 At the MML prompt, enter the command:

mml> numan-add:resulttable:custgrpid="t001",resulttype="CPCMOD",dw1="payphone", 
name="resultfour",setname="setfour"
 
   

This command adds a fourth result set to the RESULTTABLE with a result type of "CPCMOD," dataword1 value of "payphone," a name of "resultfour," and a setname of "setfour."

Step 5 To verify these four commands were executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the RESULTTABLE you created is present with all four result sets described above.

Step 6 Repeat step 1 and step 5 for each result set you want to add to the RESULTTABLE.


Adding the RETRY_ACTION Result Type

Support of trunk group advance, reattempt, or redirection is a result of cause analysis. The RETRY_ACTION result type value setting determines if route advance, reattempt, or redirection is enabled.

The following MML command adds the result type RETRY_ACTION in the results for reattempt operation.


Step 1 At the MML prompt, enter the following command:

mml> numan-add:resulttable:custgrpid="a101",name="result4",resulttype="retry_action", 
dw1="reattempt",setname="setfour"
 
   

This command adds the specified RETRY_ACTION (reattempt) to the results.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv:resulttable:custgrpid="a101",name="result4",setname="setfour"
 
   

Verify the RETRY_ACTION and the parameters you specified are now present in the Results.

Step 3 Repeat steps 1 and 2 for each RETRY_ACTION entry you add to the results.


Note For multiple RETRY_ACTION results, only the last retry action specified is applied.

Adding the MGCPDIALPKG Result Type

The MGCPDIALPKG result type is provisioned in the dialplan only against the B-Number in the B-digit tree. This result type is first read in Generic Analysis during Pre-Analysis to determine if the call is an MGCP DIAL call.

The following MML command adds the result type MGCPDIALPKG in the result table.


Step 1 At the MML prompt, enter the following command:

mml> numan-add:resulttable:custgrpid="T002",name="result45",resulttype="mgcpdialpkg",
dw1="Dynamic",dw2="1",setname="mgcpdialset3"
 
   

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the MGCPDIALPKG and the parameters you specified are now present in the result table.

Step 3 Repeat steps 1 and 2 for each MGCPDIALPKG entry you add to the result table.


Use the following MML command to select an analog call type:

mml> numan-add:resulttable:custgrpid="T002",name="result46",resulttype="mgcpdialpkg", 
dw1="Analog",dw2="1",setname="mgcpdialset2"
 
   

Or use the following MML command to select a digital call type:

mml> numan-add:resulttable:custgrpid="T002",name="result47",resulttype="mgcpdialpkg", 
dw1="Digital",dw2="1",setname="mgcpdialset1"

Adding the BCMOD Result Type

To create the bearer capability table and add the BCMOD result type, complete the following steps:


Step 1 Log in to the active Cisco MGC, start an MML session, and enter the following command to add a dial plan:

mml> numan-add:dialplan:custgrpid="dpl1",overdec="yes" 
 
   

Step 2 Enter the following command to add a result set:

mml> numan-add:resultset:custgrpid="dpl1",name="set1" 
 
   

Step 3 Enter the following command to add the BC table entry:

mml> numan-add:BC:cusgrpid="dpl1",name="bc-04",ocval="9090A3" 
 
   

Step 4 Now add the BCMOD result type to a result set and define the result set in the result table:

mml> numan-add:resulttable:custgrpid="dp11",resulttype="BCMOD",dw1="bc-04",setname="set1",
name="bc1" 
 
   

Step 5 Repeat Step 4, as necessary, to add new rows to the bearer capability table.


Adding the HLCMOD Result Type

Create the high-level capability table and add the high-level capability result type (HLCMOD) to the dial plan to modify the high level capability in the outgoing IAM by performing the following steps:


Step 1 Log in to the active Cisco MGC, start an MML session, and enter the following command to add a dial plan:

mml> numan-add:dialplan:custgrpid="dpl2",overdec="yes" 
 
   

Step 2 Enter the following command to add a result set:

mml> numan-add:resultset:custgrpid="dpl2",name="set3" 
 
   

Step 3 Enter the following command to add the HLC table entry:

mml> numan-add:HLC:cusgrpid="dpl1",name="hlc-04",ocval="9184" 
 
   

Step 4 Now add the HLCMOD result type to a result set and define the result set in the result table:

mml> numan-add:resulttable:custgrpid="dp12",resulttype="HLCMOD",dw1="hlc-04", 
setname="set3",name="result03" 
 
   

Step 5 Repeat Step 4, as necessary, to add HLCMOD result types to the result table.


Adding an A-Digit Tree (ADIGITTREE)

The A-Digit Tree contains entries, in blocks of sixteen, for each calling number. Its output is an index to the Result table or an indication that no further action is necessary. Its TID is ADIGITTREE.

To add an ADIGITTREE to the dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:adigittree:custgrpid="t100",digitstring="703484",callside="originating", 
setname="setone"
 
   

This command adds an ADIGITTREE and the required parameters to the dial plan.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the ADIGITTREE and the parameters you added are now present in the dial plan.

Step 3 Repeat steps 1 and 2 for each entry you add to the ADIGITTREE.


Adding a B-Digit Tree (BDIGITTREE)

The B-Digit Tree also contains entries, in blocks of sixteen, for each called number. Its output is an index to the results or an indication no further action is necessary. Its TID is BDIGITTREE.

To add a BDIGITTREE to the dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:bdigittree:custgrpid="t100",digitstring="703484",callside="originating", 
setname="set1"
 
   

This command adds a BDIGITTREE and the required parameters to the dial plan.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the BDIGITTREE and the parameters you added are now present in the dial plan.

Step 3 Repeat steps 1 and 2 for each entry you add to the ADIGITTREE.


Adding Numbering Plan Indicator Data (ANPI and BNPI)

Numbering Plan Indicator (NPI) provides an index into the results. It allows Pre-analysis before number analysis is performed. Its TID is NPI.


Note In MGC software Release 9.4(1), another NPI table (NPIcg) was added to allow analysis of A-numbers. As a result, the MML command changed from npi to anpi and bnpi.

A separate NPI block is required for every non-zero entry in the NPI Block column of the NOA (Example 4-1) that you want to associate with a result set. To add an NPI value to the dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:anpi:custgrpid="t001",npiblock=101,blockvalue=1,setname="set1"
 
   

This command adds an NPI with a CustGrpID of "t001," an NPI block of 1, a received NPI block value of 108, and a result set name of "set1." to the dial plan.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify that the NPI value and the parameters you added are now present as shown in Example 4-1.

Example 4-1 Numbering Plan Indicator Example

Table 4-2 Block Values and Result Sets Names 

Block Value
Result Set Name

0

 

1

set1

2

set2

3

set3

4

set4

5

set5

6

set6

7

set7

8

set8

91

set9

10

 

11

 

12

 

13

 

14

 

15

 

1 There are currently no incoming NPI values above 9. See "NOA and NPI Codes, CPC and TMR Values."


Step 3 Repeat steps 1 and 2 for each npiblock value and setname you want to add to the NPI.


Adding Nature of Address Data (NOA)

The Nature of Address (NOA) provides an index into the NPI. It allows Pre-analysis before number analysis is performed. Its TID is NOA.


Note In MGC software Release 9.4(1), another NOA table (NOAcg) was added to allow analysis of A-numbers. As a result, the MML command changed from noa to anoa and bnoa.

To add a NOA value to the dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:anoa:custgrpid="t100",noavalue=3,npiblock=1
 
   

This command adds a NOA value and the required parameters to the dial plan. For any NOA value that is configured, either an NPI block or a result set must be specified. This MML command example specifies that for an incoming NOA value of 3, pre-analysis enters NPI block 1 using the incoming NPI value.

Step 2 At the MML prompt, enter the command:

mml> numan-add:anoa:custgrpid="t001",noavalue=4,setname="set3"
 
   

This MML command specifies that for an incoming NOA value of 4, result set "set3" is used.

Table 4-3 Nature of Address 

NOA Value
NPI Block
Result Set Name

1

 

set1

2

 

set2

3

1

 

4

 

set3

5

2

 

6

3

 

7

 

set4

8

4

 

...

...

...


Step 3 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the NOA value and the parameters you added are now present.

Step 4 Repeat steps 1 through 3 for each noavalue you want to add to the dial plan.


Adding a LINEXLATE Table to the Dial Plan for Configurable NOA Mapping

To support the Configurable NOA Mapping feature (introduced in Release 9.4.1), you must provision a line translation (LINEXLATE) table in your dial plan.

See the Cisco PGW 2200 Softswitch Release 9.8 Provisioning Guide for the procedures to provision the Configurable NOA Mapping feature on the Cisco PGW 2200 Softswitch. See the Cisco PGW 2200 Softswitch Release 9 MML Command Reference for a detailed description of the command for creating a LINEXLATE table.

Provisioning the LINEXLATE Table

Perform the following steps to provision the Linexlate table in your dial plan.

Verify a line NOA value translation using a dial plan for SS7-to-SS7 calls.


Step 1 Open a provisioning session by using the following MML command:
mml>prov-sta::srcver="04",dstver="mml_05"

Step 2 Provision the Cisco MGC for a line NOA value to the dial plan of incoming calls trunk group, using the following MML command:
mml>numan-add:noa:custgrpid="1111",noavalue=4,setname="rset1"

Step 3 Provision the Cisco MGC for a line NOA value to the dial plan of outgoing calls trunk group, using the following MML command:
mml>numan-add:noa:custgrpid="1111",noavalue=14,setname="rset2"

Step 4 Commit the changes.
mml>prov-cpy

Step 5 Use prov-rtrv:linexlate:name="noa2" to verify the property is added correctly.
mml>prov-rtrv:linexlate:name="noa2"

Verify that the line NOA value translation has occurred correctly. For example, line value 4, added at the incoming trunk group, is converted to an internal NOA value 14 at the outgoing trunk group and is received at the PSTN side.

Verify a line NOA value translation for Calling, Called Party, and Redirection Number parameters for Type B calls.


Adding a Location (LOCATION)

Location identifies the type of network originating a call. The Cisco PGW 2200 Softswitch uses values from cause and location to determine result actions.

For information on cause and location, see the "Cause Analysis" section.

Its TID is LOCATION.

To add a LOCATION to the dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:location:custgrpid="t001",locationblock=1,blockvalue="8",setname="set8"
 
   

This command adds the LOCATION and sets up the Location with a CustGrpID of t001, a locationblock of 1, a block value of 8, and a result set name of "set8".


Note The blockvalue in numan-add:location should be one less than the intended internal value.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the LOCATION and the parameters you added are now present.

Step 3 Repeat steps 1 and 2 for each LOCATION entry you want to add to the dial plan.



Tip The LOCATION contains 16 groups.

Adding a Cause (CAUSE)

Cause provides an index into the Location to provide cause analysis. The Cisco PGW 2200 Softswitch uses values from Cause and Location to determine result actions. Its TID is CAUSE.

To add a CAUSE to the dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:cause:custgrpid="t001",causevalue=3,setname="set3"
 
   

This command sets up the Cause with a CustGrpId of t001, a cause value of 3, and a result set name of "set3".

or

mml> numan-add:cause:custgrpid="t001",causevalue=4,locationblock=1
 
   

This command sets up the Cause with a CustGrpId of t001, a cause value of 4, and a location block of 1. The location block cannot be empty when you use this command. See the "Adding a Location (LOCATION)" section for information on adding locations.


Note A cause value must be added to the dial plan before it can be edited. Table B-2, Internal Cause Code Values, Listed Numerically, lists the internal cause code values.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the CAUSE and the parameters you added are now present.

Step 3 Repeat steps 1 and 2 for each CAUSE entry you want to add to the dial plan.



Note When provisioning CAUSE in the dial plan, you can use either locationblock or setname, but not both. If you use setname, set the locationblock=0. If you use locationblock, set the setname="". However, setting the unused property (locationblock or setname) means it is unused.

Tip If you want to change the CAUSE property from locationblock to setname, or from setname to locationblock, use the numan-ed command to set the property not desired to its unused condition, then use the numan-ed command to set the value for the desired property.

Adding Screening Lists (SCREENING)

The dial plan can have as many as four different Screening lists—two "white" and two "black":

A White—call screening stimulated by either partial or full calling number and full calling number that must be present in the list to complete the call.

A Black—call screening stimulated by either partial or full calling number and full calling number must not be present in the list to complete the call.

B White—call screening stimulated by either partial or full called number and full calling number must be present in the list to complete the call.

B Black—call screening stimulated by either partial or full called number and full calling number must not be present in the list to complete the call.

The following sections describe the file format for AWhite and ABlack screening files.

A-Number Screening File Formats

The file format for each entry in the AWhite or ABlack screening files is the same:

<Type> <CallingPartyNumber>

where,

Type designates whether a number is to be added to or deleted from the A-number screening file:

Type = 1 if the calling party number is to be added to the A-number screening file

Type = 2 if the calling party number is to be deleted from the A-number screening file

The type field allows additions and deletions to be commingled in the same file; however, the AWhite and ABlack screening files must be maintained separately.

CallingPartyNumber is used to enter the calling party number (A-number).

B-Number Screening File Formats

The file format for each entry in the BWhite or BBlack screening files is the same:

<Type> <ServiceName> <CallingPartyNumber>

where,

Type designates whether a number is to be added to or deleted from the A-number screening file:

Type = 1 if the calling party number is to be added to the B-number screening file

Type = 2 if the calling party number is to be deleted from the B-number screening file

The type field allows additions and deletions to be commingled in the same file; however, the BWhite and BBlack screening files must be maintained separately.

ServiceName is a string field that designates a valid service name.


Note The service name entered here associates the calling party number with a specific service. A calling party number can be associated with as many different services as necessary.
Service names are limited to 10 alphanumeric characters. Spaces are not allowed.

CallingPartyNumber is used to enter the calling party number (A-number).

Importing or Exporting Screening Data

The screening list is also designed to allow you to add and remove entries without opening a provisioning session. It also enables more than one user at a time to access the screening list.

The format of the MML command to import (or export) both dial plan files and A-number and B-number whitelist and blacklist screening files is as follows:

prov-add:files:name=<file_format>, file=<file_name>, action=import | export

where the file_format and the file_name (target identifier or TID) must be paired, as listed in Table 4-2.

File Type
file_format =
file_name (or TID) =

A-number whitelist files

AWhiteFile

custgrpid.awhite

A-number blacklist files

ABlackFile

custgrpid.ablack

B-number whitelist files

BWhiteFile

custgrpid.bwhite

B-number blacklist files

BBlackFile

custgrpid.bblack


A provisioning session is not needed for individual MML commands; nor does a provisioning session need to be opened when you are using the screening file import procedure described above.

The format of the MML command to add individual entries to the A-number whitelist or blacklist screening files without opening a provisioning session is as follows:

mml> numan-add:<custgrpid.awhite|custgrpid.ablack>:cli=<cli>
 
   

The format of the MML command to add individual entries to the B-number whitelist or blacklist screening files without opening a provisioning session is as follows:

mml> numan-add:<custgrpid.bwhite|custgrpid.bblack>:cli="<cli>",service="<svcname>"
 
   

The following file types do not require a provisioning session be open if using the prov-add command to load the following tables: AWHITE, ABLACK, BWHITE, BBLACK, PORTBL, TERMTBL, ANUMDPSEL, ACHGORIGIN, CLIPREFIX, CLIIPADDRESS, H323IDDIVFROM, ANNOUNCEMENT, and SCRIPT.

Adding an AWHITE List

The AWhite list contains calling numbers that can be processed. If the presented A-number is not found in the list, then the screening is deemed to have failed and the call is released. Its TID is AWHITE.

To add an AWHITE list entry to the dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:awhite:custgrpid="t100",cli="919472123"
 
   

This command adds an AWHITE list and the required parameters to the dial plan.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the AWHITE list and the parameters you added are now present.

Step 3 Repeat steps 1 and 2 for each AWHITE list entry you want to add to the dial plan.


Adding an ABLACK List

The ABlack list contains calling numbers that cannot be processed. If the presented A-number is found in the list, then the call is released. Its TID is ABLACK.

To add an ABLACK list entry, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:ablack:custgrpid="t100",cli="919472432"
 
   

This command adds an ABLACK list entry and the required parameters to the dial plan.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the ABLACK list entry and the parameters you added are now present.

Step 3 Repeat steps 1 and 2 for each ABLACK list entry you want to add to the dial plan.


Adding a BWHITE List

The BWhite list contains called numbers that can be processed. If the presented B-number is not found in the list, the screening is deemed to have failed and the call is released. Its TID is BWHITE.

To add a BWHITE list entry to the dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:bwhite:custgrpid="t100",cli="9194721234",svcname="FreePhone"
 
   

This command adds a BWHITE list entry and the required parameters to the dial plan.


Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service names.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the BWHITE list entry and the parameters you added are now present.

Step 3 Repeat steps 1 and 2 for each BWHITE list entry you want to add to the dial plan.


Adding a BBLACK List

The BBLACK list contains called numbers that cannot be processed. If the presented B-number is found in the list, the call is released. Its TID is BBLACK.

To add a BBLACK list entry to the dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:bblack:custgrpid="t100",cli="9194724321",svcname="FreePhone"
 
   

This command adds a BBLACK list entry and the required parameters to the dial plan.


Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service names.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the BBLACK list entry and the parameters you added are now present.

Step 3 Repeat steps 1 and 2 for each BBLACK list entry you want to add to the dial plan.


Adding a Ported Number Table (PORTTBL)

The PORTTBL lists ported numbers. If the presented B-number is found in this table, the call is rerouted to the recipient network. Its TID is PORTTBL.

To add an entry to the PORTTBL list of your dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml>numan-add:PORTTBL:digitstring="2145190000",RouteNumber="23456"
 
   

This command adds an entry to the PORTTBL list and the required parameters to your dial plan.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the parameters you added are now present in the PORTTBL list.

Step 3 Repeat steps 1 and 2 for each PORTTBL list entry you want to add to your dial plan.


Adding a Term Table (TERMTBL)

The TERMTBL list contains B-numbers. If the presented B-number is found in this list, the call is routed to the RouteID associated with the corresponding digit string. Its TID is TERMTBL.

To add an entry to the TERMTBL of your dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:TERMTBL:digitstring="34567",RTLISTNAME="dallas"
 
   

This command adds an entry to the TERMTBL list and the required parameters to your dial plan.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the parameters you added are present in the TERMTBL list.

Step 3 Repeat steps 1 and 2 for each TERMTBL list entry you want to add to your dial plan.


Adding a Dial Plan Selection (DPSELECTION)

Provision the dial plan selection list using the DPSEL TID.

To add the dial plan selection list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:dpsel:custgrpid="t001",newdp="dp07" 
 
   

This command inserts the dial plan ID "dp07" into a new dial plan selection list.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the dial plan selection list and the new dial plan ID you added are now present.

Step 3 Repeat steps 1 and 2 for each dial plan ID you want to insert in the dial plan selection list.


Adding A-Number Dial Plan Selection (ANUMDPSEL)

Provision the A-number dial plan selection list using the ANUMDPSEL TID.

To add the A-number dial plan selection, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:anumdpsel:custgrpid="t001",cli="1234567",newdp="dp07"
 
   

This MML command inserts the A-number dial plan dp07 into the dial plan selection list.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the A-number dial plan selection list and the new dial plan ID you changed are now present.

Step 3 Repeat steps 1 and 2 for each A-number you want to insert in the A-number dial plan selection list.


Provisioning CODEC Capabilities (CODECSTRING)

This section describes the MML commands required to provision the CODEC capabilities.

For more information on the CODEC component, see MML Command Reference.

Provisioning the CODEC Capabilities

Provision the CODEC capabilities using MML commands. Use the following MML command formats to respectively add the CODEC result type and the CODEC string capabilities:

mml> prov-add:codecstring:name="codec1",codecstring="G.726-32;G.729b-L"
mml> numan-add:resulttable:custgrpid="T001",resulttype="CODEC",dw1="codec1",dw2="1",setnam
e="ra1",name="res1"
 
   
mml> prov-add:trnkgrpprop:name="3333",custgrpid="1111",GWDefaultCodecString="G.711a;PCMA"
mml> prov-add:sigsvcprop:name="mgcp1",GWDefaultCodecString="G.711a;PCMA"
 
   

Route Holiday Provisioning

The following MML commands are used to add, edit, delete, and retrieve data to and from the Route Holiday list.

Add a Holiday entry:

NUMAN-ADD:RTEHOLIDAY:CUSTGRPID="T002",DATE="2001.08.12",HDAY="HOL2"
 
   

Edit a day entry in the Holiday list in an already existing entry in the list:

NUMAN-ED:RTEHOLIDAY:CUSTGRPID="T002",DATE="2001.08.12",HDAY=HOL1
 
   

Delete an entry in the list:

NUMAN-DLT:RTEHOLIDAY:CUSTGRPID="T002",DATE="2001.08.12"
 
   

Retrieve a specific entry in the list:

NUMAN-RTRV:RTEHOLIDAY:CUSTGRPID="T002",DATE="2001.08.12"
 
   

Retrieve all entries in the list:

NUMAN-RTRV:RTEHOLIDAY:CUSTGRPID="T002","all"
 
   

Provisioning example for Conditional Routing

Add entries to Route Holiday list:

NUMAN-ADD:RTEHOLIDAY:CUSTGRPID="T002",DATE="2001.12.25",HDAY="HOL1"
NUMAN-ADD:RTEHOLIDAY:CUSTGRPID="T002",DATE="2001.01.01",HDAY="HOL1"
NUMAN-ADD:RTEHOLIDAY:CUSTGRPID="T002",DATE="2001.07.04",HDAY="HOL2"
NUMAN-ADD:RTEHOLIDAY:CUSTGRPID="T002",DATE="2001.09.03",HDAY="HOL3"
 
   

Conditional Routing Processing actions derived from the above MML commands:

The conditional routing will use the hol1 day of the week for Christmas day and New Years day. For Independence Day the conditional routing will use the hol2 day of the week. And for Labor Day the conditional routing will use the hol3 day of the week.

Add a conditional route:

PROV-ADD:CONDRTE:NAME="condName20",DOW="DEFAULT",RTEDESC="set22"
PROV-ED:CONDRTE:NAME="condName20",DOW="MONDAY",RTEDESC="set21  0800  set22 1800 set 24"
PROV-ED:CONDRTE:NAME="condName20",DOW="TUESDAY",RTEDESC="set21  0800  set22 1800 set 24"
PROV-ED:CONDRTE:NAME="condName20",DOW="WEDNESDAY",RTEDESC="set21 0800  set22 1800 set24"
PROV-ED:CONDRTE:NAME="condName20",DOW="HOL1",RTEDESC="set23"
PROV-ED:CONDRTE:NAME="condName20",DOW="HOL2",RTEDESC="set22"
PROV-ED:CONDRTE:NAME="condName20",DOW="HOL3",RTEDESC="set22  1200 set55 1800 set22"
 
   

The following MML command shows how to configure the COND_ROUTE results making the association with the data in the Conditional Routing list previously defined.

NUMAN-ADD:RESULTTABLE:CUSTGRPID="T002",NAME="result39",RESULTTYPE="COND_ROUTE",DW1=" 
condName20",SETNAME="condsetName"
 
   

Conditional Routing Processing actions derived from the preceding MML commands:

On Monday, Tuesday, and Wednesday:

From 0000-0800, the Routing option is result set "set21" which provides RouteList21 as the entry point into Routing analysis.

From 0801-1800, the Routing option is result set "set22" which provides Routelist22 as the entry point for Routing analysis.

From 1801-2359, the Routing option is result set "set24" which provides RouteList24 as the entry point into Routing analysis.

On a Holiday of type "HOL1"

From 0000-2359, the Routing option is "set23" which provides RouteList23 as the entry point into Routing analysis.

On a Holiday of type "HOL2"

From 0000-2359, the Routing option is "set22" which provides RouteList22 as the entry point into Routing analysis.

On a Holiday of type "HOL3"

From 0000-1200, the Routing option is result set "set22" which provides RouteList22 as the entry point into Routing analysis.

From 1201-1800, the Routing option is result set "set55" which provides Routelist55 as the entry point for Routing analysis.

From 1801-235, 9 the Routing option is result set "set22" which provides RouteList22 as the entry point into Routing analysis.

On a Default case

This means the Routing for any undefined Days in this case Thursday, Friday, Saturday, and Sunday.

From 0000 - 0800, the Routing option is result set "set22" which provides Routelist22 as the entry point for Routing analysis.

From 0801-2359, the Routing option is result set "set55" which provides Routelist55 as the entry point for Routing analysis.

Provisioning Overdecadic Status

To identify when provisioning that a dial plan is either decadic or overdecadic, use the DIALPLAN TID.

To provision the overdecadic status of a dial plan, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:dialplan:custgrpid="t001",overdec="YES"
 
   

This command inserts the dpbase into a dial plan containing a value of either YES or NO.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the dpbase and the overdecadic selection you added are now present.

Step 3 Repeat steps 1 and 2 for each dial plan you want to insert a dpbase to specify the overdecadic status of the dial plan.


Provisioning Advice of Charge

The following sections describe how to provision the Advice of Charge (AOC) feature:

Provisioning the Charge Holiday List

Provisioning the Charge List

Provisioning the Tariff List

Provisioning Charge Origin

Charging data should be defined during installation (after the creation of each customer dial plan). Additional charging data can be added at any time. AOC provisioning is accomplished in the following stages:

Defining charge origins—Can be assigned to trunk groups or signaling paths, area codes (in the A-digit trees), or in a CLI charge origin table.

Defining charge destinations in B-number tables.

Defining customer-specific holidays using the holiday table.

Creation of the charge table and population of the required tariff ids for the identified charge origin/destination/day of week combination.

Population of tariff rates within the Metering Pulse Tariff table.

Enabling AOC against ingress trunk groups or signaling paths by setting AOCEnabled to 1 (enabled).


Note To avoid alarms being generated because of inconsistent data for calls in progress while charging data is being added or modified:
provision the Charge and Holiday tables before making changes to the dial plan that references them.
disable meter pulse messaging and AOC (by setting AOCEnabled to 0, disables AOC for the call) for all the trunk groups or sigpaths that use the dial plan that references the data to be changed until all updates have been completed.

Provisioning the Charge Holiday List

The format of the date parameter in all of the following commands is as follows:

Year—yyyy = 0000 through 9999
Month—mm = 1 through 12
Day—dd = 01 through 31

Adding an Entry to the Charge Holiday List

To add an entry in the Charge Holiday list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> prov-add:holiday:date="2001.12.25",hday="hol1"
 
   

This MML command inserts a holiday date into the Charge Holiday list and designates it as a "hol1," "hol2," or "hol3.".

Step 2 To verify the command was executed successfully, enter the command:

mml> prov-rtrv
 
   

Verify the Charge Holiday list and the new holiday date you changed are now present.

Step 3 Repeat steps 1 and 2 for each holiday you want to insert in the Charge Holiday list.


Editing an Entry in the Charge Holiday List

To edit an entry in the Charge Holiday list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> prov-ed:holiday:date="2001.12.25",hday="hol2"
 
   

This command changes the holiday date (2001.12.25) from "hol1" to a "hol2."

Step 2 To verify the command was executed successfully, enter the command:

mml> prov-rtrv
 
   

Verify the holiday designation you changed is now present.

Step 3 Repeat steps 1 and 2 for any holiday you want to change in the Charge Holiday list.


Deleting an Entry From the Charge Holiday List

To delete an entry in the Charge Holiday list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> prov-dlt:holiday:date="2001.12.31"
 
   

This command deletes the existing holiday date (2001.12.31) from the Charge Holiday list.

Step 2 To verify the command was executed successfully, enter the command:

mml> prov-rtrv
 
   

Verify the holiday entry you changed was deleted.

Step 3 Repeat steps 1 and 2 for any holiday you want to delete from the Charge Holiday list.


Retrieving Entries From the Charge Holiday List

To retrieve an entry from the Charge Holiday list, complete the following steps:


Step 1 To retrieve a single entry from the Charge Holiday list, enter this command at the MML prompt:

mml> prov-rtrv:holiday:date="2001.12.31"
 
   

This command retrieves the existing holiday date (2001.12.31) from the Charge Holiday list.

To retrieve all the entries in the Charge Holiday list, enter this command at the MML prompt:

mml> prov-rtrv:holiday:"all"
 
   

This command retrieves all existing holiday dates from the Charge Holiday list.

Verify the holiday entry or entries you changed are displayed.

Step 2 Repeat step 1 for any holiday entry you want to retrieve from the Charge Holiday list.


Charge Holiday Provisioning Examples

mml> prov-add:holiday:date="2001.02.10",hday="hol1"
mml> prov-ed:holiday:date="2001.02.10",hday="hol2"
mml> prov-dlt:holiday:date="2001.02.10"
mml> prov-rtrv:holiday:date="2001.02.10"
mml> prov-rtrv:holiday:"all"

Provisioning the Charge List

This section describes the MML commands required to add the CHARGE result type and provision the Charge list.

Provisioning the Charge Result Type

Use the following MML command to add the CHARGE result type to the results:

mml> numan-add:resulttable:custgrpid="t001",name="result1",resulttype="CHARGE", 
dw1="1",dw3="2",setname="setone" 

Note When provisioning charge, ensure the charge origin (achorigin) property value matches the charge value provisioned for charge origin (chorig). Also ensure AOCEnabled is set to "1" (enabled) and AOCNodeId is provisioned.

Adding an Entry in the Charge List

To add an entry in the Charge list, complete the following steps:


Step 1 At the MML prompt, enter the following command:

mml> prov-add:charge:chorig=1000,chdest=1000,dow="monday",tariffdesc="tariff1 timechange1" 
 
   

This MML command inserts an entry in the Charge list.

The Charge Origin (CHORIG) value is optional and defaults to 0 in the list entry if not present in the MML command.

The Day of Week (DOW) value is also optional and defaults to 0 in the list entry if not present in the MML command. You can also set the DOW value to "Default" if you wish.

The timeChange value must be divisible by increments of 15 minutes to meet the AOC requirements (for example, 0030, 0315, 2145, and so on). If the last field in the TARIFFDESC parameter is a timeChange, its value must be 2400.

Step 2 To verify the command was executed successfully, enter the following command:

mml> prov-rtrv
 
   

Verify the Charge list and the new entry you changed are now present.

Step 3 Repeat steps 1 and 2 for each entry you want to insert in the Charge list.


Editing an Entry in the Charge List

To edit an entry in the Charge list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> prov-ed:charge:chorig=1000,chdest=1000,dow="monday",tariffdesc="tariff2 timechange2"
 
   

This command changes the previous entry, "tariff1 timechange1," to "tariff2 timechange2."

Step 2 To verify the command was executed successfully, enter the command:

mml> prov-rtrv
 
   

Verify the tariff designation you changed is now present.

Step 3 Repeat steps 1 and 2 for any entry you want to change in the Charge list.


Deleting an Entry from the Charge List

To delete an existing entry from the Charge list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> prov-dlt:charge:chorig=1000,chdest=1000,dow="monday"
 
   

This command deletes the existing entry from the Charge list.

Step 2 To verify the command was executed successfully, enter the command:

mml> prov-rtrv
 
   

Verify the entry you changed was deleted.

Step 3 Repeat steps 1 and 2 for any entry you want to delete from the Charge list.


Retrieving Entries From the Charge List

To retrieve an entry from the Charge list, complete the following steps:


Step 1 To retrieve a single entry from the Charge list, enter this command at the MML prompt:

mml> prov-rtrv:charge:chorig=1000,chdest=1000,dow="monday"
 
   

This command retrieves the changed entry from the Charge list.

To retrieve all the entries in the Charge list, enter this command at the MML prompt:

mml> prov-rtrv:charge:"all"
 
   

This command retrieves all existing entries from the Charge list.

Verify the entry or entries you changed are displayed.

Step 2 Repeat step 1 for any entry you want to retrieve from the Charge list.


Charge Provisioning Examples

The following MML command specifies all calls from Charge Origin 1 to Charge Destination 2 will use tariff id 3 from 0000-0700, tariff id 4 from 0700-1800, and tariff id 3 from 1800-2400 on Mondays.

mml> prov-add:charge:chorig=1,chdest=2,dow="monday",tariffdesc="3 0700 4 1800 3"

Note When provisioning charge, ensure the charge origin (achorigin) property value matches the charge value provisioned for charge origin (chorig). Also ensure AOCEnabled is set to "1" (enabled) and AOCNodeId is provisioned.

The following command specifies all calls from any Charge Origin to Charge Destination 2 will use tariff id 3 from 0000-0700, tariff id 4 from 0700-1800, tariff 3 from 1800 to 2100, and tariff id 5 from 2100-2400 for HOL1.

mml> prov-add:charge:chdest=3,dow="hol1",tariffdesc="3 0700 4 1800 3 2100 5 2400"
 
   

The following MML command specifies all calls from Charge Origin 2 to Charge Destination 2 will use tariff id 3 all day every day.

mml> prov-add:charge:chorig=2,chdest=2,tariffdesc="3"

Note When provisioning the Charge table, a value must be entered to be used as the default for the next tariff id. A default value must be provisioned in Charge table so that a next tariff id is always present.

Provisioning the Tariff List

This section describes the MML commands required to provision the Tariff list.

Adding an Entry in the Tariff List

To add an entry in the Tariff list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> prov-add:tariff:tariffid=1010,tariffrate=1010,scalefactor=3
 
   

The scale factor range is: 0, 1, 2, 3, 249, 250, 251, 252, 253, 254, or 255

This MML command inserts an entry in the Tariff list.

Step 2 To verify the command was executed successfully, enter the command:

mml> prov-rtrv
 
   

Verify the Tariff list and the new entry you changed are now present.

Step 3 Repeat steps 1 and 2 for each entry you want to insert in the Tariff list.


Editing an Entry in the Tariff List

To edit an entry in the Tariff list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> prov-ed:tariff:tariffid=1010,tariffrate=1020,scalefactor=2
 
   

This command changes the previous entry from "scalefactor3" to "scalefactor2."

Step 2 To verify the command was executed successfully, enter the command:

mml> prov-rtrv
 
   

Verify the scalefactor designation you changed is now present.

Step 3 Repeat steps 1 and 2 for any entry you want to change in the Tariff list.


Deleting an Entry in the Tariff List

To delete an existing entry from the Tariff list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> prov-dlt:tariff:tariffid=1010
 
   

This command deletes the existing entry from the Tariff list.

Step 2 To verify the command was executed successfully, enter the command:

mml> prov-rtrv
 
   

Verify the entry you changed was deleted.

Step 3 Repeat steps 1 and 2 for any entry you want to delete from the Tariff list.


Retrieving Entries From the Tariff List

To retrieve an entry from the Tariff list, complete the following steps:


Step 1 To retrieve a single entry from the Tariff list, enter this command at the MML prompt:

mml> prov-rtrv:tariff:tariffid=1010
 
   

This command retrieves the specified entry from the Tariff list.

To retrieve all the entries in the Tariff list, enter this command at the MML prompt:

mml> prov-rtrv:tariff:"all"
 
   

This command retrieves all existing entries from the Tariff list.

Verify the entry or entries you changed are displayed.

Step 2 Repeat step 1 for any entry you want to retrieve from the Tariff list.


Provisioning Charge Origin

This section describes the MML commands required to provision the CHARGEORIGIN result type and the Charge Origin list.

Provisioning the CHARGEORIGIN Result Type

Use the following MML command to add the CHARGEORIGIN result type to the Result list:

mml> numan-add:resulttable:custgrpid="t002",name=result2",resulttype="CHARGEORIGIN", 
dw1="1",setname="settwo"

Adding an Entry in the Charge Origin List

To add an entry in the Charge Origin list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:achgorigin:custgrpid="t001",cli="6123456789",corigin=1
 
   

This MML command inserts an entry in the Charge Origin list.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the Charge list and the new entry you changed are now present.

Step 3 Repeat steps 1 and 2 for each entry you want to insert in the Charge Origin list.


Editing an Entry in the Charge Origin List

To edit an entry in the Charge list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-ed:achgorigin:custgrpid="t001",cli="02087568000",corigin=1 
 
   

This command changes the previous CLI entry, "6123456789," to "02087568000."

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the CLI parameter you changed is now present.

Step 3 Repeat steps 1 and 2 for any entry you want to change in the Charge Origin list.


Deleting an Entry From the Charge Origin List

To delete an existing entry from the Charge Origin list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-dlt:achgorigin:custgrpid="t001",cli="02087568000" 
 
   

This command deletes the existing entry from the Charge Origin list.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the entry you changed was deleted.

Step 3 Repeat steps 1 and 2 for any entry you want to delete from the Charge Origin list.


Retrieving Entries From the Charge Origin List

To retrieve an entry from the Charge Origin list, complete the following steps:


Step 1 To retrieve a single entry from the Charge Origin list, enter this command at the MML prompt:

mml> numan-rtrv:achgorigin:custgrpid="t001",cli="02087568000"
 
   

This command retrieves the specified entry from the Charge Origin list.

To retrieve all the entries in the Charge Origin list, enter this command at the MML prompt:

mml> numan-rtrv:achgorigin:"all"
 
   

This command retrieves all existing entries from the Charge Origin list.

Verify the entry or entries you changed are displayed.

Step 2 Repeat step 1 for any entry you want to retrieve from the Charge Origin list.


Importing a Charge Origin List

To import a Charge Origin list, complete the following steps:


Step 1 To import a Charge Origin list, enter this command at the MML prompt:

mml> prov-add:files:name="achgoriginfile",file="achgorigin.dat",action="import"
 
   

This command imports the specified file as the Charge Origin list.

Step 2 To verify the command was executed successfully, enter the command:

mml> prov-rtrv
 
   

Verify the file you specified in step 1 is displayed as the Charge Origin list.


Charge Origin Provisioning Examples

mml> numan-add:achgorigin:custgrpid="t001",cli="02087568000",corigin=1
mml> numan-ed:achgorigin:custgrpid="t001",cli="02087568000",corigin=2
mml> numan-dlt:achgorigin:custgrpid="t001",cli="02087568000"
mml> numan-rtrv:achgorigin:custgrpid="t001",cli="02087568000"
mml> numan-rtrv:achgorigin:"all"
 
   

Provisioning AOC PRI Supplemental Services

The ingress trunk group property AOCInvokeType controls the MGCP 1.0 on the PGW 2200 feature. The AOCInvokeType property specifies whether the feature is invoked on a per call basis or for all calls. The AOCInvokeType property also specifies whether the MGCP 1.0 on the PGW 2200 feature is invoked based on the subscription (per call) from the user or is invoked automatically for all the calls (all calls). For all calls, a default configuration in the Tariff table is used (TariffID = 0). If AOCInvokeType is configured for all calls, then the default is required to prevent no charge generation being set up and invoked.

The following sections describe what to provision for the PRI AOC supplemental services. The provisioning order is:

Trunk group properties (AOCDefaultTariffId, AOCEnabled, and AOCInvokeType)

Charge table (charge origin for A-numbers or charge destination for B-numbers)

priTariff table

CHARGE result type

Charge Origins (Optional)

Charge origins are integer values (1-9999) that are assigned as a property against the trunk group or signaling path, a result type in the A-number analysis, or an entry in the CLI Charge Origin table. These values can be assigned incrementally during planning or you can assign any valid value at any time.

Trunk Group or Signaling Path Property

The ChargeOrigin property can be assigned to trunk groups or to signaling paths. For example, TG-2.ChargeOrigin=123.

A-Number Result

The ChargeOrigin result type has been created for AOC. Only the first data word is significant (carries the charge origin value). This result type is assignable against the ADIGTREE component only and is treated as an intermediate result (digit analysis can continue past this result type). For example,

mml> numan-add:resultset:custgrpid="t002",name="settwo"
 
   
mml> numan-add:resulttable:custgrpid="t002",name=result2",resulttype="chargeorigin", 
dw1="1",setname="settwo"

CLI Charge Origin Table

Dial plan component ACHGORIGIN has been created. This component is provisionable using the following generic format of the MML dial plan commands:

NUMAN-<verb>:ACHORIGIN:CUSTGRPID=<customer group ID>,CLI=<cli>,CORIGIN=<charge origin>
 
   

The following MML commands provide an example of provisioning the ACHORIGIN result type:

mml> numan-add:achgorigin:custgrpid="t001",cli="02087568000",corigin=1

Charge Destinations

CHARGE Result Type

The CHARGE result type can return a charging destination for the Metering Pulse Tariff table. This operation is achieved by setting dataword3 to a value of 5 for the ChargeDataDiscriminator field. The CHARGE result type is assigned against the BDIGTREE component only and is treated as an intermediate result. The values of the accompanying data are listed in Table 4.

Table 4 Data Values for the CHARGE Result Type 

Data Word
Data Description
Values

1

Tariff Rate or Charge Destination

Meter pulse destinations—range is 1-9999

2

Scale Factor

Always set to 1 for metering pulses

3

Charge Data Discriminator

Determines the type of data in dataword1:
1—Tariff Rate
2—Charge Destination
3—Charge Band
4—Charge Unit
5—Meter Pulse

4

Charge Type

Charge Type
1—AOC


The following MML commands show how to provision the CHARGE result type:

mml> numan-add:resultset:custgrpid="t001",name="setone"
 
   
mml> numan-add:resulttable:custgrpid="t001",name=result1",resulttype="charge",dw1="1", 
dw3="2",setname="setone"

Charge Mode Indicator Result Type

The Charge Mode Indicator (CHARGE_MODE_IND) result type indicates how the metering pulses generated by the Cisco PGW 2200 Softswitch are applied in relation to other possible other metering pulses (pulses that some other node generated). The CHARGE_MODE_IND result type is assignable against the ADIGTREE or BDIGTREE component and it is treated as an intermediate result. The values of the accompanying data are listed in Table 5.

Table 5 Data Values for the CHARGE_MODE_IND Result Type

Data Word
Data Description
Values

1

Charge Mode Indicator

Charge Mode Indicator
1—Add on the charge
2—Replace the charge
3—Free of charge


Charge Indication Result Type

The Charge indication result type indicator (CHARGE_IND) indicates if the Cisco PGW 2200 Softswitch should change the value of the charge indicator. The CHARGE_IND result type is assignable against the ADIGTREE or BDIGTREE component and it is treated as an intermediate result. The values of the accompanying data are listed in Table 6.

Table 6 Data Values for the CHARGE_IND Result Type

Data Word
Data Description
Values

1

Charge Indicator

Charge Indicator
0—Leave as it is (default)
1—Charge
2—No charge


Holiday Table (Optional)

You can create a Holiday table, and you can add, edit, and delete rows within the table. The MML provisioning commands (PROV-ADD, PROV-RTRV, and so on), can be used to access these tables. The DATE (STRING value), broken down into three integers that represent the year, month, and day of the week (yy.mm.dd) references each row. The corresponding holiday (HDAY) row entry is HOL1, HOL2, or HOL3.

An example adding a holiday for December 25, 2005:

mml> prov-add:holiday:date="041225",hday="hol1" 

PRI Charge Table

You can create a PRI Charge table, and you can add, edit, and delete rows within the table. The provisioning commands (PROV-ADD, PROV-RTRV, and so on) are used to access these tables, as listed in Table 7. Each row is referenced with three keys:

charge origin—range: 1 through 9999

charge destination—range: 1 through 9999

day of the week—range: 1 through 10 (Monday through Sunday, holiday1, holiday2, or holiday3)


Note Charge destination is the only mandatory key. Charge origin and day of the week are set to 0 in the table row entry if they are not used.

Table 7 Charge Table Provisioning Examples 

Charge Table Example
Command

Add the Charge table for all three supplementary services (fixed daily tariff)

prov-add:chargetable:chorig=1,chdest=1, 
dow=monday,stariffdesc="1",dtariffdesc="2",etariffdesc="3"

Add the Charge table for all three supplementary services (variable daily tariff)

prov-add:chargetable:chorig=1,chdest=1,dow=monday,stariffdesc="
1 0700 2 1000 1 1600 3 1900 1",dtariffdesc="1 0700 2 1000 1 
1600 3 1900 1",etariffdesc="1 0700 2 1000 1 1600 3 1900 1"

Add the Charge table for all three supplementary services (all charge origins and days)

prov-add:chargetable:chdest=1,stariffdesc="1",dtariffdesc="1",e
tariffdesc="1" 

Add the Charge table for any one of the supplementary services (fixed daily tariff)

prov-add:chargetable:chorig=1,chdest=1,dow=monday,stariffdesc="
1" 

or

prov-add:chargetable:chorig=1,chdest=1,dow=monday,dtariffdesc="
2" 

or

prov-add:chargetable:chorig=1,chdest=1,dow=monday,etariffdesc="
3"

Add the Charge table for any one of the supplementary services (variable daily tariff)

prov-add:chargetable:chorig=1,chdest=1,dow=monday,stariffdesc="
1 0700 2 1000 1 1600 3 1900 1" 

or

prov-add:chargetable:chorig=1,chdest=1,dow=monday,dtariffdesc="
1 0700 2 1000 1 1600 3 1900 1" 

or

prov-add:chargetable:chorig=1,chdest=1,dow=monday,etariffdesc="
1 0700 2 1000 1 1600 3 1900 1"

Add the Charge table for any one of the supplementary services (all charge origins and days)

prov-add:chargetable:chdest=1,stariffdesc="1" 

or

prov-add:chargetable:chdest=1,dtariffdesc="1" 

or

prov-add:chargetable:chdest=1,etariffdesc="1"

Add the Charge table for any two of the supplementary services (fixed daily tariff)

prov-add:chargetable:chorig=1,chdest=1,dow=monday,stariffdesc="
1",dtariffdesc="2"

or

prov-add:chargetable:chorig=1,chdest=1,dow=monday,stariffdesc="
1",etariffdesc="3" 

or

prov-add:chargetable:chorig=1,chdest=1,dow=monday,dtariffdesc="
2",etariffdesc="3"

Add the Charge table for any two of the supplementary services (variable daily tariff)

prov-add:chargetable:chorig=1,chdest=1,dow=monday,stariffdesc="
1 0700 2 1000 1 1600 3 1900 1",dtariffdesc="1 0700 2 1000 1 
1600 3 1900 1"

or

prov-add:chargetable:chorig=1,chdest=1,dow=monday,stariffdesc="
1 0700 2 1000 1 1600 3 1900 1",etariffdesc="1 0700 2 1000 1 
1600 3 1900 1"

or

prov-add:chargetable:chorig=1,chdest=1,dow=monday,dtariffdesc="
1 0700 2 1000 1 1600 3 1900 1",etariffdesc="1 0700 2 1000 1 
1600 3 1900 1"

Add the Charge table for any two of the supplementary services (all charge origins and days)

prov-add:chargetable:chdest=1,stariffdesc="1",dtariffdesc="1"

or

prov-add:chargetable:chdest=1,stariffdesc="1",etariffdesc="1"

or

prov-add:chargetable:chdest=1,dtariffdesc="1",etariffdesc="1"


Note If the charge origin is not used, the entered rows refer to all origins for that destination (unless explicitly entered in another row). Similarly, if the day of the week is not used, day of the week refers to all days of the week, which are not otherwise explicitly entered.

PRI Tariff Table

You can create a PRI Tariff table. The provisioning commands (PROV-ADD, PROV-RTRV, and so on) are used to access this table. A tariff ID references each row that call processing obtains from the Charge table. The retrieved row entry contains the tariff rate and other required information for generating the charging information.

PRI Tariff table example:

mml> prov-add:pritariff:tariffid=2,schargeditem=1,sca=1,srecchrg=1,drecchrg=1,erecchrg=1, 
currency=USD,amount=1,amtmult=3,timelen=1,timescale=2,granularity=1,granularityscale=2, 
vol=1,scu=1,billingid=1

Activation Type for AOC Supplementary Services—AOCInvokeType

The ingress trunk group property AOCInvokeType, which specifies if the feature is invoked on a "PER CALL" basis or for "ALL CALLs" received on the ingress trunk group controls the AOC Generation for PRI feature. The AOCInvokeType Property is in the properties.dat file (1 = PER CALL, 2 = ALL CALL). If the property is defined as "PER CALL" the Cisco PGW 2200 Softswitch receives the invoke component from the subscriber. If the property is defined as "ALL CALL", the Cisco PGW 2200 Softswitch generates the charging information and sends it to the subscriber.


Note If configured as "ALL CALL" and the Cisco PGW 2200 Softswitch receives the invoke component in the setup message then the call is treated as "PER CALL."

Note If configured as "ALL CALL" and for the Charge Destination there is no configuration, the default tariff is used to set up the charge. If no default exists, then an appropriate result message is sent to the subscriber.

AOCInvokeType example:

mml> prov-add:trnkgrpprop:name="3333",custgrpid="1111",AOCInvokeType=1

Default Tariff for AOC Supplementary Service—AOCDefaultTariffId

If the AOCInvokeType is configured as "ALL CALL" (that is, AOCInvokeType = 2) and there is no entry for the Charge Destination, the default tariff is used to set up the charge. The AOCDefaultTariff property in the properties.dat file controls the default tariff value that is configured in the PRI Tariff table. Value range: 1 (default) through 9999.

AOCDefaultTariff example:

mml> prov-add:trnkgrpprop:name="101",custgrpid="ABC234",AOCDefaultTariffId=99

Default Charging Unit Duration for AOC-D Supplementary Service— AOCDMinPeriodicTimerDuration

The Cisco PGW 2200 Softswitch periodically sends accumulated charging units to the subscriber. The Cisco PGW 2200 Softswitch controls the rate of sending charging information, so charging information is not sent more frequently than the configured value or after accumulation of at least one charging unit, whichever is later. The AOCDMinPeriodicTimerDuration signaling path property, in the properties.dat file controls the sending rate. Value range is 5 - N seconds.

AOCDMinPeriodicTimerDuration example:

mml> prov-add:sigsvcprop:NAME="ABCNET1",AOCDMinPeriodicTimerDuration="5"

Note If the time for accumulating one charging unit is less than the configured AOCMinPeriodicTimerDuration value, then the timer is set to a value greater than the configured value, and the charging unit that is accumulated is an integer value. For example, if 1 charging unit is accumulated every 0.692 second and the AOCMinPeriodicTimerDuration is 5 seconds, the value for this timer is set to 173 seconds, and the number of charging units that are accumulated is 25 on expiry of this timer, which is then sent to the subscriber or user. Similarly, if 1 charging unit is accumulated every 0.6 second and the AOCMinPeriodicTimerDuration is 5 seconds, the value for this timer is set to 6 seconds, and the number of charging units that are accumulated is 10 on expiry of this timer, which is then sent to the subscriber or user.

PRI AOC Supplementary Services Activation

The AOCEnabled property (1—enabled or 0—disabled) in the properties.dat file controls the MGCP 1.0 on the PGW 2200 feature.


Note To reduce the number of alarms that are received when you are provisioning AOC (due to charging information pointing to unpopulated tables), disable AOC on the relevant trunk groups until the charge table has been correctly updated.

AOCEnabled example:

mml> prov-add:trnkgrpprop:name="2000",aocenabled="1"

When to Provision

Charging data should be defined during installation (after the creation of each customer dial plan). More charging data can be added at any time.

Use the following suggestions to avoid alarms being generated because of inconsistent data for calls in progress while charging data is being added or modified:

Provision the charge and holiday tables before making changes to the dial plan that references them.

Disable PRI AOC supplementary services for all the trunk groups or sigPaths that use the dial plan that references the data to be changed until all updates have been completed.

Combined Charge and Meter Pulse Messaging Provisioning

The following provisioning example combines the steps for provisioning charging (AOC) and Meter Pulse messaging. Some of the steps are optional and other steps are mandatory and are so indicated at the beginning of the step.


Step 1 (Optional)—Create Charge Holiday Data

mml> PROV-ADD:HOLIDAY:DATE="00.07.04",HDAY="HOL1"
mml> PROV-ADD:HOLIDAY:DATE="00.12.25",HDAY="HOL2"
mml> PROV-ADD:HOLIDAY:DATE="00.05.01",HDAY="HOL3" 

Step 2 (Optional)—Define Charge Origins

The following example assigns charge origins from the newly introduced CLI charge origin table:

mml> NUMAN-ADD:ACHORIGIN:CUSTGRPID="PSTN"
mml> NUMAN-ADD:ACHORIGIN:CUSTGRPID="PSTN",CLI="91234567",CORIGIN=1
mml> NUMAN-ADD:ACHORIGIN:CUSTGRPID="PSTN",CLI="501234567",CORIGIN=2
 
   

Step 3 (Mandatory)—Create Charge Data

mml> PROV-ADD:CHARGE:CHORIG=1,CHDEST=1,TARIFFDESC="3 0700 4 1800 3"
mml> PROV-ADD:CHARGE:CHORIG=1,CHDEST=1,DOW=SATURDAY,TARIFFDESC="3"
mml> PROV-ADD:CHARGE:CHORIG=1,CHDEST=1,DOW=SUNDAY,TARIFFDESC="3"
mml> PROV-ADD:CHARGE:CHORIG=1,CHDEST=1,DOW=HOL1,TARIFFDESC="1"
mml> PROV-ADD:CHARGE:CHORIG=1,CHDEST=1,DOW=HOL2,TARIFFDESC="2"
mml> PROV-ADD:CHARGE:CHDEST=1,TARIFFDESC="4" 

In this example:

calls from charge origin 1 to charge destination 1 use a tariff id of 3 from 000-0700, 4 from 0700-1800 and 3 from 1800 to 2400 from Monday to Friday

Saturday and Sunday are charged at a fixed rate using tariff id 3

The 4th July and 1st of May receive a fixed charge with a tariff id of 1 and the 25th of December is charged using tariff id 2

All other calls to this charge destination (i.e. charge origin <> 0) are charged at a flat rate using tariff id 4

Step 4 (Mandatory)—Define Meter Tariff Table Data

mml> PROV-ADD:METERTARIFF:TARIFFID=1,PULSEONANS=5,INTERVAL=10,NUMPULSES=5, 
CHARGEAPP=0,AOCIND=0,MAXCALLLEN=100,TARIFFTYPE=0 
 
mml> PROV-ADD:METERTARIFF:TARIFFID=2,PULSEONANS=0,INTERVAL=60,NUMPULSES=1, 
CHARGEAPP=0,AOCIND=0,MAXCALLLEN=100,TARIFFTYPE=0
mml> PROV-ADD:METERTARIFF:TARIFFID=3,PULSEONANS=5,INTERVAL=120,NUMPULSES=1, 
CHARGEAPP=0,AOCIND=0,MAXCALLLEN=100,TARIFFTYPE=0
 
   

Step 5 (Mandatory)—Define Charge Result Type

mml> NUMAN-ADD:RESULTTABLE:CUSTGRPID="PSTN",NAME="MPMCHARGE1",RESULTTYPE="CHARGE", 
DW1="1", DW2="0",DW3="5",SETNAME="PSTNVOIPCALL" 

Step 6 (Optional)—Set Charge Mode Indicator

mml> NUMAN-ADD:RESULTTABLE:CUSTGRPID="PSTN",NAME="MPMMODIND",RESULTTYPE="CHARGE_MODE_IND", 
DW1="1",SETNAME="PSTNVOIPCALL"
 
   

Step 7 (Optional)—Set Charge Indicator

mml> NUMAN-ADD:RESULTTABLE:CUSTGRPID="PSTN",NAME="MPMCHGIND",RESULTTYPE="CHARGE_IND", 
DW1="1",SETNAME="PSTNVOIPCALL" 

Provisioning Percentage Based Routing

This section describes the MML parameters and commands used to configure percentage based routing and the PERC_ROUTE result type in the dial plan.

This section is used to configure the conditional route and conditional route description that are part of percentage based routing.

For more information on conditional route and conditional route description components, see MML Command Reference.

Provisioning the Conditional Result

The following MML commands add, edit, and add another entry to the Conditional Route list.

prov-add:condrtedesc:name="descone",starttime="0000",endtime="1200",rtlistname="three"
prov-ed:condrtedesc:name="descone",starttime="1201",endtime="2359",rtlistname="one"
prov-add:condrte:name="one",dow="default",condrtedesc="descone"
 
   

Provisioning the Percentage Route

This section is used to configure the percentage based route list.

The following MML commands examples show how to add, retrieve, edit, and delete percentage based routing information.

For more information on the percentage route component, see MML Command Reference.

Creating Conditional Route Examples

An example where connecting to a route list:

prov-add:condrtedesc:name="descone",rtlistname="three"
      prov-add:condrte:name="one",dow="default",condrtedesc ="descone"

An example where connecting to a percentage based routing name:

prov-add:condrtedesc:name="desctwo",percrtename="three"
prov-add:condrte:name="one",dow="default",condrtedesc ="desctwo"

Editing Conditional Route Examples

To add an entry for hol1 to conditional route one:

prov-ed:condrte:name="one",dow="hol1",condrtedesc ="descthree"
 
   

To add another time period to the conditional route description descone:

prov-ed:condrtedesc:name="descone",starttime="1200",endtime="2345",rtlistname="one"
 
   

To add another time period to the conditional route description desctwo:

prov-ed:condrtedesc:name="desctwo",starttime="1200",endtime="2345",perc="perctwo"
 
   

To change the primary route to percthree:

prov-ed:condrtedesc:name="desctwo",primary="ON",perc="percthree"

Deleting Conditional Route Examples

To delete the conditional route one:

prov-dlt:condrte:name="one"
 
   

To delete the whole conditional route description descone:

prov-dlt:condrtedesc:name="descone"
 
   

To delete just the hol1 entry in the conditional route description descone:

prov-dlt:condrte:name="descone",dow="hol1"
 
   

To delete the route list from the conditional route description desctwo:

prov-dlt:condrtedesc:name="desctwo",rtlistname="three"

Retrieving Conditional Route Examples

To retrieve all of the conditional routes:

prov-rtrv:condrte:"all"
 
   

To retrieve the conditional route one:

prov-rtrv:condrte:name="one"
 
   

To retrieve all of the conditional route descriptions:

prov-rtrv:condrtedesc:"all"
 
   

To retrieve the conditional route description descone:

prov-rtrv:condrtedesc:name="descone"

Provisioning an Intermediate COND_RTE Result Type

The MML example for configuring intermediate COND_ROUTE results in the results is as follows:

NUMAN-ADD:RESULTTABLE:CUSTGRPID="T002",NAME="result39",RESULTTYPE="COND_ROUTE",DW1="condNa
me1",SETNAME="condsetName1"

Creating Percentage Based Route Examples

Adding the first entry to a percentage based route name does not provision the load parameter, since the percentage default is 100%. As you add other entries, the value is adjusted to according to the new percentage values being added. Keep in mind that the maximum value is 100% and the minimum value is 0%. In the second example that follows, when the second command is executed, the first entry is modified to 75%, and when the third command is added, the first entry is modified to 50%. If the total of all the configured percentage for the percentage based route name, excluding the first entry, is greater than 100%, then an error message is generated.

For example:

prov-add:percrte:name="one",rtlistname="one",ovrflwset="ON",primary="ON"

Editing Percentage Based Route Examples

prov-ed:percrte:name="one",rtlistname="three",load=25
prov-ed:percrte:name="one",condrtename="todtwo",load=25
prov-ed:percrte:name="one",condrtename="todthree",overflow="ON"
 
   

This results in 50% traffic to route list name one, 25% traffic to route list name three, and 25% traffic to time of day name todtwo.

If overflow is supported, it allows reentry to the percentage based routing name to choose another rtlistname or todname if all of the trunks in the previously selected rtlistname or todname were unavailable.

Deleting Percentage Based Route Examples

To delete the percentage based route one:

prov-dlt:percrte:name="one"
 
   

To delete the route list three from percentage based route two:

prov-dlt:percrte:name="two",rtlistname="three"

Retrieving Percentage Based Route Examples

To retrieve all of the percentage based routes:

prov-rtrv:percrte:"all"
 
   

To retrieve the percentage based route one:

prov-rtrv:percrte:name="one"

Provisioning Conditional Routing

This section describes the MML commands required to provision the COND_ROUTE result type and the Route Holiday list. These provisioning commands should be entered in the order shown here.

Provisioning the COND_ROUTE Result Type

The COND_ROUTE result must be configured in the results, using the existing NUMAN-ADD command to make the association between the result set, result type, and the conditional route.

The following MML command adds the COND_ROUTE result type to the results:

mml> numan-add:resulttable:custgrpid="t001",name="result1",resulttype="COND_ROUTE", 
dw1="condname1",setname="set10"

Provisioning the Route Holiday List

The format of the DATE parameter in all of the following commands is:

Year—yyyy = 0000 through 9999
Month—mm = 1 through 12
Day—dd = 01 through 31

Adding an Entry to the Route Holiday List

To add an entry in the Route Holiday list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-add:rteholiday:custgrpid="t001",date="2001.12.25",hday="hol1"
 
   

This MML command inserts a holiday date (2001.12.25) into the Route Holiday list and designates it as a "hol1."

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the Route Holiday list and the new holiday date you changed are now present.

Step 3 Repeat steps 1 and 2 for each holiday you want to insert in the Route Holiday list.


Editing an Entry in the Route Holiday List

To edit an entry in the Route Holiday list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-ed:rteholiday:date="2001.12.25",hday="hol2"
 
   

This command changes the holiday date (2001.12.25) from "hol1" to a "hol2."

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the holiday designation you changed is now present.

Step 3 Repeat steps 1 and 2 for any holiday you want to change in the Route Holiday list.


Deleting an Entry From the Route Holiday List

To delete an entry in the Route Holiday list, complete the following steps:


Step 1 At the MML prompt, enter the command:

mml> numan-dlt:rteholiday:date="2001.12.31"
 
   

This command deletes the existing holiday date (2001.12.31) from the Route Holiday list.

Step 2 To verify the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Verify the holiday entry you changed was deleted.

Step 3 Repeat steps 1 and 2 for any holiday you want to delete from the Route Holiday list.


Retrieving Entries From the Route Holiday List

To retrieve an entry from the Route Holiday list, complete the following steps:


Step 1 To retrieve a single entry from the Route Holiday list, enter this command at the MML prompt:

mml> numan-rtrv:rteholiday:date="2001.12.31"
 
   

This command retrieves the existing holiday date (2001.12.31) from the Route Holiday list.

To retrieve all the entries in the Route Holiday list, enter this command at the MML prompt:

mml> numan-rtrv:rteholiday:"all"
 
   

This command retrieves all existing holiday dates from the Route Holiday list.

Verify the holiday entry or entries you changed are displayed.

Step 2 Repeat step 1 for any holiday entry you want to retrieve from the Route Holiday list.


Route Holiday Provisioning Examples

mml> numan-add:rteholiday:date="2001.02.10",hday="hol1"
mml> numan-ed:rteholiday:date="2001.02.10",hday="hol2"
mml> numan-dlt:rteholiday:date="2001.02.10"
mml> numan-rtrv:rteholiday:date="2001.02.10"
mml> numan-rtrv:rteholiday:"all"

Provisioning Calling Party Category

This section is used to configure the CPC.

Provision the CPC using MML commands. For more information on the CPC component, see MML Command Reference.

Use the following MML command format to add a CPC value of 14 (Payphone) to the CPC list:

mml> numan-add:cpc:custgrpid="T001",cpcvalue=14,setname="payphone"

Provisioning Transmission Medium Requirements

This section describes the MML commands required to provision the TMR.

Provision the TMR table using MML commands. For more information on the TMR parameter, see MML Command Reference.

Use the following MML command format to add a TMR value of 1 to the TMR table:

mml> numan-add:tmr:tmrvalue=1,custgrpid="T001",setname="tmrsetone"

Provisioning Transit Network Selection

This section describes the MML commands required to provision the TNS table.

Provision the TNS using MML commands. Use the following MML command format to add a TNS value of 111 to the TNS list:

mml> numan-add:resultset:custgrpid="T001",name="CSCO111"
mml> numan-add:resulttable:custgrpid="T001",resultType="ROUTE",setname="CSCO111",name="CSC
O111"
mml> numan-add:tns:tnsvalue="111",custgrpid="T001",setname="CSCO111"

Note The setname property must be configured before adding a TNS value to the TNS list.

The TNS value range is from 000 through FFFFFFFF.

Similarly, you can use the numan-ed or numan-dlt commands to respectively edit or delete TNS list entries.

The following examples show the embedded TNS value for ANSI and Q.761.

As can be seen, by the bold text in the following example, the number of the carrier is embedded. The following TNS example for ANSI; the TNS number is 123.

'00100011'B -- Octet 31   Transit Network Selection        H'23
'00000011'B -- Octet 32   len                              H'03
'00100001'B -- Octet 33   National, 3-digit ID             H'21
'00100001'B -- Octet 34  Digits 12                        H'21
'00100011'B -- Octet 35  Int Call op req, Digit 3         H'23
 
   

You would use the following MML command to provision the preceding ANSI TNS example.

numan-add:tns:custgrpid="test",tnsvalue="123",setname="actiontns"
 
   

As can be seen, by the bold text in the following example, the number of the carrier is embedded. The following TNS example for Q.761; the TNS number is 3333.

'00100011'B -- Octet 39   Transit Network Selection            H'23
'00000011'B -- Octet 40   len                                  H'03
'00100011'B -- Octet 41   National, X.121, even                H'23
'00110011'B -- Octet 42  Digits 33                            H'33
'00110011'B -- Octet 43  Digits 33                            H'33
'00000000'B -- Octet 24   End of Optional parameters           H'00
 
   

You would use the following MML command to provision the preceding Q.761 TNS example.

numan-add:tns:custgrpid="test",tnsvalue="3333",setname="actiontns"

Provisioning Bearer Capability Based Routing

This section describes the MML commands required to provision the bearer capability based routing.

Provisioning the Bearer Capability Based Routing

Provision the bearer capability based routing using MML commands. Use the following MML command formats to add bearer capability based routing attributes:

mml> prov-add:bearercap:name="bearer1",bearercap="12;05;31"
mml> prov-add:siprttrnkgrp:name="2222",url="128.107.132.143",srvrr=0,sipproxyport=5060,ver
sion="2.0",cutthrough=1,extsupport=1,bearercapname="bearer1"
mml> prov-add:rttrnkgrp:name="1",type=1,reattempts=3,queuing=0,cutthrough=1,bearercapname=
"bearer1"

Provisioning the Announcement

Provisioning the Tone and Announcement Database Table

To provision the ToneAndAnnouncement database table, use the following MML commands.

To add an announcement, use the following MML command:

mml> numan-add:announcement:annid=123,gwtype="AS5400",playduration="30",repeat="2", 
interval="3",locationstring="xyz.aud" 
 
   

To edit an announcement, use the following MML command:

mml> numan-ed:announcement:annid=123,gwtype="AS5400",locationstring="welcome.aud" 
 
   

To delete an announcement, use the following MML command:

mml> numan-dlt:announcement:annid=123,gwtype="AS5400" 
 
   

To retrieve an announcement, use the following MML command:

mml> numan-rtrv:announcement:annid=123,gwtype="AS5400" 
 
   

Use the following MML command to generate a data file called announcement.dat along with the file import command in numan.MML by the following MML command:

mml> prov-exp:numan:dirname="exp1" 
 
   

After editing, use the following MML command to import this file back into the database:

mml> prov-add:files:name="announcementfile",file="exp1/announcement.dat",action="import" 

Provisioning the ANNOUNCEMENT Result Type

To add a remote announcement result: announceId=123, remote, RoutelistId=dulles, use the following MML command:

mml> numan-add:resulttable:custgrpId="T002",name="result59",resulttype="ANNOUNCEMENT", 
dw1="123",dw2="1",dw3="dulles",setname="set1" 
 
   

To add a local announcement result: announceId=123, local, Final_on for playing announcement, use the following MML command:

mml> numan-add:resulttable:custgrpId="T002",name="result60",resulttype="ANNOUNCEMENT", 
dw1="123",dw2="0",dw4="1",setname="set1" 
 
   

To associate a B-digit number to the result set, use the following MML command:

mml> numan-add:bdigtree:custgrpid="T002",digitstring="7034843375",callside="originating", 
setname="set1" 

Provisioning an ATM Profile

An ATM profile must first be created in routeAnalysis.dat before it can be modified. The following sections show the MML commands to use for creating an ATM profile and then modifying that profile.

Adding an ATM Profile to routeAnalysis.dat

ATM profile support is provided by using the following MML command:

mml> prov-add:atmprofiles:name="atmprof1",atmprofile="ITU1;custom100"
 
   

The following example represents the result of the previous MML command in routeAnalysis.dat:

$ATMProfiles
# CiscoMGC:   01
#name                ATMProfiles
atmprof1            ITU1;cust100

Adding ATM Profiles to the Result Table

Add result types ATM_ORIG_PROFILE and ATM_TERM_PROFILE to the T002 dial plan, the ResultTree includes these two result types and handling their respective datawords.

MML command examples:

mml> numan-add:resulttable:custgrpId="T002",name="result59",resulttype="ATM_ORIG_PROFILE", 
dw1="atmprof1",dw2="1"
mml> numan-add:resulttable:custgrpId="T002",name="result60",resulttype="ATM_TERM_PROFILE", 
dw1="atmprof1",dw2="1",setname="set1" 
 
   

The result in T002.dialplan

$resultTable
# Customer: T002
#type           dw1         dw2          dw3             dw4              nextResult
# result1      result59
59				 1 			 1
 
   

Provisioning Tech Prefix Capabilities

This section describes the steps to take to provision the Technology Prefix (Tech Prefix) mechanism in H.323 networks. The Tech prefix is used on H.323 networks as signaling information to indicate a call origin or termination. The Tech Prefix uses overdecadic digits B and C and maps them to * and # respectively. The Tech Prefix and a separator are appended to the beginning of the B-number.

The following MML commands provide a Tech Prefix provisioning examples for adding the Tech Prefix and removing the Tech Prefix.

Adding the Tech Prefix

Use the following MML Commands to add the Tech Prefix for the trunk group.

uman-add:digmodstring:custgrpid="t999",name="ibasis_carrier",digstring="03005C"
numan-add:resultset:custgrpid="t901",name="toDMS03005"
numan-add:resultable:custgrpid="t901",name="trDMS03005",resulttype="BMODDIG",dw1="1", 
dw2="0",dw3="ibasis_carrier",setname="toDMS03005"
numan-add:resultable:custgrpid="t901",name="routeDMS03005",resulttype="ROUTE", 
dw1="routeg302", setname="toDMS03005"
numan-add:bdigtree:custgrpid="t901",callside="originating",digitstring="715", 
setname="toDMS03005"
 
   

The following MML command is for adding another Tech Prefix:

numan-add:bdigtree:custgrpid="t901",callside="originating",digitstring="03023C", 
setname="toDMS03005"

Removing the Tech Prefix

Use the following MML Commands to remove the Tech Prefix for the trunk group.

numan-add:resultset:custgrpid="t999",name="FromDMS999"
numan-add:resultable:custgrpid="t999",name="trDMS03005",resulttype="BMODDIG",dw1="1", 
dw2="6",setname="FromDMS999"
numan-add:resultable:custgrpid="t999",name="routeDMS03005",resulttype="ROUTE",dw1="routeg3
02",setname="FromDMS999"
numan-add:bdigtree:custgrpid="t999",callside="originating",digitstring="03005C",setname="F
romDMS999"

Provisioning Advanced Screening Capabilities

The following sections describe the process for provisioning the advanced screening capabilities on the Cisco PGW 2200 Softswitch.


Note This functionality is available starting in software Release 9.4(1).

Before you begin provisioning the advanced screening capabilities, you must have the following information about your installation:

H.323 messages coming from different call managers

Dial plan information (depending on the source IP address of the call manager)


Note The *.SysConnectDataAccess parameter, in XECfgParm.dat, must be set to true (enabling connection to the MMDB or call screening database) in calling scenarios where European Local Number Portability, A-number screening, or other features that require real time database access.

Note The calling party number (CgPn) cannot be empty for screening based on the IP address or calling line identity (CLI).

Provisioning CLI IP Address

The cliipaddress parameter allows you to associate an IP address with a specific customer group.

Adding CLI IP Address to a Customer Group

With an active provisioning session, perform the following steps to add the CLI IP address to a customer group:


Step 1 Add a customer group to the Dial Plan table if one has not already been created:

mml> numan-add:dialplan:custgrpid="Cus1" 
 
   

Step 2 Define the cliprefix and group them by clisetname:

mml> numan-add:cliprefix:clisetname="x",cliprefix="1844260",custgrpid="Cus1" 
 
   

Step 3 Define the IP address and the subnet for the customer group:

mml> numan-add:cliipaddress:custgrpid="Cus1",ipaddr="172.22.99.247", 
subnetmask="255.255.0.0,clisetname="x" 
 
   

Deleting CLI IP Address with Subnet Mask from a Customer Group

Perform the following command to delete CLI IP address with subnet mask from a customer group:

mml> numan-dlt:cliipaddress:custgrpid="Cus1",ipaddr="172.22.99.170",subnet= 
"255.255.255.0"

Editing CLI IP Address

Use the following command to edit the CLI IP address for a customer group:

mml> numan-ed:cliipaddress:custgrpid="Cus1",ipaddr="172.22.121.247",clisetname="x" 

Provisioning CLI Prefix

The cliprefix parameter allows you to associate a CLI prefix with a specific customer group. If an incoming call matches the CLI prefix parameter, you can apply certain dial plan functions to it. There can be a maximum of 10 CLI prefix entries for each CLI set name.


Note A DEFAULT CLI prefix entry must be configured for each CLI set name

Adding CLI Prefix to a Customer Group

Perform the following steps to add a CLI prefix to a customer group.


Step 1 Use the following MML commands to add customer groups to the Dial Plan table if they have not already been created:

mml> numan-add:dialplan:custgrpid="Cus1" 
mml> numan-add:dialplan:custgrpid="csco" 
mml> numan-add:dialplan:custgrpid="Cus2" 
mml> numan-add:dialplan:custgrpid="Cus3" 
 
   

Step 2 Use the following MML commands to add CLI prefixes to the customer groups.

mml> numan-add:cliprefix:clisetname="x",cliprefix="408",custgrpid="Cus1" 
mml> numan-add:cliprefix:clisetname="x",cliprefix="1408260",custgrpid="csco" 
mml> numan-add:cliprefix:clisetname="x",cliprefix="140826033",custgrpid="Cus2" 
mml> numan-add:cliprefix:clisetname="x",cliprefix="DEFAULT",custgrpid="Cus3" 
 
   

Deleting CLI Prefix from a Customer Group

Use the following MML command to remove a CLI prefix from a customer group.

mml> numan-dlt:cliprefix:clisetname="x",cliprefix="DEFAULT" 

Editing CLI Prefix

Use the following MML command to edit a CLI prefix for a customer group.

mml> numan-ed:cliprefix:clisetname="x",cliprefix="DEFAULT",custgrpid="Cus1" 

Provisioning H.323 ID

The h323iddivfrom parameter allows you to associate an H.323 ID with a specific customer group. If an incoming call matches the H.323 ID parameter, you can apply certain dial plan functions to it.

Adding H.323 ID to a Customer Group

Perform the following steps to add an H.323 ID to a customer group:


Step 1 Use the following MML command to add a customer group to Dial Plan table if one has not already been created:
mml> numan-add:dialplan:custgrpid="Cus1"

Step 2 Use the following MML command to add an H.323 ID to a customer group.
mml> numan-add:h323iddivfrom:custgrpid="Cus1",h323iddivfrom="4eaf005",clisetname="x"


Deleting H.323 ID from a Customer Group

Use the following MML command to remove an H.323 ID from a customer group:
mml> numan-dlt:h323iddivfrom:custgrpid="Cus1",h323iddivfrom="4eaf005"

Editing H.323 ID

Use the following MML command to edit an H.323 ID in a customer group: 
mml> numan-ed:h323iddivfrom:custgrpid="Cus1",h323iddivfrom="AFA1974",clisetname="x" 

Provisioning Results of Various Result Types

Provisioning the CC_DIG Result Type

This section describes the MML commands required to provision the CC_DIG result type. These provisioning commands should be entered in the order shown here.

Provisioning Country Codes

The required Country code digit strings can be configured in DIGMODSTRING using the existing NUMAN-ADD command. For example:

mml> numan-add:digmodstring:custgrpid="t002",name="ccspain",digstring="34"
mml> numan-add:digmodstring:custgrpid="t002",name="ccfrance",digstring="33"
mml> numan-add:digmodstring:custgrpid="t002",name="ccitaly",digstring="39"

Provisioning the Result Set

Example 4-2 is an example of a result set with the associated results. The result set lists the values that are included for each result name: result set name, result name, result type, datawords 1 through 4, and the next result name. The dataword values in the result set are determined by the dataword values of the result type, as shown in Table 1-1.

In Example 4-2, the result name for result set1 is the SCREENING result type. The value for dataword1 is 1, indicating whitelist screening will be performed. The value for dataword2 is Washington, the service name associated with the BWhite screening file that is to be used.

The result name for result set 6 is the B_NUMBER_TYPE result type. The value for dataword1 is 3, indicating the B-number type NOA is 3 (NOA_SUBSCRIBER).

Note that two result types (A_NUMBER_TYPE and BLACKLIST) have been connected in Example 4-2 by using the same result set name (set4). When the MML session is run, the last result in a result set has to be created first. If the last result in a result set is not created first, an error is generated because a next result cannot be connected, because that result does not yet exist.

Example 4-2 Result Set Example

Result Set
Result Name
Result Type
Dataword1
Dataword2
Dataword3
Dataword4
Next Result

set1

result1

SCREENING

1

1

 

 

 

set2

result1

ANNOUNCEMENT

100

Washington

relist1

 

 

set3

result1

IN_TRIGGER

1

1

 

 

 

set4

result1

A_NUMBER_TYPE

5

 

 

 

result2

set4

result2

BLACKLIST

1

 

 

 

 

set5

result1

BMODDIG

0

1

digmod1

 

result2

set5

result2

CC_DIG

ccspain

 

 

 

 

set6

result1

B_NUMBER_TYPE

3

 

 

 

 

set7

result1

INC_NUMBERING

0

4

4

 

 

set8

result1

E_PORTED_NUM

 

 

 

 

 

set9

result1

E_PORTED_NUM

1

 

 

 

 

set9

result2

E_ROUTE_NUM

4

 

 

 

 

set10

result1

COND_ROUTE

condname1

 

 

 

 


MML Commands

numan-add:resulttable:custgrpid="t001",name="result1",resulttype="SCREENING",dw1="1",dw2="
Washington",setname="set1"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="ANNOUNCEMENT",dw1="100",
dw2="1",dw3="rtlist1",setname="set2"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="IN_TRIGGER",dw1="1", 
dw2="1",setname="set3"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="A_NUMBER_TYPE",dw1="5", 
setname="set4"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="BLACKLIST",dw1="1", 
setname="set4"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="BMODDIG",dw1="1",dw2="1"
,dw3="digmod1",setname="set5"
numan-add:resulttable:custgrpid="t001",name="result2",resulttype="CC_DIG",dw1=ccspain, 
setname="set5"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="B_NUMBER_TYPE",dw1="3", 
setname="set6"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="INC_NUMBERING",dw1="0",d
w2="4",dw3="4",setname="set7"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="E_PORTED_NUM", 
setname="set8"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="E_PORTED_NUM",dw1="1", 
setname="set9"
numan-add:resulttable:custgrpid="t001",name="result2",resulttype="E_ROUTE_NUM",dw1="4", 
setname="set9"
numan-add:resulttable:custgrpid="t001",name="result1",resulttype="COND_ROUTE", 
dw1="condname1",setname="set10"
 
   
mml> numan-add:resulttable:custgrpid="t002",name="result34",resulttype="CC_DIG", 
dw1=ccspain,setname="setname1"
mml> numan-add:resulttable:custgrpid="t002",name="result33",resulttype="CC_DIG", 
dw1=ccfrance,setname="setname2"
mml> numan-add:resulttable:custgrpid="t002",name="result39",resulttype="CC_DIG", 
dw1=ccitaly,setname="setname3"

Provisioning the BdigTree

To configure the result set against the required number decode in the BDIGTREE, use the existing NUMAN-ADD command. For example:

mml> numan-add:bdigtree:custgrpid="t002",digitstring="612",callside="originating", 
setname="setname1"
mml> numan-add:bdigtree:custgrpid="t002",digitstring="493",callside="originating", 
setname="setname2"
mml> numan-add:bdigtree:custgrpid="t002",digitstring="55",callside="originating", 
setname="setname3"
 
   

This completes the linkage from the called number (B-number) to the result set, the result setname to the CC_DIG result name, and finally the result name to the Country code digits in DIGMODSTRING. The end result is to link the called number to the applicable Country code.

Provisioning the NEW_DIALPLAN Result Type

This section describes the MML parameters and commands used to configure the NEW_DIALPLAN result type in the dial plan.

The following MML example shows what is required for a B-number analysis result.

numan-<verb>:resulttable:custgrpid="<customer group id>",name="<result name>", 
resulttype="new_dialplan",dw1=CustGrpID,dw2=AnalysisType,setname="<resultsetname>"
 
   

where:

CustGrpID value

This dataword is relevant in all cases and supplies a CustGrpID that is used to read the dial plan selection list. The default value is 0.

AnalysisType value

Dataword2 for this result type is relevant when the digit analysis is defined for Pre-analysis (1 only), A-number analysis (1 only), B-number analysis (1 or 2), or Cause analysis ((2 only).

Dataword2 provides an enumerated indication of what the next stage of analysis is to be, once the new dial plan is identified and invoked. The valid values for dataword2 are as follows:

1—Revert to the Pre-analysis stage in the new dial plan

2—Restart in B-number analysis in the new dial plan

When provisioning, the provisioning code checks to ensure that the new dial plan, selected by the result type NEW_DIALPLAN, is not the same as the current dial plan to avoid a loop situation.


Note Result names are limited to 20 alphanumeric characters. Spaces are not allowed.

Provisioning the A_NUM_DP_TABLE Result Type

The MML provisioning command numan-add is used to define the A_NUM_DP_TABLE result type in A-number digit trees.

numan-<verb>:resulttable:custgrpid="<customer group id>",name="<result name>", 
resulttype="anum_dp_table",setname="<resultsetname>"

Provisioning the INC_NUMBERING Result Type

The INC_NUMBERING result type is used to ensure the incoming called number (B-number) has the necessary (minimum) number of digits in the IAM to complete the call. This is useful to refine the digit collection process to eliminate invalid number of digits based on B-number analysis.

The incoming numbering type can be either closed numbering (en bloc) or open numbering (overlap). Provision the incoming numbering result type using the following MML command to select overlap (open numbering), set the minimum digits to 5, and set the maximum digits to 12.

mml> numan-add:resulttable:custgrpid="5555",name="rtin",resulttype="INC_NUMBERING",dw1="1"
,dw2="5",dw3="12",setname="set222" 
 
   

Tip The values set for INC_NUMBERING dataword 2 (minimum digits) and dataword 3 (maximum digits overrides the OMinDigits and OMaxDigits properties. For example, if OMinDigits is set to 3 and INC_NUMBERING dataword 2 is set to 5, the incoming call will be routed after 5 digits have been received.

Provisioning Examples for Various Result Types

This section provides provisioning examples for various result types.

mml> numan-add:dialplan:custgrpid="A001"
mml> numan-add:dialplan:custgrpid="A002"
mml> numan-add:service:custgrpid="1111",name="TollFree"
mml> numan-add:dpsel:custgrpid="1111",newdp="A001"
mml> numan-add:dpsel:custgrpid="1111",newdp="A002"
mml> numan-add:digmodstring:custgrpid="1111",name="mod1",digstring="12345"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1",resulttype="ROUTE", dw1="rlst1",setname="rset1"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1t23",resulttype="SCREENING", 
dw1="1",dw2="TollFree",dw3="A001",dw4="A002",setname="rset1"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1t49",resulttype="PNMODDIG",dw1="3",dw2="5",dw3="mod1", 
setname="rset1"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1t50",resulttype="PN_NUMBER_TYPE",dw1="43", 
setname="rset1"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1t51",resulttype="PN_PRES_IND",dw1="3",setname="rset1"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1t52",resulttype="CG_SCREEN_IND",dw1="5", 
setname="rset1"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1t53",resulttype="PN_SCREEN_IND",dw1="5", 
setname="rset1"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1t54",resulttype="A_NUM_NPI_TYPE",dw1="10", 
setname="rset1"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1t55",resulttype="CG_PN_COPY", 
dw1="mod1",setname="rset1"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1t56",resulttype="PN_NPI_TYPE", 
dw1="10",setname="rset1"
mml> numan-add:resulttable:custgrpid="1111",name="rtab1t37",resulttype="CG_PRES_IND",dw1="3",setname="rset1"

Importing Dial Plan Information

Use the following MML commands to import the following information:

mml> prov-add:files:name="cliprefixfile",file="abc1.dat",action="import" 
mml> prov-add:files:name="ipaddrfile",file="abc2.dat",action="import" 
mml> prov-add:files:name="h323idfile",file="abc3.dat",action="import" 

Enabling Dial Plan Selection for Incoming Trunk groups

Enabling Dial Plan Selection for Incoming SIP Trunk Group

Perform the following steps to configure and verify the enableipscreening property for an incoming SIP trunk group:


Step 1 Use the following MML command to start and name an MML provisioning session:

mml> prov-sta::srcver="SIP_EISUP_1001",dstver="sip_0801"

Step 2 Use the following MML command to dynamically set the enableipscreening property to "1" for the SIP trunk group:

mml> prov-add:trnkgrpprop:name="550",enableipscreening="1"

Step 3 Use the following MML command to commit the changes:

mml> prov-cpy 
 
   

Enabling Dial Plan Selection for Incoming EISUP Trunk Group

Perform the following steps to configure and verify the enableipscreening property for an incoming EISUP trunk group:


Step 1 Use the following MML command to start and name an MML provisioning session:

mml> prov-sta::srcver="SIP_EISUP_1001",dstver="eisup_0801"

Step 2 Dynamically set the enableipscreening property to "1" for the EISUP trunk group:

mml> prov-add:trnkgrpprop:name="2000",enableipscreening="1"

Step 3 Commit the changes: mml> prov-cpy


Verifying Your Changes

Verify that prov-cpy is successful.

Verify the property is added correctly by using the following MML command.

mml> prov-rtrv:trnkgrpprop:"all" 

Determining Which IP Address to Use for Dial Plan Selection

Configuring the MGC to Use IP Packet Source Address for Dial Plan Selection

Perform the following steps to configure and verify the sipipsource property to use IP packet source address for dial plan selection:


Step 1 Start and name an MML provisioning session by using the following MML command.

mml> prov-sta::srcver="SIP_EISUP_1001", dstver="sip_0801" 
 
   

Step 2 Dynamically set the sipipsource property to "0" for the SIP trunk group by using the following MML command.

mml> prov-add:trnkgrpprop:name="550",sipipsource="0" 
 
   

Step 3 Commit the changes by using the following MML command.

mml> prov-cpy
 
   

Configuring Cisco PGW 2200 Softswitch to use IP from SDP INVITE for Dial Plan Selection

Perform the following steps to configure and verify the sipipsource property to use the IP address from SDP in INVITE for dial plan selection.


Step 1 Start and name the MML provisioning session:

mml> prov-sta::srcver="SIP_EISUP_1001",dstver="sip_0801" 
 
   

Step 2 Dynamically set the sipipsource property to "1" for the SIP trunk group:

mml> prov-add:trnkgrpprop:name="550",sipipsource="1" 
 
   

Step 3 Commit the changes:

mml> prov-cpy
 
   

Verifying Your Changes

Verify that the prov-cpy MML command is successful.

Verify the property is added correctly by using the following MML command.

mml> prov-rtrv:trnkgrpprop:"all" 

Verifying Incoming Trunk Group Calls

Verifying Incoming Calls that Do Not Have a Presentation Number

Perform the following steps to configure and verify the defaultpn property on incoming trunk group for the incoming calls not having presentation number.


Step 1 Start and name MML provisioning session:

mml> prov-sta::srcver="SIP_EISUP_1001", dstver="ss7_0801" 
 
   

Step 2 Set the defaultpn property for the TDM_ISUP trunk group:

mml> prov-add:trnkgrpprop:name="1000",defaultpn="4EAF005" 
 
   

Step 3 Commit the changes by using the following MML command.

mml> prov-cpy 
 
   

Verifying Incoming Calls that Do Not Have an NOA Presentation Number

Perform the following steps to configure and verify the defaultpnnoa property on incoming trunk group for the incoming calls not having presentation number Nature of Address.


Step 1 Start and name an MML provisioning session by using the following MML command.

mml> prov-sta::srcver="SIP_EISUP_1001",dstver="ss7_0801" 
 
   

Step 2 Set the defaultpnnoa property for the TDM_ISUP trunk group by using the following MML command.

mml> prov-add:trnkgrpprop:name="1000", defaultpnnoa="5"

Step 3 Commit the changes by using the following MML command.

mml> prov-cpy
 
   

Verifying Incoming Calls that Do Not Have an NPI Presentation Indicator

Perform the following steps to configure and verify the defaultpnnpi property on the incoming trunk group for the incoming calls that do not have a presentation number Nature of Presentation Indicator.


Step 1 Start and name an MML provisioning session by using the following MML command.

mml> prov-sta::srcver="SIP_EISUP_1001",dstver="ss7_0801" 
 
   

Step 2 Set the defaultpnnpi property for the TDM_ISUP trunk group:

mml> prov-add:trnkgrpprop:name="1000",defaultpnnpi="6" 
 
   

Step 3 Commit the changes by using the following MML command.

mml> prov-cpy 

Verifying Incoming Calls that Do Not Have a PN Presentation Indicator

Perform the following steps to configure and verify the defaultpnpres property on incoming trunk group for the incoming calls not having presentation number Presentation Indicator.


Step 1 Start and name MML provisioning session by using the following MML command.

mml> prov-sta::srcver="SIP_EISUP_1001",dstver="ss7_0801" 
 
   

Step 2 Set the defaultpnpres property for the TDM_ISUP trunk group by using the following MML command.

mml> prov-add:trnkgrpprop:name="1000",defaultpnpres="6" 
 
   

Step 3 Commit the changes by using the following MML command.

mml> prov-cpy 
 
   

Verifying Your Changes

Verify that prov-cpy is successful.

Verify the property is added correctly: mml> prov-rtrv:trnkgrp:name="1000"

Provisioning Call Limiting

The following section provide examples of provisioning call limiting for A-numbers, B-numbers, and number analysis by using location labels.

Provisioning Call Limiting for an A-number

The following procedure lists the steps for provisioning call limiting for an A-number.


Step 1 Enter the following MML command to add a result set:
numan-add:resultset:custgrpid="5555",name="setloc1"

Step 2 Enter the following MML command to add a result table:
numan-add:resulttable:custgrpid="5555",name="resultloc",resulttype="loc_label",dw1="location1",setname="setloc1"

Step 3 Enter the following MML command to add an A-number digit tree:
numan-add:adigtree:custgrpid="5555",callside="originating",digitstring="301",setname="setloc1"


Provisioning Call Limiting for a B-number

The following procedure lists the steps for provisioning call limiting for a B-number.


Step 1 Enter the following MML command to add a result set:
numan-add:resultset:custgrpid="5555",name="setloc2"

Step 2 Enter the following MML command to add a result table:
numan-add:resulttable:custgrpid="5555",name="resultloc2",resulttype="loc_label",dw1="location1",setname="setloc2"

Step 3 Enter the following MML command to add a B-number digit tree:
numan-add:bdigtree:custgrpid="5555",callside="originating",digitstring="306",setname="setloc2"


Provisioning the OVERRIDE_CALLIM Result Type for Number Analysis

The following procedure lists the steps for provisioning the OVERRIDE_CALLIM result type for number analysis. This included Pre-analysis (CPC, ANOA, and BNOA) and formal analysis (A-number and B-number).


Step 1 Enter the following MML command to add a result set:
numan-add:resultset:custgrpid="5555",name="setloc3"

Step 2 Enter the following MML command to add the OVERRIDE_CALLIM result type to the result set.
numan-add:resulttable:custgrpid="5555",name="resultoverride",resulttype="override_callim",setname="setloc3"

Step 3 Use one of the following MML commands to associate the OVERRIDE_CALLIM result type with:

CPC

numan-add:cpc:custgrpid="5555",cpcvalue=9,setname="setloc3"

A-number NOA

numan-add:anoa:custgrpid="5555",noavalue=4,setname="setloc3"

B-number NOA

numan-add:bnoa:custgrpid="5555",noavalue=4,setname="setloc3"

A Digit Tree

numan-add:adigtree:custgrpid="5555",callside="originating",digitstring="302",setname="setloc3"

B Digit Tree

numan-add:bdigtree:custgrpid="5555",callside="originating",digitstring="307",setname="setloc3"

Dial Plan Examples

This section provides MML command examples of provisioning the call limiting.

;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; provision a location label
;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-add:loclabel:name="location1",calllimit=1
mml> prov-add:loclabel:name="location2",calllimit=1
 
   
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; add resulttype="loc_label" and assign these labels to the A digit tree
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> numan-add:resultset:custgrpid="5555",name="setloc"
mml> numan-add:resulttable:custgrpid="5555",name="resultloc", 
resulttype="loc_label",dw1="location1",setname="setloc"
mml> numan-add:adigtree:custgrpid="5555",callside="originating", 
digitstring="301",setname="setloc"
 
   
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; assign the location labels to dpnss sigPath
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-ed:dpnsspath:name="dpnss-3745-2-0",origlabel="location1",termlabel="location2"
 
   
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; assign the location labels to dpnss trunk group
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-ed:trnkgrp:name="3702",origlabel="location1",termlabel="location2"
 
   
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; add resulttype="override_callim" and associate it with a set
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> numan-add:resulttable:custgrpid="5555",name="resultloc",resulttype="override_callim", 
setname="setloc"

Scaling Dial Plan Elements

Table 4-8 lists software Release 9 dial plan information maximums that can be supported for the dial plan elements.

Table 4-8 Dial Plan Maximums 

Dial Plan Element
Maximum Limit

Maximum number of route lists

Gives a warning if more that 20 routes are in the route list that only the first 20 are used

Maximum number of carrier translations

Limited by system resources

Maximum number of percentage based routing

Limits the number of route changes to 5

Maximum number of conditional routing

Limited by system resources

Maximum number of conditional routing descriptions

Limits the number of route changes to 5

Maximum number of routes

When weighted trunk group is ON, limits the number trunk groups in the route to 100

Maximum number of routing trunk groups

Limited by system resources

Maximum number of dial plans

Limited by system resources, or 98 dial plans (in MGC software Release 9.3(2) and earlier), or 2147483647 dial plans (in MGC software Release 9.4(1) and later)


Provisioning Call Reporting

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

To provision call reporting, use the following provisioning procedure:


Step 1 Customize reporting messages included in a call detail record by using the following MML command.

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

Step 2 Confirm the message string was added.

mml> numan-rtrv:crptmesg:

Step 3 Add a result set for call reporting.

mml> numan-add:resultset:custgrpid="1111", name="pre-ana-callreport"
 
   

Step 4 Add a result of the CALL_REPORT result type in the result set.

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

Provisioning Calling Name Delivery

The calling name delivery (CNAM) allows the name of the calling party to be delivered to the called party if the called party has subscribed to the CNAM feature. CNAM is a terminating user feature allowing a customer premises equipment (CPE) connected to a switching system to receive a calling party's name during the first silent interval.

TheCisco PGW 2200 Softswitch supports transaction capabilities application part (TCAP) query to a CNAM database, and only if, it is allowed based on calling name delivery blocking (CNAB) and calling identity delivery and suppression (CIDS) information. The calling party name resides in the line information database (LIDB) which is accessed using TCAP query.

To enable CNAM, use the following provisioning procedure:


Step 1 Add the CNAM service, route by SSN, by using the following MML command:

mml> prov-add:inservice:name="ansi-pre-ain-cnam",skortcv=0, 
gtorssn="ROUTEBYSSN",gtformat="NOGT", msname="ansi-pre-ain-cnam"
 
   

Step 2 Add the CNAM service, route by GT, by using the following MML command:

mml> prov-ed:inservice:name="ansi-pre-ain-cnam",skortcv=0,gtorssn="ROUTEBYGT", 
gtformat="GTTT",msname="ansi-pre-ain-cnam"
 
   

Step 3 Add the Intelligent Network (IN) trigger.

mml> numan-add:resultset:custgrpid="1111",name="CNAM"
mml> numan-add:resulttable:custgrpid="1111",name="CNAMtrigger",resulttype="IN_TRIGGER", 
dw1="30",dw2="0",dw3="0",dw4="6",setname="CNAM"
 
   

Step 4 Add routing information.

mml> numan-add:resulttable:custgrpid="1111",name="route",resulttype="ROUTE",
dw1="rtlist1",setname="CNAM"
 
   

Step 5 Add the B-digit tree.

mml> numan-add:bdigtree:custgrpid="1111",callside="originating",digitstring="2146",
setname="CNAM"
 
   

Step 6 Enable calling name display in EISUP path and trunk group.

mml> prov-add:sigsvcprop:name="EISUP", InhibitOutgoingCallingNameDisplay ="0"
mml> prov-add:trnkgrpprop:name="7777", InhibitOutgoingCallingNameDisplay ="0"
 
   

Step 7 Provision cgnpinclude on SIP trunk groups.

mml> prov-add:profile:NAME="sippro",type="grprofile",cgpninclude="1"
mml> prov-add:trnkgrpprof:name="5600",grprofile="sippro"

Step 8 Provision MapCLItoSipHeader on SIP sigpath to map the ISUP CLI to P-Asserted-ID header in addition to From header:

mml> prov-add:sigsvcprop:name="sip-path", mapclitosipheader="3"

Provisioning Full Number Translations

Full Number Translations provide a large-scale, number translation function on the Cisco PGW 2200 Softswitch. This feature enhances the current Cisco PGW 2200 Softswitch database query mode, which is used for local number portability (LNP) and CLI screening, by handling contiguous ranges of numbers with analysis and modification capabilities. Full Number Translations support large-scale changes of individual numbers. This feature adds the NUM_TRANS result type that is implemented in analysis where the existing Times Ten database is used to store the dial plan numbers.

As mentioned in the "NUM_TRANS" section, we recommend that you configure the *.FNTBehaviourOptions parameter to 1 in the XECfgParm.dat file.

In the following provisioning example, you can find two result examples of the NUM_TRANS result type. This procedure is for illustration purposes.


Step 1 Add a service to the dial plan, DP00, by using the following MML command:

mml> numan-add:service:custgrpid="DP00",name="freephone"
 
   

Step 2 Add an entry in the full number translation table in the TimesTen database.

mml> numan-add:fullnumbertrans:svcname="freephone",digstring="C2088880000", 
translatednum="123456",numtype="2"
 
   

Step 3 Add a result of the NUM_TRANS result type to a result set.

mml> numan-add:resulttable:custgrpid="DP00",name="results",resulttype="NUM_TRANS", 
dw1="freephone",dw2="2",dw3="3",dw4="DP01",setname="setname3"
 
   

Step 4 Add other results to the result set.

mml> numan-add:resulttable:custgrpid="DP00",name="noaa",resulttype="A_NUMBER_TYPE", 
dw1="5",setname="setname3"
mml> numan-add:resulttable:custgrpid="DP00",name="noab",resulttype="B_NUMBER_TYPE", 
dw1="5",setname="setname3"
mml> numan-add:resulttable:custgrpid="DP00",name="noar",resulttype="R_NUMBER_TYPE",
dw1="5",setname="setname3"
 
   

Step 5 Add a B-digit tree and associate it with the result set

mml> numan-add:bdigtree:custgrpid="DP00",digitstring="999810",callside="originating", 
setname="setname3"
 
   

Step 6 Add a service to the dial plan, DP01.

mml> numan-add:service:custgrpid="DP01",name="freephone1"
 
   

Step 7 Add an entry in the full number translation table in the TimesTen database.

mml> numan-add:fullnumbertrans:svcname="freephone1",digstring="456", 
translatednum="222123123",numtype="2"
 
   

Step 8 Add a result of the NUM_TRANS result type to a result set.

 
   
mml> numan-add:resulttable:custgrpid="DP01",name="results",resulttype="NUM_TRANS",
dw1="freephone1",dw2="2",dw3="3",setname="setname31"
 
   

Step 9 Add other results to the result set.

mml> numan-add:resulttable:custgrpid="DP01",name="dlt999",resulttype="BMODDIG",dw1="1", 
dw2="3",setname="setname31"
mml> numan-add:resulttable:custgrpid="DP01",name="dlt123",resulttype="AMODDIG",dw1="1",
dw2="3",setname="setname31"
mml> numan-add:resulttable:custgrpid="DP01",name="dltR",resulttype="RMODDIG",dw1="1",
dw2="3",setname="setname31"
mml> numan-add:resulttable:custgrpid="DP01",name="rtb8101",setname="setname31", 
resulttype="ROUTE",dw1="rtlist810"
 
   

Step 10 Add a B-digit tree and associate it with the result set

mml> numan-add:bdigtree:custgrpid="DP01",digitstring="999810",callside="originating", 
setname="setname31"
 
   

Figure 4-1 shows the behavior on Cisco PGW 2200 Softswitch in this example.

Figure 4-1 Cisco PGW 2200 Softswitch Behavior in the Full Number Translations Provisioning Example

1. NUM_TRANS for A number is successful. Since the FNTBehaviourOptions is enabled, the A_NUMBER_TYPE, B_NUMBER_TYPE, and R_NUMBER_TYPE results will be dropped. Dial plan will be changed from DP00 to DP01 according to the value configured for DW4 of the NUM_TRANS result type.

2. NUM_TRANS for A number is failed. BMODDIG, AMODDIG, and RMODDIG results will take effect.

Provisioning Global Titles

You can provision SS7 global title used for IN operations on the Cisco PGW 2200 Softswitch. The Cisco PGW 2200 Softswitch can be provisioned to use an SS7 point code or to use an SS7 global title. Additionally, you can set the point code and subsystem number (SSN) if the point code method is used, or set the global title to use the calling number, called number, or a fixed value if the global title method is used.

To add calling number, called number, and fixed digits for global title in the dial plan, use the following provisioning procedure:


Step 1 Add a result set for setting the calling number (A-number) as the global title by using the following MML command:

mml> numan-add:resultset:custgrpid="1111",name="LNPtrigger_Calling"
 
   

Step 2 Add the result of the result type IN_SERVICE_KEY:

mml> numan-add:resulttable:custgrpid="1111",name="GTLNP1",resulttype="IN_SERVICE_KEY", 
dw1="90001",dw2="CALLING",setname="LNPtrigger_Calling"
 
   

Step 3 Add the result of the result type IN_TRIGGER for the calling number:

mml> numan-add:resulttable:custgrpid="1111",name="LNPtrigger1",resulttype="IN_TRIGGER", 
Dw1="24",dw2="4",dw3="0",dw4="6",setname="LNPtrigger_Calling"
 
   

Step 4 Add the entry in the B digit tree:

mml> numan-add:bdigtree:custgrpid="1111",callside="originating", 
digitstring="21468012",setname="LNPtrigger_Calling"
 
   

Step 5 Add the result set for setting the called number (B-number) as the global title:

mml> numan-add:resultset:custgrpid="1111",name="LNPtrigger_Called"
 
   

Step 6 Add the result of the result type IN_SERVICE_KEY:

mml> numan-add:resulttable:custgrpid="1111",name="GTLNP2",resulttype="IN_SERVICE_KEY", 
dw1="90001",dw2="CALLED",setname="LNPtrigger_Called"
 
   

Step 7 Add the result of the result type IN_TRIGGER for the called number:

mml> numan-add:resulttable:custgrpid="1111",name="LNPtrigger2",resulttype="IN_TRIGGER", 
Dw1="24",dw2="4",dw3="0",dw4="6",setname="LNPtrigger_Called"
 
   

Step 8 Add the entry in the B digit tree:

mml> numan-add:bdigtree:custgrpid="1111",callside="originating",digitstring="21468013", 
setname="LNPtrigger_Called"
 
   

Step 9 Add the digit modification string in the dial plan:

mml> numan-add:digmodstring:custgripid="1111",name="gtfixdigits",digstring="99903651"
 
   

Step 10 Add the result set for setting the fixed digits as the global title:

mml> numan-add:resultset:custgrpid="1111",name="LNPtrigger_Fixed"
 
   

Step 11 Add the result of the result type IN_SERVICE_KEY:

mml> numan-add:resulttable:custgrpid="1111",name="GTLNP3",resulttype="IN_SERVICE_KEY", 
dw1="90001",dw2="FIX",dw3="gtfixdigits",setname="LNPtrigger_Fixed"
 
   

Step 12 Add the result of the result type IN_TRIGGER for the fixed digits:

mml> numan-add:resulttable:custgrpid="1111",name="LNPtrigger3",resulttype="IN_TRIGGER", 
Dw1="24",dw2="4",dw3="0",dw4="6",setname="LNPtrigger_Fixed"
 
   

Step 13 Add the entry in the B digit tree:

mml> numan-add:bdigtree:custgrpid="1111",callside="originating",digitstring="21468014", 
setname="LNPtrigger_Fixed"
 
   

Provisioning Domain Based Routing

Domain based routing (DBR) enhances the analysis and routing functions to allow the Cisco PGW 2200 Softswitch to route calls based on user and domain names. These changes allow the Cisco PGW 2200 Softswitch to simultaneously route calls using E.164 numbers, domain names, user names, or a combination of E.164 and non-E.164 data.

DBR also introduces domain-based call screening functions and translation tables to map E.164 numbers to domain and user names.

Here is a typical provisioning procedure for DBR.

In this example, two domain routing policy (DRP) table steps and all of the result types introduced in the DBR feature are defined. For more information on these result types, see Chapter 1 "Dial Plan and Routing."

A Cisco PGW 2200 Softswitch with this configuration would process calls as follows:

In DRP step 1, the Cisco PGW 2200 Softswitch screens SIP calls based on the source domain example.com. When a match is found, the Cisco PGW 2200 Softswitch uses the IP_SET_SOURCE_DMN result type to change the source domain from example.com to abc.cisco.com. When DRP step 1 is complete, the Cisco PGW 2200 Softswitch proceeds to DRP step 2.

In DRP step 2, the Cisco PGW 2200 Softswitch translates the destination domain and port number from dbrpgw.cisco.com to atlanta.cisco.com:5079 and routes calls based on the destination URI bob@atlanta.cisco.com.


Step 1 Start a new MML session by using the following MML command:

mml> prov-sta::srcver="active",dstver="nested",confirm
 
   

Step 2 Add a new entry in the service table:

mml> numan-add:service:custgrpid="T002",name="group1" 
 
   

Step 3 Enable DBR on trunk group 2002:

mml> prov-ed:siprttrnkgrp:name="2002",domainbasedrtgsupport=1,url="bob@atlanta.cisco.com"
 
   

Step 4 Add an entry that associates the destination domain string, bob@atlanta.cisco.com, with the route list, rtlist002, in the route selection table:

mml> numan-add:routesel:custgrpid="T002",svcname="group1", 
destdmnstring="bob@atlanta.cisco.com",rtlistname="rtlist002" 
 
   

Step 5 Add an entry that associates the source domain string, example.com, to the source domain blacklist table:

mml> numan-add:sourceblack:custgrpid="T002",svcname="group1",srcdmnstring="example.com" 
 
   

Step 6 Add an entry that associates the destination domain name, dbrpgw.cisco.com, with the new domain name, atlanta.cisco.com:5079, to the destination username and domain translation table:

mml> numan-add:desttrans:custgrpid="T002",svcname="group1", 
destdmnstring="dbrpgw.cisco.com",domainname="atlanta.cisco.com:5079" 
 
   

Step 7 Add result sets:

mml> numan-add:resultset:custgrpid="T002", name="drpstep1" 
mml> numan-add:resultset:custgrpid="T002", name="drpstep2" 
mml> numan-add:resultset:custgrpid="T002", name="setSource" 
mml> numan-add:resultset:custgrpid="T002", name="exitdrp" 
mml> numan-add:resultset:custgrpid="T002", name="trans" 
mml> numan-add:resultset:custgrpid="T002", name="routeCall" 
 
   

Step 8 Add a domain string, abc.cisco.com, to the domain string table:

mml> numan-add:dmnmodstring:custgrpid="T002",name="domainname1",dmnstring="abc.cisco.com" 
 
   

Step 9 Add a result of the result type DRP_EXIT that the Cisco PGW 2200 Softswitch exits from the entire DRP stage of the preanalysis for DRP step 1:

mml> numan-add:resulttable:custgrpid="T002",name="resultexitdrp",resulttype="DRP_EXIT", 
dw1="2", setname="exitdrp"
 
   

Step 10 Add a result of the result type IP_SET_SOURCE_DMN that the Cisco PGW 2200 Softswitch changes the source domain to domainname1 (abc.cisco.com):

mml> numan-add:resulttable:custgrpid="T002", name="changesource", 
resulttype="IP_SET_SOURCE_DMN",dw1="domainname1",setname="setSource",dw2="0",dw3="1" 
 
   

Step 11 Add a result of the result type IP_SOURCE_SCREEN that if the source username matches an entry in the source domain blacklist table added Step 5, the Cisco PGW 2200 Softswitch uses the setSource result set which you added results in Step 10:

mml> numan-add:resulttable:custgrpid="T002",setname="drpstep1",name="screen", 
resulttype="IP_SOURCE_SCREEN",dw1="2",dw2="group1",dw3="setSource" 
 
   

Step 12 Add a result of the result type IP_ROUTE_SEL that if the destination user name and destination host name matches the entry added in Step 4, then uses the rtlist002 to route the call:

mml> numan-add:resulttable:custgrpid="T002", name="resultrsel1",resulttype="IP_ROUTE_SEL", 
dw1="1",dw2="group1",dw3="exitdrp",setname="routeCall" 
 
   

Step 13 Add a result of the result type IP_DEST_TRANS that if the destination host domain matches an entry in the destination user name and destination host table added in Step 6, the Cisco PGW 2200 Softswitch uses routeCall result set. Otherwise, the Cisco PGW 2200 Softswitch uses the exitdrp result set:

mml> numan-add:resulttable:custgrpid="T002", setname="drpstep2", name="trans", 
resulttype="IP_DEST_TRANS", dw1="2",dw2="group1", dw3="routeCall", dw4="exitdrp"
 
   

Step 14 Add the two result sets, drpstep1, and drpstep2 into the DRP table:

mml> numan-add:drptable:custgrpid="T002", drpstepnum="1", setname="drpstep1" 
mml> numan-add:drptable:custgrpid="T002", drpstepnum="2", setname="drpstep2"
 
   

Step 15 End the provisioning session:

mml> prov-dply
 
   

Provisioning Generic Call Tagging

The generic call tagging feature enables a service provider to configure the Cisco PGW 2200 Softswitch to perform additional routing operations beyond the pre-existing manner of route selection. If you apply a generic call tag in Pre-analysis, A-number analysis, or B-number analysis, the Cisco PGW 2200 Softswitch can perform another level of route selection defined by the tag, which extends the route selection algorithms for certain calls. The Generic Call Tagging feature enables you to refine route selection.

Here is a typical provisioning procedure of the generic call tagging feature. In this example, you can find both two types of tag lists, tag lists for a trunk group, and tag lists for dial plans.


Step 1 Start a new MML session by using the following MML command:

mml> prov-sta::srcver="active",dstver="nested",confirm
 
   

Step 2 Add a tag list that can be associated with a trunk group (type = 0):

mml> numan-add:taglist:name="trunkgrptaglist",type="0"
 
   

Step 3 Add a tag, climust, with value true to the tag list, trunkgrptaglist:

mml> numan-add:tag:name="climust",value="true",taglist="trunkgrptaglist"
 
   

Step 4 Add a tag, codec, with value G721 to the tag list, trunkgrptaglist:

mml> numan-add:tag:name="codec",value="G721",taglist="trunkgrptaglist"
 
   

Step 5 Add a tag list that can be assocaited added in a dial plan (type = 1):

mml> numan-add:taglist:name="sipcalltaglist",type="1"
 
   

Step 6 Add a tag, codec, with value G711 to the tag list, sipcalltaglist:

mml> numan-add:tag:name="codec",value="G711",taglist="sipcalltaglist"
 
   

Step 7 Add a tag, routingclass, with value primum to the tag list, sipcalltaglist:

mml> numan-ed:tag:name="routingclass", value="primum", taglist="sipcalltaglist"
 
   

Step 8 Add a result set, gencalltag, in the dial plan:

mml> numan-add:resultset:custgrpid="1111",name="gencalltag"
 
   

Step 9 Add a result of the CALL_TAG result type in the dial plan:

mml> numan-add:resulttable:name="tag_result",resulttype="CALL_TAG",custgrpid="1111", 
setname="gencalltag",dw1="sipcalltaglist"
 
   

Step 10 Associate an SS7 trunk group with the tag list, taglist1:

mml> prov-add:trnkgrpprop:name="444",calltaglist="trunkgrptaglist"
 
   

Step 11 Associate a SIP trunk group with the tag list, sipcall:

mml> prov-add:profile:name="sip-prof1",type="SIPPROFILE",custgrpid="1111", 
mgcdomain="10.0.57.158", calltaglist="trunkgrptaglist"
 
   
mml> prov-add:trnkgrpprof:name="100",profile="sip-prof1"
 
   

Step 12 End the provisioning session:

mml> prov-dply
 
   


Note While managing the Generic Call Tagging feature, if you must delete the tagvalue.dat and taglist.dat files, you must delete the tagvalue.dat file before the taglist.dat file.

Provisioning Conditional A-Number Digit Modification

Perform the following procedures to create a dial plan for the Conditional A-Number Digit Modification feature:

Adding Digit Modification String Data

Adding A-Number Modification Result Table Data

Adding A-Number Digit Tree Data

Enabling A-Number Normalization

Adding Digit Modification String Data

The results access the Digit Modification to yield a string of numbers (digits) to apply to an A-number or B-number. To add a DIGMODSTRING list and add digit strings, complete the following steps:


Step 1 Enter the following command on the active Cisco MGC at the Man-Machine Language (MML) prompt:

mml> numan-add:digmodstring:custgrpid="cgid", name="dname", digstring="dstring"
 
   

Where:

cgid—Indicates the customer group ID. This ID is a 4-digit alphanumeric string.

dname—MML name of the digit modification string.

dstring—String of digits to modify.


Note Over-decadic digits can be used in your prefix. You must ensure that only over-decadic digits B and C are used in your prefix if the call data is routed through a H.323 network. B and C are the only over-decadic digits that are supported in H.323. If you use any of the other over-decadic digits in your prefix, once the call data enters a H.323 network through the Cisco H.323 Signaling Interface (HSI) the A-number will be forwarded without those over-decadic digits.

For example, to add a digit modification string, 666, called restpfx, enter the following MML command:

mml> numan-add:digmodstring:custgrpid="T002",name="restpfx",digstring="666"
 
   

Step 2 To verify that the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Step 3 Repeat steps 1 and 2 for each entry you add to the digit modification string list.



Tip An implied index, which contains a single string of digits that are applied to the calling number or called number, is used to access the DIGMODSTRING list.

Adding A-Number Modification Result Table Data

Results are used with number analysis. To add an A-number modification result table to the dial plan, complete the following steps:


Step 1 Enter the following command on the active Cisco MGC at the MML prompt:

mml> numan-add:resulttable:custgrpid="cgid", name="resnam", resulttype="AMODDIG", 
dw1="dw1", dw2="0", dw3="dw3", dw4="1", setname="snam"
 
   

Where:

cgid—Indicates the customer group ID. This ID is a 4-digit alphanumeric string.

resnam—MML name of the result table.

dw1 (dataword1)—Provides an index into the Script table in the MGC database, where the details of the Script table, such as the gateway type, language, location, and so on, are stored. This value is an integer.


Note When adding an index in the Script table, be sure that the value you enter is a valid value in the Script table.

Caution Dataword 2 (dw2) cannot be used to subtract digits when you are using dataword 4 (dw4) to add A-number modification result data.

dw3 (dataword3)—Indicates if an optional Address Complete Message (ACM) is to be sent when the confirmation of script invocation is received (for dw2, CallType = 1) from the gateway. This is an integer.

sname—Indicates the MML result set name for this AMODDIG result type. The user configures the set name, which can be as many as 20 alphanumeric characters.

For example, to add an A-digit tree to the customer group ID t100, enter the following MML command:

mml> numan-add:resulttable:custgrpid="T002", name="result5", resulttype="AMODDIG", 
dw1="1", dw2="0", dw3="restpfx", dw4="1", setname="setname1"
 
   

Step 2 To verify that the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Step 3 Repeat steps 1 and 2 for each A-number modification result table you want to add.


Adding A-Number Digit Tree Data

The A-Digit Tree contains entries, in blocks of 16, for each calling number. Its output is an index to the Result table or an indication that no further action is necessary. To add an A-Digit Tree to your dial plan, complete the following steps:


Step 1 Enter the following command on the active Cisco MGC at the MML prompt:

mml> numan-add:adigittree:custgrpid="cgid", digitstring="dstring", callside="cs", 
setname="snam"
 
   

Where:

cgid—Indicates the customer group ID. This ID is a 4-digit alphanumeric string.

dstring—Defines the digit string.

cs—Indicates the side of the call, either originating or terminating.

sname—Indicates the MML result set name for this A-number digit tree. The user configures the set name, which can be as many as 20 alphanumeric characters.

For example, to add an A-digit tree to the customer group ID t100, enter the following MML command:

mml> numan-add:adigittree:custgrpid="t100",digitstring="703484",callside="originating", 
setname="setone"
 
   

Step 2 To verify that the command was executed successfully, enter the command:

mml> numan-rtrv
 
   

Step 3 Repeat steps 1 and 2 for each entry you add to the A-digit tree.


Enabling A-Number Normalization

Enabling A-number normalization results in the removal of leading zeros from National (0) or International (00) European prefixes. This feature adds the ability to remove the leading zero from a UK-specific International format CLI (and the corresponding NOA change to International). In addition, this functionality can now be applied to both trunk groups and signaling services.

To enable A-number normalization for the trunk group or signaling service that is associated with your dial plan, complete the following steps:


Step 1 Enter the following command on the active Cisco MGC at the MML prompt:

mml> prov-add:property:name="comp_name",anumnormalise=1
 
   

Where:

property—MML component type for trunk group or signaling service properties. Select one of the following:

trnkgrpprop—MML component for trunk group properties.

sigsrvprop—MML component for signaling service properties.

comp_name—MML name for the trunk group or signaling service on which you want to enable A-number normalization.

For example, to enable A-number normalization on a signaling service that is called va-5300-a, enter the following MML command:

mml> prov-add:sigsvcprop:name="va-5300-a:,anumnormalise=1
 
   

Step 2 To verify that the command was executed successfully, enter the command:

mml> prov-rtrv
 
   

Step 3 Repeat steps 1 and 2 for each trunk group or signaling service on which you want to enable A-number normalization.


Provisioning E911 Mapping

This section describes the provisioning tasks that you must perform to implement E911 mapping.

Provision the MGCP 1.0 on the PGW 2200 by setting the E911PROF result type dataword1 to a value from 1 through 35.

Use the MML provisioning command numan-add to define the E911PROF result type in a result table.

 
   
numan-<verb>:resulttable:custgrpid="<customer group id>",name="<result name>", 
resulttype="E911PROF",setname="<resultsetname>" 

Adding an E911PROF Result Type

To add an E911PROF result type to your provisioning data, perform the following steps:


Step 1 Start an MML provisioning session.

Step 2 Enter the following command to add the E911PROF result type:

mmlnuman-add:resulttable:custgrpid="T002",name="routetoSR",resulttype="E911PROF",dw1="1"
,setname="selectiverouter1" 
 
   

Where:

custgrpid—The name of a previously defined customer group ID. A string of four alphanumeric characters that uniquely defines the customer. The customer group ID should begin with a letter.

name—The name you want to give to the component. The name can be as many as 20 characters long and can contain numbers, letters, and the dash (-) symbol. The name should begin with a letter.

resulttype—The result type name.

dw1—The value of the IAM profile mapping. Valid profile values can be found in Table 1-4.

Step 3 Repeat Step 2 for each E911PROF result type you want to add to your provisioning data.

Step 4 If there are no other components that you need to provision, end your provisioning session.


Collecting E911PROF Data

The E911PROF result type represents the types of SR with which the MGC communicates. You must know the following about the SR:

ESRK delivery (See Table 4-9)

CPN and ESRD delivery (See Table 4-10)

Mapping Methods

Since the MGC does not support CAMA signaling natively, an IOS gateway provides the CAMA interface. Thus, after analyzing the ESRN number, MGC proxies the INVITE message from the SIP call server to the IOS gateway. The IOS gateway then routes the call to SR using CAMA signaling.

Depending on the version of SR and PSAP, the location key (ESQK) is delivered in a different parameter of the Initial Address Message (IAM). The MGC implements the following mapping methods:

Mapping method 1, ESRK, which is equivalent to ESQK in a Voice over IP (VoIP) network

Mapping method 2, ESRD, which is equivalent to ESQK in a VoIP network

The various IAM profiles are listed in Table 4-9 for ESRK delivery and in Table 4-10 for ESRD delivery.

Mapping Method 1: ESRK Delivery

Originally based on ESRK, Table 4-9 shows the possible alternatives for populating the parameters in the IAM. Mapping method 1 describes the mode where a Mobile Switching Center (MSC) uses the ISUP protocol to send an ESRK to an E9-1-1 SR.

Table 4-9 ESRK Delivery 

ISUP Parameter Option
OLI Wireless
CpCAT Emergency
CDPN
CPN
CHGN
GDP
Note(s)

A1

No

Yes

911

ESRK

ESRK

Blank

1, 2

A2

No

Yes

911

ESRK

Blank

1, 2

A3

No

Yes

911

ESRK

Blank

1, 2

B1

No

No

911

ESRK

ESRK

Blank

1, 2

B2

No

No

911

ESRK

Blank

1, 2

B3

No

No

911

ESRK

Blank

1, 2

Note

1. This ISUP parameter option is widely supported in North America. It is estimated that 95% of the E9-1-1 SRs deployed in North America support this option when the SR has been equipped with wireless E9-1-1 features.

2. Blank—This parameter must not be populated.


Mapping Method 2: CBN and ESRD Delivery

Mapping method 2 describes the mode where an MSC uses the ISUP protocol to send the caller's CBN and ESRD to an E9-1-1 SR. Table 4-10 shows the possible alternatives for populating the parameters in the IAM.

Table 4-10 CBN and ESRD Delivery 

ISUP Parameter Option
OLI Wireless
CpCAT Emergency
CDPN
CPN
CHGN
GDP
Note(s)

A1

Yes

Yes

911

CBN

CBN

ESRD1

1

A2

Yes

Yes

911

CBN

ESRD

1

A3

Yes

Yes

911

CBN

ESRD

1

B1

Yes

No

911

CBN

CBN

ESRD

3

B2

Yes

No

911

CBN

ESRD

3

B3

Yes

No

911

CBN

ESRD

3

C1

No

Yes

911

CBN

CBN

ESRD

3

C2

No

Yes

911

CBN

ESRD

3

C3

No

Yes

911

CBN

ESRD

3

D1

No

No

911

CBN

CBN

ESRD

3

D2

No

No

911

CBN

ESRD

3

D3

No

No

911

CBN

ESRD

3

E1

Yes

Yes

ESRD

CBN

CBN

Blank

1, 2

E2

Yes

Yes

ESRD

CBN

Blank

1, 2

F1

Yes

No

ESRD

CBN

CBN

Blank

2, 3

F2

Yes

No

ESRD

CBN

Blank

2, 3

G1

No

Yes

ESRD

CBN

CBN

Blank

2, 3

G2

No

Yes

ESRD

CBN

Blank

2, 3

H1

No

No

ESRD

CBN

CBN

Blank

2, 3

H2

No

No

ESRD

CBN

Blank

2, 3

I1

Yes

Yes

ESRD

CBN

CBN

ESRD

1

I2

Yes

Yes

ESRD

CBN

ESRD

1

I3

Yes

Yes

ESRD

CBN

ESRD

3

J1

Yes

No

ESRD

CBN

CBN

ESRD

3

J2

Yes

No

ESRD

CBN

ESRD

3

K1

No

Yes

ESRD

CBN

CBN

ESRD

3

K2

No

Yes

ESRD

CBN

ESRD

3

L1

No

No

ESRD

CBN

CBN

ESRD

3

L2

No

No

ESRD

CBN

ESRD

3

Note

1. This ISUP parameter option is widely supported in North America. It is estimated that 95% of the E9-1-1 SRs deployed in North America support this option when the SR has been equipped with wireless E9-1- 1 features.

2. Blank—This parameter must not be populated.

3. This ISUP parameter option is available in some areas. It is estimated that 50% of the E9-1-1 SRs deployed in North America support this option when the SR has been equipped with wireless E9-1-1 features.

1 ESRD, in a mobile network, is equivalent to ESQK. in a VoIP network.