Table Of Contents

Routing Provisioning

Call Subtype (Release 4.5)

Call Type

Call Type Profile (Release 4.5)

Carrier

Circuit Code

Destination

Dial Plan

Dial Plan Profile

Digit Manipulation

Digit Manipulation Profile

Digit Map

Directory Number to Gateway Number (Release 4.5)

Directory Number to Routing Number (Release 4.5)

International Dial Plan

International Dial Plan Profile

Local Number Portability Profile (Release 4.4.0)

Local Service Area

Local Service Area Profile

Nature of Address Route (Release 4.5)

Nature of Address Route Profile (Release 4.5)

Policy NXX

Policy Origin Dependent Routing

Policy Originating Line Information

Policy Percent

Policy Point of Presence

Policy Prefix

Policy Region

Policy Time of Day

Region Profile

Route

Route Guide

Script (Release 4.5)

Special Call Type

Routing Provisioning

---

Revised: July 24, 2009, OL-3743-42

This chapter describes the Call Agent Routing Provisioning commands and their associated tables.

---

Note In this chapter, an asterisk preceding a token name means the token is mandatory. A token without an asterisk is optional.

---

Call Subtype (Release 4.5)

The Call Type (call-type) table contains the valid call types supported by the Call Agent. It is not provisionable. Only the show command is valid. Specific call-subtypes are linked to a call-type in the Destination table.

Table Name: CALL-SUBTYPE

Table Containment Area: EMS

Command Types

Show

Examples

show call-subtype;

Usage Guidelines

Primary Key Token(s): call-type, call-subtype

Foreign Key Token(s): call-type

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* CALL-TYPE	Primary key. Foreign key: Call Type table. The alpha numeric call type. VARCHAR(16): 1-16 ASCII characters.
CALL-SUBTYPE	Primary key. The subcategory of call type for the dialed digits. VARCHAR(16): 1-16 ASCII characters. (Default = none). See Table 3-1 for valid CALL-SUBTYPE values.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION	Service provider-defined description. VARCHAR(256): 1-256 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Table 3-1 lists the valid call subtypes with their associated call type.

Table 3-1 Valid Call Subtypes  

Call Subtype	Call Type
AMBULANCE	EMG
FIRE
NONE
POLICE
AIRLINES	INFO
NONE
RAILWAYS
TIME
TRAFFIC
TW
WEATHER
NLB-LINE-TEST	TEST-CALL
NCT-LINE-TEST
NLB-TRUNK-TEST
NCT-TRUNK-TEST
TEST-ROUTE
NONE
LB-TEST

Call Type

The Call Type (call-type) table contains the valid call types supported by the Call Agent. It is not provisionable. Only the show command is valid.

Table Name: CALL-TYPE

Table Containment Area: EMS only

Command Types

Show

Examples

show call-type;

Usage Guidelines

Primary Key Token(s): call-type

Syntax Description

* CALL-TYPE	Primary key. Alphanumeric call type. VARCHAR(16): 1-16 ASCII characters. Permitted values are:
	500—Service access code 500, use carrier to route the call.
	700—700 SAC call-route via PIC or dialed CAC.
	900—Service access code 900, use carrier to route the call.
	976—Information service calls.
	AIRLINES—Airlines Information and Reservation.
	AMBULANCE—Ambulance service call.
	ANA—Automatic number announcement. (Release 4.5)
	ATTENDANT—Call to a Centrex attendant.
	BLV—Busy line verification call.
	BUSINESS—811 call to business office.
	CARRIER—OPERATOR—101xxxx+0-, or 00(PIC) call.
	CUT-THRU—Call to user-dialed access code (101xxxx+#).
	DA—411, NPA-555-12121 call to directory assistance.
	DA-TOLL—1+411, 1+NPA-555-1212 toll call to directory assistance.
	EMG—911 emergency calls.
	EXTENSION—Call to another extension within a business group.
	FIRE—Fire department call.
	INFO—Same as 976.
	INTERLATA—InterLATA call that uses PIC or dialed CAC.
	INTL—International call.
	INTL-OPR—International operator call.
	INTL-WZ1—Calls within NANP but outside of calling country
	INVALID—Partial dialed digits that time out.
	LB-TEST—Loopback test call (108 test line).
	LOCAL—7-digit or 10-digit nontoll call.
	LRN—Calls routed by way of Local Routing Number.
	MOBILE—Calls to a mobile network. (Release 4.5)
	NAS—Network access server call.
	NAT-OPR—National operator assisted calls.
	NATIONAL—Call within the United States, use LSA Use LSA and LATA tables to determine if local, toll or destination call. See the Cisco BTS 10200 Softswitch Provisioning Manual for more information.
	NONE—No call type was provisioned into the Cisco BTS 10200 or the given dialing pattern. No data available regarding call type.
	NON-EMG—311 Civic service call.
	NULL—Service activation, deactivation, or interrogation call.
	OPERATOR—0-call.
	PCS—Call to personal communications services line. For service access code 500 use the carrier to route the call.
	POLICE—Police service call.
	PREMIUM—Same as 900.
	RAILWAYS—Railways Information and Reservation
	RELAY—711 relay call.
	REPAIR—611 repair call.
	SPEED-DIAL—Speed-dial call.
	SVC-CODE—Generic service code call type. Use when no other call types apply.
	TANDEM—Tandem call between a CA and the next switch or CA.
	TEST-CALL—Test call dialed as: 958/959-xxxx or 1xx.
	TIME—Time service call.
	TOLL—1+NPA-xxx-xxxx IntraLATA toll call.
	TOLL-FREE—8NN toll-free call (800, 888, 877, 866, 855).
	TRAFFIC—Traffic service call.
	TW—Time and weather call.
	UAN—Universal access number.
	VACANT—Call attempted to an NPA/DN that is currently unassigned.
	WEATHER—Weather service call.
AUTO- REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION	Service provider-defined description. VARCHAR(256): 1-256 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Call Type Profile (Release 4.5)

The Call Type Profile (call-type-profile) table defines the Call Type properties supported by the Cisco BTS 10200 Softswitch. Provision this table if the ALL-CALL-QUERY flag in the LNP-PROFILE table is set to Y and the ACQ-LNP-QUERY token in the Destination table is set to ACQ-BASED-ON-CALL-TYPE.

Table Name: CALL-TYPE-PROFILE

Table Containment Area: Call Agent

Command Types

Show, add, change and delete

Examples

show call-type-profile;

add call-type-profile call-type=mobile; lnp-query=y;

change call-type-profile call-type=mobile; lnp-query=n;

delete call-type-profile call-type=mobile;

Usage Guidelines

Primary Key Token(s): call-type;

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* CALL-TYPE	Primary key. Foreign key: Call Type table. The call type. The valid call types are defined in the Call Type table. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
LNP-QUERY	Specifies whether to perform an LNP query on the call type. Applies only if the all-call-query token in the LNP Profile table is set to Y and the acq-lnp-query token in the Destination table is set to acq-based-on-call-type. CHAR(1): Y/N (Default = Y) Y—Perform an LNP query. N—Do not perform an LNP query.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Carrier

The Carrier (carrier) table defines the characteristics and capabilities supported by interLATA carriers, intraLATA carriers, international carriers, and provides routing information.

---

Note LATA stands for local access transport area. It is predefined by geographical area.

---

Table Name: CARRIER

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show carrier id=2042;

add carrier id=2042;

change carrier id=0288; inter=n;

delete carrier id=2042;

Usage Guidelines

Primary Key Token(s): id

Foreign Key Token(s): route-guide-id, sp-id

Add Rules: carrier id cannot exist.

Change Rules: carrier id must exist.

Delete Rules: carrier id must exist.

Syntax Description

* ID	Primary key. Carrier identification number. CHAR(4): 4 numeric characters: XXXX.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
CASUAL	Specifies whether the carrier supports 101XXXX calls. Carrier provides. CHAR(1): Y/N (Default = Y).
CUT-THRU	Specifies whether the carrier supports 101XXX# calls. With this type of call, the called number is not dialed. Carrier provides. CHAR(1): Y/N (Default = Y).
DESCRIPTION (EMS-only field)	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
INTER	Identifies whether the carrier supports interLATA (long-distance) calls. CHAR(1): Y/N (Default = Y).
INTL	Specifies whether the carrier supports international calls. Carrier provides. CHAR(1): Y/N (Default = N).
INTRA	Identifies whether the carrier supports intraLATA (toll) calls. Carrier provides. CHAR(1): Y/N (Default = N).
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
LNP-QUERY (Not supported for North America—supported for ITU local LNP) (Release 4.5)	Specifies whether the Cisco BTS 10200 Softswitch performs an LNP Query before routing the call using a carrier. CHAR(1): Y/N (Default = N).
OP-SERVICES	Specifies whether the carrier supports operator services. Carrier provides. CHAR(1): Y/N (Default = Y).
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
ROUTE-GUIDE-ID	Foreign key: Route Guide table. Defines the routing data for the carrier. Must match ID in the Route Guide table. VARCHAR(16): 1-16 ASCII characters.
SEND-CN	Send charge number. Specifies whether the carrier requires sending a charge number; used when the charged number is different from the calling number. For example, collect calls. Also specifies whether the type of line that is making the call (OLI: originating line information) must be sent to the carrier. Carrier provides. CHAR(1): Y/N (Default = N) Note Set this token to Y to send the charge number when the billing DN is different from the DN in the Subscriber table and you are using PIC routing.
SEND-CSP	Specifies whether the carrier selection parameter must be sent to the carrier. The CSP identifies how the call was dialed for that carrier—PIC, Casual, Casual-same-as-PIC, and so forth. CHAR(1): Y/N (Default = N).
SP-ID	Foreign key: Service Provider table. Service provider ID associated with a carrier. If the SP-ID is not null, the routing information from the service provider table is used. If the SP-ID is null, then the use-dial-plan flag is checked for routing instructions. VARCHAR(16): 1-16 ASCII characters.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).
STATUS	Status of the carrier. CHAR(3): 1-3 ASCII characters. Permitted values are: OOS (Default)—Out-of-Service. INS—In-Service.
USE-DIAL-PLAN	Specifies whether to use the route guide defined in the Dial Plan table or the route guide defined in the Carrier table. This token is used when the local service provider is also the long-distance service provider. See the Cisco BTS 10200 Softswitch Provisioning Manual for information concerning routing impact. CHAR(1): Y/N (Default = N). Y—Use route guide defined in the Dial Plan table. N—Use route guide defined in the Carrier table.

Circuit Code

The Circuit Code (circuit-code) table defines the circuit code value for the transit network selection (TNS) parameter. The circuit code value is defined based on the line, class of service, and call type. Special circuit code values are assigned to calls from coin or hotel motel lines. If special circuit code values are not required, the default circuit code values are based on the call type sent.

Table Name: CIRCUIT-CODE

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show circuit-code tgn-id=101;

add circuit-code tgn-id=101; nat-cc=9; opr-cc=14; nat-opr-cc=14; sac-cc=9; da-cc=9; 
toll-free-cc=15; intl-cc=1; intl-opr-cc=2; coin-cc=13; hm-cc=13;

change circuit-code tgn-id=101; toll-free-cc=9;

delete circuit-code tgn-id=101;

Usage Guidelines

Primary Key Token(s): tgn-id

Foreign Key Token(s): tgn-id

Add Rules: tgn-id must exist in the Trunk Group table.

Change Rules: None.

Delete Rules: None.

Syntax Description

* TGN-ID (or * TG)	Primary key. Foreign key: Trunk Group table. Trunk group ID. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
* NAT-CC	1+ call. SMALLINT: 0-15.
* OPR-CC	0-, 00 operator call. SMALLINT: 0-15.
* NAT-OPR-CC	0+ call. SMALLINT: 0-15.
* SAC-CC	SAC call (500, 700, 900). SMALLINT: 0-15.
* DA-CC	Directory assistance (DA, DA-TOLL). SMALLINT: 0-15.
* TOLL-FREE-CC	Toll-free call (8XX). SMALLINT: 0-15.
* INTL-CC	011+ international call. SMALLINT: 0-15 (Default = 1).
* INTL-OPR-CC	01+ international operator call. SMALLINT: 0-15 (Default = 2).
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
COIN-CC	Coin line (OLI = 23, 27, 70). SMALLINT: 0-15.
CUT-THRU-CC	101XXXX+#. SMALLINT: 1-15.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
HM-CC	Hotel motel line (OLI = 6). SMALLINT: 0-15.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).
TOLL-CC	IntraLATA calls. SMALLINT: 0-15.
TOLL-OPR-CC	0+ IntraLATA operator calls. If not provisioned, system uses NAT-OPR-CC value. SMALLINT: 0-15.

Destination

The Destination (destination) table defines the call type and the routing information for the dialed digits. Multiple digit strings in the Dial Plan table can use the same destination ID.

Table Name: DESTINATION

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show destination dest-id=dallasaustin;

add destination dest-id=dallasaustin; call-type=toll; route-type=route; 
route-guide-id=rg10; 

change destination dest-id=dallasaustin; route-guide-id=rg11;

delete destination dest-id=dallasaustin;

Usage Guidelines

Primary Key Token(s): dest-id

Foreign Key Token(s): dnis-digman-id, ani-digman-id, route-guide-id, route-id, dial-plan-id, carrier-id, script-id, call-type, call-subtype

Add Rules:

•If call-type=nas, then route-type=none.

•If charge-band is added for one destination id then charge-unit do not datfill for same destination.

Change Rules: None.

Delete Rules:

•ID does not exist in any dial-plan::dest-id.

•ID does not exist in any intl-dial-plan::dest-id.

Syntax Description

* DEST-ID	Primary key. Destination identification. VARCHAR(16): 1-16 ASCII characters.
* ROUTE- TYPE	Routing type. VARCHAR(7): 1-7 ASCII characters. Permitted values are: ANNC—Use annc-id to terminate call. CARRIER—For SAC calls. The call is routed based on the routing specified in the Carrier table. DP—Use dial-plan-id to retranslate based on the new dial plan ID. NONE—No route required. Use for NAS application. RID—Use route-id for routing. ROUTE—Use route-guide-id for routing. SCRIPT—(Not supported) Use a scripting package to terminate a call. Release 4.4.1. SUB—Subscriber termination. Use office code index and last four digits of the DN to find the subscriber.
ACQ-LNP- QUERY (Release 4.5)	Specifies whether an LNP Query is required. Applies only if the all-call-query token is set to Y and lnp-db-type=RN in the LNP Profile table. VARCHAR(32): 1-32 ASCII characters. Permitted values are: NA (Default)—Not applicable. ACQ-BASED-ON-CALL-TYPE—Applies only if lnp-db-type in the LNP Profile table is ACQ. Perform an LNP Query based on definition in the Call Type Profile table. If the call type is not found in the Call Type Profile table, then an LNP Query is not performed. PERFORM-LNP-QUERY—Used when a call type-specific query is not required but LNP criteria is defined based on the destination ID. An LNP query is performed if the all-call-query flag in the LNP Profile table is set to Y. NO-LNP-QUERY—Do not perform an LNP query on this destination.
ANI- DIGMAN-ID	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANNC-ID	Mandatory only if route-type=annc. Announcement ID. SMALLINT: 1-1000.
AUTO- REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
CALL- SUBTYPE (Release 4.5)	Foreign key: Call Type table. Specifies the subcategory of a call type for dialed digits: call-type plus call-subtype. Only one call-type/call-subtype pair is permitted per destination. VARCHAR(16): 1-16 ASCII characters. Permitted values are: Note Any subtype listed in the Call Subtype (Release 4.5) table is permitted. NONE (Default)—No associated subtype, not applicable. If call-type=test-call the following values are permitted: NLB-LINE-TEST—Network loop-back (netwloop) test call on subscriber line endpoint. NCT-LINE-TEST—Network continuity test (netwtest) on subscriber line endpoint. NLB-TRUNK-TEST—Network loop-back (netwloop) test call on trunk endpoint. NCT-TRUNK-TEST—Network continuity (netwtest) test call on trunk endpoint. LB-TEST—TDM Loopback Test Call (108 Test Line) based on test prefix. The calling party number is in format: <test-prefix><TG><TM>. The number of digits in trunk group (trunk-grp number) and trunk member (TM) is determined based on the test-trunk-grp-digits and test-trunk-member-digits values configured in the Call Agent Configuration table. TEST-ROUTE—Route the test call using <DN>. The calling party number is of format <test-prefix><TG><TM><DN>. The number of digits in TG (trunk-grp number) and TM (trunk member) is determined based on the test-trunk-grp-digits and test-trunk-member-digits values configured from Appendix A, "Configurable Parameters and Values" in the Call Agent Configuration table. Note If you are using separate DNs for ambulance, fire, and police service (such as networks outside the U.S.A.), Cisco strongly recommends that you provision these calls with call-type EMG and call-subtype <AMBULANCE or FIRE or POLICE> to guarantee EMG treatment.
CALL-TYPE	Foreign key: Call Subtype table. Type of dialed call. VARCHAR(16): 1-16 ASCII characters (Default = VACANT). Permitted values are: 500—Service access code 500, use carrier to route the call. 700—700 SAC call-route via PIC or dialed CAC. 900—Service access code 900, use carrier to route the call. 976—Information service calls. AIRLINES—Airlines Information and Reservation. AMBULANCE—Ambulance service call. ANA—Automatic number announcement. (Release 4.5) ATTENDANT—Call to a Centrex attendant. BLV—Busy line verification call. BUSINESS—811 call to business office. CARRIER—OPERATOR—101xxxx+0-, or 00(PIC) call. CUT-THRU—Call to user-dialed access code (101xxxx+#). DA—411, NPA-555-12121 call to directory assistance. DA-TOLL—1+411, 1+NPA-555-1212 toll call to directory assistance. EMG—911 emergency calls. EXTENSION—Call to another extension within a business group. FIRE—Fire department call. INFO—Same as 976. INTERLATA—InterLATA call that uses PIC or dialed CAC. INTL-OPR—International operator call. INTL-WZ1—Calls within NANP but outside of calling country INVALID—Partial dialed digits that time out. LB-TEST—Loopback test call (108 test line). LOCAL—7-digit or 10-digit nontoll call. LRN—Calls routed by way of Local Routing Number. MOBILE—Calls to a mobile network. (Release 4.5) NAS—Network access server call. NAT-OPR—National operator assisted calls. NATIONAL—Call within the United States, use LSA Use LSA and LATA tables to determine if local, toll or destination call. See the Cisco BTS 10200 Softswitch Provisioning Manual for more information. NONE—No call type was provisioned into the Cisco BTS 10200 or the given dialing pattern. No data available regarding call type. NON-EMG—311 Civic service call. NULL—Service activation, deactivation, or interrogation call. OPERATOR—0-call. PCS—Call to personal communications services line. For service access code 500 use the carrier to route the call. POLICE—Police service call. PREMIUM—Same as 900. RAILWAYS—Railways Information and Reservation RELAY—711 relay call. REPAIR—611 repair call. SPEED-DIAL—Speed-dial call. SVC-CODE—Generic service code call type. Use when no other call types apply. TANDEM—Tandem call between a CA and the next switch or CA. TEST-CALL—Test call dialed as: 958/959-xxxx or 1xx. TIME—Time service call. TOLL—1+NPA-xxx-xxxx IntraLATA toll call. TOLL-FREE—8NN toll-free call (800, 888, 877, 866, 855). TRAFFIC—Traffic service call. TW—Time and weather call. UAN—Universal access number. VACANT—Call attempted to an NPA/DN that is currently unassigned. WEATHER—Weather service call.
CARRIER-ID	Mandatory only if route-type=carrier. Foreign key: Carrier table. The call is routed to the specified carrier. Used for 900, 500 type calls. Also used to route 800 calls to Access Tandem Server if the Call Agent does not support 800 Service Control Point (SCP) queries. CHAR(4): 4 numeric characters: 0000-9999.
CHARGE- BAND-UNIT (Release 4.5.1)	Defines the parameter value for charge band number/charge unit number in a CRG message. If charge-type is charge-band then the value is charge band number and it is included in the CRG message. If charge-type is charge-unit then the value is the charge unit number and it is included in the CRG message. VARCHAR(2): 00-FF hexadecimal characters (Default = 00).
CHARGE- TYPE (Release 4.5.1)	Defines what kind of action to take in the switch. If charge-type is charge-band then the charge band number is included in CRG message. If charge-type is charge-unit then the charge unit number is included in CRG message. VARCHAR(16): 1-64 ASCII characters (Default = NONE). Permitted values are: CHARGE-BAND—1 CHARGE-UNIT—2 NONE (Default)—0
CLDPTY- CTRL-REL- ALWD	Called party release control allowed indication. Indicates to the Cisco BTS 10200 Softswitch that this call requires called party control. CHAR(1): Y/N (Default = N).
DESCRIP- TION (EMS-only field)	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DIAL-PLAN-ID	Mandatory only if route-type=dp. Foreign key: Dial Plan table. Valid dial plan ID from the Dial Plan table. VARCHAR(16): 1-16 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
DNIS- DIGMAN-ID	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
GAP- ROUTING	If set, and a generic address parameter is present, check if the called number in the GAP parameter is a Call Agent PBX subscriber, based on the Office Code table. CHAR(1): Y/N (Default = N). Y—Check called number in the GAP. N—Do not check called number in the GAP.
INTRA- STATE	Specifies if dialed digits are for an intrastate (toll) destination. CHAR(1): Y/N (Default = Y). Y—Intrastate N—Interstate
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
SCRIPT-ID (Release 4.4.1) (Not supported)	Foreign key: Script table. Specifies a script identifier. A script id is required if route-type=script. The specified script is executed on the end point to perform IVR functions. VARCHAR(16): 1-16 ASCII characters.
ROUTE- GUIDE-ID	Mandatory only if route-type=route. Foreign key: Route Guide table. Valid route guide ID from the Route Guide table. VARCHAR(16): 1-16 ASCII characters.
ROUTE-ID	Mandatory only if route-type=route. Foreign key: Route table. Valid Route ID from the Route table. VARCHAR(16): 1-16 ASCII characters.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).
ZERO-PLUS	Specifies if 0+ calls are allowed. CHAR(1): Y/N (Default = N). Y—0+ calls are allowed to this destination. N—0+ calls are not allowed to this destination.

Dial Plan

Dial plans analyze, screen, and route calls based on dialed digits. The Dial Plan (dial-plan) table holds dial plan information for a specific type of call. It defines valid dialing patterns and determines call routing. All records that share a common dial-plan-profile id are considered a dial plan.

Table Name: DIAL-PLAN

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show dial-plan id=sub; digit-string=972-671;

add dial-plan id=sub; digit-string=972-671; noa=national; dest-id=richardson;

change dial-plan id=sub; digit-string=972-671; noa=national; dest-id=plano;

delete dial-plan id=sub; digit-string=972-671; noa=national; dest-id=plano;

Usage Guidelines

Primary Key Token(s): id, digit-string, noa

Foreign Key Token(s): id, dest-id

Add Rules: dial-plan id cannot exist.

Change Rules: dial-plan id must exist.

Delete Rules: dial-plan id must exist; NOA defaults to unknown. If NOA is other than unknown, NOA is required.

Syntax Description

* ID	Primary key. Foreign key: Dial Plan Profile table. Dial plan ID of a subscriber, trunk group, etc. Assigned by service provider. VARCHAR(16): 1-16 ASCII characters.
* DIGIT-STRING	Primary key. Dialed digits (what was dialed). VARCHAR(16): 1-16 numeric characters entered as NDC-ED-DN.
* DEST-ID	Foreign key: Destination table. Provides the routing information for the dialed number. ID from Destination table. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DEL-DIGITS	Specifies the number of digits to delete from the received digit string. SMALLINT: 0-16 (Default = 0).
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
FORCED (Release 4.5)	Specifies whether the system bypasses the parser rules and allows a user to enter a dial plan record as a free format record (ASCII). CHAR(1): Y/N (Default = N). Y—Allows a user to enter a dial plan record as a free format record (ASCII). N—Does not allow a user to enter a dial plan record as a free format record (ASCII).
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
MAX-DIGITS	Maximum number of digits allowed. SMALLINT: 1-64 (Default = 10).
MIN-DIGITS	Minimum number of digits required for a call. SMALLINT: 1-26 (Default = 10). SMALLINT: 1-64 (Default = 10). (Release 4.5)
NOA	Primary key. Nature of address. Use the Variable Default table to change the default value if required. VARCHAR(16): 1-16 ASCII characters. Permitted values are: NATIONAL (Default)—National Number. SUBSCRIBER—Subscriber Number. UNKNOWN—Nature of address is unknown.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
PFX-DIGITS	Specifies the digits to prefix. VARCHAR(16): 1-16 numeric characters.
SPLIT-NPA	Automatically provisioned when a record is added to the split-NPA table. Applies only to NANP. VARCHAR(7): 1-7 ASCII characters. Permitted values are: OLD-NPA—Dialed number is associated with the old NPA. NEW-NPA—Dialed number is associated with the new NPA. NONE (Default)—Not associated with split NPA.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Dial Plan Profile

The Dial Plan Profile (dial-plan-profile) table creates dial-plan-profile ids before they are assigned to subscribers or trunk groups. The dial-plan-profile id links digit-string entries in the Dial Plan table within a dial plan. Different dial-plan-profile ids are assigned to subscribers and trunk groups. A dial-plan-id must be created in this table before entries can be added to the Dial Plan table.

Table Name: DIAL-PLAN-PROFILE

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show dial-plan-profile id=business;

add dial-plan-profile id=business;  
description=dialing plan for new business users in dallas;

change dial-plan-profile id=business; description=dialing plan for new business users in 
northdallas;

delete dial-plan-profile id=business;

Usage Guidelines

Primary Key Token(s): id

Foreign Key Token(s): intl-dial-plan-id, dnis-digman-id, ani-digman-id, nat-dial-plan-id, noa-route-profile-id

Add Rules: None.

Change Rules: dial-plan-profile id must exist.

Delete Rules:

•ID does not exist in any dial-plan::id.

•ID does not exist in any sub-profile::dial-plan-id.

•ID does not exist in any pop::lnp-dp-id.

•ID does not exist in any trunk-grp::dial-plan-id.

•ID does not exist in any carrier::dial-plan-id.

Syntax Description

* ID	Primary key. Specifies the dial plan profile. A dial plan id is required before a dial plan can be provisioned. VARCHAR(16): 1-16 ASCII characters.
ANI-DIGMAN-ID	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION (EMS-only field)	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
DNIS-DIGMAN-ID	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
INTL-DIAL-PLAN-ID	Foreign key: International Dial Plan Profile table. Specifies which international dial plan ID to use with the dial plan ID. If this field is null, the Call Agent uses the default intl-dial-plan-id values from Appendix A, "Configurable Parameters and Values" in the Call Agent Configuration table. VARCHAR(16): 1-16 ASCII characters.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
NANP-DIAL-PLAN	Specifies whether the dial plan is in North American Number Plan (NANP) format. If it is an NANP dial plan, the EMS enforces NANP rules—the digit string must be in the format NXX-NXX-XXXX. CHAR(1): Y/N (Default = Y). Note If this token is set to N, then the NOA token in the Dial Plan table defaults to UNKNOWN.
NAT-DIAL-PLAN-ID	Foreign key: Dial Plan table. National dial plan ID to use to retranslate dialed digits. This token is used only if the dial plan ID is different from the dial plan profile ID. VARCHAR(16): 1-16 ASCII characters (Default = dial-plan-profile-id).
NOA-BASED- ROUTING (Release 4.5)	Specifies whether Nature of Address based routing is required. CHAR(1): Y/N (Default = N)
NOA-ROUTE- PROFILE-ID (Release 4.5)	Mandatory if noa-based-routing=Y. Foreign key: NOA Route Profile table. Specifies the NOA-specific route id to use for routing. When NOA-based-routing is specified, the NOA is used to index the NOA Route table. If a NOA-specified record is found, processing continues based on the Destination ID specified in the NOA Route table. If no record is found, then the Called Number is translated in the current Dial Plan. VARCHAR(16): 1-16 ASCII characters.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
OVERDECADIC- DIGITS-SUPP (Release 4.5)	Controls provisioning of overdecadic digits in a dial plan. This token can only be set to Y if the nanp-dial-plan token is set to N. CHAR(1): Y/N (Default = N).
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Digit Manipulation

The Digit Manipulation (digman) table is used to perform digit and nature of address (NOA) manipulation.

Table Name: DIGMAN

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show digman id=ndc10; 

add digman id=ndc10; rule=1; match-string=010; replace-string=none;

change digman id=ndc10; rule=1; match-noa=any; replace-noa=subscriber;

delete digman id=ndc10; rule=1;

Usage Guidelines

Primary Key Token(s): id, rule

Foreign Key Token(s): id

Add Rules:

•digman profile id must exist.

•if match-string is not equal to NULL; then replace-string is not equal to NULL.

•if match-noa is not equal to NULL; then replace-noa is not equal to NULL.

Change Rules:

•id must exist.

•if match-string is not equal to NULL; then replace-string is not equal to NULL.

•if match-noa is not equal to NULL; then replace-noa is not equal to NULL.

Delete Rules: None.

Match-string Rules:

•Consist of digits - 0-9, *, #, ^, $, dot(.), question mark (?), Percent (%) or Phrase "none".

•Caret (^) if specified, can only be 1st character of the string.

•Dollar Sign ($) if specified, can only be the last character of the string.

•Percent (%) if specified, can only be 1st character of the string.

•Phrase "none" or "NONE" can only appear by itself.

Syntax Description

* ID	Primary key. Foreign key: Digman Profile table. The digit manipulation ID. Must match ID in the Digit Manipulation Profile table. VARCHAR(16): 1-16 ASCII characters.
* RULE	Primary key. A rule specifies the order in which the rules must be applied. INTEGER: 1-20 numeric characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
MATCH-NOA	Used to match against an input NOA. VARCHAR(16): 1-16 ASCII characters. VARCHAR(40): 1-40 ASCII characters. (Release 4.5) Permitted values are: 950—950 Call ABBR—Abbreviated number ANY—Any NOA CUT-THRU—No number present, cut-thru call INTL—International number INTL-OPR—International Number, Operator Requested (Valid for Called Party Number only) INTL—Unique International Number NATIONAL—Unique National Number NAT-OPR—National Number, Operator Requested (Valid for Called Party Number only) NETWORK—Network NON-UNIQUE-INTL—Non-unique international number (valid for Calling Party number). (Release 4.5) NON-UNIQUE-NATIONAL—Non-unique national number (valid for Calling Party number). (Release 4.5) NON-UNIQUE-SUBSCRIBER—Non-unique subscriber number (valid for Calling Party number). (Release 4.5) NS0—Network specific (111 1000) NS0—Network specific (111 1000) NS1—Network specific (111 1001) NS1—Network specific (111 1001) NS2—Network specific (111 1010) NS2—Network specific (111 1010) NS3—Network specific (111 1011) NS3—Network specific (111 1011) NS4—Network specific (111 1100) NS4—Network specific (111 1100) NS5—Network specific (111 1101) NS5—Network specific (111 1101) NS6—Network specific (111 1110) NS6—Network specific (111 1110) OPERATOR—No Number, Operator Call (Valid for Called Party Number only) PORTED-NUMBER-WITHOUT-RN—The Ported Number maybe prefixed with the network id, or may not be prefixed with anything (DN or NTWK-ID+DN), but does not include the Switch ID. (Release 4.5) PORTED-NUMBER-WITH-RN—The Ported Number is prefixed with the network id and switch id (RN+DN). (Release 4.5) PRIVATE—Private Numbering Plan RESERVED—Reserved NOA SPARE0/SPARE2—Spare. Not Used. SUB-OPR—Subscriber Number, Operator Requested (Valid for Called Party Number only) SUBSCRIBER—Unique Subscriber Number TEST-LINE—Test Line UNKNOWN—Nature of Address is Unknown. VSC—Vertical Service Code
MATCH-STRING	Used to match against the input-string. VARCHAR(40): 1-40 ASCII characters. The characters can be one of the following: Digits (0-9, *, #)—Digits found on a keypad. Dot (.)—Used to indicate the string position at which to perform the match operation. If a dot is specified as the 1st character of the match-string, the digits specified by each dot are skipped until a question mark or a digit is encountered. Can also be used to check the length of the input string. Question mark (?)—Used to specify a wild card character based on its position in the match-string. Each question mark (?) represents 1 digit character. Multiple question marks must be used with another question mark. Percent (%)—Used to specify the Match and Replace function. That is, if a match occurs, replace the matched string with the replace-string. Also used as a wild card character. Caret (^)—Used to specify beginning of a string when specific leading digits are to be deleted or replaced. Also used when prefixing digits to the input string. Dollar sign ($)—Used to search from the end of a string backwards instead of from the beginning. Also used when digits are to be appended to the end of the string; deleted or replaced from the end of the string. NONE—the actual word.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
REPLACE-NOA	If a match on NOA is found, the input NOA is replaced with the NOA specified in this token. VARCHAR(16): 1-16 ASCII characters. VARCHAR(32): 1-32 ASCII characters. (Release 4.5) Permitted values are: 950—950 Call ABBR—Abbreviated number CUT-THRU—No number present, cut-thru call INTL—International number INTL-OPR—International Number, Operator Requested (Valid for Called Party Number only) INTL—Unique International Number NATIONAL—Unique National Number NAT-OPR—National Number, Operator Requested (Valid for Called Party Number only) NETWORK—Network NON-UNIQUE-INTL—Non-unique international number (valid for Calling Party number). (Release 4.5) NON-UNIQUE-NATIONAL—Non-unique national number (valid for Calling Party number). (Release 4.5) NON-UNIQUE-SUBSCRIBER—Non-unique subscriber number (valid for Calling Party number). (Release 4.5) NS0—Network specific (111 1000) NS0—Network specific (111 1000) NS1—Network specific (111 1001) NS1—Network specific (111 1001) NS2—Network specific (111 1010) NS2—Network specific (111 1010) NS3—Network specific (111 1011) NS3—Network specific (111 1011) NS4—Network specific (111 1100) NS4—Network specific (111 1100) NS5—Network specific (111 1101) NS5—Network specific (111 1101) NS6—Network specific (111 1110) NS6—Network specific (111 1110) OPERATOR—No Number, Operator Call (Valid for Called Party Number only) PORTED-NUMBER-WITHOUT-RN—The Ported Number maybe prefixed with the network id, or may not be prefixed with anything (DN or NTWK-ID+DN), but does not include the Switch ID. (Release 4.5) PORTED-NUMBER-WITH-RN—The Ported Number is prefixed with the network id and switch id (RN+DN). (Release 4.5) PRIVATE—Private Numbering Plan RESERVED—Reserved NOA SPARE0/SPARE2—Spare. Not Used. SUB-OPR—Subscriber Number, Operator Requested (Valid for Called Party Number only) SUBSCRIBER—Unique Subscriber Number TEST-LINE—Test Line UNKNOWN—Nature of Address is Unknown. VSC—Vertical Service Code
REPLACE-STRING	If a match is found, the matched string is replaced with the replace-string. VARCHAR(40): 1-40 ASCII characters. The characters can be one of the following: Digits (A-F, 0-9, *, #) Ampersand (&) NONE (the actual word)
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Digit Manipulation Profile

The Digit Manipulation Profile (digman-profile) table is used to create unique IDs for digit manipulation. This ID must be created before provisioning the Digit Manipulation table.

Table Name: DIGMAN-PROFILE

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show digman-profile id=ndc10; 

add digman-profile id=ndc10; description=Subscriber ANI manipulation digman id;

change digman-profile id=ndc10; description=Subscriber ANI manipulation digman id for 
ndc10;

delete digman-profile id=ndc10;

Usage Guidelines

Primary Key Token(s): id

Add Rules: digman-profile id cannot exist.

Change Rules: digman-profile id must exist.

Delete Rules: digman-profile id must exist.

Syntax Description

* ID	Primary key. The digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Digit Map

The Digit Map (digit-map) table tells a media gateway (MGW) how to collect and report dialed digits. The Call Agent uses a default digit-map id for normal digit collection unless a specific digit map ID is assigned to the subscriber. There are two types of subscribers:

•POTS (individual/residential)

•Centrex (business group)

POTS subscribers use a public dialing plan. Centrex subscribers use a customized dialing plan.

Example:

add digit-map id=default; 
digit-pattern=0T|00|[2-9]11|[2-9]xx[2-9]xxxxxx|1[2-9]xx[2-9]xxxxxx| 
0[2-9]xx[2-9]xxxxxx|011xxxxxx.T|01xxxxxx.T|101xxxx|#|*xx|xxxxxxxxxxxxxxxxxxx;

Table 3-2 describes the components of a digit map that is created by issuing the add digit-map command.

Table 3-2 Component Breakdown of Add Digit Map Command

Component	Description
# 0T	Operator call (0-)
# 00	Carrier operator (00)
# [2-9]11	N11 dialing
# 0[2-9]11	0+N11 dialing (0+911)
# 1[2-9]11	1+N11 dialing (1+911, 1+411)
# [2-9]xx[2-9]xxxxxx	10-digit Local in HNPA (972, 973)
# 1[2-9]xx[2-9]xxxxxx	1+ 10 digit
# 0[2-9]xx[2-9]xxxxxx	0+ 10 digit
# 011xxxxxx.T	IDDD, minimum 6 digits
# 01xxxxxx.T	Operator-assisted IDDD, minimum 6 digits
# 101xxxx	Casual dialing
# "#"	End of dialing or cut-through
# *xx	Vertical service code
# xxxxxxxxxxxxxxxxxxx	Maximum digit string (19 digits = 011+16 digits for international call)
Digit-pattern = 0T T starts 4-second timing. But if digits are dialed within that 4 seconds, that digit pattern is skipped. If no digits are dialed within 4 seconds, or the pound sign (#) is pressed, then end-of-dial is assumed and a match occurs with the specified digit pattern. The collected digits are reported to the Call Agent. Example: 0T indicates that match occurs only if user only dials digit 0 (with 4-second time out) or user dials 0#. A # indicates to cancel 4-second timing and report digits immediately. Digit-pattern = x.T In this table, T also starts 4-second timing. The dot represents any number of digits. The gateway keeps collecting digits until either 4 seconds elapses between digits or until the pound sign (#) is pressed.

Table Name: DIGIT-MAP

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show digit-map id=default;

add digit-map id=default; 
digit-pattern=0T|00|[2-9]11|[2-9]xx[2-9]xxxxxx|1[2-9]xx[2-9]xxxxxx| 
0[2-9]xx[2-9]xxxxxx|011xxxxxx.T|01xxxxxx.T|101xxxx|#|*xx|11xx|xxxxxxxxxxxxxxxxxxx;

change digit-map id=default; digit-pattern=1xxx|0T|[2-9]11;

delete digit-map id=default;

Usage Guidelines

Primary Key Token(s): id

Add Rules: None.

Change Rules: None.

Delete Rules:

•ID does not exist in any pop::digit-map-id.

•ID does not exist in any sub-profile::digit-map-id.

---

Note This table is case-sensitive.

---

Syntax Description

* ID	Primary key. Assigned by service provider to identify a specific digit map. VARCHAR(16): 1-16 ASCII characters.
* DIGIT-PATTERN	Specifies all possible digit patterns. Each digit pattern is separated by a vertical line ( | ). See Media Gateway Control Protocol (MGCP) RFC 2705 for further details. VARCHAR(1023): 1-1023 ASCII characters. VARCHAR(2048): 1-2048 ASCII characters. (Release 4.5)
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION (EMS-only field)	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Directory Number to Gateway Number (Release 4.5)

The Directory Number (DN) to Gateway Number (GN) (dn2gn) table defines the DN to GN LNP database on the Cisco BTS 10200 Softswitch.

Table Name: DN2GN

Table Containment Area: AIN-FS

Command Types

Show, add, and delete

Examples

show dn2gn dn=022-233-1234;

add dn2gn dn=022-233-1234; gn=099-991-5000;

delete dn2gn dn=022-233-1234;

Usage Guidelines

Primary Key Token(s): dn

Unique Key (UK): gn

Add Rules: None.

Delete Rules: None.

Syntax Description

* DN	Primary key. Specifies the DN of the ported subscriber. VARCHAR(14): 1-14 ASCII characters.
* GN	Unique key. Specifies the GN associated with the ported subscriber. The format of GN is similar to a DN and must be unique per DN. VARCHAR(14): 1-14 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Directory Number to Routing Number (Release 4.5)

The Directory Number (DN) to Routing Number (RN) (dn2rn) table defines the DN to RN LNP Database on the Cisco BTS 10200 Softswitch. If Centralized Routing Data supports a range of DNs, the Cisco BTS 10200 Softswitch generates individual records per DN.

Table Name: DN2RN

Table Containment Area: AIN-FS

Command Types

Show, add, change, and delete

Examples

show dn2rn dn=022-233-1234;

show dn2rn from-dn=022-233-1100; to-dn=022-233-1199;

show dn2rn start-time=yyyy-mm-dd; end-time=yyyy-mm-dd; (causes all records where valid-to 
is with the specified date or earlier to be displayed)

add dn2rn dn=022-233-1234; valid-from=2005-8-3 18:00:00; rn=d9012;

add dn2rn from-dn=022-233-1100; to-dn=022-233-1199; rn=d9012;

change dn2rn dn=022-233-1234; rn=d9012; valid-to=2005-12-31 18:00:00;

change dn2rn dn=022-233-1234; rn=d9012; forced=y;

change dn2rn from-dn=022-233-1100; to-dn=022-233-1199; rn=d111;

delete  dn2rn dn=022-233-1234; rn=d9012;

delete dn2rn from-dn=022-233-1100; to-dn=022-233-1199; rn=d111;

delete dn2rn start-time=2004-1-1; end-time=12-31-2004; forced=y; 

Usage Guidelines

Primary Key Token(s): dn; rn

Add Rules: forced is not allowed during add.

Change Rules: forced is allowed only for change.

Delete Rules: None.

---

Note When a range is specified, the range is restricted to 100 or 1000 DNs at a time. Throttling is done by the mediation device.

---

Syntax Description

* DN	Primary key. Specifies the DN of the ported subscriber. VARCHAR(14): 1-14 ASCII characters.
* RN	Primary key. Specifies the Routing Number associated with the ported subscriber. VARCHAR(14): 1-14 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
END-TIME	Allowed only for show and delete. Specifies an end time to show or delete a range of records that were created or modified based on the valid-to token. DATE: YYYY-MM-DD.
FORCED	Allowed only for change. Adds a record if it does not exist or changes an existing record.. CHAR(1): Y/N (Default = N). Y—Adds a record that does not exist; changes an existing record. N—Does not add a record that does not exist; does not change an existing record.
FROM-DN	Used for range provisioning. When specified, all DNs in the from-dn and to-dn range are provisioned in the DN2RN table. VARCHAR(14): 1-14 ASCII characters.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).
START-TIME	Allowed only for show and delete. Delete allowed only if valid-to toke is <> null. Specifies a start time to show or delete a range of records that were created or modified based on the valid-to token. Start-time must occur before end-time. DATE: YYYY-MM-DD.
TO-DN	Used for range provisioning. When specified, all DNs in the from-dn and to-dn range are provisioned in the DN2RN table. VARCHAR(14): 1-14 ASCII characters.
VALID-FROM	Specifies the start time of the porting window when the subscriber is considered ported. DATE The DN2RN record is active if: the valid-from is less than or equal to the current-time less than or equal to the valid-to or the valid-from equals the null and the current-time is less than the valid-to or the valid-from is less than the current-time and the valid-to is equal to null or the valid-from is equal to the valid-to equal to null.
VALID-TO	Specifies the end time that this record expires or is invalid. DATE The DN2RN record is active if: the valid-from is less than or equal to the current-time less than or equal to the valid-to or the valid-from equals null and the current-time equals the valid-to or the valid-from equals the current-time and the valid-to equals null or the valid-from equals the valid-to equals null.

International Dial Plan

The International Dial Plan (intl-dial-plan) table holds international dial plan information for calls to regions outside the North American Numbering Plan (NANP). It contains the country code, minimum and maximum digits, the country name, and the route-grp-id.

Table Name: INTL-DIAL-PLAN

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show intl-dial-plan id=intldp1; cc=122;

add intl-dial-plan id=intldp1; cc=122; min-digits=7; max-digits=10;

change intl-dial-planid=intldp1; cc=122; description=France;

delete intl-dial-plan id=intldp1;cc=122;

Usage Guidelines

Primary Key Token(s): id, cc

Foreign Key Token(s): id, dest-id

Add Rules: intl-dial-plan-profile id must exist.

Change Rules: id must exist.

Delete Rules: None.

Syntax Description

* ID	Primary key. Foreign key: International Dial Plan Profile table. International dial plan profile ID. VARCHAR(16): 1-16 ASCII characters.
* CC	Primary key. Country code digits. Country code as defined in ITU-T Recommendation E.164. Service provider must determine and enter accordingly. This information is often found in the front of some telephone directories. See Recommendation E.164. VARCHAR(5): 1-5 numeric characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION (EMS-only field)	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DEST-ID	Foreign key: Destination table. Used only if the service provider is also a carrier and wants to route the international call to the appropriate gateway. VARCHAR(16): 1-16 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
MAX-DIGITS	Maximum number of digits allowed. Maximum number of digits for any phone number in the country being added. SMALLINT: 3-64 (Default = 16).
MIN-DIGITS	Minimum number of digits required for a call to this country. Minimum number of digits for any phone number in the country being added. SMALLINT: 3-16 (Default = 6). SMALLINT: 3-64 (Default = 6). (Release 4.5)
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
PADDED-CC (Release 4.5.1)	Used to pad country code (cc) digits. Automatically generated by EMS if not provisioned. If 1 digit cc, pad cc with 2 zeros (2 becomes 002) If 2 digit cc, pad cc with 1 zero (44 becomes 044). If 3 digit cc, no padding required, copy as is. If cc > 3 digits, copy the first 3 digits. STRING: 3 numeric characters.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

International Dial Plan Profile

The International Dial Plan Profile (intl-dial-plan-profile) table is used to create unique IDs for international dial plans. This ID must be created before provisioning the International Dial Plan table.

Table Name: INTL-DIAL-PLAN-PROFILE

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show intl-dial-plan-profile id=pop1;

add intl-dial-plan-profile id=pop1; description=default International Dialing plan for 
Call Agent;

change intl-dial-plan-profile id=pop1; description=International Dialing plan for POP1;

delete intl-dial-plan-profile id=pop1;

Usage Guidelines

Primary Key Token(s): id

Add Rules: None.

Change Rules: None.

Delete Rules: Id does not exist in any: dial-plan::id; sub-profile::dial-plan-id; pop::lnp-dp-id; trunk-grp::dial-plan-id; or carrier::dial-plan-id.

Syntax Description

* ID	Primary key. Unique ID for this international dial plan profile. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION (EMS-only field)	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Local Number Portability Profile (Release 4.4.0)

The Local Number Portability (LNP) Profile (lnp-profile) table defines an LNP Profile supported by the Cisco BTS 10200 Softswitch.

Table Name: LNP-PROFILE

Table Containment Area: Call Agent, FSAIN

Command Types

Show, add, change and delete

Examples

show lnp-profile id=default;

add lnp-profile id=default; lnp-db-type=GN; internal-lnp-db=Y; all-call-query=N; 
onward-call-routing=Y; 

change lnp-profile id=default; all-call-query=Y; onward-call-routing=N;

delete lnp-profile id=default;

Usage Guidelines

Primary Key Token(s): id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* ID	Primary key. The LNP Profile ID. The LNP Profile id to use as defined in the Call Agent Configuration table. VARCHAR(16): 1-16 ASCII characters.
* LNP-DB-TYPE	Specifies the LNP database type supported on the Cisco BTS 10200 Softswitch. VARCHAR(16): 1-16 ASCII characters. Permitted values are: LRN—LRN-based LNP support. The call is routed based on the LRN, but the called number is carried in the GAP parameter. Note If lnp-db-type=LRN, then internal-lnp-db=N and external-lnp-db=Y. GN—GN (Gateway Number)-based LNP as used in Hong Kong. Each ported number is assigned a unique number based on the network the call is ported to. When the call reaches a recipient switch, a reverse lookup is made from the GN to find the actual DN to terminate the call. RN—Routing Number (RN)-based LNP. The call to the ported-out subscriber is routed to a specified network by prefixing the RN to the called number or by signaling it in the ISUP message. (Release 4.5) CF—Call Forwarding-based LNP. The Donor switch looks up the new number assigned to the ported-out subscriber and the call is forwarded to the new number.
ALL-CALL-QUERY	Specifies whether to perform an LNP query on all calls. CHAR(1): Y/N (Default = N). Y—An LNP query is required for all calls. N—An LNP query is not required for all calls.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
EXTERNAL-LNP-DB	Specifies the Cisco BTS 10200 Softswitch external LNP Database where an external LNP query is required. CHAR(1): Y/N (Default = N). Note If both the internal-lnp-db and external-lnp-db are set to Y, then the internal-lnp-db lookup occurs first. If an entry is not found, it then performs an external-lnp-db lookup. Note If lnp-db-type=RN, then external-lnp-db=N. (Release 4.5)
INTERNAL-LNP-DB	Specifies the Cisco BTS 10200 Softswitch local LNP database. CHAR(1): Y / N (Default = N). Note If both the internal-lnp-db and external-lnp-db are set to Y, then the internal-lnp-db lookup occurs first. If an entry is not found, it then performs an external-lnp-db lookup. Note If lnp-db-type=RN, then internal-lnp-db=Y. (Release 4.5)
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ONWARD-CALL- ROUTING (Not used in Release 4.4.0/1.)	Specifies whether the LNP type is Onward Call Routing (OCR). CHAR(1): Y/N (Default = N). Y—When the call reaches the donor switch, the switch performs an LNP lookup and routes the call towards recipient switch based on the LNP type. N—The LNP type is not OCR.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
QUERY-ON-RELEASE	Specifies whether the LNP type is Query On Release (QOR). CHAR(1): Y/N (Default = N). Y—If release-cause=ported number is received at the originating Cisco BTS 10200 Softswitch, then LNP Query is to be performed. N—The LNP type is not QOR.
RELEASE-CAUSE	Specifies whether to use a release cause when a called number is ported-out. In the United States, when a call to a ported number is received, the switch sends a release cause of 26 indicating a "misrouted ported number" call. In the EMEA market, when an LNP using QOR is deployed, a release cause (usually 14 but can be different depending on the country variant) indicating "call to a ported number" is sent. INTEGER: 0-255 (Default = 26) Note If lnp-db-type=LRN, this token defaults to 26. If lnp-db-type is not LRN, this token defaults to 14. (Release 4.5) 26—Misrouted call to a ported number. 14—Ported number.
RN-SIGNALING- METHOD (Release 4.5)	Specifies the RN signaling between networks. This field is not used when a signaling call is within the network. VARCHAR(32): 1-32 ASCII characters. Permitted values are: NA (Default)—Not Applicable. If lnp-db-type=RN you cannot set method to NA. PREFIX-METHOD—The RN is prefixed to the Called Party Number. The call is routed based on the RN+DN. SEPARATE-RN (Not used)—The RN and DN are sent separately. Similar to U.S., where the LRN is sent as a Called Party Number while the Ported Number is signaled in the GAP.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Local Service Area

The Local Service Area (lsa) table provides extended local service. If a North American Numbering Plan (NANP) dialed call results in an intraLATA toll or an interLATA call, and the subscriber has an lsa-id associated in either the Subscriber Profile or POP table, the LSA table is screened to check if the dialed digits appear in the subscriber LSA area. If the dialed digits are found in the LSA table, the call is converted to a local call.

---

Note If an lsa-id is defined in the Subscriber Profile table, it is used. If an lsa-id is not defined, then the lsa-id assigned in the POP table is used.

---

Table Name: LSA

Table Containment Area: Call Agent

Command Types

Show, add, and delete

Examples

show lsa id=1; digit-string=972-671;

add lsa id=1; digit-string=972-671;

delete lsa id=1; digit-string=972-671;

Usage Guidelines

Primary Key Token(s): id, digit-string

Foreign Key Token(s): id

Add Rules: lsa-profile id must exist.

Delete Rules: None.

Syntax Description

* ID	Primary key. Foreign key: LSA Profile table. Specifies the LSA ID. VARCHAR(16): 1-16 ASCII characters.
* DIGIT-STRING	Primary key. Digit string to be converted to a local call. VARCHAR(14): 1-14 numeric digits. Format NPA, NPA-NXX, NPA-NXX-X, or NPA-NXX-XX.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Local Service Area Profile

The Local Service Area (LSA) Profile (lsa-profile) table defines new LSA IDs before they are assigned to subscribers. An ID must be created in this table before entries can be added to the Local Service Area table.

Table Name: LSA-PROFILE

Table Containment Area: EMS

Command Types

Show, add, change, and delete

Examples

show lsa-profile id=1;lsa=atlantalsa;

add lsa-profile id=1; lsa=atlantalsa; lsa-id=1; description=local service area for 
atlanta;

change lsa-profile id=1;description=local service area for atlanta and near suburbs;

delete lsa-profile id=1

Usage Guidelines

Primary Key Token(s): id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* ID	Primary key. Specifies the LSA ID. Assigned by service provider. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION (EMS-only field)	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Nature of Address Route (Release 4.5)

The Nature of Address (NOA) Route (noa-route) table defines NOA-based routing on the Cisco BTS 10200 Softswitch. When the NOA-based routing is specified in the Dial Plan Profile table the Cisco BTS 10200 Softswitch uses the received NOA to index the NOA Route table and determine the destination id for further routing. The destination id can point to a specific route based on the NOA or it can point to a dial plan. When a destination id points to a dial plan, the received called party number is translated using the dial plan.

Table Name: NOA-ROUTE

Table Containment Area: Call Agent

Command Types

Show, add, change and delete

Examples

show noa-route;

add noa-route id=NoaRt; noa=ported-number; dest-id=lnpDP

change noa-route id=NoaRt; noa=ported-number; dest-id=RnDp

delete noa-route id=NoaRt; noa=ported-number;

Usage Guidelines

Primary Key Token(s): id, noa

Foreign Key Token(s): id, dest-id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* ID	Primary key. Foreign key: NOA Route Profile table. The NOA Route Profile id. VARCHAR(16): 1-16 ASCII characters.
* NOA	Primary key. The Nature of Address. VARCHAR(32): 1-32 ASCII characters. Permitted values are: PORTED-NUMBER-WITH-RN—The ported number is prefixed with Network ID and Switch ID (RN+DN). PORTED-NUMBER-WITHOUT-RN—The ported number may be prefixed with a Network ID, or may not be prefixed with anything (DN or NTWK-ID plus the DN), but does not include the switch id.
* DEST-ID	Foreign key: Destination table. The destination id associated with the received NOA. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Nature of Address Route Profile (Release 4.5)

The Nature of Address (NOA) Route Profile (noa-route-profile) table is used to support NOA-based routing on the Cisco BTS10200 Softswitch. This profile defines the NOA route id. The id can be assigned to a single Dial Plan Profile table or multiple Dial Plan Profile tables.

Table Name: NOA-ROUTE-PROFILE

Table Containment Area: Call Agent

Command Types

Show, add, change and delete

Examples

show noa-route-profile;

add noa-route-profile id=NoaRt;

change noa-route-profile id=NoaRt; description=noa specific route profile ID

delete noa-route-profile id=NoaRt;

Usage Guidelines

Primary Key Token(s): id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* ID	Primary key. The NOA Route Profile id. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Policy NXX

The Policy NXX (policy-nxx) table is used when a number services call results in a translated number, carrier ID, translated number and a carrier ID, or a route ID.

Table Name: POLICY-NXX

Table Containment Area: Call Agent (Not used), AIN Feature Server

Command Types

Show, add, change, and delete

Examples

show policy-nxx id=normalroute; 

add policy-nxx id=normalroute; 

change policy-nxx id=normalroute; carrier=1234;

delete policy-nxx id=normalroute;

Usage Guidelines

Primary Key Token(s): id

Add Rules: policy-id exists in policy-<policy-type>::id if entered.

Change Rules: policy-id exists in policy-<policy-type>::id if entered.

Delete Rules: ID cannot exist in any <route-guide, policy-odr, policy-region, policy-percent, policy-tod, policy-prefix, policy-oli, or policy-pop>::policy-id where policy-type = nxx.

---

Note Both the carrier and the translated-dn can be entered; however, if route is entered, neither the carrier-id nor the translated-dn can be entered.

---

Syntax Description

* ID	Primary key. Policy-nxx identification field. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
CARRIER	Carrier identification code (CIC). Used for routing a call. CHAR(4): 0000-9999. See Carrier.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
ROUTE	Defines a list of trunk groups. VARCHAR(16): 1-16 ASCII characters.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).
TRANSLATED-DN	The call is routed to the translated DN. VARCHAR(14): 1-14 numeric digits.

Policy Origin Dependent Routing

The Policy Origin Dependent Routing (policy-odr) table is used for origin-dependent routing. The NPA (or NPA-NXX) of the calling party number selects a route. If no match is found based on the calling party number, the route marked as default routes the call.

Table Name: POLICY-ODR

Table Containment Area: Call Agent, AIN Feature Server

Command Types

Show, add, change, and delete

Examples

show policy-odr id=ca200; digit-string=512;

add policy-odr id=ca200; digit-string=512; policy-type=tod; policy-id=tod101;

change policy-odr id=ca200; digit-string=512; policy-type=tod; policy-id=tod102;

delete policy-odr id=ca200; digit-string=512;

Usage Guidelines

Primary Key Token(s): id, digit-string

Add Rules: policy-id exists in policy-<policy-type>::id if entered.

Change Rules: policy-id exists in policy-<policy-type>::id if entered.

Delete Rules: id does not exist in any <route-guide, policy-region, policy-percent, policy-tod, policy-prefix, policy-oli, or policy-pop>::policy-id where policy-type = odr.

Syntax Description

* ID	Primary key. Policy-odr identification field. Assigned by service provider. VARCHAR(16): 1-16 ASCII characters.
* POLICY-TYPE	Points to the next policy type table to use in the sequence. Policy routing continues until policy-type=route or policy-nxx is reached. All policy-types except route point to the Policy-$type table where $type = odr | tod | percent | prefix | oli | pop | nxx. If policy-type = route, the Route table is used for routing. The policy-id indexes the Policy or Route table, whatever the case may be. VARCHAR(7): 1-7 ASCII characters. Permitted values are: TOD—Time-of-day routing. PERCENT—Percent allocation. PREFIX—Prefix-based routing. OLI —Originating line information. POP—Point of presence. ROUTE—Go to Route table. NXX—Use translated DN. REGION—Region-based routing.
* POLICY-ID	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
DIGIT-STRING	Primary key. Longest match based on the calling party number. VARCHAR(10): 1-10 ASCII characters in the format NDC+EC+DN or DEFAULT. Use the character string default to define a default route for the specified ID. If a record based on the calling party number is not found, the Call Agent searches for the default record.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Policy Originating Line Information

The Policy Originating Line Information (policy-oli) table performs routing based on the originating line information of the calling party number.

Table Name: POLICY-OLI

Table Containment Area: Call Agent, AIN Feature Server

Command Types

Show, add, change, and delete

Examples

show policy-oli id=normalroute; oli=00;

add policy-oli id=normalroute; oli=00; policy-type=tod; policy-id=holiday;

change policy-oli id=normalroute; oli=00; policy-type=tod; policy-id=regular;

delete policy-oli id=normalroute; oli=00;

Usage Guidelines

Primary Key Token(s): id, oli

Add Rules: policy-id exists in policy-<policy-type>::id if entered.

Change Rules: policy-id exists in policy-<policy-type>::id if entered.

Delete Rules: id does not exist in any <route-guide, policy-odr, policy-region, policy-percent, policy-tod, policy-prefix, or policy-pop>::policy-id where policy-type = oli.

Syntax Description

* ID	Primary key. Originating line information identification field. Assigned by service provider. VARCHAR(16): 1-16 ASCII characters.
* OLI	Primary key. Originating line information parameter. SMALLINT: 0-99 or 255. OLI = 255 defines default route for the specified ID. If a record based on the calling party OLI is not found, the Call Agent searches for the default record based on OLI = 255.
* POLICY-ID	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
* POLICY-TYPE	Points to the next policy type table to be used in the sequence. Policy routing continues until policy-type=route or policy-nxx is reached. All policy-types except route point to the Policy-$type table where $type = odr | tod | percent | prefix | oli | pop | nxx. If policy-type = route, the Route table is used for routing. The policy-id indexes the Policy or Route table, whatever the case may be. Examples: If policy-type=tod, then the policy-tod table is indexed with policy-id. If policy-type=route, then the route table is indexed with policy-id. VARCHAR(7): 1-7 ASCII characters. Permitted values are: ODR—Origin dependent routing. TOD—Time-of-day routing. PERCENT—Percent allocation. PREFIX—Prefix-based routing. POP—Point of presence. ROUTE—Go to Route table. NXX—Use translated DN. REGION—Region-based routing.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Policy Percent

The Policy Percent (policy-percent) table distributes traffic based on percent allocation. This type of traffic distribution is used primarily for local 8XX routing and Tandem applications.

Table Name: POLICY-PERCENT

Table Containment Area: Call Agent, AIN Feature Server

Command Types

Show, add, change, and delete

Examples

show policy-percent id=texaspercent; 

add policy-percent id=texaspercent; begin-range1=1; end-range1=90; policy-type1=tod; 
policy-id1=tod001;

change policy-percent id=texaspercent; begin-range2=91; end-range2=100; policy-type1=tod; 
policy-id1=tod002;

delete policy-percent id=texaspercent;

Usage Guidelines

Primary Key Token(s): id

Add Rules: policy-id exists in policy-<policy-type>::id if entered.

Change Rules: policy-id exists in policy-<policy-type>::id if entered.

Delete Rules: id does not exist in any <route-guide, policy-odr, policy-region, policy-tod, policy-prefix, policy-oli, or policy-pop>::policy-id where policy-type = percent.

Syntax Description

* ID	Primary key. Unique identifier for this policy-percent. Assigned by service provider. VARCHAR(16): 1-16 ASCII characters.
* BEGIN-RANGE1	At least one range must be specified. Defines the beginning percent range (beginning and ending percents) for the first destination. SMALLINT: 1-100.
* END-RANGE1	Defines the end of the percent range (beginning and ending percents) for the first destination. SMALLINT: 1-100.
* POLICY-TYPE1	Points to the next policy type table to be used in the sequence. Policy routing continues until policy-type=route or Policy-nxx is reached. All policy-types except route point to the Policy-$type table where $type = odr | tod | percent | prefix | oli | pop | nxx. If policy-type = route, the Route table is used for routing. The policy-id indexes the Policy or Route table, whatever the case may be. Examples: If policy-type=tod, then the policy-tod table is indexed with policy-id. If policy-type=route, then the route table is indexed with policy-id. VARCHAR(7): 1-7 ASCII characters. Permitted values are: ODR—Origin-dependent routing. TOD—Time-of-day routing. PREFIX—Prefix-based routing. OLI—Originating line information. POP—Point of presence. ROUTE—Go to Route table. NXX—Use translated DN. REGION—Region-based routing.
* POLICY-ID1	ID of the Policy or Route table matching the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
BEGIN-RANGE2	Defines the beginning percent range (beginning and ending percents) for the second destination. SMALLINT: 1-100.
BEGIN-RANGE3	Defines the beginning percent range (beginning and ending percents) for the third destination. SMALLINT: 1-100.
BEGIN-RANGE4	Defines the beginning percent range (beginning and ending percents) for the fourth destination. SMALLINT: 1-100.
BEGIN-RANGE4	Defines the beginning percent range (beginning and ending percents) for the fourth destination. SMALLINT: 1-100.
BEGIN-RANGE5	Defines the beginning percent range (beginning and ending percents) for the fifth destination. SMALLINT: 1-100.
DEFAULT-POLICY-ID	ID of a Policy or Route table matching the policy type. Indexes the ID to the type. Assigned by service provider. VARCHAR(16): 1-16 ASCII characters.
DEFAULT-POLICY- TYPE	See policy-type1. If default treatment is not specified, CLI copies the range1 information here. VARCHAR(7): 1-7 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
END-RANGE2	Defines the end of the percent range (beginning and ending percents) for the second destination. SMALLINT: 1-100.
END-RANGE3	Defines the end of the percent range (beginning and ending percents) for the third destination. SMALLINT: 1-100.
END-RANGE4	Defines the end of the percent range (beginning and ending percents) for the fourth destination. SMALLINT: 1-100.
END-RANGE5	Defines the end of the percent range (beginning and ending percents) for the fifth destination. SMALLINT: 1-100.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
POLICY-ID2	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID3	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID4	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID5	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-TYPE2	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE3	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE4	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE5	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Policy Point of Presence

The Policy Point of Presence (policy-pop) (POP) based policy routing routes a call to the nearest trunk group when there are multiple trunk groups. There are several situations where a policy POP can be used. If a Call Agent serves several POPs, each POP can have its own announcement server. A POP-specific announcement server can be more efficient than a centralized announcement server. InterLATA carriers also have a point of presence in each POP. Route interLATA or international calls to the nearest carrier location using policy POP routing.

Table Name: POLICY-POP

Table Containment Area: Call Agent, AIN Feature Server

Command Types

Show, add, change, and delete

Examples

show policy-pop id=car9999; pop-id=dallaspop;

add policy-pop id=car9999; pop-id=dallaspop; policy-type=tod; policy-id=tod101;

change policy-pop id=car9999;pop-id=dallaspop;policy-type=oli;policy-id=tod101;

delete policy-pop id=car9999;

Usage Guidelines

Primary Key Token(s): id, pop-id

Add Rules: policy-id exists in policy-<policy-type>::id if entered.

Change Rules: policy-id exists in policy-<policy-type>::id if entered.

Delete Rules: id does not exist in any <route-guide, policy-odr, policy-region, policy-percent, policy-tod, policy-prefix, or policy-oli>::policy-id where policy-type = pop.

Syntax Description

* ID	Primary key. Policy POP identifier. VARCHAR(16): 1-16 ASCII characters.
* POP-ID	Primary key. The pop-id assigned to the subscriber profile or the incoming trunk group to be used. VARCHAR(16): 1-16 ASCII characters.
* POLICY-TYPE	Points to the next policy type table to be used in the sequence. Policy routing continues until policy-type=route or policy-nxx is reached. All policy-types except route point to the policy-$type table where $type = odr | tod | percent | prefix | oli | pop | nxx. If policy-type = route, the Route table is used for routing. The policy-id indexes the Policy or Route table, whatever the case may be. Examples: If policy-type=tod, then the Policy TOD table is indexed with policy-id. If policy-type=route, then the Route table is indexed with policy-id. VARCHAR(7): 1-7 ASCII characters. Permitted values are: ODR—Origin dependent routing. TOD—Time of day routing. PERCENT—Percent allocation. PREFIX—Prefix-based routing. OLI—Originating line information. ROUTE—To Route table. NXX—Use translated DN. REGION—Region-based routing.
* POLICY-ID	ID of the Policy or Route table that matches the next policy type. Indexes the ID to the type. VARCHAR (16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Policy Prefix

The Policy Prefix (policy-prefix) table provides information for call routing based on prefix (type of call). Typical call types include 1+ dialing, international calls, toll-free, and so on. This table is used mainly for carrier routing.

Table Name: POLICY-PREFIX

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show policy-prefix id=standard; 

add policy-prefix id=standard; prefix1=national; policy-type1=tod; policy-id1=tod01;

change policy-prefix id=standard; prefix2=da; policy-type=tod; policy-id=tod99;

delete policy-prefix id=standard; 

Usage Guidelines

Primary Key Token(s): id

Add Rules: policy-id exists in policy-<policy-type>::id if entered.

Change Rules: policy-id exists in policy-<policy-type>::id if entered.

Delete Rules: id does not exist in any <route-guide, policy-odr, policy-region, policy-percent, policy-tod, policy-oli, or policy-pop>::policy-id where policy-type = prefix.

Syntax Description

* ID	Primary key. Unique identifier for this policy prefix. VARCHAR(16): 1-16 ASCII characters.
* PREFIX1	Type of call being provisioned. VARCHAR(10): 1-10 ASCII characters. Permitted values are: NATIONAL—National call (1+) INTL—International call (011+) OPERATOR—Operator call (0-, 00) NAT-OPR—National operator call (0+ call) INTL-OPR—International operator call (01+ call) TOLL-FREE—Toll free call (8XX) CUT-THRU—Cut-through call (101XXXX+#) DA—Directory assistance call
* POLICY-TYPE1	Points to the next policy type table to be used in the sequence. Policy routing continues until policy-type=route or policy-nxx is reached. All policy-types except route point to the Policy-$type table where $type = odr | tod | percent | prefix | oli | pop | nxx. If policy-type = route, the Route table is used for routing. The policy-id indexes the Policy or Route table, whatever the case may be. Examples: If policy-type=tod, then the Policy-tod table is indexed with policy-id. If policy-type=route, then Route table is indexed with policy-id. VARCHAR(7): 1-7 ASCII characters. Permitted values are: ODR—Origin-dependent routing. TOD—Time of day routing. PERCENT—Percent allocation. OLI—Originating line information. POP—Point of presence. ROUTE—Go to Route table. NXX—Use translated DN. REGION—Region-based routing.
* POLICY-ID1	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DEFAULT-POLICY-ID	Assigned by service provider. VARCHAR(16): 1-16 ASCII characters.
DEFAULT-POLICY- TYPE	Use default policy type/ID if the prefix does not match any of the above prefixes. Assigned by service provider. VARCHAR(7): 1-7 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
POLICY-ID2	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID3	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID4	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID5	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID6	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID7	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID8	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID9	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID10	See policy-id1. VARCHAR(16): 1-16 ASCII characters.
POLICY-TYPE10	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE2	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE3	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE4	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE5	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE6	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE7	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE8	See policy-type1. ARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE9	See policy-type1. VARCHAR(7): 1-7 ASCII characters.
PREFIX10	See prefix1. VARCHAR(10): 1-10 ASCII characters.
PREFIX2	See prefix1. VARCHAR(10): 1-10 ASCII characters.
PREFIX3	See prefix1. VARCHAR(10): 1-10 ASCII characters.
PREFIX4	See prefix1. VARCHAR(10): 1-10 ASCII characters.
PREFIX5	See prefix1. VARCHAR(10): 1-10 ASCII characters.
PREFIX6	See prefix1. VARCHAR(10): 1-10 ASCII characters.
PREFIX7	See prefix1. VARCHAR(10): 1-10 ASCII characters.
PREFIX8	See prefix1. VARCHAR(10): 1-10 ASCII characters.
PREFIX9	See prefix1. VARCHAR(10): 1-10 ASCII characters.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Policy Region

The Policy Region (policy-region) table performs region-based routing. The region is derived using the Region Profile table from the Route Guide table and the calling party number automatic number identification (ANI). If ANI is not available or the Region Profile table is not provisioned, the region assigned to the trunk group is used for trunk origination. If a record cannot be found based on the region, the record with region=default (if provisioned) is used for routing.

Table Name: POLICY-REGION

Table Containment Area: Call Agent, AIN Feature Server

Command Types

Show, add, change, and delete

Examples

show policy-region id=ca200; region=sanantonio;

add policy-region id=ca200; region=sanantonio; policy-type=tod; policy-id=tod101;

change policy-region id=ca200; region=sanantonio; policy-type=tod; policy-id=tod102;

delete policy-region id=ca200; region=sanantonio;

Usage Guidelines

Primary Key Token(s): id, region

Add Rules: region-profile id must exist; policy-id exists in policy-<policy-type>::id if entered.

Change Rules: id must exist; policy-id exists in policy-<policy-type>::id if entered.

Delete Rules: id does not exist in any <route-guide, policy-odr, policy-percent, policy-tod, policy-prefix, policy-oli, or policy-pop>::policy-id where policy-type = region.

Syntax Description

* ID	Primary key. Identifier of the policy region. VARCHAR(16): 1-16 ASCII characters.
* REGION	Primary key. Region is derived from the Region Profile table based on the ANI. If the region cannot be derived from the region-profile, use the region assigned to the incoming trunk group. If a region is not available, use the default region to route the call. VARCHAR(16): 1-16 ASCII characters. The character string default defines the default route for the specified ID. If a record based on the region based on the calling party number or incoming trunk group is not found, the Call Agent searches for the default record.
* POLICY-TYPE	Points to the next policy type table to be used in the sequence. Policy routing continues until policy-type=route or policy-nxx is reached. All policy-types except route point to the Policy-$type table where $type = odr | tod | percent | prefix | oli | pop | nxx. If policy-type = route, the Route table is used for routing. The policy-id indexes the Policy or Route table, whatever the case may be. Examples: If policy-type=tod, then the Policy TOD table is indexed with the policy-id. If policy-type=route, then the Route table is indexed with the policy-id. VARCHAR(7): 1-7 ASCII characters. Permitted values are: ODR—Origin-dependent routing. TOD—Time of day routing. PERCENT—Percent allocation. PREFIX—Prefix-based routing. OLI—Originating line information. POP—Point of presence. ROUTE—Go to Route table. NXX—Use translated DN.
* POLICY-ID	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Policy Time of Day

The Policy Time of Day (policy-tod) table provides routing information based on the following values, in order of preference (highest preference to lowest):

•day of year

•day of week

•time of day

Table Name: POLICY-TOD

Table Containment Area: Call Agent, AIN Feature Server

Command Types

Show, add, change, and delete

Examples

show policy-tod id=basictime; 

add policy-tod id=basictime; doy1=03-01; doy1-policy-type=route; 
doy1-policy-id=dallasaustin; start-dow1=mon;  
stop-dow1=fri; start-time1=07:00; stop-time1=17:00; policy-type1=per; 
policy-id1=texaspercent; 
default-policy-type=route; default-policy-id=dallasaustin;

change policy-tod id=basictime; doy2=07-04; 

delete policy-tod id= basictime; 

Usage Guidelines

Primary Key Token(s): id

Add Rules: policy-id exists in policy-<policy-type>::id if entered.

Change Rules: policy-id exists in policy-<policy-type>::id if entered.

Delete Rules: id does not exist in any <route-guide, policy-odr, policy-region, policy-percent, policy-tod, policy-prefix, policy-oli, or policy-pop>::policy-id where policy-type = tod.

Syntax Description

* ID	Primary key. Unique identifier for this policy-tod. Assigned by service provider. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DEFAULT-POLICY-ID	Use default policy ID when there is no match with the above schedule. Assigned by service provider. VARCHAR(16): 1-16 ASCII characters.
DEFAULT-POLICY- TYPE	Use default policy type when there is no match with the above schedule. VARCHAR(7): 1-7 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
DOY1	Month and day (day of year provisioning). CHAR(5): 5 characters in the format mm-dd.
DOY10	Month and day (day of year provisioning). CHAR(5): 5 characters in the format mm-dd.
DOY10-POLICY-ID	See DOY1-POLICY-ID. VARCHAR(16): 1-16 ASCII characters.
DOY10-POLICY- TYPE	See DOY1-POLICY-TYPE. VARCHAR(7): 1-7 ASCII characters.
DOY1-POLICY-ID	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. Points to the next policy type table to be used in the sequence. Policy routing continues until policy-type=route or policy-nxx is reached. All policy-types except route point to the policy-$type table where $type = odr | tod | percent | prefix | oli | pop | nxx. If policy-type = route, the route table is used for routing. The policy-id indexes the Policy or Route table, whatever the case may be. Examples: If policy-type=tod, then policy-tod table is indexed with policy-id. If policy-type=route, then Route table is indexed with policy-id. VARCHAR(16): 1-16 ASCII characters.
DOY1-POLICY-TYPE	Points to the next policy type table to be used in the sequence. Policy routing continues until policy-type=route or policy-nxx is reached. All policy-types except route point to the policy-$type table where $type = odr | tod | percent | prefix | oli | pop | nxx. If policy-type = route, the route table is used for routing. The policy-id indexes the Policy or Route table, whatever the case may be. Examples: If policy-type=tod, then policy-tod table is indexed with policy-id. If policy-type=route, then Route table is indexed with policy-id. VARCHAR(7): 1-7 ASCII characters. Permitted values are: ODR—Origin-dependent routing. TOD—Time of day routing. PERCENT—Percent allocation. PREFIX—Prefix-based routing. OLI—Originating line information. POP—Point of presence. ROUTE—Go to Route table. NXX—Use translated DN. REGION—Region-based routing.
DOY2	Month and day (day of year provisioning). CHAR(5): 5 characters in the format mm-dd.
DOY2-POLICY-ID	See DOY1-POLICY-ID. VARCHAR(16): 1-16 ASCII characters.
DOY2-POLICY-TYPE	See DOY1-POLICY-TYPE. VARCHAR(7): 1-7 ASCII characters.
DOY3	Month and day (day of year provisioning). CHAR(5): 5 characters in the format mm-dd.
DOY3-POLICY-ID	See DOY1-POLICY-ID. VARCHAR(16): 1-16 ASCII characters.
DOY3-POLICY-TYPE	See DOY1-POLICY-TYPE. VARCHAR(7): 1-7 ASCII characters.
DOY4	Month and day (day of year provisioning). CHAR(5): 5 characters in the format mm-dd.
DOY4-POLICY-ID	See DOY1-POLICY-ID. VARCHAR(16): 1-16 ASCII characters.
DOY4-POLICY-TYPE	See DOY1-POLICY-TYPE. VARCHAR(7): 1-7 ASCII characters.
DOY5	Month and day (day of year provisioning). CHAR(5): 5 characters in the format mm-dd.
DOY5-POLICY-ID	See DOY1-POLICY-ID. VARCHAR(16): 1-16 ASCII characters.
DOY5-POLICY-TYPE	See DOY1-POLICY-TYPE. VARCHAR(7): 1-7 ASCII characters.
DOY6	Month and day (day of year provisioning). CHAR(5): 5 characters in the format mm-dd.
DOY6-POLICY-ID	See DOY1-POLICY-ID. VARCHAR(16): 1-16 ASCII characters.
DOY6-POLICY-TYPE	See DOY1-POLICY-TYPE. VARCHAR(7): 1-7 ASCII characters.
DOY7	Month and day (day of year provisioning). CHAR(5): 5 characters in the format mm-dd.
DOY7-POLICY-ID	See DOY1-POLICY-ID. VARCHAR(16): 1-16 ASCII characters.
DOY7-POLICY-TYPE	See DOY1-POLICY-TYPE. VARCHAR(7): 1-7 ASCII characters.
DOY8	Month and day (day of year provisioning). CHAR(5): 5 characters in the format mm-dd.
DOY8-POLICY-ID	See DOY1-POLICY-ID. VARCHAR(16): 1-16 ASCII characters.
DOY8-POLICY-TYPE	See DOY1-POLICY-TYPE. VARCHAR(7): 1-7 ASCII characters.
DOY9	Month and day (day of year provisioning). CHAR(5): 5 characters in the format mm-dd.
DOY9-POLICY-ID	See DOY1-POLICY-ID. VARCHAR(16): 1-16 ASCII characters.
DOY9-POLICY-TYPE	See DOY1-POLICY-TYPE. VARCHAR(7): 1-7 ASCII characters.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
POLICY-ID1	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID10	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID2	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID3	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID4	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID5	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID6	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters
POLICY-ID7	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR (16): 1-16 ASCII characters.
POLICY-ID8	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
POLICY-ID9	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
POLICY-TYPE1	Points to the next policy type table to be used in the sequence. Policy routing continues until policy-type=route or policy-nxx is reached. All policy-types except route point to the policy-$type table where $type = odr | tod | percent | prefix | oli | pop | nxx. If policy-type = route, the route table is used for routing. The policy-id indexes the Policy or Route table, whatever the case may be. Examples: If policy-type=tod, then policy-tod table is indexed with policy-id. If policy-type=route, then Route table is indexed with policy-id. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE10	See POLICY-TYPE1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE2	See POLICY-TYPE1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE3	See POLICY-TYPE1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE4	See POLICY-TYPE1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE5	See POLICY-TYPE1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE6	See POLICY-TYPE1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE7	See POLICY-TYPE1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE8	See POLICY-TYPE1. VARCHAR(7): 1-7 ASCII characters.
POLICY-TYPE9	See POLICY-TYPE1. VARCHAR(7): 1-7 ASCII characters.
START-DOW1	Day of week that this policy begins (day of week provisioning). Start-dow1 and stop-dow1 define a range of days. The DOW begins on MON and ends on SUN, such as when specifying range, START-DOWn £ STOP-DOWn. CHAR(3). Permitted values are: MON—Monday TUE—Tuesday WED—Wednesday THU—Thursday FRI—Friday SAT—Saturday SUN—Sunday Examples: START-DOW1=MON; STOP-DOW1=FRI; is valid. START-DOW1=FRI; STOP-DOW1=MON; is invalid.
START-DOW10	See START-DOW1.
START-DOW2	See START-DOW1.
START-DOW3	See START-DOW1.
START-DOW4	See START-DOW1.
START-DOW5	See START-DOW1.
START-DOW6	See START-DOW1.
START-DOW7	See START-DOW1.
START-DOW8	See START-DOW1.
START-DOW9	See START-DOW1.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).
START-TIME1	The time in hours and minutes (24-hour clock) that this policy starts (time of day provisioning). CHAR(5): HH:MM.
START-TIME10	The time in hours and minutes (24-hour clock) that this policy starts (time of day provisioning). CHAR(5): HH:MM.
START-TIME2	The time in hours and minutes (24-hour clock) that this policy starts (time of day provisioning). CHAR(5): HH:MM
START-TIME3	The time in hours and minutes (24-hour clock) that this policy starts (time of day provisioning). CHAR(5): HH:MM
START-TIME4	The time in hours and minutes (24-hour clock) that this policy starts (time of day provisioning). CHAR(5): HH:MM
START-TIME5	The time in hours and minutes (24-hour clock) that this policy starts (time of day provisioning). CHAR(5): HH:MM
START-TIME6	The time in hours and minutes (24-hour clock) that this policy starts (time of day provisioning). CHAR(5): HH:MM
START-TIME7	The time in hours and minutes (24-hour clock) that this policy starts (time of day provisioning). CHAR(5): HH:MM
START-TIME8	The time in hours and minutes (24-hour clock) that this policy starts (time of day provisioning). CHAR(5): HH:MM
START-TIME9	The time in hours and minutes (24-hour clock) that this policy starts (time of day provisioning). CHAR(5): HH:MM
STOP-DOW1	Day of week that this policy ends. Start-dow1 and stop-dow1 define a range of days. The DOW begins on MON and ends on SUN, such as when specifying range, START-DOWn £ STOP-DOWn. CHAR(3). Permitted values are: MON—Monday TUE—Tuesday WED—Wednesday THU—Thursday FRI—Friday SAT—Saturday SUN—Sunday Examples: START-DOW1=MON; STOP-DOW1=FRI; is valid. START-DOW1=FRI; STOP-DOW1=MON; is invalid.
STOP-DOW10	See STOP-DOW1.
STOP-DOW2	See STOP-DOW1.
STOP-DOW3	See STOP-DOW1.
STOP-DOW4	See STOP-DOW1.
STOP-DOW5	See STOP-DOW1.
STOP-DOW6	See STOP-DOW1.
STOP-DOW7	See STOP-DOW1.
STOP-DOW8	See STOP-DOW1.
STOP-DOW9	See STOP-DOW1.
STOP-TIME1	The time in hours and minutes (24-hour clock) that this policy ends (time of day provisioning). CHAR(5): HH:MM
STOP-TIME10	The time in hours and minutes (24-hour clock) that this policy ends (time of day provisioning). CHAR(5): HH:MM.
STOP-TIME2	The time in hours and minutes (24-hour clock) that this policy ends (time of day provisioning). CHAR(5): HH:MM
STOP-TIME3	The time in hours and minutes (24-hour clock) that this policy ends (time of day provisioning). CHAR(5): HH:MM
STOP-TIME4	The time in hours and minutes (24-hour clock) that this policy ends (time of day provisioning). CHAR(5): HH:MM
STOP-TIME5	The time in hours and minutes (24-hour clock) that this policy ends (time of day provisioning). CHAR(5): HH:MM
STOP-TIME6	The time in hours and minutes (24-hour clock) that this policy ends (time of day provisioning). CHAR(5): HH:MM
STOP-TIME7	The time in hours and minutes (24-hour clock) that this policy ends (time of day provisioning). CHAR(5): HH:MM
STOP-TIME8	The time in hours and minutes (24-hour clock) that this policy ends (time of day provisioning). CHAR(5): HH:MM
STOP-TIME9	The time in hours and minutes (24-hour clock) that this policy ends (time of day provisioning). CHAR(5): HH:MM

Region Profile

The Region Profile (region-profile) table groups North American Numbering Plan (NANP) digits to an originating region. You can have many ID and digit-string combinations for a given region. In this conceptual relationship, a number of digit patterns (digit-string) can belong to a given region and a number of originating regions comprise a region profile (id). Use the value specified in the ca-config record as the default region where type=default-region.

Table Name: region-profile

Table Containment Area: Call Agent, AIN Feature Server

Command Types

Show, add, change, and delete

Examples

show region-profile id=e911; digit-string=210-470;

add region-profile id=e911; digit-string=210-470; region=sanantonio;

change region-profile id=e911; digit-string=210-470; region=sanantonio;

delete region-profile id=e911; digit-string=210-470;

Usage Guidelines

Primary Key Token(s): id, digit-string

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* ID	Primary key. Region profile ID. VARCHAR(16): 1-16 ASCII characters.
* DIGIT-STRING	Primary key. NDC-EC-XXXX to be assigned to a region. VARCHAR(14): 1-14 numeric characters.
* REGION	Region assigned to the calling party number. VARCHAR(16): 1-16 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Route

The Route (route) table contains a list of up to ten trunk groups to route a call. If all the trunk groups are busy or not available, call processing uses the alt-route-id (if specified) to route the call. The Element Management System (EMS) provisions the Call Agent ID field based on the Trunk Group table.

---

Note This table allows the service provider to provision a list of up to10 trunk groups (TG1 to TG10), and a parameter for selecting the priority of the TGs for routing (TG-SELECTION). The system attempts to route the call on the highest priority TG. If the call cannot be completed on the highest priority TG, the system attempts to use the next (lower priority) TG, a process known as route advance. The system attempts route advance to lower priority TGs up to five times. (Any TG in the list that is administratively out of service is not counted as an attempt.) If all five attempts fail, the call is released, and the system provides a release announcement.

---

Table Name: route

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show route id=dallas1;

add route id=dallas1; tgn1-id=dallas-tg; pfx-digits1=972; del-digits1=0;

change route id=dallas1; del-digits1=3;

delete route id=dallas1;

Usage Guidelines

Primary Key Token(s): id

Foreign Key Token(s): alt-route-id, call-agent-id1, tgn1-id, dnis-digman-id1, ani-digman-id1, call-agent-id2, tgn2-id, dnis-digman-id2, ani-digman-id2, call-agent-id3, tgn3-id, dnis-digman-id3, ani-digman-id3, call-agent-id4, tgn4-id, dnis-digman-id4, ani-digman-id4, call-agent-id5, tgn5-id, dnis-digman-id5, ani-digman-id5, call-agent-id6, tgn6-id, dnis-digman-id6, ani-digman-id6, call-agent-id7, tgn7-id, dnis-digman-id7, ani-digman-id7, call-agent-id8, tgn8-id, dnis-digman-id8, ani-digman-id8, call-agent-id9, tgn9-id, dnis-digman-id9, ani-digman-id9, call-agent-id10, tgn10-id, dnis-digman-id10, ani-digman-id10

Add Rules: None.

Change Rules: None.

Delete Rules: id does not exist in any <route-guide, policy-odr, policy-region, policy-percent, policy-tod, policy-prefix, policy-oli, or policy-pop>::policy-id where policy-type = route.

Syntax Description

* ID	Primary key. The route identification. VARCHAR(16): 1-16 ASCII characters.
ALT-ROUTE-ID	Foreign key: Route table. An alternate route to be used if all the trunk groups in this route are busy. VARCHAR(16): 1-16 ASCII characters. Note This token is mandatory in Release 4.5 if next-action=alt-route.
ANI-DIGMAN-ID1	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANI-DIGMAN-ID10	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANI-DIGMAN-ID2	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANI-DIGMAN-ID3	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANI-DIGMAN-ID4	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANI-DIGMAN-ID5	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANI-DIGMAN-ID6	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANI-DIGMAN-ID7	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANI-DIGMAN-ID8	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANI-DIGMAN-ID9	Foreign key: Digman Profile table. ANI (calling party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
ANNC-ID (Release 4.5)	Mandatory if next-action=annc. Foreign key: Announcement table. Announcement id. INTEGER: 1-1000 numeric digits.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
CALL-AGENT-ID1 (Not used)	Foreign key: Call Agent table. Valid home Call Agent ID for the dialed NPA or NPA-NXX. VARCHAR(8): 1-8 ASCII characters.
CALL-AGENT-ID2 (Not used)	Foreign key: Call Agent table. Home Call Agent ID for the dialed NPA or NPA-NXX. VARCHAR(8): 1-8 ASCII characters.
CALL-AGENT-ID3 (Not used)	Foreign key: Call Agent table. Valid home Call Agent ID for the dialed NPA or NPA-NXX. VARCHAR(8): 1-8 ASCII characters.
CALL-AGENT-ID4 (Not used)	Foreign key: Call Agent table. Valid home Call Agent ID for the dialed NPA or NPA-NXX. VARCHAR(8): 1-8 ASCII characters.
CALL-AGENT-ID5 (Not used)	Foreign key: Call Agent table. Home Call Agent ID for the dialed NPA or NPA-NXX. VARCHAR(8): 1-8 ASCII characters.
CALL-AGENT-ID6 (Not used)	Foreign key: Call Agent table. Home Call Agent ID for the dialed NPA or NPA-NXX. VARCHAR(8): 1-8 ASCII characters.
CALL-AGENT-ID7 (Not used)	Foreign key: Call Agent table. Valid home Call Agent ID for the dialed NPA or NPA-NXX. VARCHAR(8): 1-8 ASCII characters.
CALL-AGENT-ID8 (Not used)	Foreign key: Call Agent table. Valid home Call Agent ID for the dialed NPA or NPA-NXX. VARCHAR(8): 1-8 ASCII characters.
CALL-AGENT-ID9 (Not used)	Foreign key: Call Agent table. Valid home Call Agent ID for the dialed NPA or NPA-NXX. VARCHAR(8): 1-8 ASCII characters.
CALL-AGENT-ID10 (Not used)	Foreign key: Call Agent table. Valid home Call Agent ID for the dialed NPA or NPA-NXX. VARCHAR(8): 1-8 ASCII characters.
DEL-DIGITS1	Number of digits to delete. SMALLINT: 0-16 (Default = 0).
DEL-DIGITS10	Number of digits to delete. SMALLINT: 0-10 (Default = 0).
DEL-DIGITS2	Number of digits to delete. SMALLINT: 0-16 (Default = 0).
DEL-DIGITS3	Number of digits to delete. SMALLINT: 0-16 (Default = 0).
DEL-DIGITS4	Number of digits to delete. SMALLINT: 0-16 (Default = 0).
DEL-DIGITS5	Number of digits to delete. SMALLINT: 0-16 (Default = 0).
DEL-DIGITS6	Number of digits to delete. SMALLINT: 0-16 (Default = 0).
DEL-DIGITS7	Number of digits to delete. SMALLINT: 0-16 (Default = 0).
DEL-DIGITS8	Number of digits to delete. SMALLINT: 0-16 (Default = 0)
DEL-DIGITS9	Number of digits to delete. SMALLINT: 0-16 (Default = 0).
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
DNIS-DIGMAN-ID1	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
DNIS-DIGMAN-ID10	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
DNIS-DIGMAN-ID2	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
DNIS-DIGMAN-ID3	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
DNIS-DIGMAN-ID4	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
DNIS-DIGMAN-ID5	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
DNIS-DIGMAN-ID6	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
DNIS-DIGMAN-ID7	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
DNIS-DIGMAN-ID8	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
DNIS-DIGMAN-ID9	Foreign key: Digman Profile table. DNIS (called party number) digit manipulation ID. VARCHAR(16): 1-16 ASCII characters.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
NEXT-ACTION (Release 4.5)	Specifies what action to perform after all trunk groups within a route are exhausted. VARCHAR(16): 1-16 ASCII characters. Permitted values are: NONE (Default)—No next action. Play standard no route to destination announcement. ALT-ROUTE—Use alternate route. ANNC—Use the specific announcement ID OVERFLOW-DN (Not used)—Reroute the call using the overflow DN. ENUM-REROUTE—Reroute the call if the route is based on ENUM.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
OVERFLOW-DN (Not supported)	Mandatory if next-action=overflow-dn. Specifies using the overflow DN to reroute a call if no trunk groups are available. VARCHAR(14): 1-14 ASCII characters.
PFX-DIGITS1	Digits to be prefixed. Digits are prefixed after the number of specified digits are deleted. VARCHAR(16): 1-16 ASCII characters.
PFX-DIGITS10	Digits to be prefixed for tgn10-id. Digits are prefixed after the number of digits specified have been deleted. VARCHAR(16): 1-16 ASCII characters.
PFX-DIGITS2	Digits to be prefixed for tgn2-id. Digits are prefixed after the number of specified digits are deleted. VARCHAR(16): 1-16 ASCII characters.
PFX-DIGITS3	Digits to be prefixed for tgn3-id. Digits are prefixed after the number of specified digits are deleted. VARCHAR(16): 1-16 ASCII characters.
PFX-DIGITS4	Digits to be prefixed for tgn4-id. Digits are prefixed after the number of specified digits are deleted. VARCHAR(16): 1-16 ASCII characters.
PFX-DIGITS5	Digits to be prefixed for tgn5-id. Digits are prefixed after the number of specified digits are deleted. VARCHAR(16): 1-16 ASCII characters.
PFX-DIGITS6	Digits to be prefixed for tgn6-id. Digits are prefixed after the number of specified digits are deleted. VARCHAR(16): 1-16 ASCII characters.
PFX-DIGITS7	Digits to be prefixed for tgn7-id. Digits are prefixed after the number of specified digits are deleted. VARCHAR(16): 1-16 ASCII characters.
PFX-DIGITS8	Digits to be prefixed for tgn8-id. Digits are prefixed after the number of specified digits are deleted. VARCHAR(16): 1-16 ASCII characters.
PFX-DIGITS9	Digits to be prefixed for tgn9-id. Digits are prefixed after the number of specified digits are deleted. VARCHAR(16): 1-16 ASCII characters.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).
TGN1-ID (or TG1)	Foreign key: Trunk Group table. The first trunk group within the route. The trunk groups are searched in the order specified unless least cost routing (LCR) applies. If LCR is applied, the Call Agent reads the cost for each trunk group from the trunk-grp table and selects trunks from the least expensive trunk group to the most expensive one. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
TGN2-ID (or TG2)	Foreign key: Trunk Group table. The second trunk group within the route. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
TGN3-ID (or TG3)	Foreign key: Trunk Group table. The third trunk group within the route. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
TGN4-ID (or TG4)	Foreign key: Trunk Group table. The fourth trunk group within the route. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
TGN5-ID (or TG5)	Foreign key: Trunk Group table. The fifth trunk group within the route. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
TGN6-ID (or TG6)	Foreign key: Trunk Group table. The sixth trunk group within the route. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
TGN7-ID (or TG7)	Foreign key: Trunk Group table. The seventh trunk group within the route. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
TGN8-ID (or TG8)	Foreign key: Trunk Group table. The eighth trunk group within the route. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
TGN9-ID (or TG9)	Foreign key: Trunk Group table. The ninth trunk group within the route. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
TGN10-ID (or TG10)	Foreign key: Trunk Group table. The tenth trunk group within the route. This field can also be provisioned using tg instead of tgn-id. The EMS looks up the tgn-id based on the trunk group and then provisions it. INTEGER: 1-99999999.
TG-SELECTION	Trunk group selection policy. VARCHAR(3). Permitted values are: LCR—Least cost routing LS—Load sharing (Not used) RR—Round robin SEQ (Default)—Sequential order

Route Guide

The Route Guide (route-guide) table holds routing information based on policy-type.

Table Name: ROUTE-GUIDE

Table Containment Area: Call Agent, AIN Feature Server

Command Types

Show, add, change, and delete

Examples

show route-guide id=rg200;

add route-guide id=rg200; policy-type=tod; policy-id=tod101;

change route-guide id=rg200; policy-type=tod; policy-id=tod102;

delete route-guide id=rg200;

Usage Guidelines

Primary Key Token(s): id

Add Rules: policy-id exists in policy-<policy-type>::id if entered.

Change Rules: policy-id exists in policy-<policy-type>::id if entered.

Delete Rules: None.

Syntax Description

* ID	Primary key. Route guide identification. VARCHAR(16): 1-16 ASCII characters.
* POLICY-ID	ID of the Policy or Route table that matches the policy type. Indexes the ID to the type. VARCHAR(16): 1-16 ASCII characters.
* POLICY-TYPE	Points to the next policy type table to be used in the sequence. Policy routing continues until policy-type=route or policy-nxx is reached. All policy-types except route point to the Policy-$type table where $type = odr | tod | percent | prefix | oli | pop | nxx. If policy-type = route, the Route table is used for routing. The policy-id indexes the Policy or Route table, whatever the case may be. Examples: If policy-type=tod, then policy-tod table is indexed with policy-id. If policy-type=route, then Route table is indexed with policy-id. VARCHAR(7). Permitted values are: ODR—Origin-dependent routing. TOD—Time of day routing. PERCENT—Percent allocation. PREFIX—Prefix-based routing. OLI—Originating line information. POP—Point of presence. ROUTE—Go to Route table. NXX—Use translated DN. REGION—-based routing.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
REGION-PROFILE-ID	The region profile ID is used to convert an ANI (calling party number) to a region if region-based policy routing is encountered. VARCHAR(16): 1-16 ASCII characters.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Script (Release 4.5)

The Script (script) table defines the attributes of a script. A script is sent to the gateway for IVR functions.

Table Name: SCRIPT

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show script id=prepaid;

add script id=prepaid; type=vxml; url=tftp://prepaid-script.vxml; 
language=English;pin-length=12;

change script id=DallasAustin; route-guide-id=rg11;

delete script id=DallasAustin;

Usage Guidelines

Primary Key Token(s): id

Foreign Key Token(s): language-id

Add Rules: None.

Change Rules: None.

Delete Rules: FK constraints.

Syntax Description

* ID	Primary key. Identifies the script. A script id is required if route-type=script. The specified script is executed on the end point to perform IVR functions. VARCHAR(16): 1-16 ASCII characters.
* TYPE	Defines the script type. VARCHAR(8): 1-8 ASCII characters. Permitted values are: TCL VXML PERL XML TYPE1 (spare) TYPE2 (spare)
* URL	The URL of the script. VARCHAR(128): 1-128 ASCII characters.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION (EMS-only field)	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LANGUAGE-ID	Foreign key: Language table. Language in which the script is to be played. For language abbreviations, refer to ISO standard ISO 639.2. VARCHAR(3): 1-3 ASCII characters.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
PIN-LENGTH	Number of PIN digits to collect. 0 indicates no PIN is collected. SMALLINT: 0-24.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).

Special Call Type

The Special Call Type (special-call-type) table specifies special call types based on special NXX such as 976, 555, and so on.

For example, a service provider who needs to change all NPA-555 call types to DA or DA-TOLL defines the changes in this table.

If only a limited number of Numbering Plan Areas (NPAs) or specific NPAs must be assigned a call type of DA, they are provisioned using the Destination table.

This table is preprovisioned during installation with the parameters described in Table 3-3.

Table 3-3 Special Call Type Preprovisioned Parameters

Digit String	Call Type	Description
5551212	DA-TOLL	Directory assistance (DA) toll calls.
976	976	Information services call types.

Table Name: SPECIAL-CALL-TYPE

Table Containment Area: Call Agent

Command Types

Show, add, change, and delete

Examples

show special-call-type digit-string=976;

add special-call-type digit-string=976; call-type=976; description=976 call type;

change special-call-type digit-string=976; call-type=INFO; description=change call type to 
a generic call type;

delete special-call-type digit-string=976; call-type=INFO

Usage Guidelines

Primary Key Token(s): digit-string

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* DIGIT-STRING	Primary key. The digit string to compare. A digit string begins with NXX, the NPA string is omitted. VARCHAR(10): 1-10 numeric characters.
* CALL-TYPE	Call type based on the dialed number. VARCHAR(9): 1-9 ASCII characters. Permitted values are: DA—NPA-555-1212 calls. DA-TOLL—1+NPA-555-1212 calls. 976—Information services calls. INFO—Information services calls. TW—Time and temperature service.
AUTO-REFRESH	Specifies whether to display cached data on the screen. Valid only for the show command. CHAR(1): Y/N (Default = Y). Y—Queries the database for the most current data. N—Queries the database for the most current data only if the cached data is unavailable.
DESCRIPTION (EMS-only field)	Service provider-defined description. VARCHAR(64): 1-64 ASCII characters.
DISPLAY	Specifies what token information to display on the screen. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all tokens are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
LIMIT	Specifies the number of rows to display on the screen. Valid only for the show command. INTEGER: 1-100000000 (Default = 100000000). Note The actual maximum number of rows displayed is currently lower than 100000000 due to software limitations.
ORDER	Specifies whether to display data on the screen in a sorted order. Valid only for the show command. VARCHAR(1024): 1-1024 (Default = all rows are displayed). Permitted values are any valid token that can be shown for this command. Multiple tokens can be entered by separating with a comma.
START-ROW	Specifies to begin displaying data on the screen at a specific row. Valid only for the show command. INTEGER: 1-100000000 (Default = 1).