The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter explains how to install, compile, and run the Cisco SCA BB Service Configuration API.
You can run the Service Configuration API on Windows and Linux platforms.
Compiling and running Java programs by using the Service Configuration API requires Java Development Kit (JDK) and Java Runtime Environment (JRE) versions 1.4 or 1.5.
Note To use the API with Java Version 1.5, you must set a special JRE option (see the “Running the Service Configuration API with Java Version 1.5” section).
The Service Configuration API distribution is packaged in the serviceconfig-java-api-dist.tgz file, which is included in the SCA BB installation package.
This section consists of these topics:
The Service Configuration API distribution package installs the following folders and files:
– serviceconfig-javadoc.zip— The Service Configuration API Javadoc documentation
– serviceconfigapi.jar— The Service Configuration API library
This folder may contain additional library JAR files that are necessary for the Service Configuration API operation.
To install the package, unpack the TGZ file (keeping the folder structure) to an empty folder.
#> tar -xvfpz serviceconfig-java-api-dist.tgz
The Service Configuration API is now installed and ready for use.
To compile and run a program that uses the Service Configuration API, you must have serviceconfigapi.jar in the CLASSPATH.
For example, if your program source is in MyApiClass.java, your compilation command line should be:
To run the program, the command line should be:
To use the Service Configuration API with Java Version 1.5, some library classes must precede the JRE classes in the boot classpath. Add the following argument to the command line:
The following sections describe the configuration that is performed on the Cisco SCE platform to allow correct Service Configuration API functioning.
This section consists of these topics:
The Service Configuration API configures Cisco SCA BB, which should be installed on the Cisco SCE platform. For more information, see the Cisco Service Control Application for Broadband User Guide.
The Service Configuration API uses the Proprietary Remote Procedure Call (PRPC) protocol as a transport for the connection to the SCE. PRPC is a proprietary RPC protocol designed by Cisco. For more information, see the Cisco SCMS SCE Subscriber API Programmer Guide.