cc/td/doc/product/cable/svc_ctrl/scmgtsu
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table Of Contents

About this Guide

Audience

Document Revision History

Organization

Related Publications

Document Conventions

Obtaining Documentation, Obtaining Support, and Security Guidelines


About this Guide


Revised: May 30, 2007, OL-7204-05

The SCMS SM Java API is used for updating, querying, and configuring the Subscriber Manager (SM). It consists of two parts, which may be used separately or together without restriction.

SM Non-blocking Java API: A high-performance API with low visibility to errors and other operation results. Supports automatic integrations with OSS/AAA systems.

SM Blocking Java API: A more user-friendly API. Supports user interface applications for accessing and managing the SM.


Note A set of APIs with exactly the same functionality is also available for the C/C++ environment.


This introduction provides information about the following topics:

Audience

Document Revision History

Organization

Related Publications

Document Conventions

Obtaining Documentation, Obtaining Support, and Security Guidelines

Audience

This guide is for the networking or computer technician responsible for configuring the Subscriber Manager. It is also intended for the operator who manages the SCE platforms.

Document Revision History

Cisco Service Control Release
Part Number
Publication Date

Release 3.1.0

OL-7204-05

May, 2007


Description of Changes

Support for moving subscribers between domains. See Subscriber Domains, page 5 and the "Parameters" section of the login method.

Updated Subscriber Name Format, page 4.

Cisco Service Control Release
Part Number
Publication Date

Release 3.0.5

OL-7204-04

November, 2006


Description of Changes

Updated documentation for release 3.0.5.

Cisco Service Control Release
Part Number
Publication Date

Release 3.0.3

OL-7204-03

May, 2006


Description of Changes

Updated documentation for release 3.0.3.

Cisco Service Control Release
Part Number
Publication Date

Release 3.0

OL-7204-02

December, 2005


Description of Changes

Reorganization of documentation. No major changes or new features were added to this revision.

Cisco Service Control Release
Part Number
Publication Date

Release 2.5.7

OL-7204-01

May, 2005


Description of Changes

This is the first version of this document.

Organization

The major sections of this guide are as follows:

Table 1

Chapter
Title
Description

Chapter 1

Getting Started, page 1 

Describes the platforms on which the Java API can be used, how to install, compile, and start running the Java API component.

Chapter 2

General API Concepts, page 1 

Provides a description of the various concepts that are used when working with the SM Java API.

Chapter 3

  Blocking API, page 1

Describes the features and operations of the Blocking API and provides code examples.

Chapter 4

Non-blocking API, page 1 

Describes the features and operations of the Non-blocking API and provides code examples.

Appendix A

List of Error Codes, page 1 

Provides a list of error codes that are used in the Java API.


Related Publications

Use this SCMS SM Java API Programmer Guide in conjunction with all of the SCMS Subscriber Manager User, API, and Reference Guides.

Document Conventions

This guide uses the following conventions:

Bold is used for commands, keywords, and buttons.

Italics are used for command input for which you supply values.

Screen font is used for examples of information that are displayed on the screen.

Bold screen font is used for examples of information that you enter.

Vertical bars ( | ) indicate separate alternative, mutually exclusive elements.

Square brackets ( [ ] ) indicate optional elements.

Braces ( {} ) indicate a required choice.

Braces within square brackets ( [{}] ) indicate a required choice within an optional element.


Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the guide.



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



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


Warning Means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, you must be aware of the hazards involved with electrical circuitry and familiar with standard practices for preventing accidents. To see translated versions of warnings, refer to the Regulatory Compliance and Safety Information document that accompanied the device.


Obtaining Documentation, Obtaining Support, and Security Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, 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


hometocprevnextglossaryfeedbacksearchhelp

Posted: Thu May 31 04:28:28 PDT 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.