Table Of Contents
Local Toll-Free Service Provisioning
Automatic Numbering Identification White Black List
Customer Group
DN2 Customer Group
II Restrict List
Routing Features
Policy-NXX
Policy-ODR
Policy-OLI
Policy-Percent
Policy-POP
Policy-Prefix
Policy-Region
Policy-TOD
Region-Profile
Route-Guide
Local Toll-Free Service Provisioning
Revised: July 24, 2009, OL-3743-42
This chapter describes the Local Toll-Free Service 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.
Automatic Numbering Identification White Black List
The Automatic Number Identification (ANI) White Black List (ani-wb-list) table performs ANI screening on 800 calls. The Customer Group specifies if the list is to be used as a White List or a Black List. A White Black List specifies whether calls are allowed to connect (white) or not allowed to connect (black).
Table Name: ANI-WB-LIST
Table Containment Area: FSAIN
Command Types
Show, add, and delete
Examples
show ani-wb-list cust-grp-id=cisco; digit-string=469-255-0000;
add ani-wb-list cust-grp-id=cisco; digit-string=469-255-0000;
delete ani-wb-list cust-grp-id=cisco; digit-string=469-255-0000;
Usage Guidelines
Primary Key Token(s): cust-grp-id, digit-string
Foreign Key Token(s): cust-grp-id
Add Rules: None.
Delete Rules: None.
Syntax Description
* CUST-GRP-ID
|
Primary key. Foreign key: Customer Group table. ID of the customer group to use in determining how to apply this list.
VARCHAR(16): 1-16 ASCII characters.
|
* DIGIT-STRING
|
Primary key. The 10-digit phone number of the calling party.
VARCHAR(14): 1-14 numeric characters in the format NDC-EC-DN.
Note Hyphens are required.
|
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).
|
Customer Group
The Customer Group (cust-grp) table defines the cust-grp-id and how automatic number identification (ANI) call forwarding and call restrictions are applied.
Table Name: CUST-GRP
Table Containment Area: FSAIN
Command Types
Show, add, change, and delete
Examples
add cust-grp id=cisco; dnis-pattern=8002424444
change cust-grp id=cisco; ani-wb-list=white;
delete cust-grp id=cisco;
Usage Guidelines
Primary Key Token(s): id
Foreign Key Token(s): route-guide-id
Add Rules: None.
Change Rules: None.
Delete Rules:
•ID does not exist in any dn2cust-grp::cust-grp-id.
•ID does not exist in any ani-wb-list::cust-grp-id.
•ID does not exist in any ii-restrict-list::cust-grp-id.
Syntax Description
* ID
|
Primary key. A unique identifier for this customer group. Assigned by service provider. Required if any policy routing is needed. It is used to look up specific customer information for screening, routing, or DNIS information, if it exists.
VARCHAR(16): 1-16 ASCII characters.
|
ANI-WB-LIST
|
Indicates if White Black List ANI screening is required. Defines how the list is used to screen the calling number.
CHAR(5): 1-5 characters. Permitted values are:
NONE (Default)—No ANI screening is performed.
WHITE—Use as a White List.
BLACK—Use as a Black List.
|
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.
|
COLLECT-PIN
(Not used)
|
800 service with PIN service.
CHAR(1): Y/N (Default = N).
|
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-PATTERN
|
Identifies a dialed number identification service (DNIS) pattern. The DNIS pattern allows more than one 8XX/9XX number to be forwarded to a single line and identifies the called number.
VARCHAR(32): 1-32 ASCII characters.
|
II-RESTRICT-LIST
|
Indicates if White Black List originating line information (OLI) screening is required.
CHAR(5): 1-5 characters. Permitted values are:
NONE (Default)—No screening is performed.
BLACK—Call is blocked for the OLI digits contained in the II Restrict List table.
WHITE—Call is allowed for the OLI digits contained in the II Restrict List table.
|
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.
|
NUM-PIN-DIGITS (Not used)
|
Number of PIN digits to collect.
SMALLINT: 2-12.
|
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-
CARRIER (Not used)
|
Carrier to use for overflow calls.
CHAR(4): 4 numeric characters.
|
OVERFLOW-POTS (Not used)
|
The call is routed to the overflow POTS number if all trunk groups are busy.
VARCHAR(10): 1-10 ASCII characters.
|
ROUTE-GUIDE-ID
|
Foreign key: Route Guide table. Route guide ID is required if policy-based routing is to be performed.
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).
|
DN2 Customer Group
The DN2 Customer Group (dn2cust-grp) table provides translation of inbound/outbound 8XX (toll free) numbers to a local number and designated carrier.
Table Name: DN2CUST-GRP
Table Containment Area: FSAIN
Command Types
Show, add, change, and delete
Examples
show dn2cust-grp digit-string=800-234-5678;
add dn2cust-grp digit-string=800-234-5678; translated-dn=972-671-2355; carrier-id=1234;
change dn2cust-grp digit-string=800-234-5678; carrier-id=1235;
delete dn2cust-grp digit-string=800-234-5678;
Usage Guidelines
Primary Key Token(s): digit-string
Foreign Key Token(s): carrier-id, cust-grp-id
Add Rules: None.
Change Rules: None.
Delete Rules: None.
Syntax Description
* DIGIT-STRING
|
Primary key. Dialed digits string.
VARCHAR(14): 1-14 ASCII characters in the format 8xxNxxxxxx.
|
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-ID
|
Foreign key: Carrier table. Specifies which carrier to use to route the call by the ID assigned to the carrier in the Carrier table. The 4-digit Carrier Identification Code (CIC) 101xxxx.
CHAR(4): 4 numeric digits: 0000-9999.
|
CUST-GRP-ID
|
Foreign key: Customer Group table. Customer group ID. Required if any policy routing is needed. Same ID assigned to this customer group in the Customer Group table. It is used to look up specific customer information for screening, routing, or DNIS information, if it exists.
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.
|
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).
|
TRANSLATED-DN
|
Specifies the translated DN to use for call completion.
VARCHAR(14): 1-14 ASCII characters.
|
II Restrict List
The II Restrict List (II-restrict-list) table restricts certain types of originating line services for a given group. The use of the list is determined by provisioning in the Customer Group table. This is a Black List (restrict) only. It cannot be a White List.
Table Name: II-RESTRICT-LIST
Table Containment Area: FSAIN
Command Types
Show, add, and delete
Examples
show ii-restrict-list ii=20; cust-grp-id=cisco;
add ii-restrict-list ii=20; cust-grp-id=cisco;
delete ii-restrict-list ii=20; cust-grp-id=cisco;
Usage Guidelines
Primary Key Token(s): cust-grp-id, ii
Foreign Key Token(s): cust-grp-id
Add Rules: None.
Delete Rules: None.
Syntax Description
* II
|
Primary key. Originating line information (OLI) assigned to subscriber in the Subscriber Profile table or received in the IAM message.
SMALLINT: 0-99.
|
* CUST-GRP-ID
|
Mandatory if any policy routing is required. Primary key. Foreign key: Customer Group table. Customer group ID. ID assigned to this customer group in the Customer Group table. It is used to look up specific customer information for screening, routing, or DNIS information, if it exists.
CHAR(16): 1-16 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).
|
Routing Features
See Chapter 3, "Routing Provisioning" for detailed information.
Policy-NXX
See the "Policy NXX" section on page 3-47 for details.
Policy-ODR
See the "Policy Origin Dependent Routing" section on page 3-48 for details.
Policy-OLI
See the "Policy Originating Line Information" section on page 3-50 for details.
Policy-Percent
See the "Policy Percent" section on page 3-52 for details.
Policy-POP
See the "Policy Point of Presence" section on page 3-55 for details.
Policy-Prefix
See the "Policy Prefix" section on page 3-57 for details.
Policy-Region
See the "Policy Region" section on page 3-61 for details.
Policy-TOD
See the "Policy Time of Day" section on page 3-63 for details.
Region-Profile
See the "Region Profile" section on page 3-71 for details.
Route-Guide
See the "Route Guide" section on page 3-79 for details.
Feedback
