CH A P T E R
4
Provisioning Dial Plans with MML
Revised: January 20, 2011, OL-1141-21
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, page 4-6
•
Adding Dial Plan Components, page 4-13
•
Provisioning Overdecadic Status, page 4-28
•
Provisioning Advice of Charge, page 4-28
•
Provisioning Percentage Based Routing, page 4-38
•
Provisioning Conditional Routing, page 4-40
•
Provisioning Calling Party Category, page 4-42
•
Provisioning Bearer Capability Based Routing, page 4-44
•
Provisioning the Announcement, page 4-44
•
Provisioning an ATM Profile, page 4-45
•
Provisioning Tech Prefix Capabilities, page 4-46
•
Provisioning Advanced Screening Capabilities, page 4-46
•
Provisioning Results of Various Result Types, page 4-49
•
Provisioning Examples for Various Result Types, page 4-52
•
Importing Dial Plan Information, page 4-53
•
Provisioning Call Limiting, page 4-56
•
Scaling Dial Plan Elements, page 4-58
•
Provisioning Call Reporting, page 4-59
•
Provisioning Calling Name Delivery, page 4-59
•
Provisioning Full Number Translations, page 4-60
•
Provisioning Global Titles, page 4-63
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-1
Chapter 4
Provisioning Dial Plans with MML
Dial Plan Parameters
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
DIALPLAN
Description
Selects the customer-created dial plan.
OVERDEC
ADIGTREE
Indicates the overdecadic status only when adding a dial
plan.
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-2
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Dial Plan Parameters
Table 4-1
Dial Plan Parameter Descriptions (continued)
MML
Component Name
MML
Parameter Names
BDIGTREE
Description
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-3
Chapter 4
Provisioning Dial Plans with MML
Dial Plan Parameters
Table 4-1
Dial Plan Parameter Descriptions (continued)
MML
Component Name
MML
Parameter Names
CAUSE
Description
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
RESULTSET
MML name of the service.
Selects the result set in the Result Set table.
NAME
AWHITE
MML name of the result set.
Selects the A-digit tree white list.
CLI
ABLACK
Sets calling line identity (CLI) for A-digit tree white list.
Selects the A-digit tree black list.
CLI
BWHITE
Sets the CLI for the A-digit tree black list.
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-4
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Dial Plan Parameters
Table 4-1
Dial Plan Parameter Descriptions (continued)
MML
Component Name
MML
Parameter Names
DEFRESULTSET
Description
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
ANUMDPSEL
The new dial plan ID.
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-5
Chapter 4
Provisioning Dial Plans with MML
Adding a Dial Plan
•
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-6
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding a Dial Plan
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-7
Chapter 4
Provisioning Dial Plans with MML
Adding a Dial Plan
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. The parital parameter controls whether you
delete all of the numbers starting with a digit string, or you delete only the specified number from the
digit tree.
Here is an example command for deleting all of the numbers starting with a digit string:
numan-dlt:bdigtree:custgrpid="t001",callside="originating",digitstring="starting digits", partial="NO"
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",
partial="NO"
This MML command deletes all of the numbers starting with the 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
Step 2
For the numan-dlt:adigtree and the numan-dlt:bdigtree commands, use the partial parameter
carefully. Using this MML command with the partial parameter value set to “YES” deletes only
the specified number from the digit tree. Using this MML command with the partial parameter
value set to “NO” deletes all of the numbers starting with a specified digit string from a digit
tree. The partial parameter is mandatory in the numan-dlt:adigtree, and the numan-dlt:bdigtree
commands.
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-8
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding a 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
The following MML command deletes all B-digit tree entries that begin with a 4.
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"
;
Note
If you issue the numan-dlt:adigtree and the numan-dlt:bdigtree commands, use the partial parameter
carefully. Since Release 9.7(3) S30P30, the partial parameter is mandatory. You must specify the value
YES or NO explicitly. If you do not specify the partial parameter, the command returns the following
error message:
MGC-01 - Media Gateway Controller 2010-01-11 05:58:40.570 EST
M
DENY
SROF
"bdigtree: Partial value must be YES or NO. It is a mandatory Param."
/* Status, Requested Operation Failed on the component */
Deleting the B-digit Tree with 4 and Not Deleting 444 and 445
The following MML command deletes 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
The following MML command deletes all B-digit tree entries that contain 44.
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"
;
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-9
Chapter 4
Provisioning Dial Plans with MML
Adding a Dial Plan
Deleting Only the 444 B-digit Tree
The following MML command deletes only the specified B-digit tree entry.
mml>
numan-dlt:bdigtree:custgrpid="dp1",callside="originating",digitstring="444",partial=”yes”
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="T003"
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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-10
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding a Dial Plan
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 theCisco PGW 2200 Softswitch 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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-11
Chapter 4
Provisioning Dial Plans with MML
Migrating Dial Plans Dealing with SCREENING Entries
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
Cisco PGW 2200 Softswitch 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 PGW 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
Step 3
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.
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”
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-12
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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
Caution
Make a test call from a test phone with the CLI listed in GLBL.bwhite.
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 PGW 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 on page 1-62. 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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-13
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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
Tip
Repeat steps 1 and 2 for each digit string you want to add to the DIGMODSTRING list.
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
Step 2
Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service
names.
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
Tip
Repeat steps 1 and 2 for each service name you want to add to the service list.
The service list acts with the results to provide service names.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-14
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-15
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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 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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-16
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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 (NPI)
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 Cisco PGW 2200 Softswitch 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-2) 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”
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-17
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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 the NPI value and the parameters you added is now present. As shown in Example 4-1 on
page 4-18.
Example 4-1
Numbering Plan Indicator Example
Table 4-2
Block Value
Result Set Name
0
1
set1
2
set2
3
set3
4
set4
5
set5
6
set6
7
set7
8
9
set8
1
set9
10
11
12
13
14
15
1. There are currently no incoming NPI values
above 9. See Appendix A, “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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-18
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
Note
In Cisco PGW 2200 Softswitch 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, as shown
in Example 4-2.
Example 4-2
Nature of Address Example
Table 4-3
NOA Value
NPI Block
1
set1
2
set2
3
1
4
set3
5
2
6
3
7
Step 3
Result Set Name
set4
8
4
…
…
…
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-19
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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 on page 1-67.
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
Step 2
The blockvalue in numan-add:location should be one less than the intended internal value.
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
Tip
Repeat steps 1 and 2 for each LOCATION entry you want to add to the dial plan.
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 on page 4-20 for information on adding locations.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-20
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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.
Note
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
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-21
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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.
•
Note
•
ServiceName is a string field that designates a valid service name.
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>
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-22
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-23
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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
Step 2
Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service
names.
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
Step 2
Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service
names.
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-24
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-25
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-26
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Adding Dial Plan Components
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-27
Chapter 4
Provisioning Dial Plans with MML
Provisioning Overdecadic Status
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, page 4-29
•
Provisioning the Charge List, page 4-31
•
Provisioning the Tariff List, page 4-33
•
Provisioning Charge Origin, page 4-35
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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-28
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Advice of Charge
•
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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-29
Chapter 4
Provisioning Dial Plans with MML
Provisioning Advice of Charge
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-30
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Advice of Charge
Charge Holiday Provisioning Examples
mml>
mml>
mml>
mml>
mml>
prov-add:holiday:date="2001.02.10",hday="hol1"
prov-ed:holiday:date="2001.02.10",hday="hol2"
prov-dlt:holiday:date="2001.02.10"
prov-rtrv:holiday:date="2001.02.10"
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.
Step 2
•
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.
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-31
Chapter 4
Provisioning Dial Plans with MML
Provisioning Advice of Charge
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-32
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Advice of Charge
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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-33
Chapter 4
Provisioning Dial Plans with MML
Provisioning Advice of Charge
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-34
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Advice of Charge
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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-35
Chapter 4
Provisioning Dial Plans with MML
Provisioning Advice of Charge
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
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-36
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Combined Charge and Meter Pulse Messaging Provisioning
mml> numan-dlt:achgorigin:custgrpid="t001",cli="02087568000"
mml> numan-rtrv:achgorigin:custgrpid="t001",cli="02087568000"
mml> numan-rtrv:achgorigin:"all"
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>
mml>
mml>
mml>
mml>
mml>
PROV-ADD:CHARGE:CHORIG=1,CHDEST=1,TARIFFDESC=”3 0700 4 1800 3”
PROV-ADD:CHARGE:CHORIG=1,CHDEST=1,DOW=SATURDAY,TARIFFDESC=”3”
PROV-ADD:CHARGE:CHORIG=1,CHDEST=1,DOW=SUNDAY,TARIFFDESC=”3”
PROV-ADD:CHARGE:CHORIG=1,CHDEST=1,DOW=HOL1,TARIFFDESC=”1”
PROV-ADD:CHARGE:CHORIG=1,CHDEST=1,DOW=HOL2,TARIFFDESC=”2”
PROV-ADD:CHARGE:CHDEST=1,TARIFFDESC=”4”
In this example:
Step 4
•
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
(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
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-37
Chapter 4
Provisioning Dial Plans with MML
Provisioning Percentage Based Routing
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”
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-38
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Percentage Based Routing
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"
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-39
Chapter 4
Provisioning Dial Plans with MML
Provisioning Conditional Routing
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-40
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Conditional Routing
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-41
Chapter 4
Provisioning Dial Plans with MML
Provisioning Calling Party Category
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>
mml>
mml>
mml>
mml>
numan-add:rteholiday:date="2001.02.10",hday="hol1"
numan-ed:rteholiday:date="2001.02.10",hday="hol2"
numan-dlt:rteholiday:date="2001.02.10"
numan-rtrv:rteholiday:date="2001.02.10"
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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-42
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Calling Party Category
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
'00000011'B
'00100001'B
'00100001'B
'00100011'B
------
Octet
Octet
Octet
Octet
Octet
31
32
33
34
35
Transit Network Selection
len
National, 3-digit ID
Digits 12
Int Call op req, Digit 3
H'23
H'03
H'21
H'21
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
'00000011'B
'00100011'B
'00110011'B
'00110011'B
'00000000'B
-------
Octet
Octet
Octet
Octet
Octet
Octet
39
40
41
42
43
24
Transit Network Selection
len
National, X.121, even
Digits 33
Digits 33
End of Optional parameters
H'23
H'03
H'23
H'33
H'33
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"
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-43
Chapter 4
Provisioning Dial Plans with MML
Provisioning Bearer Capability Based Routing
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"
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-44
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning an ATM Profile
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:
#name
atmprof1
01
ATMProfiles
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
# result1
result59
59
1
dw2
dw3
dw4
nextResult
1
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-45
Chapter 4
Provisioning Dial Plans with MML
Provisioning Tech Prefix Capabilities
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
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-46
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Advanced Screening Capabilities
•
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”
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-47
Chapter 4
Provisioning Dial Plans with MML
Provisioning Advanced Screening Capabilities
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>
mml>
mml>
mml>
Step 2
numan-add:dialplan:custgrpid=“Cus1”
numan-add:dialplan:custgrpid=“csco”
numan-add:dialplan:custgrpid=“Cus2”
numan-add:dialplan:custgrpid=“Cus3”
Use the following MML commands to add CLI prefixes to the customer groups.
mml>
mml>
mml>
mml>
numan-add:cliprefix:clisetname=“x”,cliprefix=“408”,custgrpid=“Cus1”
numan-add:cliprefix:clisetname="x",cliprefix="1408260",custgrpid="csco"
numan-add:cliprefix:clisetname="x",cliprefix="140826033",custgrpid="Cus2"
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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-48
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Results of Various Result Types
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-3 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 on page 1-11.
In Example 4-3, 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).
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-49
Chapter 4
Provisioning Dial Plans with MML
Provisioning Results of Various Result Types
Note that two result types (A_NUMBER_TYPE and BLACKLIST) have been connected in Example 4-3
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-3
Result Set Example
Result Set
Result Name
Result Type
Dataword1
Dataword2
set1
result1
SCREENING
1
1
set2
result1
ANNOUNCEMENT
100
Washington
set3
result1
IN_TRIGGER
1
1
set4
result1
A_NUMBER_TYPE
5
set4
result2
BLACKLIST
1
set5
result1
BMODDIG
0
set5
result2
CC_DIG
ccspain
set6
result1
B_NUMBER_TYPE
3
set7
result1
INC_NUMBERING
0
set8
result1
E_PORTED_NUM
set9
result1
E_PORTED_NUM
1
set9
result2
E_ROUTE_NUM
4
set10
result1
COND_ROUTE
condname1
Dataword3
Dataword4
Next Result
relist1
result2
1
digmod1
4
4
result2
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"
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-50
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Results of Various Result Types
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-51
Chapter 4
Provisioning Dial Plans with MML
Provisioning Examples for Various Result Types
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
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"
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-52
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Importing Dial Plan Information
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”
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-53
Chapter 4
Provisioning Dial Plans with MML
Importing Dial Plan Information
Determining Which IP Address to Use for Dial Plan Selection
Configuring the Cisco PGW 2200 Softswitch 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 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”
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-54
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Importing Dial Plan Information
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
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-55
Chapter 4
Provisioning Dial Plans with MML
Provisioning Call Limiting
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="loc
ation1",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="s
etloc1"
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-56
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Call Limiting
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="lo
cation1",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="s
etloc2"
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_calli
m",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="s
etloc3"
B Digit Tree
numan-add:bdigtree:custgrpid="5555",callside="originating",digitstring="307",setname="s
etloc3"
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-57
Chapter 4
Provisioning Dial Plans with MML
Scaling Dial Plan Elements
Dial Plan Examples
This section provides the following MML command examples of dial plan provisioning for this feature.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;
; 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-4 lists software Release 9 dial plan information maximums that can be supported for the dial
plan elements.
Table 4-4
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 Limits the number of route
descriptions
changes to 5
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-58
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Call Reporting
Table 4-4
Dial Plan Maximums (continued)
Dial Plan Element
Maximum Limit
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
Cisco PGW 2200 Softswitch
Release 9.3(2) and earlier), or
2147483647 dial plans (in
Cisco PGW 2200 Softswitch
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-59
Chapter 4
Provisioning Dial Plans with MML
Provisioning Full Number Translations
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 on page 1-40, we recommend that you configure the
*.FNTBehaviourOptions parameter to 1 in the XECfgParm.dat file.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-60
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Full Number Translations
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"
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-61
Chapter 4
Provisioning Dial Plans with MML
Provisioning Full Number Translations
Figure 4-1 describes 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
Incomming call
DP00
Pre/A number analysis
B number analysis
setname3
NUM_TRANS
1
NUM_TRANS for A number is successful.
A number: C2088880000-->123456
Dial plan: DP00-->DP01
A_NUMBER_TYPE
B NUMBER_TYPE
R_NUMBER_TYPE
A_NUMBER_TYPE,
B_NUMBER_TYPE, and
R_NUMBER_TYPE
results are dropped.
DP01
Pre/A number analysis
B number analysis
setname31
NUM_TRANS
NUM_TRANS for A number is failed.
B number 998101234567-->8101234567
AMODDIG
A number 123456-->456
RMODDIG
R number 22110000-->10000
Trunkgroup
206614
BMODDIG
ROUTE
1.
2
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.
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-62
OL-1141-21
Chapter 4
Provisioning Dial Plans with MML
Provisioning Global Titles
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:
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
OL-1141-21
4-63
Chapter 4
Provisioning Dial Plans with MML
Provisioning Global Titles
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"
Cisco PGW 2200 Softswitch Release 9 Dial Plan Guide (through Release 9.7)
4-64
OL-1141-21