Preface

Preface
Preface
This preface describes who should read the Cisco SCA BB Service Configuration API Programmer
Guide, how it is organized, and its document conventions.
This guide is for Java developers responsible for integrations involving tools that automatically
configure the Service Control Application running on a Service Control Engine (SCE) platform.
Document Revision History
Cisco Service Control Release
Part Number
Publication Date
Release 3.1.5
OL-7207-04
January, 2008
Cisco Service Control Release
Part Number
Publication Date
Release 3.1.0
OL-7207-03
May, 2007
Cisco Service Control Release
Part Number
Publication Date
Release 3.0.0
OL-7207-02
December, 2005
Description of Changes
This document was completely rewritten for version 3.0 of the Cisco Service Control Application for
Broadband (SCA BB). The document title was also modified.
Cisco Service Control Release
Part Number
Publication Date
Release 2.5.5
OL-7207-01
February, 2005
Description of Changes
Created the Service Control Application Suite for Broadband API Programmer’s Guide.
Cisco SCA BB Service Configuration API Programmer Guide
OL-7207-04
v
Preface
Organization
The major sections of this guide are as follows:
Table 1
Documentation Organization
Chapter
Title
Description
Chapter 1
SCA BB Service Configuration
API Overview
Describes the various terms and
concepts that are used when
working with the Cisco SCA BB
Service Configuration API
(Service Configuration API).
Chapter 2
Getting Started
Explains how to install, compile,
and run the Service
Configuration API.
Chapter 3
Programming with the SCA BB
Service Configuration API
Provides a detailed description
of the Service Configuration API
programming structure and
classes, and of methods of the
main Service Configuration
Management API class, and also
contains programming
guidelines and code examples.
Chapter 4
Logging and Troubleshooting
Describes the Service
Configuration API logging
functionality that allows you to
troubleshoot the Service
Configuration API integration.
Related Publications
The following publications are available for the Cisco Service Control Application for Broadband:
•
Cisco Service Control Application for Broadband Reference Guide
•
Cisco Service Control Application for Broadband User Guide
•
Cisco SCMS SCE Subscriber API Programmer Guide
•
The SM API programmers guides:
– Cisco SCMS SM Java API Programmer Guide
– Cisco SCMS SM C/C++ API Programmer Guide
•
Cisco Service Control Management Suite Subscriber Manager User Guide
To view Cisco documentation or obtain general information about the documentation, refer to the
following sources:
•
Obtaining Documentation and Submitting a Service Request, page viii
•
The Cisco Information Packet that shipped with your SCE 2000 platform.
Cisco SCA BB Service Configuration API Programmer Guide
vi
OL-7207-04
Preface
Conventions
This document uses the following conventions:
Table 2
Documentation Conventions
Convention
Description
boldface font
Commands and keywords are in boldface.
italic font
Arguments for which you supply values are in
italics.
[]
Elements in square brackets are optional.
{x | y | z}
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.
screen font
Terminal sessions and information that the system
displays are in screen font.
boldface screen
italic screen
Note
Caution
Warning
font
font
Information you must enter is in boldface screen
font.
Arguments for which you supply values are in
italic screen 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.
Means reader take note. Notes contain helpful suggestions or references to materials not covered in this
manual.
Means reader be careful. In this situation, you might do something that could result in equipment
damage or loss of data.
Means reader be warned. In this situation, you might do something that could result in bodily injury.
Cisco SCA BB Service Configuration API Programmer Guide
OL-7207-04
vii
Preface
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.
Cisco SCA BB Service Configuration API Programmer Guide
viii
OL-7207-04
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising