3Com Nbx 100 And Ss3 Nbx Administration Guide

							Dial Plan Configuration File Commands121
ExternalSettings
Syntax
ExternalSettings szExternalKeysetPrefix 
szFirstAutoDiscoverExtension szDefaultAutoExtension
DescriptionSpecifies settings for several aspects of external devices.
Arguments
szExternalKeysetPrefix — The digits that are prepended to external calls 
made in Keyset mode. This is used to determine the Class of Service (CoS) 
for external calls made in Keyset mode. Typical values for this digit are 8, 
9, or 0 (zero). This prefix is set to the appropriate number in each 
country’s dial plan.
Example: In the default internal dial plan table, the digit 9 instructs the 
system to connect the call to an external line. When a telephone has a 
button mapped to an external device, and the user places a call using 
that external device, the system prepends the 
szExternalKeysetPrefix digit 
to the digits dialed by a user; then the system applies the dial plan tables 
to determine call Class of Service.
szFirstAutoDiscoverExtension — The first extension used when 
autodiscovering external devices. This must be in the specified range of 
lowest/highest external extensions.
The system assigns extensions starting with this number and 
incrementing upward. For information on the Auto Discovery topic, see 
“Using Auto Discovery for Initial System Configuration” in the 
NBX Installation Guide.
The default value for a 3-digit system is 750, and for a 4-digit system is 
7250. Typically, systems do not use all of the extensions from 600 
through 799 (or 6000 through 7999). If, however, the system uses all of 
these extensions and needs another one, it starts looking from the 
beginning of the range and selects the first unused one.
szDefaultAutoExtension — The default extension the system uses for 
forwarding incoming calls. This is always 500.
The system must direct each incoming call (on an external line) to an 
extension. After you import the dial plan configuration file, and complete 
the Auto Discovery process, you can manually configure the extension for 
each analog line and each Digital Line Card channel, if you want. 
						

							122CHAPTER 2: DIAL PLAN
PreTranslator Create
Syntax
PreTranslator Create nPreTranslatorId szDescription
DescriptionCreates a pretranslator. If the pretranslator already exists, 
this command removes all of its entries and operations, and overwrites its 
description with the new information.
Arguments
nPreTranslatorId — An integer in the range 1 through 32768.
szDescription — The description or name of the pretranslator.
Example: This command creates a pretranslator, designates it as the first 
one (number 1) and give it the title “4-to-3-digit DID/DDI pretranslator.”
PreTranslator Create 1 4-to-3-digit DID/DDI pretranslator
PreTranslatorEntry Create
Syntax
PreTranslatorEntry Create nPreTranslatorId nEntryId szDigits
DescriptionCreates a pretranslator entry and specifies a string of digits 
that are compared to the incoming digits. If the pretranslator entry 
already exists, this command overwrites it with the new information.
Arguments
nPreTranslatorId — An integer in the range 1 through 32768.
nEntryId — An integer in the range 1 through 32768.
szDigits — The digits to compare to the incoming digits.
Example: These example commands create, in pretranslator 1, entries 1 
through 10, each of which looks for a different single digit (0 through 9) 
in the incoming digits.
PreTranslatorEntry Create 1 1 0
PreTranslatorEntry Create 1 2 1
PreTranslatorEntry Create 1 3 2
PreTranslatorEntry Create 1 4 3
PreTranslatorEntry Create 1 5 4 
						

							Dial Plan Configuration File Commands123
PreTranslatorEntry Create 1 6 5
PreTranslatorEntry Create 1 7 6
PreTranslatorEntry Create 1 8 7
PreTranslatorEntry Create 1 9 8
PreTranslatorEntry Create 1 10 9
PreTranslatorEntry Delete
Syntax
PreTranslatorEntry Delete nPreTranslatorId nEntryId
DescriptionDeletes a pretranslator entry or deletes all entries for a 
particular pretranslator.
Use caution when using this command to delete Pretranslator entries in 
an existing Dial Plan. In general, it is best to delete all tables, routes, and 
pretranslators at the beginning of each dial plan configuration file. This 
precaution avoids the potential conflicts or unpredictable actions caused 
by importing new dial plan entries on top of an existing dial plan.
For instructions on how to edit the dial plan configuration file to delete 
existing tables, routes, and pretranslators, see “Creating Dial Plan 
Configuration Files” earlier in this chapter.
Arguments
nPreTranslatorId — An integer in the range 1–32768.
nEntryId — An integer in the range 1–32768 or * for all entries.
Example: This command deletes pretranslator entry 3 from 
pretranslator 2.
PreTranslatorEntry Delete 2 3
This command deletes all pretranslator entries from pretranslator 2.
PreTranslatorEntry Delete 2 *
Normally this command is not necessary. It is better to delete an entire 
dial plan rather than import a new dial plan over it. To accomplish this, 
3Com recommends using specific commands at the top of every dial plan 
configuration file. For an example of this technique, see “Creating Dial 
Plan Configuration Files” earlier in this chapter. 
						

							124CHAPTER 2: DIAL PLAN
PreTranslatorOperation Create
Syntax
PreTranslatorOperation Create nPreTranslatorId nEntryId 
nOperId szOperation szValue
DescriptionCreates a digit manipulation operation for a pretranslator 
entry. If the specified digit manipulation operation already exists, this 
command overwrites it with the new information. During pretranslation, 
the system processes the list of operations in ascending 
nOperId order 
(
nOperId 1 first).
Arguments
nPreTranslatorId — An integer in the range 1 through 32768.
nEntryId — An integer in the range 1 through 32768 specifying the 
pretranslator entry to which this operation applies.
nOperId — An integer in the range 1 through 32768. The 
system processes the list of operations in ascending nOperId order 
(
nOperId 1 first).
szOperation — The name of the digit manipulation operation to perform. 
Values are: stripLead, stripTrail, replace, prepend, append.
szValue — The value to use in the operation, either the string of digits to 
prepend, append, replace with, or the number of digits to strip.
Table Create
Syntax
Table Create nDialPlanTableId szDescription
DescriptionCreates a dial plan table to control the routing of calls 
placed by devices. Dial plan tables apply to internal devices such as 
telephones, incoming calls from outside the NBX system, and Least Cost 
Routes. If the dial plan table already exists, this command removes all 
entries from the table, and fills the table with the new information. 
						

							Dial Plan Configuration File Commands125
Arguments
nDialPlanTableId — An integer in the range 1 through 32768. The default 
dial plan tables use ID numbers 1 through 3:
1 — Internal dial plan table
2 — Incoming dial plan table
3 — Least Cost Routing table
szDescription — The description or name of the dial plan table. The NBX 
NetSet utility uses this name to refer to the table.
Example: This example command creates dial plan table 1 and names it 
“Internal 4 Digit Extensions.”
Table Create 1 Internal 4 Digit Extensions
TableEntry Create
Syntax
TableEntry Create nDialPlanTableId nEntryId szDigits 
nMinDigits nMaxDigits szCallClass nPriority nRouteId
DescriptionCreates an entry in a dial plan table that specifies a string 
of digits that are compared to the dialed digits. If the dial plan table entry 
already exists, this command overwrites it with the new information.
Dial plan table entries make Class of Service and call routing decisions 
based on the correspondence of dialed digits and table entry digits.
Arguments
nDialPlanTableId — An integer in the range 1 through 32768. The system 
reserves three ID numbers:
1 — Internal dial plan table
2 — Incoming dial plan table
3 — Least Cost Routing table
nEntryId — An integer in the range 1 through 32768. Each entry must 
have a unique ID. If two entries have the same ID, the system uses the 
entry closer to the bottom of the configuration file (the one processed last).
szDigits — A string of dialed digits in a dial plan entry. 
						

							126CHAPTER 2: DIAL PLAN
nMinDigits — An integer specifying the minimum number of digits to 
collect.
nMaxDigits — An integer specifying the maximum number of digits to 
collect.
szCallClass — The call class for this dial plan entry. The call class 
corresponds to permissions granted to users in their Class of Service. 
Values are Internal, Local, LongDistance, International, WAN, TollFree, 
Emergency, COCode, Wireless, Other, Toll, AlternateLong, Operator, 
TrunkToTrunk, Diagnostics, and NotAllowed.
nPriority — Not presently used. Always set to zero (0).
nRouteId — An integer specifying the ID of the route to use when this dial 
plan entry is matched. A route ID of zero (0) indicates that this entry has 
no defined route; digits are transmitted ed as soon as they are dialed.
Example: This example command creates (in table ID 1) table entry 1, 
which looks for 3 as the first digit in a 4-digit string (minimum and 
maximum number of characters are both specified as 4), classifies the call 
type as “Internal”, assigns the call a priority of zero (the only acceptable 
priority in this product release). Because the destination is an internal 
extension, there is no need for a defined route so the route number is zero.
TableEntry Create 1 13 4 4 Internal 0 0
TimedRoute Create
Syntax
TimedRoute Create nRouteId nDefaultDestinationRouteId 
szDescription
DescriptionCreates a timed route (a route that the system uses based 
on defined criteria for time of day and day of week). If the timed route 
already exists, this command removes all of its entries and overwrites its 
description and 
defaultDestinationRoute with the new information.
Arguments
nRouteId — An integer in the range 1 through 32768 which uniquely 
identifies this timed route. 
						

							Dial Plan Configuration File Commands127
nDefaultDestinationRouteId — An integer in the range 1 through 32768 
identifying the destination route the system must use if none of the 
entries in this timed route match the current time of day.
szDescription — A description or name of the timed route.
Example: This example command creates timed route 7 which uses 
destination route 1, defined in the “Routes” section of the system 
configuration file. The description of route 7 is “Business Hours Long 
Distance.”
TimedRoute Create 7 1 Business Hours Long Distance
TimedRouteEntry Create
Syntax
TimedRouteEntry Create nRouteId nEntryId szStartTime 
szEndTime szDaysOfWeek nDestinationRouteId
DescriptionCreates a timed route entry specifying either a time of day 
or system mode, day of the week criteria, and the destination route to 
use if that criteria are met. If the specified timed route entry already 
exists, this command overwrites it with the new information. During 
routing, the system checks the list of timed route entries in ascending 
nEntryId order (
nEntryId 1 first). The system performs any digit 
manipulation operations that apply to the specified destination.
Arguments
nRouteId — An integer in the range 1 through 32768.
nEntryId — An integer in the range 1 through 32768. The system checks 
the list of timed routes in ascending order based on nEntryId.
szStartTime — Start time in 24-hour format, for example, 13:30 for 
1:30 p.m. You can use either 24:00 or 00:00 to specify midnight. Instead 
of specifying times, you can enter a system mode name (open, closed, 
lunch, or other). For each system mode, the system knows the start and 
stop times. If you use one of the system modes, both szStartTime and 
szEndTime parameter must be the same.
You define start and end times for system modes through the NBX NetSet 
utility. Click System Configuration, then the Business Identity tab, and the 
Business Hours button. Enter the times you want and click OK. 
						

							128CHAPTER 2: DIAL PLAN
Example: If you define business hours from 8:00 to 17:00 on Mondays, 
Wednesdays and Fridays, and from 9:00 to 18:00 Tuesdays and 
Thursdays, then a timed route entry both szStartTime and szEndTime set 
to “open” applies differently on Monday, Wednesday, and Friday than on 
Tuesday and Thursday.
You set the beginning and ending times for open, lunch, and other using 
the NBX NetSet utility. Click System Configuration, then the Business 
Identity tab, and the Business Hours button. The NBX system treats all 
times not included these three categories as closed.
szEndTime — End time in 24-hour format, for example, “18:30” for 
6:30 p.m. You can use either 00:000 or 24:00 to indicate midnight. If you 
use a system mode (open, lunch, or other) for szStartTime, you must use 
the same system mode for szEndTime.
szDaysOfWeek — A seven character mask in which each character 
position represents one day of the week, beginning with Sunday as the 
first character and ending with Saturday as the last character. The NBX 
system excludes any day if a dot “.” character appears in that days 
position. (As a convention, you place the first letter of each day in the 
appropriate character position to indicate that the day is included, but 
you can use any letter you want; the presence of a dot “.” in a given 
position excludes the day of the week and the presence of any other 
character in that position selects that day.
You use the szDaysOfWeek parameter to specify when this timed route is 
active. You can specify that the timed route entry apply to all days of the 
week. If you specify the start and end times for open mode differently on 
some days of the week than for other days, one timed route entry can 
operate differently depending on the day.
Example: The system interprets “SMT.T.S” (or “XXX.X.X”) as “all days 
except Wednesday and Friday.” The “dot” characters in positions four 
and six exclude the fourth and sixth days of the week (Wednesday and 
Friday).
nDestinationRouteId — The Id of the destination route to use if this entry’s 
time of day and day of week criteria are met.
Example: This example command creates two entries, one to define the 
route to use during business hours (open) and the other to define the 
route when the business is closed. 
						

							Dial Plan Configuration File Commands129
The first entry is timed route 7, timed route entry 1. The two occurrences 
of the word “Open” instruct the system to use the start time and end 
time defined by the “open for business” hours, and the letters 
“SMTWTFS” indicate that this entry applies to all seven days of the week 
(Sunday through Saturday).
The number 6 designates destination route 6, defined in the system 
routes table. Because this entry applies to the “open for business” hours, 
route 6 could define a least cost route for outgoing long distance calls.
The second entry is timed route 7, timed route entry 2. The two 
occurrences of the word “Closed” instruct the NBX system to use the 
start time and end time defined by the “business closed” hours, and the 
letters “SMTWTFS” indicate that this entry applies to all seven days of the 
week (Sunday through Saturday). The number 3 designates destination 
route 3, defined in the system routes table. Because this route applies to 
the “business closed” hours, route 3 could connect the incoming call to 
an Auto Attendant menu that tells the caller that the company is closed 
and gives instructions on how to leave a message and how to reach 
someone in an emergency.
TimedRouteEntry Create 7 1 Open Open SMTWTFS 6
TimedRouteEntry Create 7 2 Closed Closed SMTWTFS 3
TimedRouteOperation Create
Syntax
TimedRouteOperation Create nRouteId nEntryId nOperId 
szOperation szValue
DescriptionCreates a digit manipulation operation for a timed route 
entry. If the specified digit manipulation operation already exists, this 
command overwrites it with the new information. During routing, the 
system processes the list of operations in ascending 
nOperId order 
(
nOperId 1 first).
CAUTION:Timed route operations are performed before 
Destination Route operations. So if you strip a leading 9 using a 
TimedRouteOperation Create command verify that you don’t mistakenly 
perform the same action in a DestinationRouteOperation Create 
command. If you made that error, you would lose the first dialed digit. 
						

							130CHAPTER 2: DIAL PLAN
Arguments
nRouteId — An integer in the range 1 through 32768.
nEntryId — An integer in the range 1 through 32768 specifying the timed 
route entry to which this operation applies.
nOperId — An integer in the range 1 through 32768. The 
system processes the list of operations in ascending nOperId order 
(nOperId 1 first).
szOperation — The name of the digit manipulation operation to perform: 
stripLead, stripTrail, replace, prepend, append.
szValue — The value used by the operation, either the string of digits to 
prepend, append, replace with, or the number of digits to strip.
Sample Solutions 
Using Dial Plan 
Configuration File 
CommandsThis section describes several requirements that a customer might have, 
and for each one, provides a sample solution. An explanation follows 
each step in the solution.
For a detailed explanation of each command, see “Dial Plan 
Configuration File Commands” earlier in this chapter.
Customer Requirement 1.Assume that the telephone company 
passes 4-digit numbers to the NBX system for each incoming telephone 
call (for example, numbers in the range 5200 through 5300). If the 
system uses 3-digit extensions in the range 200 through 300, you could 
define a single pretranslation operation that performed a stripLead to 
remove the first digit. For example, the system could remove the number 
five from an incoming number such as 5278, and pass the call to 
extension 278. 
To accomplish the pretranslation:
PreTranslator Create 1 4-to-3-digit T1 DID/DDI Pretranslator
Explanation: Create pretranslator table 1, called “4-to-3-digit T1 
DID/DDI Pretranslator.”
PreTranslatorEntry Create 1 1 5
Explanation: Create, in pretranslator table 1, entry number 1, which 
applies when the first digit in the sequence is 5.