Provisioning Dial Plans with MML

Transcription

1 CHAPTER 4 Revised: January 20, 2011, 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

2 Dial Plan Parameters Chapter 4 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 DIALPLAN ADIGTREE MML Parameter Names OVERDEC SETNAME DIGITTOPRESENT CALLSIDE DIGITSTRING Description Selects the customer-created dial plan. Indicates the overdecadic status only when adding a dial plan. Selects the A-digit tree table. MML name of the result set. Indicates the number of digits to skip (forward or backward) during analysis, if not set to 0. Indicates if the call side is originating or terminating. All the digits in a calling number or called number. Cannot use with NEXTNODE, DIGIT, or INDEX. 4-2

3 Chapter 4 Dial Plan Parameters Table 4-1 Dial Plan Parameter Descriptions (continued) MML Component Name BDIGTREE RESULTTABLE DIGMODSTRING ANOA ANPI BNOA BNPI MML Parameter Names SETNAME DIGITTOPRESENT CALLSIDE DIGITSTRING NAME RESULTTYPE DW1 DW2 DW3 DW4 NEXTRESULT SETNAME NAME DIGSTRING NOAVALUE NPIBLOCK SETNAME NPIBLOCK BLOCKVALUE SETNAME NOAVALUE NPIBLOCK SETNAME NPIBLOCK BLOCKVALUE SETNAME Description Selects the B-digit tree table. MML name of the result set. Indicates the number of digits to skip (forward or backward) during analysis, if not set to 0. Indicates if the call side is originating or terminating. All the digits in a calling number or called number. Cannot use with NEXTNODE, DIGIT, or INDEX. Selects the Result table. MML name of the result. Indicates the type of result. First data word. Second data word. Third data word. Fourth data word. Next result name. MML name of the result set. Selects Digit String Modification table. MML name of the digit modification string. The digit string. Selects calling number Nature of Address (NOA) table. The NOA value. The NPI block value. MML name of the result set. Selects calling number Numbering Plan Indicator (NPI) table. The NPI block. The NPI block value. MML name of the result set. Selects called number NOA table. The NOA value. The NPI block value. MML name of the result set. Selects called number NPI table. The NPI block. The NPI block value. MML name of the result set. 4-3

4 Dial Plan Parameters Chapter 4 Table 4-1 Dial Plan Parameter Descriptions (continued) MML Component Name CAUSE LOCATION SERVICE RESULTSET AWHITE ABLACK BWHITE BBLACK PORTTBL TERMTBL ACHORIGIN MML Parameter Names CAUSEVALUE LOCATIONBLOCK SETNAME LOCATIONBLOCK SETNAME BLOCKVALUE NAME NAME CLI CLI CLI SVCNAME CLI SVCNAME DIGITSTRING ROUTENUMBER DIGITSTRING ROUTELISTNAME CUSTGRPID CLI CORIGIN Description Selects the Cause table. The cause value. The cause location block. MML name of the result set. Selects the Location table. The location block. MML name of the result set. The location block value. Selects the Service table. MML name of the service. Selects the result set in the Result Set table. MML name of the result set. Selects the A-digit tree white list. Sets calling line identity (CLI) for A-digit tree white list. Selects the A-digit tree black list. Sets the CLI for the A-digit tree black list. Selects the B-digit tree white list. Sets the CLI for the B-digit tree white list. MML name of the previously defined service. Selects the B-digit tree black list. Sets the CLI for B-digit tree black list. MML name of the previously defined service. Selects the Ported Number table. The called number. The routing number. Selects the Number Termination table. The called number. The route list name. Selects the A-number charge origin. The customer group ID. Sets calling line identity (CLI) for A-digit tree white list. The call origin. 4-4

5 Chapter 4 Dial Plan Parameters Table 4-1 Dial Plan Parameter Descriptions (continued) MML Component Name DEFRESULTSET DPSEL ANUMDPSEL RTEHOLIDAY CPC TMR TNS CLIPREFIX CLIIPADDRESS H323IDDIVFROM MML Parameter Names RESULTTYPE DW1 DW2 DW3 DW4 NEWDP CLI DATE HDAY CPCVALUE SETNAME TMRVALUE SETNAME TNSVALUE SETNAME CLISETNAME CLIPREFIX CUSTGRPID CUSTGRPID IPADDR SUBNETMASK CLISETNAME CUSTGRPID H323IDDIVFROM CLISETNAME Description Selects the default result set. Indicates the type of result. First data word. Second data word. Third data word. Fourth data word. Selects the dial plan. The new dial plan ID. Selects the A-number dial plan. The calling party number. Selects the route holiday. The holiday date. The holiday day. Selects the calling party category. The CPC value. MML name of the result set. Selects the transmission medium requirement. The TMR value. MML name of the result set. Selects the transit network selection. The TNS value. MML name of the result set. Selects the CLI prefix. The CLI prefix set name. The CLI prefix. The Customer group ID. Selects the CLIP address. The Customer group ID. The IP Address. The Subnet mask. The CLI prefix set name. Selects the H323 ID, Division header, or From field. The Customer group ID. H323 ID, Division header, or From field. The CLI prefix set name. 4-5

6 Adding a Dial Plan Chapter 4 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. 4-6

7 Chapter 4 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: mml> numan-add:dialplan:custgrpid="t100" This command adds the dial plan component and the required custgrpid parameter. mml> numan-rtrv Verify the dial plan you added is present. 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: 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. mml> numan-rtrv Verify the route component you added to the dial plan is present. 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. 4-7

8 Adding a Dial Plan Chapter 4 For example, to delete a resultset component from a dial plan, complete the following steps: 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 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. mml> numan-rtrv Verify the resultset component you deleted is no longer present. Repeat and 2 for each resultset component you want to delete from the dial plan. 4-8

9 Chapter 4 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 :49: 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 :58: 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 :34: 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 :49: EST M COMPLD "bdigtree:warning: All partial matching digit tree are removed" ; 4-9

10 Adding a Dial Plan Chapter 4 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 :34: 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. mml> numan-dlt:dialplan:custgrpid="t001" 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: 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. 4-10

11 Chapter 4 Adding a Dial Plan mml> numan-rtrv Verify the setname component you changed now reads settwo as changed. 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. 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. Continue to provision the dial plan. 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: 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. 4-11

12 Migrating Dial Plans Dealing with SCREENING Entries Chapter 4 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. Using an active PGW system, login. Using the prov-export command, export the screening data from each dial plan. prov-exp:all:dirname= save-config-2 Note Step 4 Step 5 Step 6 Step 7 Step 8 Step 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 Import GLBL.bwhite as follows: prov-add:files:name= bwhitefile,file= GLBL.bwhite,action= import numan-rtrv:bwhite:custgrpid="glbl",cli="x" Modify the screening type dw1 to dw3 for one resulttable in T001 dial plan. Make a test call from a test phone with the CLI listed in GLBL.bwhite. Modify the screening type dw1 to dw3 for one resulttable in T002 dial plan. Make a test call from a test phone with the CLI listed in GLBL.bwhite. 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 Save your changes and quit the editor as follows: :wq! 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 4-12

13 Chapter 4 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" 2 Make a test call from a test phone with the CLI listed in GLBL.bwhite. Caution Configuration of the Cisco PGW 2200 Softswitch software requires that the system software be shut down. In a simplex system, calls cannot be processed during system shut down. In a continuous service system, your system loses the ability to maintain calls during a critical event while the system software on one of the 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 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: 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. mml> numan-rtrv Verify a new row has been added to the Carrier Selection list. Repeat steps 1 and 2, as necessary, to add new rows and new Carrier IDs to the Carrier Selection list. 4-13

14 Adding Dial Plan Components Chapter 4 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: 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. mml> numan-rtrv Verify the DIGMODSTRING list and the digit string you entered are now present. Repeat steps 1 and 2 for each digit string you want to add to the DIGMODSTRING list. Tip An implied index, which contains a single string of digits to be applied to the calling number or called number, is used to access the DIGMODSTRING list. Adding a Service (SERVICE) Service contains user-defined services for screening. Its TID is SERVICE. To add a service list and add service names, complete the following steps: mml> numan-add:service:custgrpid= t001,name= Washington This command adds a service with the service name TollLine to the dial plan. Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service names. mml> numan-rtrv Verify the service with the service name that you entered is present. Repeat steps 1 and 2 for each service name you want to add to the service list. Tip The service list acts with the results to provide service names. 4-14

15 Chapter 4 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 4 Step 5 Step 6 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. 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. 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. 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. 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. 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. At the MML prompt, enter the following command: 4-15

16 Adding Dial Plan Components Chapter 4 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. 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. 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. At the MML prompt, enter the following command: mml> numan-add:resulttable:custgrpid="t002",name="result45",resulttype="mgcpdialpkg", dw1="dynamic",dw2="1",setname="mgcpdialset3" mml> numan-rtrv Verify the MGCPDIALPKG and the parameters you specified are now present in the result table. 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: 4-16

17 Chapter 4 Adding Dial Plan Components 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. mml> numan-rtrv Verify the ADIGITTREE and the parameters you added are now present in the dial plan. 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: 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. mml> numan-rtrv Verify the BDIGITTREE and the parameters you added are now present in the dial plan. 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: mml> numan-add:anpi:custgrpid= t001,npiblock=101,blockvalue=1,setname= set1 4-17

18 Adding Dial Plan Components Chapter 4 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. mml> numan-rtrv Verify the NPI value and the parameters you added is now present. As shown in Example 4-1 on page 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 set8 9 1 set There are currently no incoming NPI values above 9. See Appendix A, NOA and NPI Codes, CPC and TMR Values. 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. 4-18

19 Chapter 4 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: 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. 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 Result Set Name 1 set1 2 set set set4 8 4 Step 4 mml> numan-rtrv Verify the NOA value and the parameters you added are now present. Repeat steps 1 through 3 for each noavalue you want to add to the dial plan. 4-19

20 Adding Dial Plan Components Chapter 4 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 Its TID is LOCATION. To add a LOCATION to the dial plan, complete the following steps: mml> numan-add:location:custgrpid= t001,locationblock=1,blockvalue= 8,setname= set8 This command adds the LOCATION and sets up the Location with a CustGrpID of t001, a locationblock of 1, a block value of 8, and a result set name of set8. Note The blockvalue in numan-add:location should be one less than the intended internal value. mml> numan-rtrv Verify the LOCATION and the parameters you added are now present. Repeat steps 1 and 2 for each LOCATION entry you want to add to the dial plan. Tip The LOCATION contains 16 groups. Adding a Cause (CAUSE) Cause provides an index into the Location to provide cause analysis. The Cisco PGW 2200 Softswitch uses values from Cause and Location to determine result actions. Its TID is CAUSE. To add a CAUSE to the dial plan, complete the following steps: 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. 4-20

21 Chapter 4 Adding Dial Plan Components Note A cause value must be added to the dial plan before it can be edited. Table B-2, Internal Cause Code Values, Listed Numerically, lists the internal cause code values. mml> numan-rtrv Verify the CAUSE and the parameters you added are now present. 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) A-Number Screening File Formats 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. 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 4-21

22 Adding Dial Plan Components Chapter 4 B-Number Screening File Formats 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). The file format for each entry in the BWhite or BBlack screening files is the same: <Type> <ServiceName> <CallingPartyNumber> where, Type designates whether a number is to be added to or deleted from the A-number screening file: Type = 1 if the calling party number is to be added to the B-number screening file Type = 2 if the calling party number is to be deleted from the B-number screening file The type field allows additions and deletions to be commingled in the same file; however, the BWhite and BBlack screening files must be maintained separately. ServiceName is a string field that designates a valid service name. Note The service name entered here associates the calling party number with a specific service. A calling party number can be associated with as many different services as necessary. Service names are limited to 10 alphanumeric characters. Spaces are not allowed. CallingPartyNumber is used to enter the calling party number (A-number). Importing or Exporting Screening Data The screening list is also designed to allow you to add and remove entries without opening a provisioning session. It also enables more than one user at a time to access the screening list. The format of the MML command to import (or export) both dial plan files and A-number and B-number whitelist and blacklist screening files is as follows: prov-add:files:name=<file_format>, file=<file_name>, action=import export where the file_format and the file_name (target identifier or TID) must be paired, as listed in Table 4-2. File Type file_format = file_name (or TID) = A-number whitelist files AWhiteFile custgrpid.awhite A-number blacklist files ABlackFile custgrpid.ablack B-number whitelist files BWhiteFile custgrpid.bwhite B-number blacklist files BBlackFile custgrpid.bblack A provisioning session is not needed for individual MML commands; nor does a provisioning session need to be opened when you are using the screening file import procedure described above. The format of the MML command to add individual entries to the A-number whitelist or blacklist screening files without opening a provisioning session is as follows: mml> numan-add:<custgrpid.awhite custgrpid.ablack>:cli=<cli> 4-22

23 Chapter 4 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: mml> numan-add:awhite:custgrpid="t100",cli=" " This command adds an AWHITE list and the required parameters to the dial plan. mml> numan-rtrv Verify the AWHITE list and the parameters you added are now present. 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: mml> numan-add:ablack:custgrpid="t100",cli=" " This command adds an ABLACK list entry and the required parameters to the dial plan. mml> numan-rtrv Verify the ABLACK list entry and the parameters you added are now present. Repeat steps 1 and 2 for each ABLACK list entry you want to add to the dial plan. 4-23

24 Adding Dial Plan Components Chapter 4 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: mml> numan-add:bwhite:custgrpid="t100",cli=" ",svcname="freephone" This command adds a BWHITE list entry and the required parameters to the dial plan. Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service names. mml> numan-rtrv Verify the BWHITE list entry and the parameters you added are now present. 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: mml> numan-add:bblack:custgrpid="t100",cli=" ",svcname="freephone" This command adds a BBLACK list entry and the required parameters to the dial plan. Note Service names are limited to 10 alphanumeric characters. Spaces are not allowed in service names. mml> numan-rtrv Verify the BBLACK list entry and the parameters you added are now present. Repeat steps 1 and 2 for each BBLACK list entry you want to add to the dial plan. 4-24

25 Chapter 4 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: mml>numan-add:porttbl:digitstring=" ",routenumber="23456" This command adds an entry to the PORTTBL list and the required parameters to your dial plan. mml> numan-rtrv Verify the parameters you added are now present in the PORTTBL list. 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: 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. mml> numan-rtrv Verify the parameters you added are present in the TERMTBL list. 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: mml> numan-add:dpsel:custgrpid="t001",newdp="dp07" This command inserts the dial plan ID dp07 into a new dial plan selection list. 4-25

26 Adding Dial Plan Components Chapter 4 mml> numan-rtrv Verify the dial plan selection list and the new dial plan ID you added are now present. 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: mml> numan-add:anumdpsel:custgrpid="t001",cli=" ",newdp="dp07" This MML command inserts the A-number dial plan dp07 into the dial plan selection list. mml> numan-rtrv Verify the A-number dial plan selection list and the new dial plan ID you changed are now present. 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 ;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: 4-26

27 Chapter 4 Adding Dial Plan Components NUMAN-ADD:RTEHOLIDAY:CUSTGRPID="T002",DATE=" ",HDAY="HOL2" Edit a day entry in the Holiday list in an already existing entry in the list: NUMAN-ED:RTEHOLIDAY:CUSTGRPID="T002",DATE=" ",HDAY=HOL1 Delete an entry in the list: NUMAN-DLT:RTEHOLIDAY:CUSTGRPID="T002",DATE=" " Retrieve a specific entry in the list: NUMAN-RTRV:RTEHOLIDAY:CUSTGRPID="T002",DATE=" " 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=" ",HDAY="HOL1" NUMAN-ADD:RTEHOLIDAY:CUSTGRPID="T002",DATE=" ",HDAY="HOL1" NUMAN-ADD:RTEHOLIDAY:CUSTGRPID="T002",DATE=" ",HDAY="HOL2" NUMAN-ADD:RTEHOLIDAY:CUSTGRPID="T002",DATE=" ",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="set set set 24" PROV-ED:CONDRTE:NAME="condName20",DOW="TUESDAY",RTEDESC="set set set 24" PROV-ED:CONDRTE:NAME="condName20",DOW="WEDNESDAY",RTEDESC="set set 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="set set 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 , the Routing option is result set set21 which provides RouteList21 as the entry point into Routing analysis. From , the Routing option is result set set22 which provides Routelist22 as the entry point for Routing analysis. From , the Routing option is result set set24 which provides RouteList24 as the entry point into Routing analysis. On a Holiday of type HOL1 From , the Routing option is set23 which provides RouteList23 as the entry point into Routing analysis. On a Holiday of type HOL2 From , the Routing option is set22 which provides RouteList22 as the entry point into Routing analysis. 4-27

28 Provisioning Overdecadic Status Chapter 4 On a Holiday of type HOL3 From , the Routing option is result set set22 which provides RouteList22 as the entry point into Routing analysis. From , the Routing option is result set set55 which provides Routelist55 as the entry point for Routing analysis. From , 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 , the Routing option is result set set22 which provides Routelist22 as the entry point for Routing analysis. From , 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: 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. mml> numan-rtrv Verify the dpbase and the overdecadic selection you added are now present. 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: 4-28