Sunteți pe pagina 1din 87
Broadband Communications Sector Copyright © 2000 Motorola, Inc. All rights reserved . Security Level 1

Broadband Communications Sector

Copyright © 2000 Motorola, Inc. All rights reserved.

Security Level 1

CS-1000 User's Guide

Document Number:

365-095-1578

Revision:

X.11

Author:

Pat O'Connell-Racicot

Revision Date:

11/27/02

Pat O'Connell-Racicot Revision Date: 11/27/02 Broadband Communication Sector 101 Tournament Drive Horsham,

Broadband Communication Sector 101 Tournament Drive Horsham, PA 19044

CS-1000 User's Guide

Rev

Number

Description

Incorporated By

Date

X.1

365-095-1578

CS-1000 User's Guide

Pat O'Connell-Racicot

1/15/01

X.2

365-095-1578

Updated to reflect changes made to the CS-1000 in software release 3.2.0

Pat O'Connell-Racicot

3/30/01

x.3

365-095-1578

Updated to reflect corrections made to the CDG section of the document.

Pat O'Connell-Racicot

4/16/01

X.4

365-095-1578

Updated to reflect new CDG utility functionality that will allow use of CDG with DCT5xxxs.

Pat O'Connell-Racicot

6/6/01

 

Incorporated changes for Release 3.3.0 Added a section describing how to manage

 

X.5

365-095-1578

StagingAreas and FTP User Logins Added all necessary text describing new import and export tools. Changed ConfigFile section to reflect new enhancements. Replaced figure 4.8-1 to reflect changes to the GUI window.

Todd Fisher

9/25/01

X.6

365-095-1578

Added a note to the “Add a Carousel” section describing carousel behavior when a CS-1000 is powered on from a powered off state. Added in the Content Management descriptions to the Status and Control section and the DMG tag descriptions to the PDCS carousel section. Added in the description of Content Management and PID MUX features. Updated GUI screen captures. Added description of the EDSC carousel type in Section

Todd Fisher

11/15/01

   

X.7

365-095-1578

Pat O’Connell-Racicot

1/2/02

   

1.1

X.8

365-095-1578

Added a new section to the Introduction for DMG Added a new section for the Edit Stream Data Source window. Performed a general review and update of entire guide, Added notes about the importance of setting the time and timezone correctly on both the server machine and the GUI machine. Corrected XML format for ASTB_TUNE and BOOT_CODE CONTROL messages.

Todd Fisher

4/23/02

   

X.9

365-095-1578

Todd Fisher

5/16/02

   

X.10

365-095-1578

Modified Figure 4.1-1 CS Graphical User Interface

Bing Mu

8/26/02

X.11

365-095-1578

Add CFS Stream Output Directories section to CS GUI.

Todd Fisher

11/27/02

Date

Document Title

11/27/02

CS-1000 User's Guide

 
 
  Document Number: 365-095-1578

Document Number:

365-095-1578

Broadband Communications Sector 101 Tournament Drive Horsham PA 19044

Revision Number:

X.11

CS-1000 User's Guide

CS-1000 User's Guide Table of Contents 1 Introduction 6 1.1 Types of Carousels 6 1.2 CS-1000

Table of Contents

1

Introduction

6

1.1 Types of Carousels

6

1.2 CS-1000

7

1.3 CFS API

7

1.4 CS GUI

7

1.5 Communication Interfaces

8

1.6 Code Download Generator (CDG)

8

1.7 DCII Message Generator (DMG)

8

1.8 SNMP Support

8

 

2 Scope

9

3 CS Concepts

9

3.1 CS Network Interfaces

9

3.2 CS Configuration

10

3.2.1 CFS Stream Set/Stream Configuration

11

3.2.2 PDCS Stream Set/Stream Configuration

11

3.3

CFS

12

3.3.1 File Systems

12

3.3.2 Staging Areas

14

3.3.3 Types of Data

15

3.4

PDCS

16

3.4.1 Code Download Generator (CDG)

16

3.4.2 DCII Message Generator (DMG)

16

3.5

PID Multiplexing

18

3.5.1 External Data Source Carousel (EDSC)

18

3.5.2 Data Sources

18

4 CS GUI

19

4.1 CS-1000 Menu Structure

19

4.2 CS GUI Startup

20

4.2.1

CS GUI Login

21

4.3

CS GUI Main Menu

22

4.3.1 System Menu

23

4.3.2 Configure Menu

24

4.3.3 Window and Help Menus

25

4.4

System – Users…

26

4.4.1

User Privileges

27

4.5

System – Status and Control…

28

4.5.1 Manage Content

29

4.5.2 Stream Set Status

31

4.6 System – Export…

33

4.7 System – Import…

34

4.8 Configure - CFSOOBTAB

35

4.8.1

OOBTAB Entries

36

4.9

Configure – Interfaces…

38

4.9.1

Add an IP Interface

39

4.10

Configure – Data Sources…

40

4.10.1 Add an IP Data Source

41

4.10.2 Add an IP Data Source Address

42

CS-1000 User's Guide

4.11

Configure – Carousels…

43

4.11.1 Add a Carousel

43

4.11.2 CFS Directory

46

4.11.3 Add a Stream Set

47

4.11.4 Add a Stream

48

4.11.5 Output Directories

52

4.11.6 Edit an EDCS Stream

53

4.11.7 Edit Stream_Interface

53

4.11.8 Edit Stream_DataSource

54

5 CFS Content Management

55

5.1

Managing StagingAreas and FTP User Logins

55

5.1.1 Add an ISV User

55

5.1.2 Delete an ISV User

55

5.2 Metadata File Format

56

5.3 Rules for using Metadata Files

57

5.4 CFS OOBTAB Metadata File

58

6 PDCS Content Management

58

7 Code Download Generator (CDG) and DCII Message Generator (DMG)

58

7.1 CDG XML File Format

59

7.2 DMG XML File Format

61

7.2.1

DCII Message Generator (DMG) Tags

61

7.3

PDCS Streams

63

7.3.1 Control Stream Message

64

7.3.2 Code Download Message

64

7.4

DCT5xxx Specific Subcommands and Messages

66

7.4.1 Boot Code Control

67

7.4.2 ASTB Tune

68

7.4.3 Object Conditional Access

71

7.5 Preambles

72

7.6 Creating the DCII Download/Message File

73

7.7 Downloading Code Objects

73

7.8 Clearing a DCII Message from the Carousel

74

8 CS-1000 Setup in a Local Headend

75

8.1 Define Source

75

8.2 Define a Digital (Download) Service

76

8.3 Define Service in Channel Map (Adding Channel Map Assignments)

78

8.4 Obtain the application PID

78

8.5 Define Multicast 16 Address Set

79

8.6 Add Multicast 16 Address for CS Server

80

8.7 Update the DAC Database for Multicast 16 Address

81

8.8 Obtain IP Addresses of Headend Network

82

8.9 Define the UDP Port within the OM 1000

83

9 CS File Maintenance

9.1

9.2

9.2.1

9.2.2

Persistent Data Store Log Files Log File Trace Settings Log File Naming Conventions

10

Acronyms

84

84

84

84

85

87

CS-1000 User's Guide

List of Figures and Tables

FIGURE 3.1-1 - CS CONFIGURATION IN A HEADEND

10

FIGURE 3.2-1 - CS SERVER COMPONENTS

11

FIGURE 3.3-1 - CFS VIRTUAL FILE SYSTEM

12

FIGURE 3.3-2 - CFS OOBTAB

13

FIGURE 3.3-3 - CFS OVERALL VIRTUAL FILE SYSTEM

14

FIGURE 3.3-4 - CFS STAGING AREA

15

FIGURE 3.4-1 - CODE DOWNLOAD GENERATOR (CDG) PROCESS

17

FIGURE 4.1-1 - CS GRAPHICAL USER INTERFACE

19

FIGURE 4.2-1

- CONNECTION WINDOW

20

FIGURE 4.2-2 - INCOMPATIBLE VERSION MESSAGE

21

FIGURE 4.2-3

- LOGIN WINDOW

21

FIGURE 4.3-1 - CS GUI MAIN MENU

22

FIGURE 4.3-2

- SYSTEM MENU

23

FIGURE 4.3-3 - CONFIGURE MENU

24

FIGURE 4.3-4 - WINDOW MENU

25

FIGURE 4.4-1 - USER LIST

26

FIGURE 4.4-2

- ADD USER

27

FIGURE 4.5-1

- CAROUSEL STATUS AND CONTROL

28

FIGURE 4.5-2 - CFS CAROUSEL MANAGEMENT

29

FIGURE 4.5-3

- STREAM SET STATUS-VERSION TABLE

31

FIGURE 4.5-4 - STREAM SET STATUS-STREAM TABLE

31

FIGURE 4.5-5 - STREAM SET STATUS-DIRECTORY TABLE

31

FIGURE 4.5-6 - STREAM SET STATUS-FILE TABLE

31

FIGURE 4.6-1

- EXPORT

33

FIGURE 4.7-1

- IMPORT

34

FIGURE 4.8-1 - ADD CFS OOBTAB

35

FIGURE 4.8-2 - ADD OOBTAB ENTRY

36

FIGURE 4.9-1

- INTERFACES

38

FIGURE 4.9-2 - ADD IP INTERFACE

39

FIGURE 4.10-1

- DATA SOURCES

40

FIGURE 4.10-2

- EDIT IP DATA SOURCE

41

FIGURE 4.11-1

- CAROUSELS

43

FIGURE 4.11-2

- ADD/EDIT CAROUSEL

44

FIGURE 4.11-3

- CFS DIRECTORY

46

FIGURE 4.11-4 - ADD/EDIT STREAM SET

47

FIGURE 4.11-5

- ADD/EDIT STREAM

48

FIGURE 4.11-6 - SELECT A PROTOCOL

50

FIGURE 4.11-7 - SELECT AN ADDRESS TYPE

50

FIGURE 4.11-8

- OUTPUT CONFIGURATION

51

FIGURE 4.11-9

- OUTPUT DIRECTORIES

52

FIGURE 4.11-9 - EDCS STREAM CONFIGURATION

53

FIGURE 4.11-10 - EDIT STREAM INTERFACE

54

FIGURE 4.11-11 - EDIT STREAM DATA SOURCE

54

TABLE 5.2-1 - CFS METADATA FILE FORMAT

56

FIGURE 5.2-1 - CFS METADATA FILE FORMAT ILLUSTRATION

57

FIGURE 8.1-1

- DAC - DEFINE SOURCE

75

FIGURE 8.2-1 - DAC - DEFINE DIGITAL SERVICE

76

FIGURE 8.2-2

- DAC - SOURCE NAME AND PROVIDER

77

FIGURE 8.3-1

- DAC - EDIT VIRTUAL CHANNEL MAP ROW

78

FIGURE 8.4-1 - DAC - DISPLAY OM DEVICE STATUS

79

CS-1000 User's Guide

FIGURE 8.5-1 - DAC - DEFINE MULTICAST 16 ADDRESS SET

80

FIGURE 8.6-1 - DAC - EDIT DOWNSTREAM PLANT

81

FIGURE 8.7-1

- DAC - UPDATE THE DAC DATABASE FOR MULTICAST 16 ADDRESS

82

FIGURE 8.8-1 - DAC - OBTAIN IP ADDRESS OF HEADEND NETWORK

83

FIGURE 9.2-1 - TRACE PARAMETERS

85

FIGURE 9.2-2 - ARCHIVED LOG FILE NAME SYNTAX

86

1 Introduction

The Carousel System (CS) is a Motorola product that provides a generic means of transmitting data from a head-end to a population of DCTs. The CS implements several subsystems or types of carousels:

Carousel File System (CFS) - Consists of client and server side components that work together to

present a virtual file system to DCT client applications. Private Data Carousel System (PDCS) - Used to transmit any arbitrary DCII message set.

External Data Source Carousel (EDSC) - Used to multiplex data from multiple sources, either internal or external.

In general, the CS consists of:

The Carousel Server 1000 (CS-1000) for transmitting data to a population of DCTs. A client-side (DCT) API for accessing data delivered by the CS-1000 (CFS). A Graphical User Interface (GUI) for configuring and managing carousels. Communication Interfaces between the CS-1000 and the API client. A Code Download Generator (CDG) tool for creating DCII download messages from raw code objects. A DCII Message Generator (DMG) tool for creating a DCII Message file from payload data input file(s). SNMP support, including creation of a MIB for the SNMP agent which reports status information to a network manager.

SNMP support, including creation of a MIB for the SNMP agent which reports status information to
SNMP support, including creation of a MIB for the SNMP agent which reports status information to
SNMP support, including creation of a MIB for the SNMP agent which reports status information to
SNMP support, including creation of a MIB for the SNMP agent which reports status information to
SNMP support, including creation of a MIB for the SNMP agent which reports status information to
SNMP support, including creation of a MIB for the SNMP agent which reports status information to

1.1 Types of Carousels

The differences between the CFS and PDCS are illustrated below:

Carousel File System (CFS)

Private Data Carousel System (PDCS)

Presents a virtual file system to the

Transmits any arbitrary set of DCII

DCT client application Allows ISV definition of the file system

compatible messages Provides MPEG packetization of DCII

structure Supports content management via

messages Supports code downloads using the

simple file transfer mechanisms Allows flexible partitioning of file system data across multiple streams to support prioritized file delivery

Code Download Generator (CDG)

Streams can be configured to utilize

External Data Source Carousel (EDSC)

Multicast 16 addressing allowing multiple virtual streams to be carried on a single Service (PID)

Transmits any arbitrary set of DCII compatible messages

Requires the CFS API to be

Provides MPEG packetization of DCII

CS-1000 User's Guide

downloaded to the DCT Allows client applications to obtain

messages Multiplexes data from multiple external

their content data through the use of API calls to the CFS API CFS API tunes to the proper streams based on ISV application requests

data source addresses and outputs on a single PID. Outputs data at the same rate that the data is received.

1.2 CS-1000

The CS-1000 is the production server hardware and software system that transmits data to a population of DCTs.

Processes and streams files onto the network. Data within the file system is transmitted

repeatedly (carouselled). Stream configurations are modifiable at the server level via the CS GUI to support client

application needs. Supports broadcast and multicast-16 addressed messages.

Provides a simple mechanism for adding, updating and deleting content. Files are placed in a

staging area, with associated metadata. The CS-1000 periodically polls the directory and adds files to the carousel according to the metadata information. Simultaneously targets multiple downstream plants.

Supports multiple independent file systems with distinct stream configurations and output

behaviors (CFS). Streams can be configured to output time-sensitive and/or non time-sensitive files. Time-

sensitive files contain data relevant to a particular time window (CFS). Transmits DCII private messages as part of the PDCS subsystem.

Supports multiplexing data from external sources to be output on a single PID (EDSC).

1.3 CFS API

The CFS API works with the CS-1000 to present a virtual file system to DCT client applications.

Allows a DCT application to access files via the CFS API. Hides complex implementation details and requires no knowledge of proprietary protocols, hardware or interfaces. The CFS API consists of calls to log in, obtain directory listings and access files or portions of files. ISV applications can also preallocate a buffer for the CFS API to use when assembling files. Downloaded and enabled as a separate DCT object.

also preallocate a buffer for the CFS API to use when assembling files. Downloaded and enabled
also preallocate a buffer for the CFS API to use when assembling files. Downloaded and enabled
also preallocate a buffer for the CFS API to use when assembling files. Downloaded and enabled

1.4 CS GUI

The CS GUI is a Java-based application that runs on the CS Windows NT/2000 workstation.

Add, edit and delete carousels, stream sets, streams, interfaces, data sources, CFS OOBTABs. Import and export carousels (stream sets and streams) interfaces, data sources and CFS OOBTAB configurations. Monitor system status, start and stop carousels, manage and clear content. Create CFS OOBTAB files Manage users

Monitor system status, start and stop carousels, manage and clear content. Create CFS OOBTAB files Manage
Monitor system status, start and stop carousels, manage and clear content. Create CFS OOBTAB files Manage
Monitor system status, start and stop carousels, manage and clear content. Create CFS OOBTAB files Manage
Monitor system status, start and stop carousels, manage and clear content. Create CFS OOBTAB files Manage

CS-1000 User's Guide

1.5 Communication Interfaces

The CFS Carousel and CFS APIs communicate via a network protocol.

CS Network provides the formats/protocols to deliver the file information from the server to the client. Allows for automatic and transparent adaptation to new stream configurations. Data delivered over Ethernet/UDP through the OOB channel.

and transparent adaptation to new stream configurations. Data delivered over Ethernet/UDP through the OOB channel.
and transparent adaptation to new stream configurations. Data delivered over Ethernet/UDP through the OOB channel.

1.6 Code Download Generator (CDG)

The CDG is a utility for creating code objects in DCII message format to be loaded on the DCT.

Generates a DCII Code Download File from a Code Download Metadata File. The DCII Code Download File consists of DCII Download messages created using the DCII Segmentation Overlay Protocol. Uses existing PDCS functionality to support code downloads through one or more OM-1000s. The CS can deliver multiple code objects over one or more PID streams. Creates download commands that will ENABLE, DISABLE, DELETE or PURGE objects from the set top box. CDG supports DCII message creation for all types of tunes, including conditional tunes. Code download messages may be addressed to specific sets of terminals through the use of an optional message preamble. The preamble contains an expression consisting of decoder conditional terms and logical operators. Supports both DCII message type versions 0 and 2, allowing objects of any size to be downloaded.

and logical operators. Supports both DCII message type versions 0 and 2, allowing objects of any
and logical operators. Supports both DCII message type versions 0 and 2, allowing objects of any
and logical operators. Supports both DCII message type versions 0 and 2, allowing objects of any
and logical operators. Supports both DCII message type versions 0 and 2, allowing objects of any
and logical operators. Supports both DCII message type versions 0 and 2, allowing objects of any
and logical operators. Supports both DCII message type versions 0 and 2, allowing objects of any

1.7 DCII Message Generator (DMG)

The DCII Message Generator is a utility for creating DCII message file from generic payload data file(s).

Like CDG, the parameters of the DCII message are included in an XML formatted file that is processed and staged to a PDCS carousel. Multiple payload input files can be combined together and processed into a single DCII message file. DCII messages can be broadcast or singlecast addressed. In the case of singlecast, either one address or a group of specified addresses can be applied to messages. An external address file can be used to hold a group of DCT unit addresses. Certain rules about preambles and address tags can be applied when generating DCII messages. A PDCS carousel compatible output file(.dat file), along with a .trg file will be automatically generated by the DMG batch file. These two files will be placed in the staging area to be carouselled to the DCT(s).

generated by the DMG batch file. These two files will be placed in the staging area
generated by the DMG batch file. These two files will be placed in the staging area
generated by the DMG batch file. These two files will be placed in the staging area
generated by the DMG batch file. These two files will be placed in the staging area

1.8 SNMP Support

The Simple Network Management Protocol (SNMP) support consists of a server program known as a SNMP agent that provides device status information to a client application known as a network manager. The SNMP agent controls a database referred to as the Management Information Base (MIB), and is a standard set of statistical and control values.

CS-1000 User's Guide

The CS-1000 contains an SNMP agent that reports status information to a network manager. The MIB contains machine, network and CS configuration information.

that reports status information to a network manager. The MIB contains machine, network and CS configuration

2 Scope

The Carousel System User's Guide describes how to use the various capabilities of the CS. CS installation is covered in CS-1000 Sun Netra Installation Guide and CS-1000 Windows Installation Guide. The CFS API is described in CFS API Reference Guide. This document covers the following:

CS Concepts (CFS, PDCS and EDSC)

CS GUI

o

Adding users

o

Adding interfaces

o

Creating and configuring carousels, stream sets and streams

o

Content management

o

Status and control

o

Starting and stopping carousels

Using the Code Download Generator (CDG) tool

Using the DCII Message Generator (DMG) tool

CS configuration in a local headend

CFS and PDCS Content Management

CS File Maintenance

3 CS Concepts

3.1 CS Network Interfaces

The CS-1000 is part of the Motorola headend. It has two network interfaces. One network interface is for the OAM&P (headend) network. The other network interface is the application server network. This network allows third party application servers to deliver content and application objects to the CS-1000 for delivery to DCTs.

CS-1000 User's Guide

Note: Figure 3.1-1 depicts inband data delivery as a CS option. Inband data delivery is scheduled for a future CS release.

Figure 3.1-1 - CS Configuration in a Headend

Content Creation Headend Application Interactive Interactive Server Server Server Inband Data Delivery Carousel
Content
Creation
Headend
Application Interactive Interactive Server
Server Server
Inband Data
Delivery
Carousel
Application Server Network
Server
OOB Data
Delivery
DAC-
NC1500
6000
64QAM
modulator
IRT IRT
IRT
OAM&P Network
(IM-1000)
C8U C6U C6U
OM1000
RPD-2000
HFC
DCT
Content Delivery
Content Delivery

3.2 CS Configuration

As shown in Figure 3.2-1 below, the CS Server (CS-1000) is configured as a hierarchy of Carousels, Stream Sets, Streams, Interfaces and Data Sources. Configuration is performed to suit the data delivery needs of individual applications, and can be changed at any time without impacting client (DCT) applications.

Carousels are defined on a per application or per content provider basis, and hold the virtual directory structure (CFS Carousels only) as well as manage content for the application. The content maintained by the Carousel is utilized by the subordinate Stream Sets. Although Stream Sets share the content maintained by the parent Carousel, their individual Stream settings determine how much of that content they output.

Interfaces provide for the actual delivery of streamed data across the physical network. Once defined, interfaces can be accessed by multiple streams to effect transmission.

Data Sources provide for a definition of external sources that the CS may obtain data from. These data sources define a live feed that the CS will gather from and multiplex with other feeds for transmmision over a configured interface.

CS-1000 User's Guide

Figure 3.2-1 - CS Server Components

Interface 1 (e.g. OM-1000 ethernet) Port, IP Address 192.168.10.32, UDP port 6557

Interfaces 2 thru N

Address 192.168.10.32, UDP port 6557 Interfaces 2 thru N Interface 1 Interfaces are referenced by streams

Interface 1 Interfaces are referenced by streams and are accessed to provide physical transport of data. A single stream may be sent to multiple physical destinations simultaneously.

Interfaces 2 thru N

Stream 1 Each stream is used to deliver data in a format appropriate to the carousel. The parent Stream Set prevents duplication of data across streams to prevent wasted bandwidth.

Streams 2 thru N

Stream Set 1 (e.g. OOB Streams) Each CFS Stream Set acts as a distinct virtual file system that delivers data over its subordinate streams. The subordinate streams act as a cohesive unit to transmit the file system over the network. Within the CFS, the Stream Set tracks the configuration of its subordinate streams to produce operations data that enables the CFS API to locate and reassemble files – operations data is part of the CFS network protocol.

Stream Sets 2 thru N

Carousel 1 (e.g., ISV carousel)

Carousels 2 thru N

Carousel Server

3.2.1 CFS Stream Set/Stream Configuration

Each CFS Stream Set comprises a virtual file system that consists of one or more Streams that work as a unit to deliver the contents of the file system. A single CFS Carousel can contain multiple Stream Sets, and each Stream Set can contain multiple Streams. Each Stream can output to multiple interfaces. The configuration of its individual streams determines how the file system is partitioned across the streams.

Each Stream can be given its own file selection algorithm that produces a “view” onto the content contained in the carousel. For example, Streams can be configured to output files within all or only particular virtual directories. They can also be configured to output time sensitive files and/or non-time sensitive files; time sensitive files contain data relevant to a particular time window (e.g. today, tomorrow, 8:00AM-9:00AM today, etc.). When configured for time sensitive output, Streams are given sliding time window definitions that limit the number of files eligible for output based on the applicability of their data to the time window.

Streams are responsible for forwarding their data, at a defined bit rate, to one or more Interfaces for actual transmission. Streams can be configured to take advantage of Motorola Multicast addressing in order to allow the creation of multiple “virtual” streams within a single MPEG PID stream. This capability takes advantage of DCT hardware filtering capabilities in order to simplify service provisioning.

3.2.2 PDCS Stream Set/Stream Configuration

Like the CFS, the PDCS also allows for flexible configuration of Carousels, Stream Sets, Streams and Interfaces. A single PDCS Carousel can contain multiple Stream Sets, and each Stream Set can contain multiple Streams. Each Stream can output to multiple interfaces. Creating a single Carousel, Stream Set and Stream outputting to one or more Interfaces is the most practical configuration, and suitable for most needs. This will also achieve better performance on the CS server.

CS-1000 User's Guide

3.3

CFS

The CFS presents a virtual file system to DCT client applications. Third party developers create this virtual file system via the CS GUI. Files are loaded onto carousels via a staging area located on the CS-

1000 physical file system. A metadata file accompanies the content files loaded into the staging area.

The metadata file contains information about the file (e.g., date created, file size, etc.) and where the file

should be placed within the virtual directory structure. There must be a separate staging area for each carousel configured into the CS-1000 via the GUI. This staging area must also be created on the CS-

1000 physical file system, using the isv_user_add script. Once the carousel has been entered into the

system and is started, the data is transmitted repeatedly (carouselled) by the CS-1000 through the OOB channel. A DCT client application makes calls to the CFS API to obtain directory listings and get files.

3.3.1 File Systems

The virtual file system presented by the CFS API contains one or more independent virtual file systems output from CS Server. A file system can be viewed conceptually as a "virtual disk" each of which can be mounted at a given directory. Figure 3.3-1 illustrates this concept. ISV virtual disks are mounted under "/usr/XXX", where XXX is a user name which typically identifies the particular ISV or application. In this illustration, there are three virtual disks for ISV use, /usr/ISV_A, /usr/ISV_B, and /usr/ISV_C.

Figure 3.3-1 - CFS Virtual File System / (contains /usr/ISV_A /etc/cfsoobtab) Virtual File System /usr/ISV_B
Figure 3.3-1 - CFS Virtual File System
/
(contains
/usr/ISV_A
/etc/cfsoobtab)
Virtual
File
System
/usr/ISV_B
/usr/ISV_C

Each virtual file system should have a virtual disk mounted at "/" and containing "/etc/". This file system, known as the root file system, carries a file used by the CFS API known as CFS Out-of-Band Table (CFS OOBTAB), which is created using the CS GUI. This file contains a map to other CFS virtual file systems. Each record in the file contains three pieces of information: the user name, and the service name and MCA-16 address that correspond to the stream carrying "operations data". Operations data is information about the files, directories, streams and versions for a particular file system. It is needed by the CFS API to perform all of the work necessary to service requests from third party applications.

CS-1000 User's Guide

The CFS API predefines the “/usr” directory while the CFS OOBTAB file defines the subdirectories for ISV_A, ISV_B, etc. The subdirectories under each ISV directory are defined in the CS GUI Carousel screen. Figure 3.3-2 illustrates this concept.

Note: An ISV is not restricted to the "/usr/XXX" directory; subdirectories can be created below "/usr/XXX".

Figure 3.3-2 - CFS OOBTAB

/etc cfsoobtab
/etc
cfsoobtab

The CFS OOBTAB file is always transmitted on

CFS_MAIN/1

User Service MCA ISV_A ISVA 65535 /usr/ISV_A ISV_B ISVB 65535 ISV_C ISVC 65535 /usr/ISV_B /usr/ISV_C
User
Service
MCA
ISV_A
ISVA
65535
/usr/ISV_A
ISV_B
ISVB
65535
ISV_C
ISVC
65535
/usr/ISV_B
/usr/ISV_C

Services may be broadcast addressed or MCA-16 addressed. If broadcast addressed, the MCA-16 value must be 65535. In this example, each of the three services are broadcast-based. This would require that each service by configured in the headend controller, and each service would be assigned its own PID. An alternative is for each entry to have a common service name (one PID), but a different MCA value between 1 and 65534.

User

Service

MCA

ISV_A

ISVCOMMON

10

ISV_B

ISVCOMMON

20

ISV_C

ISVCOMMON

30

In this case, only one service is configured in the controller. The advantages to this are (1) simplifies provisioning of services in the controller, (2) does not require changes in the controller if another virtual file system is added to the CFS OOBTAB, (3) uses only one PMT (the OM-1000 is limited to 49 simultaneous PMTs).

Note: Service/MCA-16 must be unique. All ISV’s MCA-16 addresses within the CFS_MAIN service are assigned to ISVs by Acadia Application Integration Center. This is important since no two streams can be sending data on the same service/MCA-16 stream.

CS-1000 User's Guide

In order to establish the root file system, a carousel is created containing a single stream. The service name for this stream is CFS_MAIN, and its MCA-16 address is 1. Using the CS GUI, a CFS directory is created for the carousel named "etc". As with any carousel, there is a separate staging area created on the CS-1000. The staging area is a physical directory located on the CS-1000. The CFS OOBTAB file is placed into the CFS_MAIN staging area. The metadata file instructs the CS-1000 to place the file in the "/etc" virtual directory. The CS-1000 periodically polls the staging area, processes and carousels the file. The CFS API downloads this file, processes it and creates the overall virtual file system as shown below. ISV applications perform directory listings and can get files placed within these virtual directories. Security measures ensure that an ISV application cannot access another ISV's virtual directory. The virtual directory structure is a construct known only to the CFS API. The directories do not correspond to physical directories located anywhere on a disk.

Figure 3.3-3 - CFS Overall Virtual File System

etc usr ISV_A ISV_B ISV_C

etc

usr

ISV_A

ISV_B

ISV_C

3.3.2 Staging Areas

Each carousel created through the CS GUI must be assigned a single staging area, which is a physical directory on the CS-1000. Content can be added, modified and deleted through this interface. In the example shown in Figure 3.3-2, there would be four carousels, and therefore four staging areas. By convention, the staging area corresponding to the carousel containing CFS OOBTAB is named CFS_MAIN, but staging areas can be named any valid directory name.

CS-1000 User's Guide

Figure 3.3-4 - CFS Staging Area

cfsoobtab is placed in a staging area corresponding to the carousel defined with a service
cfsoobtab is placed in a
staging area
corresponding to the
carousel defined with a
service name =
CFS_MAIN and an MCA-
16 = 1. The metadata file
instructs the CS-1000 to
place the file in "/etc"
ISV content is placed in these staging areas. The metadata file instructs the CS-1000 to
ISV content is placed in
these staging areas. The
metadata file instructs the
CS-1000 to place these
files in a valid subdirectory
of "/usr/XXX". The CFS
Directory Path should
specify "/" for the file to
appear in "/usr/XXX" on
the API side (see Section
5)
in "/usr/XXX" on the API side (see Section 5) StagingArea CFS_MAIN ISV_A_StagingArea ISV_B_StagingArea
in "/usr/XXX" on the API side (see Section 5) StagingArea CFS_MAIN ISV_A_StagingArea ISV_B_StagingArea
in "/usr/XXX" on the API side (see Section 5) StagingArea CFS_MAIN ISV_A_StagingArea ISV_B_StagingArea
in "/usr/XXX" on the API side (see Section 5) StagingArea CFS_MAIN ISV_A_StagingArea ISV_B_StagingArea
in "/usr/XXX" on the API side (see Section 5) StagingArea CFS_MAIN ISV_A_StagingArea ISV_B_StagingArea

StagingArea

CFS_MAIN

ISV_A_StagingArea

ISV_B_StagingArea

ISV_C_StagingArea

3.3.3 Types of Data

There are three types of data that can be sent on a CFS carousel:

Operations Data – System specific data transmitted from the CS-1000 to the CFS API (non-ISV related). Every stream set must have at least one stream outputting operations data and that stream’s Service/MCA16 address must match an entry in the OOBTAB. There is no need for content to be loaded for operations data to be sent on a stream.

Non-time Sensitive Data – The data is carouselled immediately until its expiration date is reached or it is forcibly expired using the CS GUI Clear Content option on the Status and Control screen.

Time Sensitive Data – The data is carouselled during a specific period of time (once the file date range

in the content metadata file and the time window behavior configured in the CS GUI coincide).

A separate CFS stream may be configured for each type of data, or data types can be combined on a

single stream, provided the Output Data Type does not conflict with the type of data loaded on the

carousel.

3.3.3.1 Time Sensitive Data Streams

When configuring a time sensitive data stream, there are three fields that define the characteristics and behavior of the time "window":

Time sensitive behavior (time window type): defines the basis for the start of a time window.

Discrete: based on 00:00:00 of the current day.

Continuous: based on the current time.

Time Window Size – the number of seconds that make up the time window For example: a “Discrete” time window with a window size of 25200 (7 hours) and time window offset of 0 would output files containing a metadata date range that falls between 12am and 7am.

CS-1000 User's Guide

Time window offset the time (in seconds, either plus or minus) from 00:00:00 of the current day (for a discrete window) or from the current time (for a continuous window) that the start of a time sensitive window will be shifted.

3.4

For example: a “Discrete” time window with an offset of 14400 (4 hours) and a window size of 36000 (10 hours) means that files containing a metadata date range that falls between 4am and 2pm are carouselled.

PDCS

The PDCS transmits DCII private messages verbatim to DCTs. The PDCS provides MPEG encapsulation of these messages and delivers them to the appropriate interfaces as defined in the CS GUI, but it does not generate these DCII messages. Valid DCII messages must be provided from an external source, such as CDG or DMG. Like the CFS, content management is provided via a staging area, but the contents of the files must be in DCII format, whereas the CFS delivers any arbitrary file. Unlike the CFS, the PDCS does not present a virtual file system to a DCT client application, and the CFS API does not apply to PDCS carousels.

3.4.1 Code Download Generator (CDG)

The CDG is a tool that takes a raw code object and turns it into a DCII Code Download File that can be loaded on a PDCS carousel. This file is generated using an XML file that contains information about the raw code object. The XML file is also used to specify download commands that will ENABLE, DISABLE, DELETE or PURGE a specified object, tune the DCT for download, as well as send preamble information that provide for conditional message execution on the DCT. The DCII Code Download File is placed in the staging area corresponding to the PDCS carousel created with the CS GUI. This carousel is configured with one or more PID streams that will carousel the code object in the OOB transport. Two streams are needed to download a code object. One stream needs to be configured with an interface that is configured with the EMM PID for the tune command. A second stream needs to be configured for an interface that is configured with the MPEG PID for the download channel that the code object is being sent on. When a DCT is tuned to a valid download channel, the code object will begin downloading to the DCT. The PDCS can deliver multiple code objects over one or more PID streams via one or more OM-

1000s.

3.4.2 DCII Message Generator (DMG)

The DMG is a tool that takes an arbitrary payload and wraps it into a DCII stream file. This file is generated using an XML file that contains information about the DCII messages and DCT addresses you wish have the messages sent to. The input message can consist of either single or multiple payload files. Multiple input files will be processed in the specified order into a single DCII stream file. DCT unit addresses can be specified either in the address tag or from an external address file which contains a group of DCT unit addresses. Since the stream output file is compatible with the PDCS carousel protocol, a PDCS carousel can be utilized to carousel the data to a population of set-top boxes.

CS-1000 User's Guide

Figure 3.4-1 - Code Download Generator (CDG) Process

Code Object
Code
Object

XML File

Code Download Generator (CDG) Process Code Object XML File CDG DCII Code Download File File is
CDG

CDG

CDG
CDG
DCII Code Download File
DCII Code
Download
File

File is copied to the applicable staging area with a trigger file

C /StagingArea/PDCS_01 (example) CS-1000
C
/StagingArea/PDCS_01
(example)
CS-1000

CS-1000 User's Guide

3.5 PID Multiplexing

The CS has the capability to multiplex streams from several sources and create a single stream on a

single PID. This multiplexing of PID streams is referred to as PID MUX.

capability to multiplex data onto a single PID; it does so when multiple streams are going to the same

interface for a given carousel. The new capability involves taking external sources and multiplexing the

PIDs.

resultant PID stream. PID streams can arrive via UDP/IP Singlecast, Multicast, or Broadcast sources, or from CS-1000 CFS/PDCS carousels. The sources can be either internal or external. The resultant PID stream can be sent to M destinations (via UDP/IP), on a distinct PID per destination.

The CS has always had the

The general requirement is to multiplex N data PID streams from N distinct sources into a single

The mechanism that enables PID MUX is the use of the External Data Source Carousel (EDSC). An EDSC can support a single Data Source and multiple Interfaces. The Data Source provides the input and the Interfaces specify the output.

3.5.1 External Data Source Carousel (EDSC)

The EDSC is a carousel type that enables the multiplexing of multiple streams on different PIDs into a single stream with the same PID. The resultant Stream can be sent to multiple Interfaces. Like other types of carousels, an EDSC can specify multiple Stream Sets. Each Stream Set can specify multiple

Streams.

are the source for the input streams that are to be multiplexed. Each EDSC Stream can also specify multiple Interfaces, in the same way that Interfaces are specified for other carousel streams. Multiple Data Sources can be multiplexed onto a common PID in one of two ways. The first uses a single EDSC with multiple streams, with each stream configured with a unique Data Source and a common Interface. The second method involves using separate EDSCs each with Streams configured with a unique Data Source and a common Interface. In this case specifying the same Interface (and PID value) causes all associated Streams to be multiplexed.

Each EDSC Stream can specify a Data Source. Data Sources are configured separately and

3.5.2 Data Sources

Data Sources are used as the input medium to EDSC carousels. When a Data Source is configured the following parameters are specified: Name, Type (currently limited to UDP/IP), Description, Port (on which the data is expected), and list of Multicast Groups. The list of multicast groups is optional and specifies which groups the EDSC can receive data from and on which network interface the data is present. The multicast group is specified using a valid multicast IP address. (224.0.0.0 – 239.256.256.256) For each multicast group a valid network interface is also specified. The network interface can be either the network interface IP address or the network interface name corresponding to the entry in the hosts file.

CS-1000 User's Guide

4 CS GUI

The CS GUI allows you to configure users, create carousels, stream sets and streams, interfaces, data sources and CFS OOBTABs. You can also view system status, manage content and start and stop carousels.

Note: There are two screen conventions that are used consistently throughout the CS: greyed fields and

astericked fields (*).

with an * means that it is a required field and must be completed in order to save the screen’s contents.

When a field is greyed out, it means it is read only and cannot be edited. A field

4.1 CS-1000 Menu Structure

The CS-1000 graphical user interface (GUI) consists of a Multiple Document Interface (MDI) frame, MDI child and modal window structure. After logging into the CS GUI, only the MDI frame is open. The MDI frame contains pull down menus at the top of the frame. These menus are used to open various MDI child and modal windows within the MDI frame. You may have more than one MDI child window open at the same time and may minimize, cascade, close and restore these windows using the Window menu. However, when a modal window is opened, no other windows may be opened or accessed until the action on the modal window is complete (saved/canceled) and the window is closed. Figure 4.1-1 illustrates the windowing structure.

Figure 4.1-1 - CS Graphical User Interface Connect Login System Configure Help CFSOOBTab Users Carousels
Figure 4.1-1 - CS Graphical User Interface
Connect
Login
System
Configure
Help
CFSOOBTab
Users
Carousels
Interfaces
Data Sources
About
Maintenance
Carousel
Interfaces
User Add/Edit
IP Data Source
Add/Edit
CFSOOBTab
Add/Edit
Add/Edit
Add/Edit
Status and
Stream Set
IP Data Source
Address Add/Edit
CFSOOBTab
Control
Add/Edit
Entry Add/Edit
Manage
Stream
Content
Add/Edit
Stream Set
Stream
Window Type
Status
Interface
Menu choice
EDSC Stream
Export
Data Source
MDI Child
Modal
Import

CS-1000 User's Guide

4.2 CS GUI Startup

Please refer to the CS-1000 Sun Netra Installation Guide for information on setting the Sun Netra’s system time, date and time zone.

Note: You must verify that the system time, date and time zone are correct on both the machine that is running the CS server and the machine that is running the CS GUI. Time sensitive data attributes will be incorrect if these times, dates, and time zones are incorrect.

To start the CS GUI, you need to double click the Run_CS_GUI.bat file located in the CS directory of your Windows NT/2000 PC or double click a shortcut icon you may have setup on your desktop. The CS GUI then starts by presenting the Connect window, as shown in Figure 4.2-1. When running the CS using a Sun Netra server, the IP address for the server needs to be entered. The port setting should remain the default value - 1701.

Figure 4.2-1 - Connection Window

the default value - 1701. Figure 4.2-1 - Connection Window Field Name Description IP Address The

Field Name

Description

IP Address

The IP address for the CS-1000 server on the Sun Netra. In the case of an CS NT installation for a development environment, the IP address should remain as the default - 127.0.0.1 indicating the local machine.

Port

The port designation should remain as the default - 1701.

Note: For quick reference, your connection information (IP address and port) is displayed in the title banner at the top of the main screen. (see Figure 4.3-1) The default values that appear in this window are set in the <drive>:\CS\ConfigFiles\CarouselManagerGUI.cfg file.

If you are running GUI and server software that is incompatible, you are presented with the following message and you will be prevented from logging in.

CS-1000 User's Guide

Figure 4.2-2 - Incompatible Version Message

User's Guide Figure 4.2-2 - Incompatible Version Message The latest CS GUI software can be downloaded

The latest CS GUI software can be downloaded from the CS-1000 webpage. Point a web browser to the IP address of the CS-1000 server and download a compatible version of the CS GUI software.

4.2.1 CS GUI Login

After connecting to the server, you must then log into the CS GUI. Your login information will determine what your privileges are on the CS server (read only, control, edit, add, delete, and/or administrator).

Note: All privileges are cumulative meaning a person with control privilege also has read, a person with add has read, control and edit privilege and so on.

Figure 4.2-3 - Login Window

and edit privilege and so on. Figure 4.2-3 - Login Window Field Name Description Username Once

Field Name

Description

Username

Once an Administrator has entered users into the system, their name will be included in the Username list. Users should contact their system administrator for their user name when signing into the CS-1000 for the first time.

Password

The Administrator creates passwords when a user is entered into the system. Users can then edit their password. All users should change their password upon first login to the system.

CS-1000 User's Guide

4.3 CS GUI Main Menu

The CS GUI Main Menu window contains drop down menus that spawn and control the windows in the GUI. The contents of these menus are described below.

Figure 4.3-1 - CS GUI Main Menu

menus are described below. Figure 4.3-1 - CS GUI Main Menu Menu Choice Description System Contains

Menu Choice

Description

System

Contains the menu items that pertain to the CS-1000 system including User configuration that allows you to add or delete users, edit user privileges. Status and Control allows you to manually start and stop carousels, and manually poll a carousel’s staging area, manage content and view Stream Set status. A system tool to import and export configurations is also available.

Configure

Contains the menu choices that allow you to create and configure carousels (stream sets, streams), interfaces, data sources and CFS OOBTABs including PIDs, IP addresses, stream bit rates, and ports.

Window

Contains the menu choices that allow you to manage the main CS GUI windows including Cascade, Restore All, Minimize All and Close All.

Help

Contains an about screen that lists the version of the currently installed CS Server and GUI.

CS-1000 User's Guide

4.3.1 System Menu

The System Menu contains options for User Management, System Status and Control, and the configuration Import/Export tools.

Figure 4.3-2 - System Menu

Import/Export tools. Figure 4.3-2 - System Menu Menu Choice Description Users… Allows

Menu Choice

Description

Users…

Allows Administrators to add and delete users on the system and to change their privileges. Allows all other uses to change their own password.

Status and Control…

Allows users to manually start and stop individual carousels, force poll a carousel’s Staging Area, manage and clear content on the carousel as well as view a carousel’s stream set status.

Export…

Allows users to export a selection of configured carousels, interfaces, data sources and CFS OOBTABs to an external file in XML format.

Import…

Allows users to select an XML file for import which is then inserted into the CS database.

Exit

Log out and exit the CS GUI.

CS-1000 User's Guide

4.3.2 Configure Menu

The Configure menu accesses the windows that allow for configuration of the Carousels (Stream Sets and Streams), Interfaces and Data Sources.

Maintenance of the CFS OOBTAB is also part of the Configure menu. The CFS OOBTAB file defines the

An OOBTAB acts as a roadmap that enables the

CFS API to locate virtual file systems and retrieve data from them.

virtual file system mount points and tuning information.

Figure 4.3-3 - Configure Menu

points and tuning information. Figure 4.3-3 - Configure Menu Menu Choice Description Carousels… Allows users

Menu Choice

Description

Carousels…

Allows users to add, edit and delete Carousels, Streams Sets, Streams, Stream_Interface and Stream_DataSource associations. It is also possible to add a new Interface or Data Source from the Stream configuration window.

Interfaces…

Allows users to add, edit and delete IP Interfaces.

Data Sources…

Allows users to add, edit and delete Data Sources.

CFS OOBTAB Maintenance…

Allows users to add, edit and delete CFS OOBTABs and create CFS OOBTAB files.

CS-1000 User's Guide

4.3.3 Window and Help Menus

Figure 4.3-4 - Window Menu

Guide 4.3.3 Window and Help Menus Figure 4.3-4 - Window Menu Menu Choice Description Cascade Positions

Menu Choice

Description

Cascade

Positions open windows so you may view the title banner of each open window.

Restore All

Displays all minimized windows.

Minimize All

Minimizes all windows and displays a tab for each window at the bottom of the main window.

Close All

Closes all open windows.

Help Menu

Menu Choice

Description

About…

Displays the current version of the CS Server and GUI as well as developer information.

CS-1000 User's Guide

4.4 System – Users…

Each CS site will require a System Administrator (SA). One of the functions of the SA will be to add users

to the CS GUI, edit their privileges as necessary, and delete users from the system.

Administrator privileges is able to perform these tasks, so assigning a backup SA should be considered at each deployment site.

Only a person with

Note: Each CS is deployed with a generic Administrator user with NO password. Upon first logon, the site SA should edit the password to make it unique. This will ensure the integrity of the CS-1000 database and its configuration.

Figure 4.4-1 - User List

database and its configuration. Figure 4.4-1 - User List Menu Choice Description Add Allows Administrators

Menu Choice

Description

Add

Allows Administrators to add new users to the CS and assign user privileges.

Edit

Allows all users to change their password and Administrators to update user privileges and passwords.

Delete

Allows Administrators to delete users from the CS.

Refresh

Allows users to refresh the User list to obtain the most current list of users.

Close

Closes the current window.

CS-1000 User's Guide

4.4.1 User Privileges

User privileges are cumulative in the CS GUI.

allows a user to only view the data within the CS GUI. The Control privilege allows a user to read as well as control the starting and stopping of carousels. Edit allows a user to read, control and edit carousel configuration and so on. Each privilege is described in the field descriptions that follow.

The most basic privilege is the Read Only privilege that

Figure 4.4-2 - Add User

is the Read Only privilege that Figure 4.4-2 - Add User Privilege Description Read Only Users

Privilege

Description

Read Only

Users assigned this privilege cannot change any data or configuration in the CS GUI, but may view all screens.

Control

Users assigned this privilege may see all screens in the CS and may control the operation of a carousel within the CS server by stopping and starting it. Users with this privilege may not edit or add any configuration settings to the CS.

Edit

Users assigned this privilege have all the Read Only and Control privileges and may also edit any existing CS configuration settings.

Add

Users assigned this privilege have all the Read Only, Control, and Edit privileges and may also add Carousels, Stream Sets, Streams, Interfaces and Data Sources to the CS.

Delete

Users assigned this privilege have full control of the CS configurations including the ability to delete Carousels, Stream Sets, Stream, Interfaces and Data Sources. They cannot, however, change user privileges or add or delete users.

Administrator

Users assigned this privilege have full rights within the CS GUI including the ability to add and delete other users in the system.

Note: The default Administrator may not be deleted from the CS.

CS-1000 User's Guide

4.5 System – Status and Control…

The CS GUI Status and Control window allows users, with the appropriate privileges, to start and stop carousels, force poll a carousel’s staging area, manage and clear content present on the carousel, as well as view a carousel’s stream set status.

Figure 4.5-1 - Carousel Status and Control

set status. Figure 4.5-1 - Carousel Status and Control Field Description Carousel Name of carousel as

Field

Description

Carousel

Name of carousel as defined on the Carousel screen.

Description

Carousel description as entered on the Carousel screen.

Status

Displays whether a carousel is running or stopped.

Total Bit Rate

Cumulative bit rate (bits/second) for all the streams associated with the carousel.

Content Size

Cumulative file size, in bytes, for all files that have been loaded on a particular carousel. This number is not the actual size of the content being carouselled since some time senstive files may not currently be active.

Action

Description

Start/Stop

Allows users to immediately start or stop any carousel in the list.

Refresh

Updates the carousel list with the latest data.

Poll Staging Area

Causes the selected carousel’s staging area to be polled immediately rather than waiting for the designated polling interval.

CS-1000 User's Guide

Action

Description

Manage Content

Spawns the Content Management window that allows users to view a list of the files currently loaded on the selected carousel. This window allows users to modify file attributes and expire files.

Clear Content

Expires all files loaded on the selected carousel. You are prompted for confirmation of this action.

Stream Set Status

Spawns the Stream Set Status window. Allows you to view status information for any stream sets associated with the selected carousel.

Close

Closes the Status and Control window.

4.5.1 Manage Content

The Content Management window allows all users to view the file attributes of content currently loaded on the selected carousel. Those users with the Delete or Administrator privilege may also expire or update file attributes as necessary. Sort order for the file list is user definable by clicking on the header column for the data you want the list to be sorted by. The default sort order for this table is on virtual directory and then file name. Consequent clicks on a column header toggles between ascending and descending sort order.

Note: All file updates and file expirations are buffered and appear in bold until the Send Metadata button is clicked, at which time a new content metadata file with the changes is created and then sent to the carousel. It is possible to back out changes to a carousel’s content by clicking the Refresh button before clicking the Send Metadata button. This action will clear all buffered requests and refresh the list with the most current data.

Figure 4.5-2 - CFS Carousel Management

most current data. Figure 4.5-2 - CFS Carousel Management Motorola Security Level 1 Page 29 of

CS-1000 User's Guide

Field

Description

Total Files Loaded

Number of files loaded on the selected carousel.

File Name

The name of a file loaded on the selected carousel.

Virtual Directory

The virtual directory that the file is associated with as defined in the content metadata file.

File Size

The size of the file, in bytes.

File Date

The creation file date as defined in the content metadata file. The proper format for this field is yyyymmdd hh:mm:ss.

Expiration Date

The date the file will be deleted from the carousel. The format for this field is the same as the File Date format.

Time Range

In the case of time sensitive data, the begin and end date for when the file should be carouselled. In addition, a non-time sensitive file may be changed to time sensitive by adding a begin and end date to the file in the Edit File box. The proper format for this field is yyyymmdd hh:mm:ss- yyyymmdd hh:mm:ss.

Action

Description

Expire

Allows you to expire a selected file. When pressed, the file is displayed in bold. You must then press the Send Metadata button to have a new content metadata file created and sent that will expire the data file.

Send Metadata

Processes all updates and expirations that have been buffered in the current file list (as indicated in bold). A new content metadata file is created for the selected carousel based on the changes indicated on this screen.

Refresh

Updates the list with the most recent data. This action will also clear the buffered update and expiration requests.

Close

Closes the Content Management window.

Update

Allows you to update the file’s metadata attributes. When pressed the file is displayed in bold. You must then press the Send Metadata button to have a new content metadata file sent to complete the updates.

CS-1000 User's Guide

4.5.2 Stream Set Status

The Stream Set Status window allows all users to view the operations data associated with each Stream Set for the selected CFS carousel. Information is provided for the Version, Stream, Directory, and File Tables.

Figure 4.5-3 - Stream Set Status-Version Table

File Tables. Figure 4.5-3 - Stream Set Status-Version Table Figure 4.5-4 - Stream Set Status-Stream Table

Figure 4.5-4 - Stream Set Status-Stream Table

Table Figure 4.5-4 - Stream Set Status-Stream Table Figure 4.5-5 - Stream Set Status-Directory Table Figure

Figure 4.5-5 - Stream Set Status-Directory Table

Table Figure 4.5-5 - Stream Set Status-Directory Table Figure 4.5-6 - Stream Set Status-File Table Motorola

Figure 4.5-6 - Stream Set Status-File Table

Table Figure 4.5-6 - Stream Set Status-File Table Motorola Security Level 1 Page 31 of 87

CS-1000 User's Guide

Field

Description

Version Table

The Version Table screen displays version information for the selected stream set.

Stream Table

The Stream Table screen displays stream information for the selected stream set.

Directory Table

The Directory Table screen displays a graphic of the virtual directory structure and the directory information for the selected stream set.

File Table

The File Table screen displays file information for the selected stream set.

Note: The file list displays only files that are currently being output based on a file’s time sensitive attributes. Therefore, the list of files may not include all files that are loaded on the carousel for the selected stream set.

Action

Description

Refresh

Allows users to refresh the display to obtain the most current operations data.

Close

Closes the Stream Set Status window.

CS-1000 User's Guide

4.6 System – Export…

The CS-1000 Export window allows users to export the configuration of carousels, interfaces, data sources and CFS OOBTAB configurations to an XML file in a specified format. This utility writes a file to a location that is on the same machine as the CS GUI. Once the export button is pressed a file chooser is displayed to designate the destination path and filename. The resulting file can be saved and used for import on the same machine or another machine that requires the exported configuration.

Figure 4.6-1 - Export

requires the exported configuration. Figure 4.6-1 - Export Action Description Select All Allows users to

Action

Description

Select All

Allows users to select all items in all lists. Independent rows can be deselected by holding the CTRL key and single clicking on rows.

Deselect All

Allows users to deselect all items in all lists. Independent rows can be selected by holding the CTRL key and single clicking on rows.

Export

Opens a file chooser window to designate the path and filename to export to. Once the file is validated the selected items are exported.

Close

Closes the Export window.

CS-1000 User's Guide

4.7 System – Import…

The CS-1000 Import window allows users to chose an XML file to import from. This file must be in the exact format that is expected by the import tool. Any discrepancies will be reported and import will be aborted. An example import XML file is located with the CS GUI and on the Windows NT/2000 development installation at: <drive>:\CS\ImportExport\default_config.xml. This file contains the default configuration that a standard CS-1000 is shipped with.

Note: If you encounter ANY errors while importing a configuration you will not have all of the expected objects inserted into the CS-1000. One common reason for errors during import is caused by duplicate carousel, interface, data source or CFS OOBTAB names. Be sure that no duplicates exist so that the desired configuration will be imported as expected.

Figure 4.7-1 - Import

will be imported as expected. Figure 4.7-1 - Import Action Description Browse Opens a standard file

Action

Description

Browse

Opens a standard file chooser window for browsing the local file system and selecting the file that is targeted for import.

OK

Performs import from the file designated in the text field.

Cancel

Cancels current action and closes import window.

CS-1000 User's Guide

4.8 Configure - CFSOOBTAB Maintenance….

The CFS OOBTAB is a special file needed by the CFS API to locate the out-of-band mount points that are being carouselled by the CS-1000. The CFS API will attempt to locate and read the CFS OOBTAB on start-up (starting from the “/etc” directory) and periodically poll for any new versions of CFS OOBTAB that may have been placed into the CFS_MAIN staging area. The API validates each directory and GET request against the CFS OOBTAB to determine if the request is within one of the listed mount points.

Note: CFS OOBTAB only pertains to carousels of type “CFS”, since PDCS carousels have no interaction with the CFS API and therefore do not require mount points. The CFS OOBTAB has no special meaning to the Carousel Server (CS-1000). From the server’s perspective, it is just a file that is being carouselled like any other.

Figure 4.8-1 - Add CFS OOBTAB

carouselled like any other. Figure 4.8-1 - Add CFS OOBTAB Field Name Description CFS OOB Tab

Field Name

Description

CFS OOB Tab Name

The name entered into this field is not the file name but rather the name that will appear on the OOBTAB List screen. Maximum field length is 50 characters.

CS-1000 User's Guide

Field Name

Description

Create CFSOOBTAB File

Filename must be named “cfsoobtab”.

Creates a CFS OOBTAB file consisting of the CFS OOBTAB entries listed on this screen. The file is saved with this name in the designated directory on the CS GUI machine. The directory designated must already exist on this machine. The <drive>:\CS\cfsoobtab directory is a good location to create the file.

Note: This file must be transferred to the CFS_MAIN Staging Area for

carouselling to the settop population. The file you create from the GUI is

binary file. If you FTP this file to the CS-1000, ensure that the transfer mode is set to binary.

a

In the ISV development version, the file should be copied to the CFS_MAIN Staging Area on the Windows NT/2000 machine.

4.8.1 OOBTAB Entries

The OOBTAB Entries define the contents of the CFS OOBTAB file. The CFS OOBTAB should contain all the valid mount points on the CS-1000. When a settop application makes a request it is to a mount point (User Name) contained in the CFS OOBTAB. The CFS API then uses the service name and MCA-16 address to tune to the right stream to acquire operations data needed to fulfill the request. If a new CFS OOBTAB is found during the polling process, the CFS API will re-evaluate the mount points of any pending requests against the new information.

Figure 4.8-2 - Add OOBTAB Entry

against the new information. Figure 4.8-2 - Add OOBTAB Entry Field Name Description User Name The

Field Name

Description

User Name

The name of the mount point for a particular carousel. This name indicates the name of the directory within the /usr directory in the CS-

1000 virtual directory structure that data will be mounted for a particular carousel. For example, if the user name is TEST, then the mount point

is

/usr/TEST. Third party applications will make directory and file

requests within this mount point and subdirectories of this mount point

(e.g., /usr/TEST/test.txt, /usr/TEST/subdir/test.txt).

CS-1000 User's Guide

Field Name

Description

Service Name

The service name that the API uses when tuning or connecting to the downstream source for any requests on that mount point. This field value reflects the service name corresponding to the CFS carousel's operations data stream.

MCA 16

The Multicast-16 Address that the API uses in conjunction with the Service Name for tuning or connecting to the downstream source for any requests on that mount point. This field value should correspond to the MCA-16 Address of the stream that is ouputting operations data for the carousel.

CS-1000 User's Guide

4.9 Configure – Interfaces…

The Interface configuration screen allows you to add, edit and delete the output interface(s) for the CS-

1000. This screen may also be accessed from the CFS Stream window under the Configure Carousel

menu item. When accessed from the main menu, however, multiple interfaces may be added and/or edited without being tied to a specific stream configuration.

Figure 4.9-1 - Interfaces

a specific stream configuration. Figure 4.9-1 - Interfaces Field Name Description Interface Type While both

Field Name

Description

Interface Type

While both UDP/IP and TCP/IP are selectable from this field, UDP is currently the only available output interface. Future releases of the CS may allow a TCP/IP output connection.

CS-1000 User's Guide

4.9.1 Add an IP Interface

The CS-1000 may output to multiple interfaces so that data can be sent to multiple downstream plants. Each OM is configured with the same port number. However, different IP addresses are entered for each

OM-1000.

Note: This menu item is available for you to add and configure all your Interfaces up front and separately from a specific Stream configuration. However, you may also add IP Interfaces from the Stream configuration window.

Figure 4.9-2 - Add IP Interface

Stream configuration window. Figure 4.9-2 - Add IP Interface Field Name Description Interface Name An

Field Name

Description

Interface Name

An identifier that describes the type of equipment being output to. The interface name may be up to 50 characters and should distinguish one device from another (i.e., OM1000-1, OM1000-2, etc.)

Interface Type

The data for this field is chosen and edited on the main IP interface MDI window.

IP Address

The specific IP address for the output device.

Port

The port designation for the output device as configured within that device. The default port value is 6557 (CS to OM).

CS-1000 User's Guide

4.10 Configure – Data Sources…

The Data Source configuration screen allows you to add and configure the input Data Source(s) for EDSC carousels. This screen may also be accessed from the EDSC Stream window under the Configure Carousel menu item. When accessed from the main menu, multiple Data Sources may be added and/or edited without being tied to a specific stream configuration.

Figure 4.10-1 - Data Sources

specific stream configuration. Figure 4.10-1 - Data Sources Field Name Description Data Source Type UDP/IP is

Field Name

Description

Data Source Type

UDP/IP is currently the only available data source type.

CS-1000 User's Guide

4.10.1 Add an IP Data Source

This menu item allows you to add and configure all your Data Sources up front and separately from a specific EDSC Stream configuration. However, you may also add IP Data Sources from the EDSC Stream configuration window. Each EDSC requires a single Data Source. Multiple Data Sources can be

added from the Data Source window. NIC IP address are specified.

For each optional Multicast Group, an IP Multicast Address and

Figure 4.10-2 - Edit IP Data Source

IP Multicast Address and Figure 4.10-2 - Edit IP Data Source Field Name Description Data Source

Field Name

Description

Data Source Name

An identifier that describes the source of the data. The Data Source name may be up to 50 characters and should distinguish one source from another.

Data Source Type

The data for this field is chosen and edited on the main Data Source interface MDI window.

Description

Optional description for the data source.

Port

The port designation for the data source.

CS-1000 User's Guide

4.10.2 Add an IP Data Source Address

Each Multicast Group requires at least one IP multicast address to specify the multicast group and a NIC IP Address to specify the network interface where the data is available. The NIC IP Address is either the network interface IP address or the network interface name corresponding to the entry in the hosts file of the CS.

Figure 4.10-3 - Add IP Data Source Address

file of the CS. Figure 4.10-3 - Add IP Data Source Address Field Name Description IP

Field Name

Description

IP Multicast Address

A valid multicast IP address. (224.0.0.0 – 239.256.256.256)

NIC IP Address

Either the IP address or name of the network interface. This field must correspond to an entry in the hosts file of the CS.

CS-1000 User's Guide

4.11 Configure – Carousels…

The CS-1000 is designed with several types of carousels: the Carousel File System (CFS), the Private Data Carousel System (PDCS) and the External Data Source Carousel (EDSC). The CFS is the carousel used in connection with the CFS API. The PDCS is strictly a pass through stream that sends DCII Private Data across a defined PID. How that data is received and managed on the settop is strictly up to the ISV application on the settop box. The PDCS is commonly used for code downloads. The EDSC is used to multiplex data from multiple external sources.

The default configuration for the CS-1000 is two CFS carousels, two PDCS carousels and one EDSC carousel. These carousels may be edited for use in your network, deleted, or added to as necessary.

Note: Depending on the type of carousel you are adding or configuring, the CS GUI screens may vary in content.

Figure 4.11-1 - Carousels

GUI screens may vary in content. Figure 4.11-1 - Carousels Field Name Description Carousel Type This

Field Name

Description

Carousel Type

This field selects the type of Carousel to be added.

4.11.1 Add a Carousel

Once you have selected the type of carousel you want to create, the screens that are presented for further configuration of the carousel, its stream sets, and streams will vary slightly depending on whether you chose CFS, PDCS or EDSC. On the Add/Edit Carousel window, the difference in screen presentation is the addition of the CFS directory button once the new CFS carousel is saved. This button is located beside the Staging Area field and allows you to build the virtual directory structure that is used

CS-1000 User's Guide

by the ISV application to manage content data. This virtual directory structure appears under the carousel's mount point as defined in the CFS OOBTAB (e.g., /usr/TEST).

Figure 4.11-2 - Add/Edit Carousel

OOBTAB (e.g., /usr/TEST). Figure 4.11-2 - Add/Edit Carousel Field Name Description Carousel Name An identifier

Field Name

Description

Carousel Name

An identifier that describes the carousel being configured. The carousel name may be up to 50 characters and should distinguish one carousel from another.

Carousel Type

View only field. The data for this field is chosen and edited on the main Carousel window.

Description

A 255 character field that may be used to further describe the type of data being sent on this carousel.

Startup

The choices in this drop down field allow you to choose the status of the carousel at server startup. The values indicate whether the carousel will start automatically on server startup, or require a manual start using the Status and Control window.

Note: Carousels configured with automatic startup will start automatically when the server is powered on. Carousels configured with either manual or disabled startup will need to be manually started using the CS GUI when the server is powered on.

CS-1000 User's Guide

Field Name

Description

Staging Area

The directory where data is placed to be carouselled. Each carousel should have its own directory within the CS-1000’s Staging Area directory.

Note: Defining a specific staging area directory here for the CFS carousel does not create that directory on the CS-1000 server. You must still manually create this directory within the CS-1000’s StagingArea directory on the server. Use the isv_user_add and isv_user_delete scripts to manage Staging Areas on a Sun Netra CS-1000.

CFS Dirs

This button is only present when creating a CFS carousel. It allows you to build the virtual directory structure that an application uses when making calls to the CFS API. (see Section 4.11.2)

Note: This button only appears after a successful carousel Add.

Persistent Storage Area

DO NOT EDIT, DELETE or ACCESS ANY FILES IN THIS DIRECTORY !

This directory is where the CS-1000 database and carouselled data is stored. This directory also contains the raw data files that were loaded into the carousel from its Staging Area. These files remain in this directory until they are deleted. Additionally, operations files for the carousel are stored here.

Note: All carousels can share the same Persistent Storage Area (PSA) since the CS-1000 separates persistent storage area data via well defined naming conventions. However, if separate directories are desired in the

PSA, defining these directories in the GUI does not create them on the CS-

1000.

You must still create the directories within the CS-1000’s

PersistentDataStore directory.

Staging Area Polling Interval

The frequency, in seconds, that the CS-1000 checks the Staging Area for new files.

CS-1000 User's Guide

4.11.2 CFS Directory

The CFS Directory screen allows you to build a virtual directory structure for the current carousel. The virtual directory structure appears beneath the mount point for the carousel.

Figure 4.11-3 - CFS Directory

mount point for the carousel. Figure 4.11-3 - CFS Directory Note: Each CFS carousel has its

Note: Each CFS carousel has its own virtual root (“/”). This virtual root is mapped to a mount point (e.g., /usr/TEST) by the CFS API based on the CFS OOBTAB.

Special Note: The CFS_MAIN carousel should have a single CFS Directory named “/etc”. This is the directory where the file named “cfsoobtab” should be loaded. This file defines the mount points for the CFS, or subdirectories of “/usr”. Application carousels should define CFS Directories as they see fit. This subdirectory structure will be present under each carousel’s mount point, ie: “/usr/ISV_A”

Field Name

Description

Add

Brings up the New Directory dialogue that allows you to add to the current directory structure. The directory is added below the item in the structure that is selected, i.e. if “/” is selected, the directory will be added off the root of the structure.

Rename

Allows you to rename an existing directory. The directory you wish to rename must be highlighted before pressing Edit. Double clicking on an existing directory will also allow for the directory to be renamed.

Delete

Allows you to delete the selected directory and subdirectories from the list.

Clear

Allows you to delete the entire directory structure. You will be prompted to confirm this action before it is performed.

Close

Closes the current window and returns you to the Add Carousel screen.

CS-1000 User's Guide

4.11.3 Add a Stream Set

You may have one or more Stream Sets per carousel and one or more Streams defined per Stream Set. For instance, you may want to have one stream set for out-of-band data and one for inband (future capability). In the case of a CFS carousel, the stream set tracks the configuration of subordinate streams to produce operations data that enables the CFS API to locate and reassemble files.

Figure 4.11-4 - Add/Edit Stream Set

and reassemble files. Figure 4.11-4 - Add/Edit Stream Set Field Name Description Stream Set Name A

Field Name

Description

Stream Set Name

A

50 character field that identifies a particular stream set within the

selected carousel.

Stream Set Type

View only field. The data for this field is pre-determined based on the type of carousel that was selected.

Refresh Interval

This field determines how often streams will be refreshed.

Note: A Stream Set Refresh consists of updating content on time sensitive streams and rebuilding operations data if needed. If there are no streams in the stream set that carry time sensitive data it is reasonable to set the refresh interval to a very high value since stream refreshes occur automatically after content is uploaded onto a carousel.

Startup Enabled

When checked, the current Stream Set is automatically started when the carousel is started. When not checked, the stream set is not accessed

by the carousel. A stream set may be disabled in order to trouble shoot

a

particular carousel’s operation, or when the selected stream set needs

to

be temporarily taken off line, but deleting the stream set is not

desirable.

CS-1000 User's Guide

4.11.4 Add a Stream

The Edit CFS Stream screen, illustrated in Figure 4.11-5, varies significantly depending on the type of carousel you are configuring the stream for, as well as what type of CFS configuration you are performing. The PDCS stream configuration screen is a subset of the CFS screen and contains only the Stream Name, Stream Type, Description, and Bit Rate fields. A CFS carousel stream window contains additional fields that pertain to the stream’s output and will vary depending on whether time sensitive data is being used and if you are sending broadcast or Multicast 16 addressed data. All field definitions for the CFS stream window are provided. PDCS fields share the same corresponding field definitions.

An EDSC stream configuration, as shown later in this section at Figure 4.11-9, varies significantly from the CFS and PDCS stream configuration in that it only requires the input data source and output interface.

Figure 4.11-5 - Add/Edit Stream

source and output interface. Figure 4.11-5 - Add/Edit Stream Motorola Security Level 1 Page 48 of

CS-1000 User's Guide

Field Name

Description

Stream Name

A

50 character field that identifies a particular stream within the selected

stream set.

Stream Type

The data for this field is pre-determined based on the type of stream set that was selected.

Description

A

255 character field that may be used to further described the type of

data

being sent on this stream.

Bit Rate

An integer that defines the rate in bits per second that data is to be sent across the stream.

Service Name

The name of the service that will carry this stream, exactly as it appears

in

the headend controller. This is a 50 character field.

Note: This Service must be manually configured into the headend controller prior to CS-1000 use. See Section 8.2 for instructions on setting up this service.

DCII

Address

When configuring the stream as MCA-16, a unique multicast address

   

must

be entered. The valid range of values is 1 through 65534. When

DCII

Broadcast is selected as the Address type, this field defaults to

65535 and is not editable.

Note: There is no automated duplicate checking on this field, so you

 

must

make certain that the DCII address entered is unique for the

specified service name.

Time sensitive window size

Specifies a window size (in seconds) for which this stream should output files. The stream time window must overlap with the time sensitive attributes on a file for the file to be carouselled on the stream.

Note: This field is only valid when Time Sensitive Files has been selected under Output.

Time sensitive window offset

Specifies an offset (in seconds) for the time window. Offset can be plus or minus. An offset is relative to either the current time, or to the beginning of the current day, based on the “Time Sensitive Behavior” for the stream.

Note: This field is only valid when Time Sensitive Files has been selected under Output.

Time Sensitive Behavior

There are two valid values: Discrete sliding window and Continuous

 

Slide

window.

Discrete sliding windows start at the beginning of the current day. The window always “jumps” 24 hours at a time.

Continuous sliding windows start at the current time.

Note: This field is only valid when Time Sensitive Files has been selected under Output.

Data

Source

A

50 character field used to descriptively name a Data Source. This field

 

only

appears in the EDSC stream.

Interface

A

50 character field used to descriptively name an interface device.

CS-1000 User's Guide

General Note: Time sensitive streams output time sensitive files that have ANY overlap with the stream’s time window. The streams re-evaluate their contents according at each Stream Set Refresh or content upload.

4.11.4.1 Select a Protocol

Figure 4.11-6 - Select a Protocol

4.11.4.1 Select a Protocol Figure 4.11-6 - Select a Protocol Field Name Description MPEG Packet When

Field Name

Description

MPEG Packet

When selected, data sent on the selected stream will be in the MPEG format.

Note: Select this option when sending to a device that requires an MPEG stream (e.g., OM-1000). This option should be selected when setting up CFS streams, since the only interface currently supported is the OM-1000.

DCII

Private

When selected, raw DCII private messages will be sent on the selected stream.

 

Note: Select this option only when sending to a device that requires raw DCII messages.

4.11.4.2 Select an Address Type

Figure 4.11-7 - Select an Address Type

an Address Type Figure 4.11-7 - Select an Address Type Field Name Description DCII Broadcast When

Field Name

Description

DCII

Broadcast

When selected, data sent on the selected stream will be broadcast addressed on the stream.

DCII

MCA16

When selected, multi-cast addressed messages will be sent across the selected stream.

CS-1000 User's Guide

4.11.4.3 Output Configuration

Figure 4.11-8 - Output Configuration

Output Configuration Figure 4.11-8 - Output Configuration Field Name Description Operations Data When

Field Name

Description

Operations Data

When checked, indicates that the current stream will carry operations data for the carousel. Only one stream per carousel needs to send operations data.

Non-time sensitive files

When checked, indicates that the current stream can carry non-time sensitive data.

Time sensitive files

When checked, indicates that the current stream can carry time sensitive data. The Time Sensitive Window Size, Time Sensitive Window Offset and Time Sensitive Behavior fields must have values entered when this box is checked.

All Directories

When checked, indicates that data from all virtual directories can be sent on this stream.

Output Dirs…

Opens the Output Directories window. This window displays the virtual directory structure defined on the Add Carousel screen and allows you to select specific directories to output on this stream. See the Output Directories section below for more details.

Note: This button is only available after a successful stream Add.

CS-1000 User's Guide

4.11.5 Output Directories

The Output Directories screen allows you to choose which virtual directories will be output by the

associated stream.

Select all virtual directories and subdirectories that you wish to output data for. Selecting a parent directory will not output the data loaded in its subdirectories. This window is only available when

configuring CFS Streams.

Only content loaded into the selected virtual directories will be output on the stream.

Figure 4.11-9 - Output Directories

be output on the stream. Figure 4.11-9 - Output Directories Field Name Description Update Saves your

Field Name

Description

Update

Saves your selections into the database and closes the window.

Clear

Allows you to clear all selections. You will be prompted to confirm this action before it is performed.

Close

Closes the current window and returns you to the Add CFS Stream screen. Any selection changes will not be saved.

CS-1000 User's Guide

4.11.6 Edit an EDCS Stream

Figure 4.11-10 - EDCS Stream Configuration

an EDCS Stream Figure 4.11-10 - EDCS Stream Configuration 4.11.7 Edit Stream_Interface Note : The Edit

4.11.7 Edit Stream_Interface

Note: The Edit Stream Interface screen is the same for all types of carousel streams with the same field definitions pertaining to each stream type.

The Stream Interface association allows the user to specify which PID this stream should use when sending data to this interface. The Add button in the Output Interfaces section of the Stream window will bring up the list of devices you created in the Interfaces menu area, or allow you to add an interface now. In either event, when you select or create an interface to configure, you will need to have the packet ID (PID) associated with that service in the headend controller. See Section 8, CS-1000 Setup in a Local Headend for instructions on obtaining this PID.

CS-1000 User's Guide

Figure 4.11-11 - Edit Stream Interface

User's Guide Figure 4.11-11 - Edit Stream Interface Field Name Description Interface Name A 50

Field Name

Description

Interface Name

A

50 character field used to descriptively name an interface device.

Packet ID Stream (PID)

The MPEG PID that this stream should use when sending data to this interface.

Note: This PID value is not used when the stream is sending only raw DCII messages (refer to the “Select a Protocol” section).

4.11.8 Edit Stream_DataSource

The Stream Data Source association allows the user to specify which PID this stream should use when receiving data from this data source. The Add button in the Data Source section of the Stream window

will bring up the list of data sources you created in the Data Sources menu area, or allow you to add a

data source now.

have the packet ID (PID) that you wish to receive data from.

In either event, when you select or create adata source to configure, you will need to

Figure 4.11-12 - Edit Stream Data Source

you will need to Figure 4.11-12 - Edit Stream Data Source Field Name Description Data Source

Field Name

Description

Data Source Name

A

50 character field used to descriptively name an data source device.

Packet ID Stream (PID)

The MPEG PID that this stream should use when receiving data from this data source.

CS-1000 User's Guide

5 CFS Content Management

This section discusses content management using a CFS carousel. A similar process for staging DCII files onto PDCS is discussed in Section 6.

The CFS does not provide any authoring or content creation tools, since content is application specific. It is the ISV's responsibility to provide content to the CFS carousel for transmission. The CFS Carousel delivers application specific files verbatim. It does not require files to adhere to any particular format.

Content management is performed via simple file transfers. Each CFS Carousel is given a separate staging area directory on the CS-1000, from which content is processed and uploaded into the Carousel. Application specific content should be transferred to this directory using FTP.

5.1 Managing StagingAreas and FTP User Logins

Application content is transferred to the CS-1000 staging area by way of FTP. Each ISV or user will have their own user login which will, upon successful login, put the user in their correct staging area directory. The script used to create these users also creates a corresponding directory within the /export/home/CS/StagingArea directory. Each user will be restricted to their own area and will be unable to access any other area of the system.

5.1.1 Add an ISV User

This script will create a directory for isv1 at /export/home/CS/StagingArea/isv1. Once logged in as isv1 it will appear as though you are logged in at “/”, this is intended. The working directory appears to be “/” because the isv1 user does not have the privilege to change directories outside of its own area, although it can create directories within its own area.

1. Login as root to the CS-1000 network card 0 via telnet.

2. Type isv_user_add and follow the prompts to create a user (isv1) and a corresponding StagingArea directory.

3. Logoff as root.

4. Login as the newly created user on either network card.

5.1.2 Delete an ISV User

This script will remove the ISV user login as well as the associated directory within the StagingArea and all subdirectories and files located within.

1. Login as root to the CS-1000 network card 0 via telnet.

2. Type isv_user_delete and follow the prompts to delete a user (isv1) and a corresponding StagingArea directory.

3. Logoff as root.

CS-1000 User's Guide

5.2 Metadata File Format

In order for the content to be uploaded, an accompanying “metadata” file must be provided. The metadata file is a simple text file that describes the content within the staging area. Streams eventually use the metadata to select content for output. Each line of metadata contains the following pipe (“|”) delimited data:

Table 5.2-1 - CFS Metadata File Format

Field

Type

Description

Staging Area Filename

String

Name of application specific file loaded into the staging area (physical file name). This filename does not have to match the CFS Filename.

CFS Directory Path and Filename

String

Fully qualified virtual directory path/file name to be used on the CFS. This can be different from the Staged Filename. The CFS Filename is the file name specified when calling CFS API functions.

This path is relative to the virtual root of this particular CFS carousel. For example, if the mount point for this carousel is /usr/ISV_A, then "/test.txt" will place the file "test.txt" in /usr/ISV_A (i.e., /usr/ISV_A should not be specified). However, if a subdirectory exists under /usr/ISV_A (e.g., /usr/ISV_A/mydir), then "/mydir/test.txt" will place the file "test.txt" in /usr/ISV_A/mydir.

CFS File Date

Formatted date string:

Date/Time the file was last updated.

yyyymmdd hh:mm:ss

yyyy = 4 digit year

mm

= 2 digit month (1-12)

dd = 2 digit day (1-31)

hh = 2 digit hour (0-23)

mm

= 2 digit minute (0-59)

ss = 2 digit second (0-59)

CFS File Expiration Date

See

above.

Date/Time that this file should be removed from the CFS.

CFS Data Date Range

Formatted date range:

Holds the date range to which the data within the file pertains. If the data is not time related, this field should be left BLANK.

yyyymmdd hh:mm:ss-yymmdd hh:mm:ss

CS-1000 User's Guide

The figure below illustrates the format of a metadata file:

Figure 5.2-1 - CFS Metadata File Format Illustration

Staging Area File CFS Directory Path & File Name CFS File Date (last updated) CFS
Staging
Area
File
CFS
Directory
Path & File
Name
CFS File Date
(last updated)
CFS File
Name
Expiration Date

Time Sensitive Data Date Range

File Name Expiration Date Time Sensitive Data Date Range test.txt|/content.txt|20001214 00:00:00|20001231

test.txt|/content.txt|20001214 00:00:00|20001231 23:59:59|20001214 00:00:00-20001231 23:59:59

5.3 Rules for using Metadata Files

The metadata fields allow for content to be added, updated, or removed based on their settings. If the file specified by a line of metadata does not exist on the application’s Carousel, it will be added. If the file specified by a line of metadata already exists on the Carousel it will be updated. An existing file can be removed by (1) Leaving the Staging Area Filename blank and (2) Setting a “CFS Expiration Date” prior to the current date/time. Content files can also be updated and expired using the Content Management screen in the CS GUI.

The CS-1000 will not process content in the staging area until there is a corresponding trigger file copied to the staging area. This ensures that content will not be processed before the copy process has completed. For example, it may take a significant amount of time to copy content and metadata files to the staging area. It is not desirable to have the CS-1000 begin processing these files while the copy is taking place. It is mandatory that the trigger file be copied to the staging area only after the content and metadata files have been copied completely. This order in which files are copied into the Staging Area is irrelevant if the carousel is stopped.

The metadata file must be named “CFS_METADATA_*.cmd”. The associated trigger file must have the same name as its corresponding metadata file, but with a “.trg” extension.

Example:

CFS_METADATA_MYCONTENT.cmd

CFS_METADATA_MYCONTENT.trg

Trigger files can be zero length. The contents of the trigger file are not relevant.

Multiple metadata files can be uploaded simultaneously provided they are uniquely named. These files would then be processed in date order.

Dates used in metadata must not specify a date past 20371231 23:59:59.

Metadata files can have multiple entries, for example:

apple.txt|/apple.txt|20000214 00:00:00|20101231 23:59:59| orange.txt|/orange.txt|20000214 00:00:00|20101231 23:59:59| grape.txt|/grape.txt|20000214 00:00:00|20101231 23:59:59| banana.txt|/banana.txt|20000214 00:00:00|20101231 23:59:59| grapefruit.txt|/sour/grapefruit.txt|20000214 00:00:00|20101231 23:59:59|20011231 00:00:00-20011231

23:59:59

cherry.txt|/cherry.txt|20000214 00:00:00|20101231 23:59:59| strawberry.txt|/strawberry.txt|20000214 00:00:00|20101231 23:59:59|

CS-1000 User's Guide

5.4 CFS OOBTAB Metadata File

The CFS OOBTAB file must be placed in the staging area corresponding to the CFS_MAIN carousel (Service = CFS_MAIN, MCA-16 = 1). When creating the CFS OOBTAB file from the GUI, any valid file name can be used. However, the CFS file name must be “cfsoobtab” (all lowercase), and the file must be placed in "/etc". Since the virtual root for this file system is "/", the CFS Directory Path and Filename must specify the "/etc" directory. The complete entry is "/etc/cfsoobtab".

In the example below, a CFS OOBTAB file is created from the GUI and saved as “myoobtab”. It must be placed in "/etc" as "cfsoobtab".

myoobtab|/etc/cfsoobtab|20000726 00:00:01|20101231 23:59:59|

Note: If you FTP this file to the CS-1000 (Netra), ensure that the transfer mode is set to binary. The