Getting Started

Published: September 23, 2015

Introduction

This chapter explains how to install, compile, and run the Cisco SCA BB Service Configuration API.

System Requirements

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).

Installation Package

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:

Distribution Content

The Service Configuration API distribution package installs the following folders and files:

  • <installation folder>

– README

  • <installation folder>\doc

– serviceconfig-javadoc.zip— The Service Configuration API Javadoc documentation

  • <installation folder>\lib

– serviceconfigapi.jar— The Service Configuration API library

– jdmkrt.jar

This folder may contain additional library JAR files that are necessary for the Service Configuration API operation.

Installing the Package

To install the package, unpack the TGZ file (keeping the folder structure) to an empty folder.

  • On Windows platforms, use any common Windows compression utility to extract the file.
  • On Linux platform, use:

#> tar -xvfpz serviceconfig-java-api-dist.tgz

The Service Configuration API is now installed and ready for use.

Compiling and Running the Service Configuration API

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:

#>javac -classpath.;<installation folder>\lib\serviceconfigapi.jar MyApiClass.java
 

To run the program, the command line should be:

#>java -cp.;<installation folder>\lib\serviceconfigapi.jar MyApiClass
 

Running the Service Configuration API with Java Version 1.5

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:

-Xbootclasspath/p:<installation folder>/lib/jdmkrt.jar
 

For example:

#>java -Xbootclasspath/p:<installation folder>/lib/jdmkrt.jar -cp.;<installation folder>/lib/serviceconfigapi.jar MyApiClass
 

Service Control Engine Platform Setup

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:

Cisco SCA BB Setup

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.

Proprietary Remote Procedure Call Server

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.

Before using the Service Configuration API, ensure that:

  • SCE is up and running, and reachable from the machine that hosts the Service Configuration API.
  • PRPC server on the SCE has started.