Skip Headers
Oracle® Communications Unified Inventory Management Cable TV Technology Pack Implementation Guide
Release 7.2.2

Part Number E36043-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

3 Cable TV Content

This chapter describes the entity specifications and rulesets included in the cable TV-specific cartridges in the Cable TV Technology Pack.

The cable TV cartridges are:

Entity Specifications

This section describes the specifications included in the cable TV-specific cartridges, organized by specification type. You can view the details of the specifications by opening the cartridges in Oracle Communications Design Studio.

Inventory Group Specifications

Table 3-1 lists and describes the Inventory Group specifications included in the cable TV-specific cartridges of the technology pack.

Table 3-1 Inventory Group Specifications

Specification Description

Headend

Represents a headend as an inventory group specification. A headend forms a group of headend resources such as access controllers, device partitions, and Video On Demand (VOD) controllers.

Creating an inventory group based on this specification triggers the CREATE_VIDEO_HEADEND_BEFORE ruleset, which validates that the headend you create has a unique name in the inventory.


Involvement Specifications

Table 3-2 lists and describes the Involvement specifications included in the cable TV-specific cartridges of the technology pack.

Table 3-2 Involvement Specifications

Specification Description

Video Service Subscriber

Represents a relationship between a subscriber and a service. The Subscriber specification designates an organization or an individual as a cable video subscriber.


Logical Device Specifications

Table 3-3 lists and describes the Logical Device specifications included in the cable TV-specific cartridges of the technology pack.

Table 3-3 Logical Device Specifications

Specification Description

Access Controller

Creates a logical device that represents an access controller. This is a key headend resource that supports subscription video. The technology pack supports two models of access controllers supplied by two vendors, Cisco (Digital Network Control System (DNCS) access controller) and Motorola (Digital Access Carrier (DAC) access controller).

Creating a logical device based on this specification triggers the CREATE_VIDEO_ACCESS_CONTROLLER_BEFORE ruleset, which validates that the video access controller that you created has a unique name in the inventory.

The Access Controller specification contains the following characteristic:

  • Video Channel Map ID: Identifies the default channel map for this controller. This is an optional characteristic.

Device Partition

Creates a logical device that represents a device partition. A device partition identifies a section or domain within the access controller. It may represent a collection of attributes such as time zone or language.

Creating a logical device based on this specification triggers the CREATE_VIDEO_DEVICE_PARTITION_BEFORE ruleset, which validates that the device partition that you created has a unique name in the inventory.

VOD Controller

Creates a logical device that represents a VOD controller. This logical device controls access to VOD entitlements of a subscriber.

Creating a logical device based on this specification triggers the CREATE_VOD_CONTROLLER_BEFORE ruleset, which validates that the VOD controller that you created has a unique name in the inventory.


Media Stream Specifications

Table 3-4 lists and describes the Media Stream specifications included in the cable TV-specific cartridges of the technology pack.

Table 3-4 Media Stream Specifications

Specification Description

Subscription Video

Represents a provisionable media stream that you can provide to subscribers as a subscription video.

When you create an entity based on a Media Stream specification, you associate logical devices to the media stream using a media handle. A logical device (access controller) uses the media handle to identify a media resource. This media handle is the network facing value for the video entitlement for that access controller. The media handle value cannot be duplicated for any media stream within the context of an access controller or logical device.

Creating a media stream based on this specification triggers the CREATE_SUBSCRIPTION_VIDEO_BEFORE ruleset, which validates that the subscription video that you create has a unique name in the inventory.


Network Specifications

Table 3-5 lists and describes the Network specifications included in the cable TV-specific cartridges of the technology pack.

Table 3-5 Network Specifications

Specification Description

Cable Office Network

Represents a network that comprises a group of video subscriptions. In Oracle Communications Unified Inventory Management (UIM), this specification is used in topological view to represent the devices that make up a Cable Office network.

Cluster Network

Represents a group of cable offices. In UIM, this specification is used in topological view to represent the devices that make up a Cluster network.

Region Network

Represents a group of Cluster networks. In UIM, this specification is used in topological view to represent the devices that make up a Region network.

MSO Network

Represents an organization (Party) with a role of Multi-System Operator (MSO) and by a network. In UIM, this specification is used in topological view to represent the devices that make up an MSO network.


Place Specifications

Table 3-6 lists and describes the Place specifications included in the cable TV-specific cartridges of the technology pack.

Table 3-6 Place Specifications

Specification Description

Cable Office Location

Represents the location of a cable office

Cluster Location

Represents the location of a cluster that comprises cable offices

Region Location

Represents the location of a region that comprises clusters


Physical Device Specifications

Table 3-7 lists and describes the Physical Device specifications included in the cable TV-specific cartridges of the technology pack.

Table 3-7 Physical Device Specifications

Specification Description

Programmable Video Receiver

Represents a video receiver as a physical device. This is typically a set-top box, but receiver can also be used to describe a TV with a set-top box.

Creating a physical device based on this specification triggers the CREATE_VIDEO_RECEIVER_BEFORE ruleset, which validates that the video receiver that you created has a unique name in the inventory.

The Programmable Video Receiver specification contains the following characteristics.

  • Video Device IP Address: IP address of the set-top box

  • Video Device Model Number: Model number of the set-top box

  • Video Device Model Type: Represents a classification of the model of the set-top box. For example, for a Motorola set-top box, this could have a value of 20002 for a Pace DC-755 HD set-top box.

  • Video Device Return Path: Represents the mechanism for the return path of information for the set-top box.

  • Video Device DVR Capable: Indicates whether the set-top box is DVR capable

  • Video Device HD Capable: Indicates whether the set-top box has high-definition (HD) capability

  • Video Device is PPV Enabled: Indicates whether IPPV purchases can be made on the set-top box

  • Video Device On Plant: Indicates whether the set-top box is physically connected to the plant. The controller uses this to determine whether communication is possible.

  • Video Device Credit Limit: Indicates, in units or dollars, the subscriber's remaining credit amount for IPPV

  • Video Device Host ID: Indicates an additional identifier for the set-top box

  • Video Device Unit Address: Indicates the unit addresses printed on the back panels of set-top boxes which include dashes between numbers for readability. The dashes are not part of the unit address.

Video Subscription Card

Represents a video subscription card as a physical device. This device determines the content a subscriber has access to.

Creating a physical device based on this specification triggers the CREATE_VIDEO_CARD_BEFORE ruleset, which validates that the video card that you created has a unique name in the inventory.

The Video Subscription Card specification contains the following characteristics:

  • Video Device Host ID: Indicates an additional identifier for the card

  • Video Device IP Address: IP address of the video subscription card

  • Video Device Model Number: Model number of the video subscription card

  • Video Device Model Type: Represents a classification of the model of the video subscription card.

  • Video Device On Plant: Indicates whether the video subscription card is physically connected to the plant. The access controller uses this to determine whether communication is possible.

  • Video Device Unit Address: Indicates the unit address if it is applicable.


Role Specifications

Table 3-8 lists and describes the Role specifications included in the cable TV-specific cartridges of the technology pack.

Table 3-8 Role Specifications

Specification Description

Multi System Operator

Defines a party (individual or organization) as an MSO


Service Specifications

Table 3-9 lists and describes the Service specifications included in the cable TV-specific cartridges of the technology pack.

Table 3-9 Service Specifications

Specification Description

Video Service

Contains specifications required to define a video service


Service Configuration Specifications

Table 3-10 lists and describes the Service Configuration specifications included in the cable TV-specific cartridges of the technology pack.

Table 3-10 Service Configuration Specifications

Specification Description

Video Service Configuration

Contains specifications and configuration items required to define a video service configuration.

Creating a video service configuration based on this specification triggers the CREATE_SERVICE_CONFIGURATION_AFTER ruleset. This ruleset removes configuration items with the label Subscription <Removed>, and their child items, that are associated with a previous version of the video service configuration.

The Video Service Configuration specification contains the following configuration items:

  • Headend Profile

  • Access Controller

  • Device Partition

  • Default Channel Map

  • Headend

  • VOD Controller

  • Business System Interface

  • Subscriptions

  • Subscription Module (Receiver and Subscription Card)

  • Features (HD Enabled, DVR Enabled and Subscription Channel Map)

  • Video Entitlements


Rulesets Included in the Cable TV Cartridges

Rules are executed at the point identified in the corresponding ruleset extension point specification. The identified point corresponds to a class or method signature in a base extension point that is included in the ora_uim_baseextpts cartridge. The cable TV cartridge requires the ora_uim_baseextpts cartridge to execute the rules. See "Deploying the Cable TV Technology Pack" for more information. To modify the rules and their extension points, see UIM Developer's Guide.

Table 3-11 lists the rulesets that are included in the Cable TV Technology Pack.

Table 3-11 Rulesets in the Cable TV Technology Pack

Ruleset/Ruleset Extension Points Functionality

CREATE_VIDEO_ACCESS_CONTROLLER_BEFORE

CREATE_VIDEO_ACCESS_CONTROLLER_BEFORE_EXT

Validates that the access controller that you create has a unique name in the inventory.

Triggered when an access controller is added to the inventory.

COPY_VIDEO_ACCESS_CONTROLLER_BEFORE

COPY_VIDEO_ACCESS_CONTROLLER_BEFORE_EXT

Ensures that an access controller cannot be copied.

Triggered when you try to create a copy of an access controller.

UPDATE_VIDEO_ACCESS_CONTROLLER_BEFORE

UPDATE_VIDEO_ACCESS_CONTROLLER_BEFORE_EXT

Validates that the access controller that you update exists in the inventory. This rule also validates that the access controller you update has a unique name in the inventory.

Triggered when information about an access controller is updated in the inventory.

CREATE_VIDEO_DEVICE_PARTITION_BEFORE

CREATE_VIDEO_DEVICE_PARTITION_BEFORE_EXT

Validates that the device partition that you create has a unique name in the inventory.

Triggered when a device partition is added to the inventory.

COPY_VIDEO_DEVICE_PARTITION_BEFORE

COPY_VIDEO_DEVICE_PARTITION_BEFORE_EXT

Ensures that a device partition cannot be copied.

Triggered when you try to create a copy of a device partition.

UPDATE_VIDEO_DEVICE_PARTITION_BEFORE

UPDATE_VIDEO_DEVICE_PARTITION_BEFORE_EXT

Validates that the device partition that you update exists in the inventory. This rule also validates that the device partition you update has a unique name in the inventory.

Triggered when information about a device partition is updated in the inventory.

CREATE_VIDEO_CARD_BEFORE

CREATE_VIDEO_CARD_BEFORE_EXT

Validates that the video subscription card that you create has a unique name in the inventory.

Triggered when a cable card is added to the inventory.

COPY_VIDEO_CARD_BEFORE

COPY_VIDEO_CARD_BEFORE_EXT

Ensures that a video subscription card cannot be copied.

Triggered when you try to create a copy of a video subscription card.

UPDATE_VIDEO_CARD_BEFORE

UPDATE_VIDEO_CARD_BEFORE_EXT

Validates that the subscription card that you update exists in the inventory. This rule also validates the subscription card that you update has a unique name in the inventory.

Triggered when information about a cable card is updated in the inventory.

CREATE_VIDEO_HEADEND_BEFORE

CREATE_VIDEO_HEADEND_BEFORE_EXT

Validates that the headend that you create has a unique name in the inventory.

Triggered when a headend is added to the inventory.

UPDATE_VIDEO_HEADEND_BEFORE

UPDATE_VIDEO_HEADEND_BEFORE_EXT

Validates that the headend you update exists in the inventory and has a unique name in the inventory.

Triggered when information about a headend is updated in the inventory.

CREATE_VIDEO_RECEIVER_BEFORE

CREATE_VIDEO_RECEIVER_BEFORE_EXT

Validates that the programmable video receiver that you create has a unique name in the inventory.

Triggered when a programmable video receiver is added to the inventory.

COPY_VIDEO_RECEIVER_BEFORE

COPY_VIDEO_RECEIVER_BEFORE_EXT

Ensures that a programmable video receiver cannot be copied.

Triggered when you try to create a copy of a programmable video receiver.

UPDATE_VIDEO_RECEIVER_BEFORE

UPDATE_VIDEO_RECEIVER_BEFORE_EXT

Validates that the programmable video receiver or set top box that you update exists in the inventory. This rule also validates that the video receiver has a unique name in UIM.

Triggered when information about a programmable video receiver is updated in the inventory.

CREATE_SUBSCRIPTION_VIDEO_BEFORE

CREATE_SUBSCRIPTION_VIDEO_BEFORE_EXT

Validates that the subscription video that you create has a unique name in the inventory.

Triggered when a new subscription video is added to the inventory.

UPDATE_SUBSCRIPTION_VIDEO_BEFORE

UPDATE_SUBSCRIPTION_VIDEO_BEFORE_EXT

Validates that the subscription video that you update exists in the inventory. This rule also validates that the subscription that you update has a unique name in the inventory.

Triggered when information about a subscription video is updated in the inventory.

CREATE_VOD_CONTROLLER_BEFORE

CREATE_VOD_CONTROLLER_BEFORE_EXT

Validates that the VOD controller that you create has a unique name in the inventory.

Triggered when a VOD controller is added to the inventory.

COPY_VOD_CONTROLLER_BEFORE

COPY_VOD_CONTROLLER_BEFORE_EXT

Ensures that a VOD controller cannot be copied.

Triggered when you try to create a copy of a VOD controller.

UPDATE_VOD_CONTROLLER_BEFORE

UPDATE_VOD_CONTROLLER_BEFORE_EXT

Validates that the VOD controller you update exists in the inventory and has a unique name in the inventory.

Triggered when information about a VOD controller is updated in the inventory.

APPROVE_VIDEO_SERVICE_CONFIGURATION_BEFORE

APPROVE_VIDEO_SERVICE_CONFIGURATION_BEFORE_EXT

Before approving a configuration, this rule validates that the service configuration is complete. For the first version of the configuration, the Location (associated to the Service) and Access Controller specifications are mandatory.

This rule validates that:

  • While creating a service, an access controller, device partition, and VOD controller that are already assigned to an existing headend (Inventory Group) are not assigned to another headend (Inventory Group)

  • A subscription has a Party (Subscriber), when a service has a subscription

  • A programmable video receiver or set top box is HD and DVR enabled, when the features of the service have HD and DVR enabled

  • At least one subscription video service is associated with every subscription

Triggered from the Approved action in the Service Fulfillment Web Service request.

AUTOMATE_VIDEO_SERVICE_CONFIGURATION

AUTOMATE_VIDEO_SERVICE_CONFIGURATION_EXT

This rule drives the behavior of the Process Interaction Web service operation request.

This rule handles all the different types of requests (create, change, cancel, etc.) based on the action in the Web service operation request. For each of these actions, cable video code calls its respective process methods.

Triggered from any cable-specific custom action in the Service Fulfillment Web service request that affects the configuration, such as create, changeAddSubscription, changeRemoveSubscription, and so forth.

CANCEL_VIDEO_SERVICE_CONFIGURATION_AFTER

CANCEL_VIDEO_SERVICE_CONFIGURATION_AFTER_EXT

After an existing service is canceled, the application activates the last completed service. This rule deletes an existing party when the service does not have a subscription.

Triggered from the Cancel action in the Service Fulfillment Web Service request.

CANCEL_VIDEO_SERVICE_CONFIGURATION_BEFORE

CANCEL_VIDEO_SERVICE_CONFIGURATION_BEFORE_EXT

Before an existing service is canceled, this rule validates that the resources such as receivers, subscription cards, and video streams associated with the service are unassigned.

Triggered from the Cancel action in the Service Fulfillment Web Service request.

COMPLETE_VIDEO_SERVICE_CONFIGURATION_BEFORE

COMPLETE_VIDEO_SERVICE_CONFIGURATION_BEFORE_EXT

Validates that the service is in the Issued state. This rule also validates that a party, subscription, place, receiver, and video stream are added to the service before completing the video service configuration.

Triggered from the Complete action in the Service Fulfillment Web Service request.

CREATE_SERVICE_CONFIGURATION_AFTER

CREATE_SERVICE_CONFIGURATION_AFTER_EXT

Removes configuration items with the label Subscription <Removed>, and their child items, that are associated with a previous version of the service configuration.

Triggered by creating a new service configuration version in a Video Service work area in UIM.

DETERMINE_ACTION_FOR_WEBSERVICE_BEFORE

DETERMINE_ACTION_FOR_WEBSERVICE_BEFORE_EXT

Determines the appropriate service fulfillment action in order to execute the correct function.

Triggered before the Web service action is evaluated.

DISCONNECT_VIDEO_SERVICE

DISCONNECT_VIDEO_SERVICE_EXT

Removes all subscriptions and parties that are associated with a service.

Triggered from the changeUnsubscribeAll cable-specific custom action in the Service Fulfillment Web Service request.

ISSUE_VIDEO_SERVICE_CONFIGURATION_AFTER

ISSUE_VIDEO_SERVICE_CONFIGURATION_AFTER_EXT

After issuing a service configuration, for each video stream configuration item, this rule creates the Controller Id configuration item for a video stream and associates it with a characteristic so that activation has the related controller IDs for the video stream. (These controller IDs are the same values as the Media Handles setup in the Readiness steps.)

Triggered from the Issue action in the Service Fulfillment Web Service request.

ISSUE_VIDEO_SERVICE_CONFIGURATION_BEFORE

ISSUE_VIDEO_SERVICE_CONFIGURATION_BEFORE_EXT

Before you issue a video service configuration, this rule validates that the configuration is complete.

Triggered from the Issue action in the Service Fulfillment Web Service request.

RESUME_VIDEO_SERVICE

RESUME_VIDEO_SERVICE_EXT

This rule displays an error message indicating that the Resume action is not supported for the video service in UIM.

Triggered from the Resume action in the Service Fulfillment Web Service request.

SUSPEND_VIDEO_SERVICE

SUSPEND_VIDEO_SERVICE_EXT

This rule displays an error message indicating that the Suspend action is not supported for the video service in UIM.

Triggered from the Suspend action in the Service Fulfillment Web Service request.

VALIDATE_VIDEO_SERVICE_CONFIGURATION

VALIDATE_VIDEO_SERVICE_CONFIGURATION_EXT

Validates that a video service configuration is complete. This validation is called before a configuration is issued or completed. For the first version of a video service configuration, the Location and Access Controller specifications are mandatory.

This rule validates that:

  • An access controller, device partition, and VOD controllers that are associated with an existing headend (Inventory Group) are not assigned to another headend (Inventory Group)

  • A subscription has a Party (Subscriber), when a service has a subscription

  • A programmable video receiver or set top box is HD and DVR enabled, when the features of the service have HD and DVR capabilities enabled

  • At least one subscription video service and physical device are associated with every subscription

Triggered from the Issue or Complete action in the Service Fulfillment Web Service request.