About this Guide

About this Guide

Revised: June 05, 2013, OL-24174-05

Introduction

This chapter describes who should read Cisco Service Control Application for Broadband Reference Guide, how it is organized, its document conventions, and how to obtain documentation and technical assistance. This guide assumes a basic familiarity with the concept of the Cisco Service Control solution, the Service Control Engine (SCE) platforms, and related components.

This guide provides information about the data structures created and used by Cisco Service Control Application for Broadband (Cisco SCA BB). It is intended for the:

  • Administrator who is responsible for daily operations of the Cisco Service Control solution.
  • Integrators who are developing applications on top of Cisco SCA BB.

Document Revision History

Table 1 records changes to this document.

 

Table 1 Document Revision History

Revision
Cisco Service Control
Release Number and Date
Change Summary

OL-24174-05

Supports all 3.7.x releases
June 05, 2013

Updated the GENERATOR_ID feld in the Link Usage RDR

OL-24174-04

Supports all 3.7.x releases
November 23, 2012

Updated Chapter2, “Raw Data Records: Formats and Field Contents”

OL-24174-04

Supports all 3.7.x releases
November 19, 2012

Updated Chapter2, “Raw Data Records: Formats and Field Contents”

OL-24174-04

Supports all 3.7.x releases
September 04, 2012

Updated Chapter4, “Database Tables: Formats and Field Contents”

OL-24174-04

Supports all 3.7.x releases
August 29, 2012

Updated Chapter2, “Raw Data Records: Formats and Field Contents”

OL-24174-04

Supports all 3.7.x releases
July 24, 2012

Updated Chapter2, “Raw Data Records: Formats and Field Contents”.

OL-24174-04

Supports all 3.7.x releases
April 30, 2012

Updated to resolve caveats.

OL-24174-04

Supports all 3.7.x releases
April 3, 2012

Updated with RDR information.

OL-24174-04

Supports all 3.7.x releases
March 22, 2012

Updated with information about the newly added fields for the following:

OL-24174-03

Supports all 3.7.x releases
February 14, 2012

Updated with minor information.

OL-24174-03

Supports all 3.7.x releases
January 06, 2012

Updated with information pertaining to Release 3.7.2.

Changes include new subscriber attribute fields in the RDRs. Updated information about the following RDRs:

HTTP Transaction Usage RDR

Subscriber Usage RDR

Video Transaction Usage RDR

OL-24174-02

Supports all 3.7.x releases
October 20, 2011

Updated for 3.7.1. Changes include:

  • Updated Media Flow RDRs with new protocol support.
  • Updated supported protocol tables with details of protocol pack 25.

Improved the quality of the user documentation by adding customer and internal feedback.

OL-24174-01

Supports all 3.7.x releases June 13, 2011

First version of this document (new for the Release 3.7.x train).

The following changes were made from the last release of the 3.6.x train:

  • Added the following RDRs:

Anonymized Transaction RDR

Anonymized Transaction Usage RDR

Anonymized HTTP Transaction Usage RDR

Anonymized RTSP Transaction Usage RDR

Anonymized VoIP Transaction Usage RDR

Anonymized Video Transaction Usage RDR

Anonymized Blocking RDR

Anonymized Flow Start RDR

Anonymized Flow End RDR

Anonymized Flow Ongoing RDR

Anonymized Media Flow RDR

Anonymized Spam RDR

  • Added details on RDR field SESSION_LINK_ID to Transaction Usage RDR.
  • Added details on Anonymous Group CSC file format.

Organization

Table 2 lists the document organization of this guide.

 

Table 2 Document Organization

Section
Title
Description

1

Default Service Configuration Reference Tables

Describes the default service configuration provided with Cisco SCA BB.

2

Raw Data Records: Formats and Field Contents

Lists the various RDRs produced by the SCE platform. Provides the structure of RDRs, describes the columns and fields of each RDR, and states under what conditions each RDR is generated.

Also provides field-content information for fields generated by Service Control components (such as tags), and a description of the Periodic RDR Zero Adjustment Mechanism.

3

NetFlow Records: Formats and Field Contents

Lists the RDRs whose data can be generated as NetFlow records and describes the fields possible in a NetFlow record.

4

Database Tables: Formats and Field Contents

Presents the different database tables used for storing RDRs (after their conversion by an adapter), and a description of the table columns (field names and types).

5

CSV File Formats

Describes the location and structure of CSV files pertaining to service configuration, subscriber management, and data collection management.

6

Cisco SCA BB Proprietary MIB Reference

Describes the part of the Cisco SCE proprietary MIB that provides configuration and run-time status for Cisco SCA BB.

Related Documentation

Use Cisco Service Control Application for Broadband Reference Guide with the following Cisco documentation:

Cisco SCE 1000 2xGBE Installation and Configuration Guide

Cisco SCE 2000 Installation and Configuration Guide

Cisco SCE 8000 10GBE Software Configuration Guide

Cisco SCE 8000 GBE Software Configuration Guide

Conventions

Table 3 lists the conventions used in this document.

 

Table 3 Document 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 includes the quotation mark.

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. Notes contain helpful suggestions or references to material not covered in the manual.



Tip Means the following information will help you solve a problem. The tips information might not be troubleshooting or even an action, but could be useful information, similar to a Timesaver.



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


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



Warning Means reader be warned. In this situation, you might perform an action that could result in bodily injury.


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.