Chapter 3. Provisioning Dial Plans with CMM
Available Languages
Table Of Contents
Provisioning Dial Plans with CMM
Adding Results to a Result Set
Modifying a Result in a Result Set
Deleting a Result from a Result Set
Provisioning the B_Digit_Tree (Originating)
Provisioning the B_Digit_Tree (Terminating)
Provisioning the A_Digit_Tree (Originating)
Provisioning the A_Digit_Tree (Terminating)
Provisioning Digit Modification
Modifying a Digit Modification String
Deleting a Digit Modification String
Processing the Number Analysis File
Provisioning Whitelist and Blacklist Screening
Processing the White List or Black List File
Provisioning Dial Plans with CMM
This chapter provides information and procedures for provisioning dial plans for Cisco Media Gateway Controller Software Release 7.4 using the Cisco Media Gateway Controller Manager (CMM).
The topics addressed in this chapter include:
Note
The dial plan provisioning procedures in this chapter are applicable only to Cisco Media Gateway Controller (MGC) software Release 7.4(x).
The CMM is an X Window System graphical user interface (GUI) that accesses Cisco Media Gateway Controller (MGC) information using the Simple Network Management Protocol (SNMP).
You can use the CMM to perform a variety of provisioning tasks, including:
•
•
•
•
•
The CMM can be used alone or with MML commands to provision dial plans for your system. For more information on using MML commands, refer to "Provisioning Dial Plans with MML."
You should have the information described in "Preparing for Dial Plan Provisioning," before beginning your dial plan provisioning session.
When provisioning dial plans, you must first ensure that all system components have been provisioned as described in the Cisco Media Gateway Controller Software Release 7 Provisioning Guide.
CMM Overview
The CMM provides a GUI that allows you to create dial plan provisioning sessions. The CMM saves your current provisioning session each time you click a set command. After you finish the provisioning session and choose commit or deploy, the CMM saves your dial plan as the active dial plan. After you have created the active dial plan, you cannot modify it. To make changes, you must save it with another name and commit or deploy the new provisioning session to make it active.
The software allows only one active provisioning session. Therefore, you cannot have an active MML provisioning session open at the same time you are using the CMM. Other users can access the CMM in read-only mode from a different host; however, the Create, Modify, Set, and Delete buttons are not enabled in read-only mode.
Note
Read-only mode permits viewing of the current active provisioning data stored in the /opt/CiscoMGC/etc directory on the Cisco MGC host. Read-only users cannot access any other provisioning sessions, regardless of what is entered in the Source Version Name or Destination Version Name field. In read-only mode, information in the View, Traffic, and Number Analysis tabs can be edited and used to create files on the local machine. You can also export customer-specific files, such as dial plans, when in read-only mode.
The number of dial plans you can store might be limited by available disk space. Consider deleting old or unwanted dial plans, or saving them to another machine if you do not have sufficient disk space.
Note
Starting the CMM
To start the CMM, complete the following steps:
Step 1
You must be logged in to the CMM server or access it from a machine with X Window System capability.
See the Cisco Media Gateway Controller Software Release 7 Installation and Configuration Guide for more information on setting up user privileges and access rights.
Step 2
cd /opt/CMM/bin
./start.sh cmm IPAddr/HostName SourceVersionName DestVersionName
The system opens the X Window System interface, and the login window is displayed (Figure 3-1).
Tip
Timesaver
Figure 3-1 Login Window
Note
Step 3
Step 4
Step 5
•
If you are creating an entirely new dial plan, you must create a new configuration.
•
You can use information in the active configuration as the basis for a new configuration; however, you must enter a new destination version name. You cannot overwrite the active configuration.
•
The name can be as many as 250 alphanumeric characters and must start with a letter or number.
To modify the information in an existing, inactive configuration, use the same name for both the source and destination version names. If the destination version name you specify exists, but is inactive, it can be overwritten and no error messages appear.
Step 6
The name can be as many as 250 alphanumeric characters, including hyphens or underscores; however, you cannot use the labels "active" or "new" in the Destination Version Name field.
Caution
If the destination directory you specify already exists, an error message is displayed. The Cisco MGC software does not allow you to overwrite an existing configuration unless you previously specified that configuration as the source version and it was inactive.
Step 7
Figure 3-2 Main Window
Note
The CMM main window displays two panes. The left pane displays a list of components that you can select. To expand the component list, click the plus sign (+) next to the component name in the left pane. To select a component, click the component name. The right pane then displays fields in which you can enter data for the selected component.
The bottom left portion of the CMM main window provides status messages when you perform an action. For example, after you start the CMM the message "Cisco Media Gateway Controller Manager started" appears. After you click the Create button when creating an external node, the message "extnode set successful" appears.
Navigating the CMM
This section describes the procedures to use when navigating the CMM.
Tabs
The CMM main window provides tabs to navigate through the system, You click on these tabs to add or change network components. The top of the CMM main window contains the following tabs:
•
•
•
Information Boxes
The top of the CMM main window also contains the following information boxes:
•
•
•
Menu Bar
The CMM also provides a menu bar whose selections remain constant throughout the provisioning session; however, the menu choices depend on whether you are in read-only mode or read-write mode. The menu bar contains the following options: Session, View, and Help
Session Menu
The Session menu contains the choices listed in Table 3-1 The choices that are displayed in the Session menu depend on whether you are in read-only mode or read-write mode.
Table 3-1 Session Menu Choices
Sync
Copies all dial plans on the active1 host to the standby host if you have a continuous-service configuration.
Read-only
Stop
Ends the current session.
Read-write
Deploy
Ends the session and saves the current dial plan as the active dial plan. Copies the dial plan to the standby host if you have a continuous-service configuration.
Read-write
Commit
Ends the session and saves the current dial plan as the active dial plan. In a continuous-service configuration, this is regardless of whether it is deployed on the active host or the standby host.
Read-write
Exit
Stops any open provisioning session and exits the TCM.
Read-only Read-write
1 The active Cisco MGC in a continuous-service configuration is the machine that is currently processing calls.
Do not confuse the active machine with the active provisioning session, which is located on the TCM host machine.
To activate the provisioning session:
•
•
•
Note
Note
View Menu
The View menu contains the View Next option, which allows you to choose the number of data rows displayed in the CMM list boxes. For example, if you enter 10, the list boxes in the CMM display data 10 rows at a time. You can display a range of 1 through 999.
Help Menu
The Help menu currently contains only software copyright and version information.
Note
Exiting the CMM
You can exit the CMM at any time by performing one of these actions:
•
•
•
Note
Provisioning the Dial Plan
The MGC enables you to create a dial plan to perform number analysis on both the A-number (calling number) and B-number (called number). For more information on creating a dial plan, refer to the "Creating a Dial Plan" section.
This section provides procedures for entering dial plan information into the CMM. You should already have your dial plan information recorded before beginning any data entry in the CMM.
This section contains the following subsections:
•
•
•
•
Creating the Dial Plan File
To enter your dial plan information into the CMM, you must first create the dial plan file.
To create a dial plan file, complete the following steps:
Step 1
Step 2
Step 3
The Customer Group ID is a 4-character alphanumeric name beginning with a letter.
Caution
We suggest that you create a sufficiently large number of Customer Group IDs during the initial provisioning of your system to accommodate your anticipated needs, then assign Customer Group IDs to your users as they are needed.
Provisioning new Customer Group IDs for an operational system means that you have to take the SS7 sigPath OOS, which will result in a loss of service for any calls associated with that SS7 sigPath.
Step 4
The Dial Plan component appears under the Customer Group ID you created in Step 3.
Step 5
The following dial plan components are displayed:
•
•
•
•
•
•
•
•
•
•
Depending on your dial plan, you can add information for only the types of analysis you want to perform.
For example, for A-number or B-number analysis, first enter the results you want to achieve in the Results window. Then enter the digits you want to analyze in either the A-digit tree or B-digit tree. The Cisco MGC analyzes the number one digit at a time and performs the results that you specify.
Provisioning Result Sets
A result set is a grouping of results that can be connected to an A-digit tree, a B-digit tree, pre-analysis, or cause analysis. Each result set consists of a grouping of one or more results. Each result set requires a unique name, and each result within a result set requires a unique name. However, the result names do not need to be unique across result sets. It is the combination of the result set name and the result name that must be unique.
You can have only one result set for each digit string; however, you can have multiple results in a result set. When determining the result types for a result set, enter them in logical order—for example, from screening to route. Once a result set has a result type with an endpoint analysis point, that is the end of the result set; however, you can have as many intermediate analysis point result types in a result set as you want. Refer to Table 2-4 for a list of the analysis point result types.
Note
For the dial plan to perform an action on a called or calling number, you must add a result for the action you want to occur. You must first create a result set. Your result set can contain one or more results (result types) that you want to occur in the sequence that you want them to occur.
Adding a Result Set
To add a new result set, complete the following steps:
Step 1
Step 2
Step 3
The Dial Plan component appears under the Customer Group ID you select.
Step 4
The Dial Plan component section is expanded to display a list of choices.
Step 5
The Result Type Table window is displayed.
Step 6
Step 7
The result set name can be as many as 20 alphanumeric characters.
Step 8
The Result Set window is displayed.
Adding Results to a Result Set
To add result types to your new result set, continue with the following steps:
Step 1
The Result Type Table window is displayed.
Step 2
You can choose any result type from those listed:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Step 3
For detailed information on any result type, refer to Table 1-3 and the "Result Type Definitions" section.
Note
Modifying a Result in a Result Set
To modify a result type entry in a result set, complete the following steps:
Step 1
Step 2
A dialog box appears requesting verification.
Step 3
Deleting a Result from a Result Set
To delete a result type entry from a result set, complete the following steps:
Step 1
A dialog box appears requesting verification.
Step 2
Provisioning Pre-Analysis
Pre-analysis is an initial analysis request you can make on a digit string after receiving the IAM or Setup message. Pre-analysis also enables you to perform early analysis on the called number (B-number).
Pre-analysis can be performed on the following results:
•
•
•
•
Using the incoming values for the Nature of Address (NOA) and Numbering Plan Indicator (NPI), you can perform pre-analysis on the first digit in the B-digit string before any formal analysis is performed.
Note
Provisioning the NPI Table
Even though NOA pre-analysis is performed first, the NPI table must be provisioned first if the NOA table refers to an NPI block.
To perform NPI table provisioning, complete the following steps:
Step 1
Step 2
Step 3
The Dial Plan component appears under the Customer Group ID you select.
Step 4
The Dial Plan component section is expanded to display a list of choices.
Step 5
The Numbering Plan Indicator window is displayed (Figure 3-3 on the next page).
Step 6
There are 16 values (0 through 15) displayed for each NPI block added to the NPI table.
Step 7
The Numbering Plan Indicator window is redisplayed with the specified number of blocks added to the NPI table.
Tip
Figure 3-3 Numbering Plan Indicator Window
Modifying the NPI Table
To modify a specific NPI block in the NPI table, complete the following steps:
Step 1
The NPI block you specified should be displayed in the Numbering Plan Indicator window.
Step 2
Step 3
A dialog box appears requesting verification.
Step 4
The Numbering Plan Indicator window is redisplayed with the selected NPI block changed.
Deleting an NPI Block
To delete a specific NPI block from the NPI table, complete the following steps:
Step 1
The NPI block you specified should be displayed in the Numbering Plan Indicator window.
Step 2
A dialog box appears requesting verification.
Step 3
The Numbering Plan Indicator window is redisplayed with the selected NPI block deleted.
Provisioning the NOA Table
To perform NOA table provisioning, complete the following steps:
Step 1
Step 2
Step 3
The Dial Plan component appears under the Customer Group ID you select.
Step 4
The Dial Plan component section is expanded to display a list of choices.
Step 5
The Nature of Address window is displayed (Figure 3-4).
Figure 3-4 Nature of Address Window
Step 6
The new Nature of Address window is displayed (Figure 3-5).
The NOA number appears in the top block.Figure 3-5 New Nature of Address Window
Step 7
The Nature of Address window is redisplayed with the data you just entered.
Note
Modifying a NOA Table
To modify a specific NOA block in an NOA table, complete the following steps:
Step 1
Step 2
A dialog box appears requesting verification.
Step 3
The Nature of Address window is redisplayed with the selected NOA block changed.
Deleting a NOA Block
To delete a specific NOA block in an NOA table, complete the following steps:
Step 1
A dialog box appears requesting verification.
Step 2
The Nature of Address window is redisplayed with the selected NOA block deleted.
Provisioning Digit Trees
This section describes the procedures for provisioning the A-digit tree and B-digit tree.
Provisioning the B_Digit_Tree (Originating)
To provision the B-digit tree, complete the following steps:
Step 1
Step 2
Step 3
The Dial Plan component appears under the Customer Group ID you select.
Step 4
The Dial Plan component section is expanded to display a list of choices.
Step 5
Two branches, Originating and Terminating, are displayed.
Step 6
A warning message appears indicating that no filter is set and all configured digit strings are displayed.
Step 7
•
•
Figure 3-6 B-Digit Tree Window
Step 8
This displays the Add String box.
Step 9
The B Digit Tree window is redisplayed with the information entered in the Add String box added.
Step 10
Modifying a Digit String
To modify a digit string, complete the following steps:
Step 1
This displays the Modify String box.
Step 2
A dialog box appears requesting verification.
Step 3
The B Digit Tree window is redisplayed with the information entered in the Modify String box changed.
Note
Deleting a Digit String
To delete a digit string, complete the following steps:
Step 1
A dialog box appears requesting verification.
Step 2
The B Digit Tree window is redisplayed with the selected digit string deleted.
Note
Provisioning the B_Digit_Tree (Terminating)
To provision the B-digit tree, complete the following steps:
Step 1
Step 2
Step 3
The Dial Plan component appears under the Customer Group ID you select.
Step 4
The Dial Plan component section is expanded to display a list of choices.
Step 5
Two branches, Originating and Terminating, are displayed.
Step 6
A warning message appears indicating that no filter is set and all configured digit strings are displayed.
Step 7
•
•
Step 8
This displays the Add String box.
Step 9
The B Digit Tree window is redisplayed with the information entered in the Add String box added.
Step 10
Provisioning the A_Digit_Tree (Originating)
To provision the A-digit tree, complete the following steps:
Step 1
Step 2
Step 3
The Dial Plan component appears under the Customer Group ID you select.
Step 4
The Dial Plan component section is expanded to display a list of choices.
Step 5
Two branches, Originating and Terminating, are displayed.
Step 6
A warning message appears indicating that no filter is set and all configured digit strings are displayed.
Step 7
•
•
Step 8
This displays the Add String box.
Step 9
The A Digit Tree window is redisplayed with the information entered in the Add String box added.
Step 10
Provisioning the A_Digit_Tree (Terminating)
To provision the A-digit tree, complete the following steps:
Step 1
Step 2
Step 3
The Dial Plan component appears under the Customer Group ID you select.
Step 4
The Dial Plan component section is expanded to display a list of choices.
Step 5
Two branches, Originating and Terminating, are displayed.
Step 6
A warning message appears indicating that no filter is set and all configured digit strings are displayed.
Step 7
•
•
Step 8
This displays the Add String box.
Step 9
The A Digit Tree window is redisplayed with the information entered in the Add String box added.
Step 10
Provisioning Digit Modification
B-digit modification (BMODDIG) pre-analysis allows you to remove one or more digits from anywhere in the digit string and replace the removed digits with one or more digits.
To add a result set that performs digit modification, complete the following steps:
Step 1
Step 2
Step 3
The Dial Plan component appears under the Customer Group ID you select.
Step 4
The Dial Plan component section is expanded to display a list of choices.
Step 5
The Digit Modification String window is displayed (Figure 3-7).
Figure 3-7 Digit Modification String Window
Step 6
The Digit Modification window is displayed (Figure 3-8).
Figure 3-8 Digit Modification Window
Step 7
The Digit Modification String window is redisplayed with the name and value from the Digit Modification window added.
Note
Step 8
The Result Type table window appears.
Step 9
Step 10
The Result Set window is redisplayed with the new result set name added.
Step 11
The MODDIG_B window, with the Result Set Name added, is displayed (Figure 3-9).
Figure 3-9 MODDIG_B Window
Step 12
The Result Set window is redisplayed with the MODDIG_B information added.
Note
Step 13
The Route window appears with the Result Set Name already added.
Step 14
The Result Set window is redisplayed with another line with the ROUTE information added.
Note
Modifying a Digit Modification String
To modify a Digit Modification string, complete the following steps:
Step 1
The MODDIG_B window is displayed
Step 2
A dialog box appears requesting verification.
Step 3
The Digit Modification String window is redisplayed with the changes to the selected digit modification string.
Deleting a Digit Modification String
To delete a Digit Modification string, complete the following steps:
Step 1
A dialog box appears requesting verification.
Step 2
The Digit Modification String window is redisplayed with the selected digit modification string deleted.
Provisioning the Service Name
To provision a Service Name, complete the following steps:
Step 1
Step 2
Step 3
The Dial Plan component appears under the Customer Group ID you select.
Step 4
The Dial Plan component section is expanded to display a list of choices.
Step 5
The Service Name window is displayed (Figure 3-10).
Figure 3-10 Service Name Window
Step 6
This displays the New Service Name window (Figure 3-11).
Figure 3-11 New Service Name Window
Step 7
The Service Name window is redisplayed with the new Service Name listed in the Service Name column.
Step 8
Modifying a Service Name
To modify a service name, complete the following steps:
Step 1
This displays the Modify Service Name window.
Step 2
A dialog box appears requesting verification.
Step 3
The Service Name window is redisplayed with the selected service name changed.
Deleting a Service Name
To delete a service name, complete the following steps:
Step 1
A dialog box appears requesting verification.
Step 2
The Service Name window is redisplayed with the selected service name deleted.
Provisioning Location
To provision the Location table, complete the following steps:
Step 1
Step 2
The Dial Plan component appears under the Customer Group ID you select.
Step 3
The Dial Plan component section is expanded to display a list of choices.
Step 4
The Location window is displayed (Figure 3-12).
Figure 3-12 Location Window
Step 5
The New Block window is displayed (Figure 3-13).
Figure 3-13 New Block Window
Step 6
This redisplays the Location window with the Current Block showing the value entered in Step 6 and 16 entries (0 through 15) in the Location Value column.
Step 7
The Add String box is displayed.
Step 8
Step 9
Step 10
Modifying a Location
To modify a Location, complete the following steps:
Step 1
Step 2
A dialog box appears requesting verification.
Note
Step 3
The Location window is redisplayed with the changes that you just made.
Deleting a Location
To delete a Location, complete the following steps:
Step 1
A dialog box appears requesting verification.
Step 2
The Location window is redisplayed with the selected Location Block deleted.
Provisioning Cause Codes
To provision Cause codes, complete the following steps:
Step 1
Step 2
The Dial Plan component appears under the Customer Group ID you select.
Step 3
The Dial Plan component section is expanded to display a list of choices.
Step 4
The Cause window is displayed (Figure 3-14).
Figure 3-14 Cause Window
Step 5
The Cause window is displayed with the Cause code number displayed in the top box.
Note
Step 6
The Cause window is redisplayed with the data you just entered.
Modifying a Cause Code
To modify a Cause code, complete the following steps:
Step 1
Step 2
A dialog box appears requesting verification.
Step 3
The Cause window is redisplayed with the selected Cause code number changed.
Deleting a Cause Code
To delete a Cause code number, complete the following steps:
Step 1
A dialog box appears requesting verification.
Step 2
The Cause window is redisplayed with the selected Cause code number deleted.
Processing the Number Analysis File
After you complete your dial plan, you must process the number analysis file. To process the number analysis file, complete the following steps:
Step 1
Step 2
Step 3
Step 4
The system opens an FTP session to the Cisco MGC host and copies the file. In addition, SNMP sets the filename in the management information base (MIB), and the file is post-processed.
Note
Tip
Provisioning Whitelist and Blacklist Screening
You can provision whitelists or blacklists to include or exclude calls from certain numbers. You can provision whitelists that allow calls from specified A-numbers or to specified B-numbers. Blacklists block calls from specified A-numbers or to specified B-numbers.
To provision a whitelist or blacklist, you must complete the following procedures:
•
•
•
To create the list file, complete the following steps:
Step 1
If you have already entered a Customer Group ID, it appears under the Number Analysis component. Continue with Step 2.
If you have not entered a Customer Group ID, or want to enter a new one, complete the following steps:
a.
b.
c.
Caution
We suggest that you create a sufficiently large number of Customer Group IDs during the initial provisioning of your system to accommodate your anticipated needs, then assign Customer Group IDs to your users as they are needed.
Provisioning new Customer Group IDs for an operational system means that you have to take the SS7 sigPath OOS, which will result in a loss of service for any calls associated with that SS7 sigPath.
Step 2
The Number Analysis File Types window is displayed.
Step 3
•
•
•
•
Step 4
The file type you created appears in the directory under the Customer Group ID.
Adding Numbers for Screening
After you create the whitelist or blacklist file, you must set up screening for the list.
To provision the numbers for screening, complete the following steps:
Step 1
For example, if you are provisioning an A whitelist, click AWhiteList. The A WhiteList window appears on the right side of the window.
Step 2
The Screening window is displayed.
Step 3
Step 4
Step 5
The number is displayed in the A WhiteList window.
Step 6
Processing the White List or Black List File
After you complete your whitelist or blacklist file, you must process the file.
To process the whitelist or blacklist file, complete the following steps:
Step 1
Step 2
Step 3
Step 4
The system opens an FTP session to the Cisco MGC host and copies the file. In addition, SNMP sets the filename in the MIB and the file is post-processed.
Note
Tip
Feedback