Preface

The Cisco Broadband Access Center 3.7 Integration Developer's Guide describes the Cisco Broadband Access Center (BAC) Application Programming Interface (API). You can use this API to integrate
Cisco IP Solution Center (ISC) Multiprotocol Label Switching (MPLS) virtual private network (VPN) with your Business Support Systems (BSS) and Operational Support Systems (OSS).

This chapter provides an outline of the other chapters in this guide. It gives information about related documents that support this Cisco BAC release, and demonstrates the styles and conventions used in the guide.

This chapter contains the following sections:

•Audience

•Organization

•Conventions

•Product Documentation

•Obtaining Documentation and Submitting a Service Request

Audience

System integrators, network administrators, and network technicians can use this integration guide to integrate the various BSS and OSS with Cisco BAC. Only experienced users should use these instructions. To use the instructions in this guide, you must be familiar with:

•Cisco BAC architecture.

•Java programming.

Organization

This guide includes the following sections:

Section
Title
Description

Chapter 1

Introduction

Describes the components that integrate with Cisco BAC.

Chapter 2

Cisco BAC Architecture

Describes the Cisco BAC architecture and the functions of each component.

Chapter 3

Client and RDU Communication

Describes the communication between the Cisco BAC API and the Regional Distribution Unit (RDU).

Chapter 4

Batches and Commands

Describes the concepts and rules related to batches and how you can troubleshoot the errors that occur during integration.

Chapter 5

Events

Describes and explains how to register and handle Cisco BAC events.

Chapter 7

Getting Started with the BAC API

Describes how you can get started with the API.

Chapter 8

Use Cases

Describes some of the most common provisioning API use cases.


Conventions

This document uses the following 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.

Product Documentation

Note We sometimes update the printed and electronic documentation after original publication. Therefore, you should also review the documentation on http://www.cisco.com for any updates.

Table 1 describes the product documentation that is available.

Table 1 Product Documentation 

Document Title
Location

Cisco Broadband Access Center 3.7 Documentation Overview

On Cisco.com at this URL:
http://www.cisco.com/en/US/docs/net_mgmt/broadband_access
_center/3.7/documentation/overview/Cisco_BAC37
_DocOverview.html

Cisco Broadband Access Center 3.7 Release Notes

On Cisco.com at this URL:
http://www.cisco.com/en/US/products/sw/netmgtsw/ps529/
prod_release_notes_list.html

Cisco Broadband Access Center 3.7 Installation Guide

On Cisco.com at this URL:
http://www.cisco.com/en/US/products/sw/netmgtsw/ps529/
prod_installation_guides_list.html

Cisco Broadband Access Center 3.7 Administrator Guide

On Cisco.com at this URL:
http://www.cisco.com/en/US/products/sw/netmgtsw/ps529/
prod_maintenance_guides_list.html

Cisco Broadband Access Center 3.7
DPE CLI Reference

On Cisco.com at this URL:
http://www.cisco.com/en/US/products/sw/netmgtsw/ps529/
prod_command_reference_list.html

Cisco Broadband Access Center 3.7 Third Party and Open Source Copyrights

On Cisco.com at this URL:
http://www.cisco.com/en/US/products/sw/netmgtsw/ps529/
products_licensing_information_listing.html


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 an RSS feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service. Cisco currently supports RSS Version 2.0.