Table Of Contents

About this Guide

Introduction

Document Revision History

Organization

Related Documentation

Conventions

Obtaining Documentation and Submitting a Service Request

About this Guide

---

Revised: July 28, 2009, OL-8236-08

Introduction

The Cisco SCMS SCE Subscriber API Programmer Guide is used for integrations that require direct access to the Cisco Service Control Engine (SCE) platform for subscriber provisioning purposes.

This guide is intended for the networking or computer technician responsible for integrations involving policy servers that perform subscriber provisioning with the SCE platform.

Document Revision History

The Document Revision History below records changes to this document.

Table 1 Document Revision History 

Revision	Cisco Service Control Release and Date	Change Summary
OL-8236-08	3.5.5 July 28, 2009	Versioned document to Release 3.5.5.
OL-8236-07	3.5.0 June 19, 2009	The SCE Subscriber API is now operable on platforms that support Java version 5.0 and is not operable on platforms that support version 1.4. Corrected CLI command format. #>logger get user-log file-name <FILE NAME>
OL-8236-06	3.1.6 May, 2008	Private IP address over VLAN and private IP range over VLAN are now supported for the Network ID. See Information About Network ID Mappings, page 4-2 and Specifying Private IP Address or Private IP Range over VLAN Mapping, page 4-3.
OL-8236-05	3.1.5 November, 2007	VLAN mapping type deprecated and replaced by VPN mapping type. See Information About Network ID Mappings, page 4-2.
OL-8236-04	3.1.0 May, 2007	Added new RedundancyStateListener interface to support cascade SCE setups. See Information About SCE Cascade Topology Support, page 5-14.
OL-8236-03	3.0.5 November, 2006	•Added new section on Quota State Restore Event, page 3-7. •Updated SCAS_BB_Quota, page 4-7 class. •Updated the QuotaListenerEx interface due to deprecation of the QuotaListener interface. See Information About the QuotaListenerEx Interface Class, page 5-11.
OL-8236-02	3.0.3 May, 2006	Updated API code examples. See API Code Examples, page 5-39.
OL-8236-01	3.0 December, 2005	First version of this document.

Organization

This guide contains the following sections:

Table 2 Document Organization 

Section	Title	Description
1	Getting Started, page 1-1	Discusses the platforms on which the SCE Subscriber Application Programming Interface (API) can be used, and how to install, compile, and start running the API.
2	Concepts and Terms, page 2-1	Describes various terms and concepts that are utilized when working with the SCE Subscriber API.
3	Application Programming Interface Events, page 3-1	Describes various events accessed by the SCE Subscriber API.
4	Getting Familiar with the Application Programming Interface Data Types, page 4-1	Describes the various API data types.
5	Programming with the Service Control Engine Subscriber Application Programming Interface, page 5-1	Provides a detailed description of the API programming structure, classes, methods, and interfaces.
6	Troubleshooting, page 6-1	Describes the usage of the API logging abilities for troubleshooting the integration with the API. API logging enables the user to monitor the operations being called including the received parameters both at the API client and at the SCE side.
A	List of Error Codes, page A-1	Lists the error codes that are returned by the API.

Related Documentation

Use this API guide in conjunction with the following Cisco documentation:

•Cisco Service Control Management Suite Subscriber Manager User Guide

•Cisco Service Control Application for Broadband User Guide

•Cisco SCE 1000 2xGBE Installation and Configuration Guide

•Cisco SCE 2000 Installation and Configuration Guide

Conventions

This document uses the following conventions:

Table 3 Conventions 

Convention	Indication
bold font	Commands and keywords and user-entered text appear in bold font.
italic font	Document titles, new or emphasized terms, and arguments for which you supply values are in italic font.
[ ]	Elements in square brackets are optional.
{x | y | z }	Required alternative keywords are grouped in braces and separated by vertical bars.
[ x | y | z ]	Optional alternative keywords are grouped in brackets and separated by vertical bars.
string	A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.
courier font	Terminal sessions and information the system displays appear in courier font.
< >	Nonprinting characters such as passwords are in angle brackets.
[ ]	Default responses to system prompts are in square brackets.
!, #	An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.

---

Note Means reader take note.

---

---

Tip Means the following information will help you solve a problem.

---

---

Caution Means reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data.

---

---

Timesaver Means the described action saves time. You can save time by performing the action described in the paragraph.

---

---

Warning Means reader be warned. In this situation, you might perform an action that could result in bodily injury.

---

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.