Cisco BTS 10200 Softswitch

Table Of Contents

Enhanced Outgoing Call Barring (OCB)

Contents

OCB Highlights (Release 3.2)

OCB Highlights (Release 4.4.1)

How To Use This Document

OCB for Release 3.2

OCB Subscription and Provisioning (Release 3.2)

OCB Activation and User Options (Release 3.2)

OCB Deactivation (Release 3.2)

OCB Interrogation (Release 3.2)

OCB Invocation and Screening (Release 3.2)

OCB Lockout Behavior (Release 3.2)

Class of Service Screening via Black and White List (Release 3.2)

Feature Interactions (Release 3.2)

Release Causes and Announcements (Release 3.2)

Provisioning Examples (Release 3.2)

Create Entries in the Feature Table for OCB and COS

Create Entries in the VSC table for OCB

Create Entries in the Service Table for OCB and COS

Provision Call Type Screening Exceptions

Create COS Restriction (If Necessary)

Create Entries in the Subscriber Table and Assign COS Restriction

Create Entries in the Subscriber Service Profile Table for OCB

Add Initial Password in Subscriber-Feature-Data Table

Centrex Provisioning

Billing (Release 3.2)

Counters (Release 3.2)

Events and Alarms (Release 3.2)

OCB Enhancements for Release 4.4.1

OCB Subscription and Provisioning (Release 4.4.1)

OCB Activation and User Options (Release 4.4.1)

OCB Deactivation (Release 4.4.1)

NO-K-VALUE Option

K-VALUE-NO-MATCH Option

K-VALUE-MATCH

OCB Interrogation (Release 4.4.1)

OCB Invocation and Screening (Release 4.4.1)

OCB Lockout Behavior (Release 4.4.1)

Class of Service Screening via Black and White List (Release 4.4.1)

OCB Feature Interactions (Release 4.4.1)

Limitations and Restrictions (Release 4.4.1)

Limitations On Reporting of Traffic Counters (Release 4.4.1)

Special Call Types (Release 4.4.1)

SIP Subscribers (Release 4.4.1)

Installing (Release 4.4.1)

Configuring (Release 4.4.1)

Office Provisioning (Release 4.4.1)

Subscriber Provisioning (Release 4.4.1)

Centrex Provisioning (Release 4.4.1)

MLHG Provisioning

Alternate Activation and Deactivation Method (Release 4.4.1)

Provisioning Notes and Caveats (Release 4.4.1)

Operating (Release 4.4.1)

Billing Fields (Release 4.4.1)

Feature Server Derived Call Data (Release 4.4.1)

Traffic Counters for Blocking Different Call Types (Release 4.4.1)

Command Responses (Release 4.4.1)

Tones (Release 4.4.1)

Cause Codes and Announcements (Release 4.4.1)

Recoverable and Non-Recoverable Error Codes (Release 4.4.1)

References

CLI Reference Guide (Release 4.4.1)

Object Commands (Release 4.4.1)

Modified CA-CONFIG Table (Release 4.4.1)

Modified Point of Presence Table (Release 4.4.1)

OCB PROFILE Table (Release 4.4.1)

OCB-K-VALUE Table (Release 4.4.1)

Related Documents

Industry Standards

Enhanced Outgoing Call Barring (OCB)

---

Feature History

Release	Modification
Release 3.2	This feature was introduced.
Release 4.4.1	OCB was enhanced.

Contents

This feature module describes the Cisco BTS 10200 Softswitch support for the outgoing call barring (OCB) feature. This feature was introduced in Release 3.2, and enhanced in Release 4.4.1. The OCB feature allows an individual subscriber or business group administrator to restrict certain types of outgoing calls. Once the OCB feature is provisioned and activated on a calling line, the OCB restrictions are transparently invoked on all outgoing calls.

OCB Highlights (Release 3.2)

The following list highlights some of the major functions and behaviors for the OCB feature in Release 3.2:

•K-values (call-barring levels) are K=1 (all calls), K=2 (domestic long distance and international), and K=3 (international). These values are automatically enabled for the handset user when the OCB feature is provisioned by the service provider.

•The private identification number (PIN) and PIN length are provisioned by the service provider. They cannot be provisioned by the user via the handset, and cannot be changed by the user.

•If a user forgets the original password, the service provider can, with proper authorization, reset the password. The service provider (after proper authorization) can provision a new password and inform the subscriber.

•Only one K-value can be active at any time on a specific subscriber line.

•If the user deactivates OCB via the handset, the system deactivates OCB without checking the K-value the user enters.

•If the user attempts to reactivate OCB to the same K-value that is currently active, the system treats the attempt as a new attempt, and provides the same success announcement as for the previous activation. If the user attempts to activate OCB to a different K-value than is currently-activated, the system plays the appropriate announcement.

OCB Highlights (Release 4.4.1)

Release 4.4.1 introduces extensions to the OCB feature. It is important to understand that the Release 4.4.1 extensions to OCB are additions to the initial Release 3.2 OCB feature. If you provision a Release 4.4.1 system using Release 3.2 OCB provisioning steps, the OCB feature will, by default, operate exactly as it did when initially introduced in Release 3.2.

The following list describes the OCB enhancements introduced with Release 4.4.1:

•The range of K-values (call-barring levels) is 1 through 9, and the service provider can provision each of the 9 values for specific call types.

•K-values can be mapped to call-types at the POP or at the office level. If K-values are not mapped at the POP level, the software checks to see if they are mapped at the office level. If K-values are not provisioned at either the POP or office level, OCB defaults to the hard-coded mapping of the three K-values as in Release 3.2. K-value mapping need not be configured per subscriber.

•Only one K-value can be active on a specific subscriber line.

•The service provider can provision three deactivation options for the handset user, including the option to deactivate only if the user enters a currently-active K-value.

•The PIN length is provisioned by the service provider and cannot be provisioned by the user via the handset, and cannot be changed by the user. The initial PIN setup can be performed either by the service provider, or can be provisioned for the user to set up using the handset. However, the initial PIN cannot be changed by the handset user.

•If a user forgets the original password, the service provider (after proper authorization) can reset the password.

How To Use This Document

If you provision a Release 4.4.1 system using Release 3.2 OCB provisioning steps, the OCB feature will, by default, operate exactly as it did when initially introduced in Release 3.2.

•For the Release 3.2 description, provisioning, and behavior, see the "OCB for Release 3.2" section.

•To use one or more of the enhanced OCB features for Release 4.4.1, see the "OCB Enhancements for Release 4.4.1" section.

OCB for Release 3.2

The outgoing call barring feature allows an individual subscriber or business group administrator to restrict certain types of outgoing calls. Once the OCB feature is provisioned and activated on a calling line, the OCB restrictions are transparently invoked on all outgoing calls.

---

Note The class of service (COS) feature is an optional functionality (subset) of OCB. The service provider can provision the COS feature by itself, without the OCB feature. The details are discussed later in this section.

---

OCB Subscription and Provisioning (Release 3.2)

The service provider sets up OCB service at the request of the subscriber. There are a number of service provider provisionable parameters that affect the behavior of the feature on the subscriber line:

•Vertical service code (VSC)—ASCII strings that the user must enter to access OCB activation, deactivation, and interrogation options. The recommended values are *54*, #54* and *#54# as used in the examples below. However, VSCs are not preprovisioned in the system. The service provider can provision these values with any unique ASCII string up to five characters long.

•Private identification number (PIN)—A digit string that the user must enter for authorization to set OCB activation and deactivation options from his or her local phone.

•PIN length (PIN-LEN)—The number of digits required for a valid PIN.

---

Note The PIN and PIN-LEN are provisioned by the service provider. They cannot be provisioned by the user via the handset, and cannot be changed by the user.

---

•Allowed activation/deactivation attempts and lockout parameters—Parameters can be provisioned to limit the number of times that a user can enter incorrect data or PIN within a specified time. If the limit is exceeded, the system ignores further activation and deactivation attempts for a provisionable length of time (lockout period).

OCB Activation and User Options (Release 3.2)

OCB activation (OCBA) allows a user to activate OCB and select various call barring options on his or her local phone. The user does this by dialing *54*K-VALUE<PIN># (the trailing # is optional to signify the end of entry). The parameters are defined as follows:

•*54* is the VSC the user must enter on his or her handset to access the OCBA feature

•K-VALUE is the parameter that determines the type of outgoing calls to be barred:

–K-VALUE=1: all outgoing calls barred

–K-VALUE=2: domestic long distance and international outgoing calls barred

–K-VALUE=3: international outgoing calls barred

---

Note Emergency calls are not barred, regardless of the specified K-value.

---

•<PIN> is the assigned private digit string that the user must enter. A success announcement is given on a successful activation, and an error announcement, indicating the type of error, is given if activation is unsuccessful.

---

Note The K-VALUE can be changed only when the OCB feature is in the deactivated state.

---

If a user enters incorrect data or PIN repeatedly in a specified time period, the system can lock out further activation or deactivation attempts, as described in the "OCB Subscription and Provisioning (Release 3.2)" section.

The following user actions are invalid, and the system provides an appropriate error announcement:

•The user enters a value for K-VALUE that is not 1,2, or 3.

•The user tries to activate OCB on a fresh system (a system with no initial PIN entry in the SUBSCRIBER-FEATURE-DATA table). In this case, the user receives the error announcement.

OCB Deactivation (Release 3.2)

OCB deactivation (OCBD) allows a user to deactivate all OCB on his or her local phone. The user does this by dialing #54*K-VALUE<PIN>#. The parameters are defined as follows:

•#54* is the VSC the user must enter on his or her handset to access the OCBD feature

•K-VALUE must be entered as 1, 2, or 3. However, the actual value is ignored by the system, because OCBD deactivates all call barring.

•<PIN> is the same as for OCBA.

A success announcement is given on a successful deactivation, and an error announcement, indicating the type of error, is given if deactivation is unsuccessful.

---

Note See the Cisco BTS 10200 Softswitch CLI Reference Guide for provisioning details.

---

If a user enters incorrect data or PIN repeatedly in a specified time period, the system can lock out further activation or deactivation attempts, as described in the "OCB Subscription and Provisioning (Release 3.2)" section.

OCB Interrogation (Release 3.2)

OCB interrogation allows a user to check the level of outgoing call restrictions on his or her local phone. The dial string for OCB Interrogation is *#54#. No PIN is required to use this feature. The system provides an appropriate announcement to the user.

OCB Invocation and Screening (Release 3.2)

For a calling party that is subscribed to OCB, and has activated the feature, the feature is invoked for every call made after the called party digits are dialed. There is no user driven invocation method involved for the feature. Once provisioned for a calling party, and activated on the calling party's line, the invocation is handled automatically by the Cisco BTS 10200 Softswitch.

OCB Lockout Behavior (Release 3.2)

The LOCK-OUT, TO, and FAIL-CNT parameters in the feature table are intended to prevent unauthorized changes or bypassing of OCB screening. If a user repeatedly enters the password or other OCBA/OCBD data incorrectly on the handset, the system can lock the line against both OCBA and OCBD. These tokens control the lockout behavior as described in Table 1.

---

Tip Note that there is no service lockout when either the TO or FAIL-CNT token is set to zero.

---

Table 1 OCB Lockout Behavior

OCB Tokens in Feature Table			Lockout Behavior Due to OCBA/OCBD Misuse
LOCK-OUT	TO	FAIL-CNT
n/a	n/a	0	No service lockout
n/a	0	n/a	No service lockout
0	1 or greater	1 or greater	OCBA and OCBD are locked out indefinitely after the user misuses the OCBA/OCBD feature <FAIL-CNT> times in <TO> minutes
1 or greater	1 or greater	1 or greater	OCBA and OCBD are locked out for <LOCK-OUT> minutes after the user misuses the OCBA/OCBD feature <FAIL-CNT> times in <TO> minutes

Class of Service Screening via Black and White List (Release 3.2)

---

Note The class of service (COS) feature is an optional functionality (subset) of OCB. The service provider can provision the COS feature by itself, without the OCB feature.

---

The Cisco BTS 10200 Softswitch supports class of service (COS) screening, which is provisioned and assigned by the service provider, and cannot be controlled or deactivated by individual subscribers. The service provider can provision a list of directory numbers (DNs) to appear on a black list or a white list as follows:

•Black listed calls do not undergo further screening, and all calls on this list are rejected.

•White listed calls are subject to additional normal OCB restrictions based on call type.

---

Note The service provider should provision the desired COS restrictions for all subscribers that have the OCB feature. This ensures that the black and white list restrictions are in effect, even if the user deactivates OCB. COS provisioning steps are provided later in this section.

---

Separate black and white lists are maintained for local/national calls and international calls.

•National white/black lists are used to allow/restrict calls to specified destinations within a region or within a local area.

---

Note A region is a country or numbering plan area. The national white/black list identifies a set of national destination code (NDCs) and/or exchange codes (ECs) to be allowed or blocked.

---

Outgoing calls are restricted as follows:

–No restrictions (default), except that all calls are subject to the additional OCB restrictions

–National white list—Allows calls within a predefined list, except that all calls are subject to the additional OCB restrictions

–National black list—All calls within a predefined list are blocked.

---

Note National call restrictions do not apply to operator calls. This is true even if national call restriction is provisioned in the cos-restrict table for the calling party.

---

•International black/white lists are used to allow/restrict calls made to specific country codes. Outgoing calls are restricted as follows:

–No international calls allowed—Does not allow any international calls

–International white list—Allows those calls that have a prefix noted in the white list, except that all calls are subject to the additional OCB restrictions

–International black list—Does not allow any calls that have a prefix noted in the black list

–All international calls allowed—No restrictions are applied on any international calls, except that all calls are subject to the additional OCB restrictions

---

Note International call restrictions do not apply to operator calls. This is true even if international call restriction is provisioned in the cos-restrict table for the calling party.

---

The service provider can provision an exception list to override black and white list and OCB screening on certain types of calls. The types of calls on this list can include, for example, emergency calls, toll free calls, and so forth. The applicable types of calls are listed in the NATURE OF DIAL (NOD) table, and the specific exceptions are provisioned in the NOD-RESTRICT-LIST table. These exceptions are applicable at the switch level (all office codes) and cannot be specified for individual subscribers. A provisioning example is included in the "Provision Call Type Screening Exceptions" section.

Feature Interactions (Release 3.2)

Call forwarding—The interaction of OCB and call forwarding features depends upon the sequence in which they are activated:

---

Note In this section, "CFx" refers to any of the call forwarding features, CFU, CFB, or CFNA.

---

•If OCB is activated prior to CFx activation—OCB screening is performed on each DN the user enters when attempting to activate CFx. Successful CFx activation depends on the existing OCB K-VALUE and the forward-to DN:

–If the existing OCB K-VALUE is set to block calls to the forward-to DN, then the system does not allow CFx activation. The user receives an error announcement.

–If the OCB K-VALUE allows calls to this DN, then the CFx activation process continues. Once the CFx activation attempt to a specific DN is accepted by the system, it is applicable permanently regardless of any future OCB K-VALUE changes. That is, future changes to the OCB K-VALUE have no effect on CFx invocation. CFx to this DN can be deactivated by the user in the normal manner (#XX#).

•If CFx is activated prior to OCB activation—The user can activate the OCB feature, or change the OCB K-VALUE, regardless of the existing CFx feature. However, invocation of OCB depends upon the type of call:

–User-dialed calls—User-dialed calls can be blocked by OCB (depending on the K-VALUE).

–Forwarded calls—CFx remains active as originally set up by the user, therefore, calls forwarded by the CFx feature cannot be blocked using OCB screening.

•COS restriction—The COS feature is an optional functionality (subset) of OCB. To utilize the COS functionality, the service provider must provision individual COS restriction settings for the subscriber line. Table 2 lists additional details about the interaction of COS and OCB.

Table 2 Interactions between COS and OCB Features  (Release 3.2)

Desired Screening Function(s) On Outgoing Calls	Feature that Must Be Provisioned in Feature Table	Provisioning required for COS Tables 1	How the System Reports Billing Data
User-controlled screening only	OCB	Do not provision individual COS restrictions. Leave all COS table tokens set to their default values	OCB
User-controlled screening and network (office) screening	OCB 2	Provision individual COS restriction tables.	OCB
Network (office) screening only	COS	Provision individual COS restriction tables.	COS

1 The COS restriction tables include the following: COS-RESTRICT, NATIONAL-WB-LIST, INTL-WB-LIST, NOD-RESTRICT-LIST, and NOD-WB-LIST. 2 The COS feature is contained in the OCB feature

Release Causes and Announcements (Release 3.2)

Table 3 shows the default mapping of cause codes to announcement IDs and announcement files for the OCB feature.

---

Note If an audible announcement file cannot be played on the applicable phone, the system plays a reorder tone.

---

Table 3 Default Mapping of Cause Codes to Prerecorded Announcements for OCB Feature 

Cause Code Number and Name	User Action	Announce- ment ID	Announcements Provided on Cisco AS53xx Announcement Server		Announcements Provided on Cognitronics Media Resource Server
			File Name	Contents	Number	Contents
1111—Password not provisioned	User attempts OCBA or OCBD, but initial password has not been set up by service provider	501	ann_id_501.au	The password required by this feature is not provided on your line. Please contact your telephone service provider to set up a password.	3001	The password required by this feature is not provided on your line. Please contact your telephone service provider to set up a password.
1112—Indefinitely locked out	User attempts OCBA or OCBD, but they are permanently locked due to repeated password failures	502	ann_id_502.au	The feature you have used is permanently locked up due to repeated password entry failures. Please contact your telephone service provider to remove this feature.	3002	The feature you have used is permanently locked up due to repeated password entry failures. Please contact your telephone service provider to remove this feature.
1113—Temporarily locked out	User attempts OCBA or OCBD, but they are temporarily locked due to repeated password failures	503	ann_id_503.au	The feature you have used is permanently locked up due to repeated password entry failures. You may retry the feature again later.	3003	The feature you have used is permanently locked up due to repeated password entry failures. You may retry the feature again later.
1114—OCB K-VALUE set to 0 (OCB deactivated)	User with K-VALUE=0 attempts OCBI and receives announcement	504	ann_id_504.au	You have no restrictions placed on outgoing calls.	3004	You have no restrictions placed on outgoing calls.
1115—OCB K-VALUE set to 1	User with K-VALUE=1 attempts an outgoing call or OCBI, and receives announcement	505	ann_id_505.au	You are not permitted to place any calls on this line due to outgoing call restrictions. However you may still place emergency calls.	3005	You are not permitted to place any calls on this line due to outgoing call restrictions. However you may still place emergency calls.
1116—OCB K-VALUE set to 2	User with K-VALUE=2 attempts an outgoing national or international call or OCBI, and receives announcement	506	ann_id_506.au	You are only permitted to place local calls on this line. National and international calls may not be made due to call restrictions.	3006	You are only permitted to place local calls on this line. National and international calls may not be made due to call restrictions.
1117—OCB K-VALUE set to 3	User with K-VALUE=3 attempts an outgoing international call or OCBI, and receives announcement	507	ann_id_507.au	You are only permitted to place local and long-distance calls on this line. International calls may not be made due to call restrictions.	3007	You are only permitted to place local and long-distance calls on this line. International calls may not be made due to call restrictions.
1147—Activation successful	User attempts OCBA and is successful	526	ann_id_526.au	Your activation attempt was successful.	n/a	n/a
1148—Activation failed	User attempts OCBA and is not successful	527	ann_id_527.au	Your activation attempt failed.	n/a	n/a
1149—Deactivation successful	User attempts OCBD and is successful	528	ann_id_528.au	Your deactivation attempt was successful.	n/a	n/a
1150—Deactivation failed	User attempts OCBD and is not successful	529	ann_id_529.au	Your deactivation attempt failed.	n/a	n/a
1151—Interrogation successful	User attempts OCBI and receives OCB announcement (one of 504 through 507)	530	ann_id_530.au	Your interrogation attempt was successful.	n/a	n/a
1152—Interrogation failed	User attempts OCBI but does not receive OCB announcement (one of 504 through 507)	531	ann_id_531.au	Your interrogation attempt failed.	n/a	n/a

Provisioning Examples (Release 3.2)

Use CLI commands as shown in the following examples to provision OCB and COS.

Create Entries in the Feature Table for OCB and COS

add feature FNAME=OCBA; tdp1=COLLECTED-INFORMATION; tid1=VERTICAL-SERVICE-CODE; ttype1=R; feature_server_id=FSPTC235; description=OCB activation;

add feature FNAME=OCBD; tdp1=COLLECTED-INFORMATION; tid1=VERTICAL-SERVICE-CODE; ttype1=R; feature_server_id=FSPTC235; description=OCB deactivation;

add feature FNAME=OCBI; tdp1=COLLECTED-INFORMATION; tid1=VERTICAL-SERVICE-CODE; ttype1=R; feature_server_id=FSPTC235; description=OCB interrogation;

add feature FNAME=OCB; tdp1=COLLECTED_INFORMATION; tid1=COS_TRIGGER; TTYPE1=R; FEATURE_SERVER_ID=FSPTC235; TYPE1=PIN-LEN; VALUE1=5; TYPE2=FAIL-CNT; VALUE2=3; TYPE3=TO; VALUE3=20; TYPE4=LOCK-OUT; VALUE4=60; FNAME2=OCBA; FNAME3=OCBD; FNAME4=OCBI; DESCRIPTION=Outgoing Call Barring;

The TYPEn/VALUEn entries are defined as follows (n=1, 2, 3, 4). Note that there is no significance to the order in which these values are assigned, nor the number (1, 2, 3, or 4) assigned in the CLI command:

•PIN-LEN—The number of digits required for a valid PIN. The range is 1 to 8 (default is 4).

---

Note The PIN and PIN-LEN are provisioned by the service provider. They cannot be provisioned by the user via the handset, and cannot be changed by the user.

---

•FAIL-CNT (fail count) and TO (timeout, in minutes)—The number of invalid (failed) attempts to activate or deactivate OCB within a specified time period before service is locked out:

–FAIL-CNT range is 0 to 10.

–TO range is 0 to 180 minutes. The time span begins with the first OCBA or OCBD failure.

•LOCK-OUT—The lockout period in minutes during which the OCBA and OCBD features cannot be used. LOCK-OUT range is 0 to 180 minutes. The lockout period begins after the last failed attempt.

---

Tip PIN is not provisioned in the feature table. See the "Add Initial Password in Subscriber-Feature-Data Table" section for provisioning of the PIN.

---

---

Caution If you assign a value of zero to the FAIL-CNT, TO, or LOCK-OUT token, this results in special lockout behavior. See the "OCB Lockout Behavior (Release 3.2)" section for details.

---

add feature fname=COS; tdp1=COLLECTED_INFORMATION; tid1=COS_TRIGGER; ttype1=R; description=Class of service screening; feature_server_id=FSPTC235;

Create Entries in the VSC table for OCB

add vsc fname=OCBA; digit-string=*54*;

add vsc fname=OCBD; digit-string=#54*;

add vsc fname=OCBI; digit-string=*#54#;

Create Entries in the Service Table for OCB and COS

In the service table, add the OCB feature (which automatically includes the COS feature), or add the COS feature only (if no OCB feature is desired). Refer to Table 2 for additional information about COS interaction with OCB.

add service id=1; FNAME1=OCB; (for OCB and option to perform COS screening)

add service id=2; FNAME1=COS; (for COS feature only)

---

Note The COS-RESTRICT table default settings do not need to be changed unless COS screening features are desired. The original COS defaults are preset for no COS restriction.

---

Provision Call Type Screening Exceptions

Provision the call types that are not to be screened by the OCB and COS features. See the nature of dial (NOD) table in the Cisco BTS 10200 Softswitch CLI Reference Guide for a complete list of valid call types.

The following command example ensures that calls to numbers with call-type=EMG will not be screened by the OCB feature.

add nod-restrict-list fname=OCB; nod=EMG;

The following command example ensures that calls to numbers with call-type=POLICE will not be screened by the COS feature.

add nod-restrict-list fname=COS; nod=POLICE;

Create COS Restriction (If Necessary)

Create a COS restriction, if desired.

add cos-restrict id=international; INTL-RESTRICT-TYPE=NO-CC-ALLOWED;

Create Entries in the Subscriber Table and Assign COS Restriction

add subscriber id=china-1; dn=28-8652-8888; privacy=full; cos-restrict-id=international;

Create Entries in the Subscriber Service Profile Table for OCB

add subscriber-service-profile sub-id=china-1; service-id=1;

Add Initial Password in Subscriber-Feature-Data Table

change subscriber-feature-data sub-id=china-1; fname=OCB; type1=PASSWD; value1=12345; type2=K-VALUE; value2=2;

---

Note Additional token information for the SUBSCRIBER-FEATURE-DATA table:

The K-VALUE token does not need to be provisioned by the service provider. It is recorded by the system when the subscriber uses the OCBA and OCBD features.

The COUNT and TIME tokens are not provisioned by the service provider. They are system internal.

---

Centrex Provisioning

Add the feature into the custom-dial-plan table for the Centrex group.

add custom-dial-plan id=cdp1; DIGIT-STRING=*54*; NOD=VSC; FNAME=OCBA; CAT-STRING=11111111111;

add custom-dial-plan ID=cdp1; DIGIT-STRING=#54*; NOD=VSC; FNAME=OCBD; CAT-STRING=11111111111;

add custom-dial-planID=cdp1; DIGIT-STRING=*#54#; NOD=VSC; FNAME=OCBI; CAT-STRING=11111111111;

Billing (Release 3.2)

Billing data is listed in Table 4 through Table 7.

Table 4 OCB FCI Fields

Field	Values	Associated CDB Field
ServiceId	OCB	ServiceType1, ServiceType2, or ServiceType3
ServiceStatus	INSTANCE	ServiceInstanceTime1, ServiceInstanceTime2, or ServiceInstanceTime3
FeatureData	n/a	n/a
Result	Valid	n/a

Table 5 OCBA FCI Fields

Field	Values	Associated CDB Field
ServiceId	OCB	ServiceType1, ServiceType2, or ServiceType3
ServiceStatus	ACTIVATION	ServiceInstanceTime1, ServiceInstanceTime2, or ServiceInstanceTime3
FeatureData	"1", "2", or "3"	FeatureData1, FeatureData2, or FeatureData3
Result	Valid	n/a

Table 6 OCBD FCI Fields

Field	Values	Associated CDB Field
ServiceId	OCB	ServiceType1, ServiceType2, or ServiceType3
ServiceStatus	DEACTIVATION	ServiceInstanceTime1, ServiceInstanceTime2, or ServiceInstanceTime3
FeatureData	n/a	n/a
Result	Valid	n/a

Table 7 OCBI FCI Fields 

Field	Values	Associated CDB Field
ServiceId	OCB	ServiceType1, ServiceType2, or ServiceType3
ServiceStatus	INTERROGATION	ServiceInstanceTime1, ServiceInstanceTime2, or ServiceInstanceTime3
FeatureData	n/a	n/a
Result	Valid	n/a

Counters (Release 3.2)

The following counters are maintained for the OCB feature:

•POTS_OCB_LOCAL_BLOCKED (For every call that is blocked due to K-VALUE being provisioned as `1' for OCB feature, this counter is incremented.)

•POTS_OCB_NATL_BLOCKED (For every call that is blocked due to K-VALUE being `2' for OCB feature, this global counter is incremented.)

•POTS_OCB_INTL_BLOCKED (For every call that is blocked due to K-VALUE being `3' for OCB feature, this global counter is incremented.)

•POTS_OCB_ACTIVATION_SUCC (For every successful OCB activation, this global counter is incremented.)

•POTS_OCB_DEACTIVATION_SUCC (For every successful OCB deactivation, this global counter is incremented.)

•POTS_OCB_INTERROGATION_SUCC (For every OCB interrogation attempt, this global counter is incremented.)

•POTS_OCB_INVALID_PASSWORD (For every OCBA or OCBD attempt that fails due to incorrect password entry, this global counter is incremented.)

•POTS_OCB_INVOCATIONS (For every OCB invocation (indirect usage by user), this global counter is incremented.)

The following counters are maintained for the COS feature:

•POTS_ANI_BLOCKED_CALLS (The total number of calls that were blocked based on Automatic Number Identification lookup on the reporting POTS Feature Server)

•POTS_NANP_BLOCKED_BW (The number of North American Numbering Plan based calls that were blocked due to a match on a black list or exclusion from a white list on the reporting POTS Feature Server)

•POTS_INTL_BLOCKED_BW (The number of international based calls that were blocked due to a match on a black list or exclusion from a white list on the reporting POTS Feature Server)

•POTS_900_RESTRICTED (The number of calls denied due to subscriber based 900 restrictions on the reporting POTS Feature Server)

•POTS_976_RESTRICTED (The number of calls denied due to subscriber based 976 restrictions on the reporting POTS Feature Server)

•POTS_NANP_RESTRICTED (The number of calls denied due to subscriber based North American Numbering Plan restrictions on the reporting POTS Feature Server)

•POTS_INTL_RESTRICTED (The number of calls denied due to subscriber based international restrictions on the reporting POTS Feature Server)

•POTS_CASUAL_RESTRICTED (The number of calls denied due to subscriber based casual dialing restrictions on the reporting POTS Feature Server)

•POTS_DA_RESTRICTED (The number of calls denied due to subscriber based directory assistance restrictions on the reporting POTS Feature Server)

•POTS_NANP_OP_RESTRICTED (The number of calls denied due to subscriber based NANP operator restrictions on the reporting POTS Feature Server)

•POTS_INTL_OP_RESTRICTED (The number of calls denied due to subscriber based international operator restrictions on the reporting POTS Feature Server)

Events and Alarms (Release 3.2)

No events or alarms are generated for the OCB feature.

OCB Enhancements for Release 4.4.1

This section describes the enhancements that have been made to the basic OCB feature that was introduced in Release 3.2. The Release 3.2 information is available in the "OCB for Release 3.2" section.

OCB Subscription and Provisioning (Release 4.4.1)

The service provider sets up OCB service at the request of the subscriber. There are a number of service provider provisionable parameters that affect the behavior of the feature on the subscriber line:

•Vertical service code (VSC)—ASCII strings that the user must enter to access OCB activation, deactivation, and interrogation options (for example, *54*, #54* and *#54#).

---

Note The VSCs used throughout this document are typical values. The service provider can provision these values with the ASCII characters 0-9, *, and #. For a complete list of predefined VSCs, see the Vertical Service Code appendix in the Cisco BTS 10200 Softswitch Command Line Interface Reference Guide.

---

•Private identification number (PIN)—A digit string that the user must enter for authorization to set OCB activation and deactivation options from his or her local phone.

---

Note Initially, the service provider or the user establishes a PIN for the user. Thereafter, the user cannot modify the PIN.

---

•PIN length (PIN-LEN)—The number of digits required for a valid PIN (can be provisioned as 1 to 8 digits).

The PIN and PIN-LEN can be provisioned by the service provider.

The PIN and PIN-LEN cannot be provisioned or changed by a user via the handset if the OCB-PROFILE has not been provisioned at either the point-of-presence (POP) or at the office level. However, if the OCB-PROFILE has been provisioned and the FREE_SELECT_PIN token has been set to Y (Yes), a subscriber can free-select and register a PIN using a handset at activation if a PIN has not already been assigned and registered.

•Allowed activation/deactivation attempts and lockout parameters—OCB can be provisioned to limit the number of times that a user can enter an incorrect PIN within a specified time. If the limit is exceeded, the system ignores further activation and deactivation attempts for a provisionable length of time (lockout period).

Detailed provisioning steps for these options are provided in the section Configuring (Release 4.4.1).

OCB Activation and User Options (Release 4.4.1)

OCB activation (OCBA) allows a user to activate OCB and select various call barring options on the handset (local phone). A user does this by dialing *54*K-VALUE<PIN># (the trailing # is optional to signify the end of the entry). The parameters are defined as follows:

•*54* is the VSC the user enters on the handset to access the OCBA feature.

•K-VALUE is the parameter that determines the type of outgoing calls to be barred. For Release 4.4.1, OCB can enable K-values up to 9 levels.

---

Note A K-Value can be mapped to a special mapping table, the OCB-K-Value table.

---

•<PIN> is the assigned private digit string that the user must enter. A success announcement is given on a successful activation, and an error announcement, indicating the type of error, is given if activation is unsuccessful.

---

Note The K-VALUE can be changed when the OCB feature is active if the subscriber performs another activation and enters a different value for the K-VALUE token. The new K value overwrites the preceding K value.

---

If a user enters an incorrect PIN repeatedly in a specified time period, the system can lock out further activation or deactivation attempts, as described in the "OCB Subscription and Provisioning (Release 4.4.1)" section.

The following user actions are invalid, and the system provides an appropriate error announcement:

•The user enters a value for K-VALUE that is not in the range 1 through MAX-K-VALUES (as specified in the OCB-PROFILE table).

If a subscriber attempts an activation and specifies a K-VALUE that is not in the range established by the provisioned MAX-K-VALUE token, the subscriber receives an error announcement. If the MAX-K-VALUES token is not provisioned in the OCB-PROFILE table at either the POP or Cisco BTS 10200 Softswitch, by default, the valid K-VALUE range is 1 through 3.

---

Note The POP table is checked first for the MAX-K-VALUE and then the office level (call agent configuration table). If the token is not provisioned in either table, OCB defaults to the behavior established in the initial release of OCB in Cisco BTS 10200 Release 3.2.

---

•The user is not provisioned for the OCB feature.

•The user enters an incorrect PIN.

OCB Deactivation (Release 4.4.1)

The Enhanced OCB feature supports three options for OCB deactivation. An option is specified by provisioning the DEACTIVATION-OPTION token in the OCB-PROFILE table.

NO-K-VALUE Option

To select the NO_K_VALUE deactivation option, the subscriber enters <VSC><PIN> without entering a K-VALUE.

K-VALUE-NO-MATCH Option

The K-VALUE-NO-MATCH deactivation option enables a user to deactivate all OCB on the handset. The user does this by dialing #54*K-VALUE<PIN>#. The parameters are defined as follows:

•#54* is the VSC the user enters on the handset to access the OCBD feature

•K-VALUE must be entered as a value from 1 through MAX-K-VALUES. However, the actual value is ignored during processing.

•<PIN> is the same as for OCBA.

---

Note If the K-VALUE token is not provisioned in the OCB-K-VALUE table at either the POP or softswitch, by default, the K-value range is 1 through 3.

---

K-VALUE-MATCH

The K-VALUE-MATCH deactivation option requires the subscriber to enter a K-VALUE that matches the K-VALUE provisioned for the subscriber. If the subscriber enters a K-VALUE that does not match the value provisioned for K-VALUE, the subscriber receives an error announcement.

A success announcement is given on a successful deactivation, and an error announcement, indicating the type of error, is given if deactivation is unsuccessful.

---

Note Refer to the Cisco BTS 10200 Softswitch Command Line Interface Reference Guide for provisioning details.

---

If a user enters an incorrect PIN repeatedly in a specified time period, the system can lock out further activation or deactivation attempts, as described in the "OCB Subscription and Provisioning (Release 4.4.1)" section.

OCB Interrogation (Release 4.4.1)

OCB interrogation for Release 4.4.1 operates as it did for Release 3.2.

OCB Invocation and Screening (Release 4.4.1)

For a calling party that is subscribed to OCB, and has activated the feature, OCB is invoked for every call made after the called party digits are dialed.

OCB Lockout Behavior (Release 4.4.1)

For the Enhanced OCB feature, if the FAIL-CNT (fail count), LOCK-OUT, and TIME-OUT tokens are provisioned in the OCB-PROFILE table, OCB lockout behaves according to those specifications.

If the OCB-PROFILE table is not provisioned, OCB lockout behaves according to the provisioning of the LOCK-OUT, TIME-OUT, and FAIL-CNT tokens in the FEATURE table.

The LOCK-OUT, TIME-OUT, and FAIL-CNT tokens in the FEATURE table are intended to prevent unauthorized changes or bypassing of OCB screening. If a user repeatedly enters the PIN incorrectly on the handset, the system can lock the line against both OCBA and OCBD. These tokens control the lockout behavior as described in Table 8.

---

Tip Note that there is no service lockout when either the TIME-OUT or FAIL-CNT token is set to zero.

---

Table 8 OCB Lockout Behavior

OCB Tokens in Feature Table			Lockout Behavior Due to OCBA/OCBD Misuse
LOCK-OUT	TO	FAIL-CNT
—	—	0	No service lockout
—	0	—	No service lockout
0	1 or greater	1 or greater	OCBA and OCBD are locked out indefinitely after the user misuses the OCBA/OCBD feature <FAIL-CNT> times in <TO> minutes
1 or greater	1 or greater	1 or greater	OCBA and OCBD are locked out for <LOCK-OUT> minutes after the user misuses the OCBA/OCBD feature <FAIL-CNT> times in <TO> minutes

Class of Service Screening via Black and White List (Release 4.4.1)

Class of Service Screening via Black and White List for Release 4.4.1 operates as it did for Release 3.2.

OCB Feature Interactions (Release 4.4.1)

OCB feature interactions for Release 4.4.1 are the same as for Release 3.2.

Limitations and Restrictions (Release 4.4.1)

This section provides information on limitations and restrictions that apply to the enhanced OCB feature for Release 4.4.1.

Limitations On Reporting of Traffic Counters (Release 4.4.1)

Cisco BTS 10200 Softswitch OCB does not support the following traffic counters whenever it uses the OCB-Profile to block calls:

•POTS_OCB_LOCAL_BLOCKED

•POTS_OCB_NATL_BLOCKED

•POTS_OCB_INTL_BLOCKED

Special Call Types (Release 4.4.1)

Call types such as Emergency, Fire, Police, Ambulance, and Toll-Free are not limited by OCB restrictions.

SIP Subscribers (Release 4.4.1)

If the service provider sets NANP_DIAL_PLAN="Y" in the dial plan for a SIP subscriber, the OCB feature will not operate properly.

Installing (Release 4.4.1)

There are no new, modified, or deleted requirements for installation procedures for the Cisco BTS 10200 Softswitch as a result of the enhancement to the OCB feature.

Configuring (Release 4.4.1)

Outgoing Call Barring is a superset of Class Of Service screening and includes all provisioning steps of COS. However, COS functionality itself, in OCB, is optional and need not be provisioned.

This section provides separate explanations for how OCB is provisioned by the service provider, by an individual subscriber, by a business group administrator, for a centrex office, or for an MLHG.

Office Provisioning (Release 4.4.1)

The following office provisioning example for OCB is new for Release 4.4.1.

---

Step 1 Register the OCB feature in the office:

add feature FNAME=OCB; tdp1=COLLECTED-INFORMATION; tid1=COS-TRIGGER; ttype1=R; 
feature_server_id=FSPTC235; description=Outgoing Call Barring; grp_feature=N;

Step 2 Register the OCB activation, deactivation, and interrogation features into the office:

add feature FNAME=OCBx; tdp1=COLLECTED-INFORMATION; tid1=VERTICAL-SERVICE-CODE; ttype1=R; 
feature_server_id=FSPTC235; description=OCB act/deact/interr; grp_feature=N;

---

Note For the steps of this procedure, OCB activation (OCBA), OCB deactivation (OCBD), and OCB interrogation (OCBI) are referred to interchangeably as OCBx.

---

Step 3 Register the COS feature in the office.

---

Note See the provisioning notes for COS screening. This step is optional and is required only under two circumstances:
² COS screening functionality is required as a subset of OCB.
² BW-list screening functionality of OCB needs to be offered to the subscriber even if OCB is    in a deactivated state.

---

Step 4 Add/change the vsc code for OCBA.

add vsc fname=OCBA; digit-string=*54*;

Step 5 Add/change the vsc code for OCBD.

add vsc fname=OCBD; digitstring=#54*;

Step 6 Add/change the vsc code for OCBI.

add vsc fname=OCBI; digit-string=#54#;

Step 7 Provision the OCB features as a service package.

add service id=ocb; FNAME1=OCB; FNAME2=OCBA; FNAME3=OCBD; FNAME4=OCBI

Step 8 Provision feature parameters if required.

add feature fname=OCB; type1=pin-len; value1=5; type2=to; value2=20; type3=fail-cnt; 
value3=4; type4=lock-out; value4=60;

Step 9 Provision a nature-of-dial screening exception list. Enter as many nature-of-dial records for OCB as required.

add nod-restrict-list fname=OCB; call-type=local;

Step 10 Provision OCB feature parameters using the OCB-PROFILE if required.

add ocb-profile Id=ocb_prof; Max-k-values=5; All-calls-restrict-k-value=5; Fail-cnt=3; 
Pin-len=5; Lock-out=30; Time-out=30; Deactivation-option=K-VALUE-MATCH; Free-select-pin=Y;

Step 11 Provision the OCB-K-VALUE if required.

add ocb-k-value Ocb-profile-id=ocb_prof; k-value=1; call-type=local, call-type=intl;

---

Note For the call-type option, you can specify multiple call types.

---

Step 12 Provision base OCB behavior for the office.

add ca-config Type=DEFAULT-OCB-PROFILE-ID; Datatype=STRING; Value=ocb_prof;

Step 13 Provision OCB behavior for the POP level.

add pop Id=<subscriber corresponding pop id>; Ocb-profile-id=ocb_prof;

---

Subscriber Provisioning (Release 4.4.1)

The following subscriber provisioning example is new for OCB since Release 3.2.

---

Step 1 Add the service to the subscriber's service profile:

add subscriber-service-profile sub-id=sub1_plano.com; service-id=ocb;

Step 2 Add an initial password for the subscriber. (This step is optional.)

add subscriber-feature-data sub-id=sub1_plano.com; fname=OCB; type1=PASSWD; value1=1234;

---

Centrex Provisioning (Release 4.4.1)

Centrex provisioning for Release 4.4.1 is as it was for Release 3.2.

MLHG Provisioning

MLHG provisioning is similar to subscriber provisioning. See the section "Subscriber Provisioning (Release 4.4.1)" section.

Alternate Activation and Deactivation Method (Release 4.4.1)

This feature is deactivated by default when it is assigned to a subscriber. OCB can be activated and deactivated alternately by creating an entry in the Subscriber-feature-data table.

Use a CLI command similar to the following to activate OCB:

add subscriber-feature-data sub-id=sub_1; active=Y; fname=OCB; type1=K_VALUE;

value1=1; type2=PASSWD; value2=1234;

---

Note The value can be in the range 1 through 9.

---

Use a CLI command similar to the following to deactivate OCB:

add subscriber-feature-data sub-id=sub_1; active=N; fname=OCB;

Provisioning Notes and Caveats (Release 4.4.1)

•The K-VALUE for the subscriber in the Subscriber-feature-data table will be recorded by the system when the subscriber uses the OCBA feature.

•The COUNT and TIME fields in the Subscriber-feature-data table are used by the operator to manually reset a locked-out subscriber. To unlock a locked-out subscriber, set both fields to '0'.

•The PASSWD provisioned in the Subscriber-feature-data table can be optional if FREE-SELECT-PIN=Y.

Operating (Release 4.4.1)

This section explains how the enhancements to the OCB feature affect the following operational areas:

•Billing Fields (Release 4.4.1)

•Traffic Counters for Blocking Different Call Types (Release 4.4.1)

•Command Responses (Release 4.4.1)

•Tones (Release 4.4.1)

•Cause Codes and Announcements (Release 4.4.1)

•Recoverable and Non-Recoverable Error Codes (Release 4.4.1)

Billing Fields (Release 4.4.1)

A billing record is generated whenever OCB is activated, deactivated, interrogated and invoked. For the Release 4.4.1 enhancement to OCB, no new interface requirements are identified. However, the FeatureData field of the OCBA feature is extended from 3 to 9 values as shown in Table 9.

Table 9 OCB Billing Record Change for Release 4.4.1

Feature Name	Field	Values	Associated CDB Field
OCBA	FeatureData	•"1" •"2" •"3" •"4" •"5" •"6" •"7" •"8" •"9"	FeatureData1, FeatureData2, FeatureData3, ...FeatureData9. Note: •"1"—Outgoing Call Barring with barring level 1 •"2"—Outgoing Call Barring with barring level 2 •"3"—Outgoing Call Barring with barring level 3 •"4"—Outgoing Call Barring with barring level 4 •"5"—Outgoing Call Barring with barring level 5 •"6"—Outgoing Call Barring with barring level 6 •"7"—Outgoing Call Barring with barring level 7 •"8"—Outgoing Call Barring with barring level 8 •"9"—Outgoing Call Barring with barring level 9

Feature Server Derived Call Data (Release 4.4.1)

This section describes the data related to the OCB feature that is placed within various fields in the call detail block (CDB) records. This data is generated by the Feature Servers, either internal or external, whenever a feature is invoked during the context of a given call. Up to three feature instances can be captured in a single call detail block. The format of the data and the possible values are shown in the following sections. Each block of feature data contains up to four sub-fields, as follows:

---

Note This section provides only the data related to the OCB feature. For the complete description of the feature server derived call data for the Cisco BTS 10200 Softswitch, see the Cisco BTS 10200 Softswitch Billing Interface Guide.

---

•ServiceId—a string describing which services/features were involved in this billing event. The possible values are:

–58 = OCB—Outgoing Call Barring

•ServiceStatus—a string denoting the type of invocation that occurred. The valid values are:

–INSTANCE

–ACTIVATION

–DEACTIVATION

–INTERROGATION

•FeatureData—a string containing the service/feature specific billing data as described in the following sections.

•Result—a string indicating if the action taken was successful or not. The valid values are:

–SUCCESS

–FAILURE

Table 10 lists the available features including the fields, values, and associated CDB fields.

Table 10 Features and the Associated Call Detail Block Fields 

Feature Name	Field	Value	Associated CDB Fields
Outgoing Call Barring	ServiceId	OCB	ServiceType1, ServiceType2, or ServiceType3
	ServiceStatus	INSTANCE	ServiceInstanceTime1, ServiceInstanceTime2, or ServiceInstanceTime3
		ACTIVATION	ServiceActivationTime1, ServiceActivationTime2, or ServiceActivationTime3
		INTERROGATION	ServiceInterrogationTime1, ServiceInterrogationTime2, or ServiceInterrogationTime3
		DEACTIVATION	ServiceDeactivationTime1, ServiceDeactivationTime2, or ServiceDeactivationTime3
	FeatureData	"1" through "9" (On Activation)	FeatureData1, through FeatureData9
	Result	•OCBA •OCBD •OCBI	•ServiceResultCode1, ServiceResultCode2, or ServiceResultCode3 •ServiceResultCode1, ServiceResultCode2, or ServiceResultCode3 •ServiceResultCode1, ServiceResultCode2, or ServiceResultCode3

Traffic Counters for Blocking Different Call Types (Release 4.4.1)

The traffic counters for Release 4.4.1 are the same as those for Release 3.2. See "Limitations On Reporting of Traffic Counters (Release 4.4.1)" section.

Command Responses (Release 4.4.1)

There are no new, modified, or deleted command responses related to the enhancement to the OCB feature described in this document. For

Tones (Release 4.4.1)

There are no new, modified, or deleted command responses related to the enhancements to the OCB feature described in this document.

Cause Codes and Announcements (Release 4.4.1)

Table 11 lists the new cause codes associated with Outgoing Call Barring for Release 4.4.1.

Table 11 Outgoing Call Barring Cause Codes 

Release Cause-Code1	Announcement ID	Billing Cause-Code	Fallback Tone	Text of announcement2	Usage context(s)
1115 FS_CAUSE_OCB_K1	556	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is active with barring level 1.	User does interrogation with K-Value=1 activated.
	505	NORMAL_ CALL_ CLEARING	Confirmation- tone	You are not permitted to place any calls on this line due to outgoing call restrictions. However you may still place emergency calls.	User does interrogation with K-Value=1 activated. Note: Only used for default OCB behavior.
1116 FS_CAUSE_OCB_K2	557	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is active with barring level 2.	User does interrogation with K-Value=2 activated.
	506	NORMAL_ CALL_ CLEARING	Confirmation- tone	You are only permitted to place local calls on this line. National and International calls may not be made due to call restrictions.	User does interrogation with K-Value=2 activated. Note: Only used for default OCB behavior.
1117 FS_CAUSE_OCB_K3	558	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is active with barring level 3.	User does interrogation with K-Value=3 activated.
	507	NORMAL_ CALL_ CLEARING	Confirmation- tone	You are only permitted to place local and long-distance calls on this line. International calls may not be made due to call restrictions.	User does interrogation with K-Value=3 activated. Note: Only used for default OCB behavior.
1230 FS_CAUSE_OCB_K4	559	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is active with barring level 4.	User does interrogation with K-Value=4 activated.
1231 FS_CAUSE_OCB_K5	560	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is active with barring level 5.	User does interrogation with K-Value=5.
1232 FS_CAUSE_OCB_K6	561	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is active with barring level 6.	User does interrogation with K-Value=6.
1233 FS_CAUSE_OCB_K7	562	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is active with barring level 7.	User does interrogation with K-Value=7.
1234 FS_CAUSE_OCB_K8	563	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is active with barring level 8.	User does interrogation with K-Value=8.
1235 FS_CAUSE_OCB_K9	564	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is active with barring level 9.	User does interrogation with K-Value=9.
1236 FS_CAUSE_OCB_DEACT_K_ MISMATCH	565	SERVICE_ DENIED	Reorder-tone	Deactivating outgoing call barring failed. The barring level you have entered does not match that in your record.	User deactivate OCB requires providing K-Value and Match
1237 FS_CAUSE_OCB_ALREADY_ ACT_SAME_K	566	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is already activated with the barring level you just entered.	User continuously activate OCB with same K-Value
1238 FS_CAUSE_OCB_ALREADY_ DEACT	567	NORMAL_ CALL_ CLEARING	Confirmation- tone	Your outgoing call barring feature is already deactivated.	User continuously deactivate OCB when it already deactivated
1239 FS_CAUSE_OCB_ACT_REGIST_ PIN_SUCC	568	NORMAL_ CALL_ CLEARING	Confirmation- tone	You have successfully setup your password and activated outgoing call barring feature.	User activate OCB when no PIN registered.
1240 FS_CAUSE_OCB_ACT_REGIST_ PIN_FAIL	569	SERVICE_ DENIED	Reorder-tone	You cannot activate outgoing call barring feature without setting up your password, please try again.	User activate OCB when no PIN registered, PIN invalid.
1241 FS_CAUSE_OCB_INV_K1	572	SERVICE_ DENIED	Reorder-tone	Your outgoing call barring feature is active with barring level 1 to block this call.	User invokes OCB when K-Value=1 activated.
1242 FS_CAUSE_OCB_INV_K2	573	SERVICE_ DENIED	Reorder-tone	Your outgoing call barring feature is active with barring level 2 to block this call.	User invokes OCB when K-Value=2 activated.
1243 FS_CAUSE_OCB_INV_K3	574	SERVICE_ DENIED	Reorder-tone	Your outgoing call barring feature is active with barring level 3 to block this call.	User invokes OCB when K-Value=3 activated.
1244 FS_CAUSE_OCB_INV_K4	575	SERVICE_ DENIED	Reorder-tone	Your outgoing call barring feature is active with barring level 4 to block this call.	User invokes OCB when K-Value=4 activated.
1245 FS_CAUSE_OCB_INV_K5	576	SERVICE_ DENIED	Reorder-tone	Your outgoing call barring feature is active with barring level 5 to block this call.	User invokes OCB when K-Value=5 activated.
1246 FS_CAUSE_OCB_INV_K6	577	SERVICE_ DENIED	Reorder-tone	Your outgoing call barring feature is active with barring level 6 to block this call.	User invokes OCB when K-Value=6 activated.
1247 FS_CAUSE_OCB_INV_K7	578	SERVICE_ DENIED	Reorder-tone	Your outgoing call barring feature is active with barring level 7 to block this call.	User invokes OCB when K-Value=7 activated.
1248 FS_CAUSE_OCB_INV_K8	579	SERVICE_ DENIED	Reorder-tone	Your outgoing call barring feature is active with barring level 8 to block this call.	User invokes OCB when K-Value=8 activated.
1249 FS_CAUSE_OCB_INV_K9	580	SERVICE_ DENIED	Reorder-tone	Your outgoing call barring feature is active with barring level 9 to block this call.	User invokes OCB when K-Value=9 activated.

1 The release cause code must be a value greater than 1000. If a new announcement is created, it must be assigned an unallocated value greater than 1000. 2 Although the text of an announcement may be changed abruptly, the purpose of the announcement must remain as defined here.

Recoverable and Non-Recoverable Error Codes (Release 4.4.1)

There are no new, modified, or deleted error codes related to the enhancements to the OCB feature described in this document.

References

The following sections provide references related to the Outgoing Call Barring feature.

CLI Reference Guide (Release 4.4.1)

This section describes new or modified CLI command, tokens, or values introduced with the implementation of the OCB feature.

---

Note All existing commands used with this feature are documented in the Cisco BTS 10200 Softswitch Command Reference Guide.

---

---

Caution This section describes only the information that is new for Enhanced OCB. Tables, tokens, and values that remain unchanged are not included here.

---

Object Commands (Release 4.4.1)

Configuring Outgoing Call Barring includes provisioning the following objects for Enhanced OCB:

•Modified Call Agent Configuration (CA-CONFIG) table [Chapter 1]

•Modified Point of Presence (POP) table

•OCB PROFILE table

•OCB-K-VALUE table

Modified CA-CONFIG Table (Release 4.4.1)

For office-level provisioning, the CA-CONFIG table includes the following token.

---

Note For the full description of the CA-CONFIG table, see Chapter 1: Call Agent Provisioning in the Cisco BTS 10200 Softswitch Command Line Interface Reference Guide for Release 4.1, 4.2, 4.3, 4.4,and 4.5.

---

Syntax Description

DEFAULT- OCB- PROFILE-ID

Specifies the default office-based Outgoing Call Barring Profile ID that is used if the POP-specific OCB-PROFILE_ID is not provisioned. STRING:

Modified Point of Presence Table (Release 4.4.1)

To support the OCB feature, the Point of Presence (POP) table includes the following token.

---

Note For the full description of the POP table, see Chapter 2: Office Provisioning in the Cisco BTS 10200 Softswitch Command Line Interface Reference Guide for Release 4.1, 4.2, 4.3, 4.4,and 4.5.

---

Syntax Description

OCB-PROFILE-ID

Foreign key: OCB Profile table.The OCB Profile ID.If not provisioned, the OCB feature uses the default values defined in the Feature table. VARCHAR(16): 1-16 ASCII characters.

OCB PROFILE Table (Release 4.4.1)

The Outgoing Call Barring (OCB) Profile (ocb-profile) table defines an OCB Profile. The OCB Profile can be defined at a POP level by provisioning the ocb-profile-id, in the Point of Presence (POP) table, or at the office level by provisioning the default-ocb-profile-id in the Call Agent Configuration (CA-CONFIG) table. If an OCB Profile id is not provisioned in either the POP table or the CA-CONFIG table, then a default OCB behavior is used.

---

Note If an ocb-profile-id is provisioned in the POP table and CA Config table, the value in the POP table has precedence.

---

Table Name: OCB-PROFILE

Table Containment Area: FSPTC, EMS

Command Types

Show, add, change, and delete

Examples

show ocb-profile id=atlantaPop;

add ocb-profile id=atlantaPop;

change ocb-profile id=atlantaPop; all-calls-restrict-k-value=9;

delete ocb-profile id=atlantaPop;

help ocb-profile;

Usage Guidelines

Primary Key Token(s): id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* ID	Primary key.The OCB profile ID. VARCHAR(16): 1-16 ASCII characters.
MAX-K-VALUES	Specifies the maximum number of k-values supported by the OCB feature. INTEGER: 1-9 (Default = 3).
ALL-CALLS- RESTRICT-K-VALUE	The default K-value.The default k-value restricts all calls except emergency and other calls as defined by the COS Trigger Escape List. INTEGER: 0-9 (Default = 1). 0—Specifies that the all-call-restriction option does not apply.
FAIL-CNT	Fail count. Specifies the number of consecutive failures allowed before the service is locked. INTEGER: 0-10 (Default = 3). 0—No service lockout. 1-10—Specifies the number of invalid attempts to activate or deactivate OCB before service is locked out.
PIN-LEN	Specifies the private identification number (PIN) length used by the OCB feature. INTEGER: 1-8 (Default = 4).
LOCK-OUT	Specifies the lock-out period of time in minutes.The service is locked out for activation or deactivation during this lockout period after the fail-cnt reaches the specified threshold.The lockout period begins after the last failed attempt. INTEGER 0-180 (Default = 30). 0—Lockout indefinitely. The service provider must reset the subscriber to unlock.
TIME-OUT	Specifies a duration in minutes within which the number of consecutive failures is counted. The duration begins with the first failure. INTEGER: 0-180 (Default = 30). 0—Ignore all failures.
DEACTIVATION- OPTION	Specifies how the k-value affects OCB deactivation. VARCHAR(20): 1-20 ASCII characters.Permitted values are: NO-K-VALUE (Default)—K-value is not required for deactivation. K-VALUE-MATCH—K-value is required and must match the current K-Value used during activation. K-VALUE-NO-MATCH—K-value is required but is not matched with the K-value used during activation.
FREE-SELECT-PIN (New for Enhanced OCB in Cisco BTS 10200 Release 4.4.1.)	Specifies whether the user's PIN is registered when the OCB feature is initially activated. CHAR(1): Y (yes) or N (no). Y—the user PIN is registered when the OCB feature is first activated. N—the user PIN is not registered when the OCB feature is first activated.
DESCRIPTION (EMS-only field)	Service provider's description. VARCHAR(64): 1-64 ASCII characters.

OCB-K-VALUE Table (Release 4.4.1)

The OCB K Value (ocb-k-value) table associates call types to a particular k-value. A k-value is an integer from 1 to 9 that is dialed by a user to select different levels of OCB restrictions. Multiple call types can be provisioned against each k-value. A call type can be associated with multiple k-values. Each call type/k-value combination generates one unique record in the EMS.

---

Note Multiple Call Types can be specified during add and delete commands. If multiple call types are specified in a command and one of the call types is invalid, then the whole command is rejected and must be re-provisioned.

---

---

Note Use the forced token to delete all records against a particular K-value or to delete all records for OCB-PROFILE-ID.

---

Table Name: OCB-K-VALUE

Table Containment Area: FSPTC, EMS

Command Types

Show, add, delete, and help

Examples

show ocb-k-value ocb-profile-id=atlantaPop;

add ocb-k-value ocb-profile-id=atlantaPop; k-value=1; call-type=local, national, intl, 
mobile;

delete ocb-k-value ocb-profile-id=atlantaPop; k-value=1; call-type=local;

delete ocb-k-value ocb-profile-id=atlantaPop; FORCED=Y; deletes all records associated 
with the atlantaPop;

delete ocb-k-value ocb-profile-id=atlantaPop; k-value=3; FORCED=Y; deletes all records 
associated with atlantaPop and k-value=3:

help ocb-k-value;

Usage Guidelines

Primary Key Token(s): ocb-profile-id, k-value, call-type

Foreign Key Token(s): ocb-profile-id

Add Rules: None.

Change Rules: None.

Delete Rules: None.

Syntax Description

* OCB-PROFILE-ID	Primary key. Foreign key: OCB Profile table. The OCB Profile id as specified in the OCB Profile table. VARCHAR(16) 1-16 ASCII characters.
* CALL-TYPE	Primary key. Foreign key: Call Type table. Specifies the call type to block for the associated k-value. VARCHAR(16): 1-16 ASCII characters.
* K-VALUE	Primary key. The k-value associated with the call type. INTEGER: 1-9.
FORCED	Specifies whether all records for a particular K-VALUE are to be deleted. Use FORCED =Y: •If multiple records for an OCB-PROFILE-ID are to be deleted. •If a K-VALUE is specified, all records for the specified K-value and OCB-PROFILE-ID are to be deleted. •If only OCB-PROFILE-ID is specified, all records for the specified OCB-PROFILE-ID are deleted. CHAR(1): Y/N (Default = N). N—Do not delete all records. Y—Delete all records. Note Valid only for the delete command. If FORCED =Y, the specified call-type token is not allowed.

Related Documents

The Cisco BTS 10200 Softswitch user documentation set is available online at:

http://www.cisco.com/univercd/cc/td/doc/product/voice/bts10200/index.htm

Access to this site requires a special username and password. Please contact your Cisco account team for this access information.

Related Topic	Document Title
Task-oriented guide for provisioning the database	Cisco BTS 10200 Softswitch Provisioning Guide
Reference listing all provisionable tables and tokens	Cisco BTS 10200 Softswitch Command Line Interface (CLI) Reference Guide
OAM&T procedures	Cisco BTS 10200 Softswitch Operations, Maintenance, and Troubleshooting Guide
Information necessary to manage the Cisco BTS 10200 Softswitch accounting subsystem	Cisco BTS 10200 Softswitch Billing Interface Guide

Industry Standards

The Cisco BTS 10200 Softswitch support for the Outgoing Call Barring feature complies with the following industry standard:

Standard	Title
ITU-T (I255.5)	Outgoing Call Barring

Copyright © 2005 Cisco Systems, Inc. All rights reserved.