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
PDF · Mobi · ePub

7 Automating Cable Services through Web Services

This chapter provides information on using the Cable TV Technology Pack with the Oracle Communications Unified Inventory Management (UIM) Service Fulfillment Web service to automate the fulfillment of cable services. This chapter assumes that you are familiar with the UIM Service Fulfillment Web service, as described in UIM Developer's Guide.

Note:

Before reading this chapter, read Chapter 9: Integrating UIM Through Web Services in UIM Developer's Guide, which describes the UIM Service Fulfillment Web service operations in detail.

About the UIM Service Fulfillment Web Service

The UIM Service Fulfillment Web service enables an external system to create new business interactions and change existing unprocessed business interactions in UIM. Through business interactions, an external system can manage services, including the relationships between services, and the resources associated with them.

The UIM Service Fulfillment Web service defines the following operations, as described in detail in UIM Developer's Guide:

The CaptureInteraction operation captures a service order request, and saves it in UIM in the form of a business interaction. The ProcessInteraction operation performs the work that is necessary to move the business interaction into live inventory. ProcessInteraction retrieves the business interaction and, based on the request items, creates or updates services and service configurations, and provides the means to execute customizations that create or update service configuration items. In the case of the Cable TV Technology Pack, the content of the technology pack provides the customizations that create and update cable services.

The UpdateInteraction operation enables external systems to transition UIM business entities to specific life cycle states within the context of a business interaction. The GetInteraction and GetConfiguration operations enable you to retrieve information from UIM.

About Cable TV Custom Service Actions and Parameters

The CaptureInteraction request defines an interaction with multiple items, and each item defines a service or service change. The request also defines several actions: interaction action, item action, and service action. The interaction action and item action are defined as enumerations, while the service action is a custom action that is recognized by, and acted upon by, custom code. The Cable TV Technology Pack provides the custom code, and it defines custom service actions that drives the custom logic.

The CaptureInteraction request defines custom parameters for each service that are recognized by, and acted upon by, custom code. The Cable TV Technology Pack provides the custom code, and it defines custom parameters are used with a specific service action.

The focus of this chapter is the custom service actions and custom parameters that the Cable TV Technology Pack defines, which you need to know to populate the CaptureInteraction request to automate the fulfillment of cable services. Example requests are included with the first few actions that are described.

The Cable TV Technology Pack defines the following custom service actions, each of which define a specific set of custom parameters:

create

The create action establishes a service location and desired cable service support for that location in UIM. When using the Web service operations, the create action must be the first action taken per cable service. All of the remaining actions assume that the service location and the video service for that location already exist in UIM.

Table 7-1 shows the parameter names that are recognized by, and processed by, the Cable TV Technology Pack when the service action is create. The corresponding parameter values specify data, which must reflect the specific data type that each parameter name expects, such as String, Boolean, or EntityNameType.

Additional information regarding each parameter is described in the sections following the table.

Table 7-1 Parameters for create Action

Name Value Data Type Req

serviceAddress

GeographicAddressType

Y

accessController

String (logical device name)

Y

devicePartition

String (logical device name)

N

channelMapId

String

N

vodController

String (logical device name)

N

businessSystemInterfaceCode

String

N

headend

String (inventory group name)

N


serviceAddress

This parameter defines the service address where the cable service is to be established (or may be established in the future, if tracking homes that can possibly be serviced). The technology pack defines several Place specifications you can use to specify the service address. See Table 2-2, "Place Specifications".

The service address is associated to the service in UIM.

In the request, you specify the parameter name, and the corresponding parameter value as a GeographicAddressType structure. The structure defines a place name, a Place specification, and specific address information such as street address, city, state, and ZIP code. (For information on Place specifications and how they are realized as GeographicAddress entities in UIM, see the Place Entity chapter in UIM Information Model Reference.)

In the GeographicAddressType structure, you must specify a place name; supplying a Place specification is optional. If the place is found, it is used. If the place is not found, it is created based on the supplied Place specification name, or, if not supplied, on the default Place specification (usAddress). If the place is being created, the request must also supply the specific address information, such as street address, city, state, and ZIP code. These address elements are based on the supplied Place specification.

accessController, devicePartition, vodController

These parameters define configuration items that are used to support the cable service. The Video Service Configuration specification defines several configuration items, including Access Controller, Device Partition, and Video On Demand (VOD) Controller. These configuration items reference logical devices, which are based on the Access Controller, Device Partition, and VOD Controller Logical Device specifications. (The configuration items and Logical Device specifications are named the same.)

In the request, you specify the parameter name and corresponding parameter value as a String, which represents the name of a logical device that the configuration item references. The specified logical device must already exist in UIM; if it does not, an error is thrown.

headend

This parameter defines a configuration item that is used to support the cable service. The Video Service Configuration specification defines several configuration items, including Headend. This configuration item references an inventory group, which is based on the Headend Inventory Group specification. (The configuration item and Inventory Group specification are named the same.)

In the request, you specify the parameter name and corresponding parameter value as a String, which represents the name of an inventory group that the configuration item references. The specified inventory group must already exist in UIM; if it does not, an error is thrown.

channelMapId, businessSystemInterfaceCode

These parameters define configuration items that are used to establish the cable service. The Video Service Configuration specification defines several configuration items, including Default Channel Map and Business System Interface Code. These configuration items are defined as characteristics.

In the request, you specify the parameter name and corresponding parameter value as a String, which defines the value of the characteristic cited by the parameter name.

If channelMapId is not specified, it defaults to the value of the channelMapId characteristic defined for the Logical Device specification, as specified by the accessController parameter. (The channelMapId characteristic is defined on the Access Controller specification.)

Understanding the Request

Example 7-1 is a condensed version of the CaptureInteraction request that highlights specific content to better understand what is required when using the UIM Service Fulfillment Web service with the Cable TV Technology Pack. The example is numbered so that information describing the example can be referenced.

Example 7-1 Request With create Action

01  <biws:captureInteractionRequest>
02      <biws:interaction>
03          <invbi:specification>
04              <invspec:name>Service Order</invspec:name>
05          </invbi:specification>
06          <invbi:action>CREATE</invbi:action>
07          <invbi:name>Create Video Service Request</invbi:name>
08          <invbi:effectiveDate>2011-07-14T00:00:00Z</invbi:effectiveDate>
09          <invbi:item>
10              <invbi:action>ADD</invbi:action>
11              <invbi:service>
12                  <invsvc:specification>
13                      <invspec:name>Video Service</invspec:name>
14                  </invsvc:specification>
15                  <invsvc:action>create</invsvc:action>
16                  <invsvc:name>San Diego Video Service</invsvc:name>
17              </invbi:service>
18              <invbi:parameter>
19                  <invbi:name>serviceAddress</invbi:name>
20                  <invbi:value xsi:type="invplace:GeographicAddressType">
21                      <invplace:specification>
22                          <invspec:name>usAddress</invspec:name>
23                      </invplace:specification>
24                      <invplace:property>
25                          <invprop:name>addressLine1</invprop:name>
26                          <invprop:value>123 Main Street</invprop:value>
27                      </invplace:property>
28                      <invplace:property>
29                          <invprop:name>americanCity</invprop:name>
30                          <invprop:value>San Diego</invprop:value>
31                      </invplace:property>
32                      <invplace:property>
33                          <invprop:name>americanState</invprop:name>
34                          <invprop:value>CA</invprop:value>
35                      </invplace:property>
36                      <invplace:property>
37                          <invprop:name>countryCode</invprop:name>
38                          <invprop:value>USA</invprop:value>
39                      </invplace:property>
40                      <invplace:property>
41                          <invprop:name>americanZipCode</invprop:name>
42                          <invprop:value>92104</invprop:value>
43                      </invplace:property>
44                  </invbi:value>
45              </invbi:parameter>
46              <invbi:parameter>
47                  <invbi:name>accessController</invbi:name>
48                  <invbi:value xsi:type="xs:string">San Diego</invbi:value>
49              </invbi:parameter>
50              <invbi:parameter>
51                  <invbi:name>devicePartition</invbi:name>
52                  <invbi:value xsi:type="xs:string">PT Timezone
53                                                    Lineup</invbi:value>
54              </invbi:parameter>
55              <invbi:parameter>
56                  <invbi:name>channelMapId</invbi:name>
57                  <invbi:value xsi:type="xs:string">101</invbi:value>
58              </invbi:parameter>
59              <invbi:parameter>
60                  <invbi:name>vodController</invbi:name>
61                  <invbi:value xsi:type="xs:string">Seachange
62                                                    Axiom</invbi:value>
63              </invbi:parameter>
64              <invbi:parameter>
65                  <invbi:name>businessSystemInterfaceCode</invbi:name>
66                  <invbi:value xsi:type="xs:string">23</invbi:value>
67              </invbi:parameter>
68              <invbi:parameter>
69                  <invbi:name>headend</invbi:name>
70                  <invbi:value xsi:type="xs:string">Vista Headend</invbi:value>
71              </invbi:parameter>
72          </invbi:item>
73      </biws:interaction>
74  </biws:captureInteractionRequest>

About the Interaction, Item, and Service

The request defines an interaction (line 02-73) that results in the creation of the a business interaction in UIM. The business interaction is based on the Service Order Business Interaction specification (line 04), which is defined in the ora_uim_base_specifications base cartridge. The creation is based on the interaction action of CREATE (line 06). The business interaction that gets created in UIM is named Create Video Service Request (line 07). The effective date (line 08) is required.

The request also defines an item (lines 09-72), with an item action of ADD (line 10). Within the item, the request defines a service (lines 11-17), and custom parameters for the service (lines 18-71). The service is based on the Video Service specification (line 13). The service action of create (line 15) is the Cable TV Technology Pack custom service action. The service that gets created in UIM is named San Diego Video Service (line 16).

About the Parameters

The custom parameters for the service (lines 18-71) are based on the parameters for the create service action, as described in Table 7-1. For example, the first parameter name in the table is serviceAddress, which is a required parameter with a corresponding value that must reflect a data type of GeographicAddressType. In the request, this parameter (lines 18-45) specifies a parameter name of serviceAddress (line 19), and a parameter value of GeographicAddressType (lines 20-44). The GeographicAddressType structure defines a Place specification of usAddress (lines 21-23), which is a Place specification that is defined in the technology pack. (For information on Place specifications and how they are realized as GeographicAddress entities, see the Place Entity chapter in UIM Information Model Reference.) The usAddress Place specification defines several characteristics, including addressLine1, americanCity, americanState, and americanZipCode. These characteristics, and their corresponding values, are represented as properties of GeographicAddressType (lines 24-43).

The second parameter name in Table 7-1 is acccessController, which is a required parameter with a corresponding value that must reflect a data type of String, where the String value is the name of an existing logical device. In the request, this parameter (lines 46-49) specifies a parameter name of accessController (line 47), and a parameter value String of San Diego (line 48). This requests that the San Diego logical device be used to support the cable service.

Similarly, based on the devicePartition parameter (lines 50-54), this requests that the PT Timezone Lineup logical device be used to support the cable service.

The channelMapId parameter (lines 55-58) defines a Default Channel Map service configuration item, which is characteristic with a value of 101.

The vodController parameter (lines 59-63) requests that the Seachange Axiom logical device be used to support the cable service.

The businessSystemInterfaceCode parameter (lines 64-67) defines a Business System Interface Code configuration item, which is a characteristic with a value of 23.

Lastly, the headend parameter (lines 68- 71) requests that the Vista Headend inventory group be used to support the cable service.

Understanding How Characteristic Values are Set in the Request

In the request, characteristic values are set one of two ways: As a parameter value, or as a property value.

The value of a characteristic that represents a configuration item is set by a parameter value. For example, the Video Service Configuration specification defines the Default Channel Map configuration item, which is defined as a characteristic. The value for this characteristic is set by the parameter value for the channelMapId parameter. In Example 7-1, the value of the channelMapId characteristic, which represents a configuration item, is set to 101 (lines 55-58).

The value of a characteristic that is related to a specification is set by a property value. For example, the usAddress specification relates the following characteristics: addressLine1, addressline2, americanState, americanCity, americanZipCode, and countryCode. In Example 7-1, the value of these characteristics are set by the properties (lines 24-43) that the usAddress specification defines (lines 21-23).

Understanding How Primitive Data Types are Represented in the Request

Throughout this chapter, tables list the parameters that are applicable for each action. These tables list the data type that is expected in the value element, such as String, Boolean, or Long. The data is actually a primitive instance of the specified data type. For example, string, boolean, or long.

In the request, you must include the namespace that defines primitive instances, which is "http://ww.w3.org/2001/XMLSchema-instance". You can define the namespace in the heading of your XML, which is then referenced from within the value element. For example:

. . .
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
. . 
<invbi:parameter>
    <invbi:name>channelMapId</invbi:name>
    <invbi:value xsi:type="xs:string">101</invbi:value>
</invbi:parameter>
 

You can also define the namespace within the value element that contains string, boolean, or long data, in which case the namespace does not need to be defined in the header. For example:

<invbi:parameter>
    <invbi:name>channelMapId</invbi:name>
    <invbi:value xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:type="xs:string">101</invbi:value>
</invbi:parameter>

All of the examples in this chapter assume that the namespace is defined in the header, so they do not show the namespace defined within the value element.

changeAddSubscriber

The changeAddSubscriber action establishes a new cable service subscriber for an existing video service in UIM.

Table 7-2 shows the parameter names that are recognized by, and processed by, the Cable TV Technology Pack when the service action is changeAddSubscriber. The corresponding parameter values specify data, which must reflect the specific data type that each parameter name expects, such as String or EntityNameType.

Additional information regarding each parameter is described in the sections following the table.

Table 7-2 Parameters for changeAddSubscriber Action

Name Value Data Type Req

subscriber

PartyType

Y

channelMapId

String

N


subscriber

This parameter defines the subscriber of the cable service that was previously established by the create action. The technology pack defines Party specifications you can use to specify the subscriber. See Table 2-1, "Party Specifications". The technology pack also defines Role specifications you can use to further describe the party. See Table 2-3, "Role Specifications".

The subscriber is associated to the service in UIM.

In the request, you specify the parameter name and the corresponding parameter value as a PartyType structure. The structure defines a party name, a Party specification, and specific party information such as name and account number. In addition, the structure defines a role name and Role specification for the party, such as Subscriber. (For information on Party and Role specifications, see the Party Entity and Role Pattern chapters in UIM Information Model Reference.)

In the PartyType structure, you must specify a party name; supplying a Party specification is optional. If the party is found, it is used. If the party is not found, it is created based on the supplied Party specification name, or, if not supplied, on the default Party specification (Individual). If the party is being created, the request must also supply the specific party information, such as name and account number. These party elements are based on the supplied Party specification.

channelMapId

This parameter adds or updates the configuration item that describes the default channel map id in the headend profile section of the video service. This is the overall default channel map id for the video service and all subscriptions. The Video Service Configuration specification defines several configuration items, including Default Channel Map. This configuration item is defined as a characteristic.

In the request, you specify the parameter name and corresponding parameter value String, which defines the value of the characteristic cited by the parameter name.

If channelMapId is not specified, it remains the same value that was specified by the create action.

Understanding the Request

Example 7-2 is a condensed version of the CaptureInteraction request that highlights specific content to better understand what is required when using the UIM Service Fulfillment Web service with the Cable TV Technology Pack.

In this example, the changeAddSubscriber action is changing the San Diego Video Service, which is the service that was created by the create action in Example 7-1.

Example 7-2 Request With changeAddSubscriber Action

<biws:captureInteractionRequest>
    <biws:interaction>
        <invbi:specification>
            <invspec:name>Service Order</invspec:name>
        </invbi:specification>
        <invbi:action>CREATE</invbi:action>
        <invbi:name>AddSubscriberRequest</invbi:name>
        <invbi:effectiveDate>2011-05-09T00:00:00Z</invbi:effectiveDate>
        <invbi:item>
            <invbi:action>ADD</invbi:action>
            <invbi:service>
                <invsvc:specification>
                    <invspec:name>Video Service</invspec:name>
                </invsvc:specification>
                <invsvc:action>changeAddSubscriber</invsvc:action>
                <invsvc:name>San Diego Video Service</invsvc:name>
                <invsvc:id>33</invsvc:id>
            </invbi:service>
            <invbi:parameter>
                <invbi:name>subscriber</invbi:name>
                <invbi:value xsi:type="invparty:PartyType">
                    <invparty:specification>
                        <invspec:name>Individual</invspec:name>
                    </invparty:specification>
                    <invparty:name>Joseph Schmow</invparty:name>
                    <invparty:property>
                        <invprop:name>accountNumber</invprop:name>
                        <invprop:value>33</invprop:value>
                    </invparty:property>
                    <invparty:role>
                        <invrole:specification>
                            <invspec:name>Subscriber</invspec:name>
                        </invrole:specification>
                    </invparty:role>
                </invbi:value>
            </invbi:parameter>
            <invbi:parameter>
                <invbi:name>channelMapId</invbi:name>
                <invbi:value xsi:type="xs:string">103</invbi:value>
            </invbi:parameter>
        </invbi:item>
    </biws:interaction>
</biws:captureInteractionRequest>

changeAddSubscription

The changeAddSubscription action establishes a new cable service subscription for an existing subscriber in UIM. This subscription is a block of configuration items within the video service.

Table 7-3 shows the parameter names that are recognized by, and processed by, the Cable TV Technology Pack when the service action is changeAddSubscription. The corresponding parameter values specify data, which must reflect the specific data type that each parameter name expects, such as String, Boolean, or EntityNameType.

Additional information regarding each parameter is described in the sections following the table.

Table 7-3 Parameters for changeAddSubscription Action

Name Value Data Type Req

receiver

PhysicalDeviceType

Y/N

subscriptionCard

PhysicalDeviceType

Y/N

featureHD

Boolean

N

featureDVR

Boolean

N

subscriptionVideo[]

MediaStreamType

Y

channelMapId

String

N


receiver, subscriptionCard

These parameters define configuration items that are used to establish the cable service. One or the other is required, or both may be provided.The Video Service Configuration specification defines several configuration items, including Receiver and Subscription Card. Physical devices are assigned to these configuration items. The physical devices are based on the Programmable Video Receiver and Video Subscription Card Physical Device specifications.

In the request, you specify the parameter name and corresponding parameter value as a PhysicalDeviceType structure. In the structure, you specify a physical device. If the specified physical device is found, it is assigned to the configuration item. If the specified physical device is not found, it is created based on the Physical Device specification supplied in the PhysicalDeviceType structure. If the name of the receiver or card is not provided, the name defaults to the concatenation of the modelNumber and physicalAddress attributes specified in the PhysicalDeviceType structure. The new physical device is then assigned to the configuration item.

featureHD, featureDVR

These parameters define configuration items that are used to establish the cable service. The Video Service Configuration specification defines several configuration items, including HD Enabled and DVR Enabled.

In the request, you specify the parameter name and corresponding parameter value as a Boolean, which determines whether or not the configuration item indicated by the parameter name is added. For example, if the boolean is true, the configuration item is added, and if the boolean is false, the configuration item is not added. The default value is false.

subscriptionVideo

This parameter defines a configuration item that is used to support the cable service, and a minimum of one is required. The Video Service Configuration specification defines several configuration items, including Video Stream. A media stream is assigned to this configuration item, which is a Subscription Video specification.

In the request, you specify the parameter name and corresponding parameter value as a MediaStreamType structure. In the structure, you specify a media stream. If the specified media stream is found, it is assigned to the configuration item. If the specified media stream is not found, an error is thrown.

The request can specify multiple subscriptionVideo parameters.

channelMapId

This parameter defines a configuration item that describes the subscription channel map for this subscription on the video service. The Video Service Configuration specification defines several configuration items, including Subscription Channel Map. This configuration item is defined as a characteristic.

In the request, you specify the parameter name and corresponding parameter value as a String, which defines the value of the characteristic cited by the parameter name.

If channelMapId is not specified, it is not added to the subscription block within the video service.

Understanding the Request

Example 7-3 is a condensed version of the CaptureInteraction request that highlights specific content to better understand what is required when using the UIM Service Fulfillment Web service with the Cable TV Technology Pack.

Example 7-3 Request With changeAddSubscription Action

<biws:captureInteractionRequest>
    <biws:interaction>
        <invbi:specification>
            <invspec:name>Service Order</invspec:name>
        </invbi:specification>
        <invbi:action>CREATE</invbi:action>
        <invbi:name>AddSubscrition</invbi:name>
        <invbi:effectiveDate>2011-05-09T00:00:00Z</invbi:effectiveDate>
        <invbi:item>
            <invbi:action>ADD</invbi:action>
            <invbi:service>
                <invsvc:specification>
                    <invspec:name>Video Service</invspec:name>
                </invsvc:specification>
                <invsvc:action>changeAddSubscription</invsvc:action>
                <invsvc:id>25</invsvc:id>
                                        <invsvc:name>San Diego Video Service</invsvc:name>
            </invbi:service>
            <invbi:parameter>
                <invbi:name>subscriptionCard</invbi:name>
                <invbi:value xsi:type="invpd:PhysicalDeviceType">
                                        <invpd:specification>
                        <invspec:name>Video Subscription Card</invspec:name>
                    </invpd:specification>
                    <invpd:physicalAddress>01:1E:SC:F8:0B:25
                    </invpd:physicalAddress>
                                        <invpd:serialNumber>1233533</invpd:serialNumber>
                    <invpd:physicalLocation>LivingRoom</invpd:physicalLocation>
                                                <invpd:description>MediaCipher CableCard MCard TWOWAY
                    </invpd:description>
                                        <invpd:property>
                                                        <invprop:name>videoDeviceIPAddress</invprop:name>
                                                <invprop:value>55.49.151.25</invprop:value>
                                  </invpd:property>
                                        <invpd:property>
                                                        <invprop:name>videoDeviceModelNumber</invprop:name>
                                                <invprop:value>MCardTW</invprop:value>
                                  </invpd:property>
                                        <invpd:property>
                                                        <invprop:name>videoDeviceModelType</invprop:name>
                                                <invprop:value>9062</invprop:value>
                                </invpd:property>
                                        <invpd:property>
                                                        <invprop:name>videoDeviceOnPlant</invprop:name>
                                                <invprop:value>true</invprop:value>
                                </invpd:property>
                </invbi:value>
            </invbi:parameter>
            <invbi:parameter>
                <invbi:name>featureHD</invbi:name>
                <invbi:value xsi:type="xs:boolean">false</invbi:value>
            </invbi:parameter>
            <invbi:parameter>
                <invbi:name>featureDVR</invbi:name>
                <invbi:value xsi:type="xs:boolean">false</invbi:value>
            </invbi:parameter>
            <invbi:parameter>
                <invbi:name>subscriptionVideo</invbi:name>
                <invbi:value xsi:type="invms:MediaStreamType">
                    <invms:name>HBO Advanced</invms:name>
                                        <invms:specification>
                        <invspec:name>Subscription Video</invspec:name>
                    </invms:specification>
                </invbi:value>
            </invbi:parameter>   
        </invbi:item>
    </biws:interaction>
</biws:captureInteractionRequest>

changeRemoveSubscription

The changeRemoveSubscription action unassigns an existing subscription block from a video service in UIM.

Table 7-4 shows the parameter names that are recognized by, and processed by, the Cable TV Technology Pack when the service action is changeRemoveSubscription. The corresponding parameter values specify data, which must reflect the specific data type that each parameter name expects, such as String or EntityNameType.

Additional information regarding each parameter is described in the section following the table.

Table 7-4 Parameters for changeRemoveSubscription Action

Name Value Data Type Req

receiver

PhysicalDeviceType

Y/N

subscriptionCard

PhysicalDeviceType

Y/N


receiver, subscriptionCard

These parameters specify the subscription block configuration items that are to be unassigned from an existing video service, and one or the other is required.

In the request, you specify the parameter name and corresponding parameter value as a PhysicalDeviceType structure. The structure defines the physical device configuration item that is to be unassigned and the matching subscription block that gets marked as removed.

changeAddStream

The changeAddStream action adds a video stream to an existing cable service for the particular subscription block defined by the input receiver or card, or both.

Table 7-5 shows the parameter names that are recognized by, and processed by, the Cable TV Technology Pack when the service action is changeAddStream. The corresponding parameter values specify data, which must reflect the specific data type that each parameter name expects, such as String, Boolean, or EntityNameType.

Additional information regarding each parameter is described in the sections following the table.

Table 7-5 Parameters for changeAddStream Action

Name Value Data Type Req

receiver

PhysicalDeviceType

Y/N

subscriptionCard

PhysicalDeviceType

Y/N

featureHD

Boolean

N

featureDVR

Boolean

N

channelMapId

String

N

subscriptionVideo[]

MediaStreamType

Y


receiver, subscriptionCard

These parameters define configuration items that specify the subscription block to which the Video Stream is to be added. One or the other parameter is required. The Video Service Configuration specification defines several configuration items, including Receiver and Subscription Card. Physical devices are already assigned to these configuration items. The physical devices are based on the Programmable Video Receiver and Video Subscription Card Physical Device specifications.

In the request, you specify the parameter name and corresponding parameter value as a PhysicalDeviceType structure. In the structure, you specify a physical device. If the specified physical device is found as a subscription block in the video service, the changeAddStream action is processed. If it is not found, an error is thrown.

featureHD, featureDVR

These parameters define configuration items that are used to describe the cable service. The Video Service Configuration specification defines several configuration items, including HD Enabled and DVR Enabled.

In the request, you specify the parameter name and corresponding parameter value as a Boolean, which determines whether or not the configuration item indicated by the parameter name is added. For example, if the boolean is true, the configure item is added, and if the boolean is false, the configuration item is removed (if it exists). The default value is false.

channelMapId

This parameter defines a configuration item that describes the subscription channel map for this subscription on the video service. The Video Service Configuration specification defines several configuration items, including Default Channel Map. This configuration item is defined as a characteristic. This value is used to set or change the subscription channel map value on the video service.

In the request, you specify the parameter name and corresponding parameter value as a String, which defines the value of the characteristic cited by the parameter name.

subscriptionVideo

This parameter defines a configuration item that adds a video stream to the subscription block defined by the input physical device of the receiver or card, or both. A minimum of one subscription video is required. The Video Service Configuration specification can have multiple subscription blocks, and each subscription block can include multiple video streams. A media stream is assigned to this configuration item, which is a Subscription Video specification.

In the request, you specify the parameter name and corresponding parameter value as a MediaStreamType structure. In the structure, you specify a media stream. If the specified media stream is found, it is assigned to the configuration item. If the specified media stream is not found, an error is thrown.

The request can specify multiple subscriptionVideo parameters.

changeRemoveStream

The changeRemoveStream action unassigns an existing video stream from a video service for the particular subscription block defined by the input receiver and/or card.

Table 7-6 shows the parameter names that are recognized by, and processed by, the Cable TV Technology Pack when the service action is changeRemoveStream. The corresponding parameter values specify data, which must reflect the specific data type that each parameter name expects, such as String, Boolean, or EntityNameType.

Additional information regarding each parameter is described in the sections following the table.

Table 7-6 Parameters for changeRemoveStream Action

Name Value Data Type Req

receiver

PhysicalDeviceType

Y/N

subscriptionCard

PhysicalDeviceType

Y/N

featureHD

Boolean

N

featureDVR

Boolean

N

channelMapId

String

N

subscriptionVideo[]

MediaStreamType

Y


receiver, subscriptionCard

These parameters define configuration items that are to be matched for finding the subscription block on the video service to unassign the video stream or streams. One or the other is required.

In the request, you specify the parameter name and corresponding parameter value as a PhysicalDeviceType structure. The structure defines the physical device configuration item that is to be matched.

featureHD, featureDVR

These parameters define configuration items that are used to describe the cable service. The Video Service Configuration specification defines several configuration items, including HD Enabled and DVR Enabled.

In the request, you specify the parameter name and corresponding parameter value as a Boolean, which determines whether or not the configuration item indicated by the parameter name is added. For example, if the boolean is true, the configure item is added, and if the boolean is false, the configuration item is removed (if it exists). The default value is false.

channelMapId

This parameter defines a configuration item that describes the subscription channel map for this subscription on the video service. The Video Service Configuration specification defines several configuration items, including Default Channel Map. This configuration item is defined as a characteristic. This value is used to set or change the subscription channel map value on the video service.

In the request, you specify the parameter name and corresponding parameter value as a String, which defines the value of the characteristic cited by the parameter name.

subscriptionVideo

This parameter defines a video stream that is to be unassigned from an existing video service, and a minimum of one is required.

In the request, you specify the parameter name and corresponding parameter value of a MediaStreamType structure. The structure defines the media stream that is to be unassigned.

The request can specify multiple subscriptionVideo parameters.

changeSwapSubscriptionDevice

The changeSwapSubscriptionDevice action swaps a subscription block by unassigning an existing subscription block (identified by a receiver or card, or both), and marking it as removed, and then adding a new subscription block of configuration items including a subscription device, optional features, and video streams.

Table 7-7 shows the parameter names that are recognized by, and processed by, the Cable TV Technology Pack when the service action is changeSwapSubscriptionDevice. The corresponding parameter values specify data, which must reflect the specific data type that each parameter name expects, such as String, Boolean, or EntityNameType.

Additional information regarding each parameter is described in the sections following the table.

Table 7-7 Parameters for changeSwapSubscriptionDevice Action

Name Value Data Type Req

receiverToRemove

PhysicalDeviceType

Y/N

subscriptionCardToRemove

PhysicalDeviceType

Y/N

receiverToAdd

PhysicalDeviceType

Y/N

subscriptionCardToAdd

PhysicalDeviceType

Y/N

featureHD

Boolean

N

featureDVR

Boolean

N

subscriptionVideo[]

MediaStreamType

Y

channelMapId

String

N


receiverToRemove, subscriptionCardToRemove

These parameters specify the subscription block configuration items that are to be unassigned from an existing video service, and one or the other is required.

In the request, you specify the parameter name and corresponding parameter value as a PhysicalDeviceType structure. The structure defines the physical device configuration item that is to be unassigned and the matching subscription block that gets marked as removed.

receiverToAdd, subscriptionCardToAdd

These parameters define configuration items that are used to establish the cable service. One or the other is required, or both may be provided.The Video Service Configuration specification defines several configuration items, including Receiver and Subscription Card. Physical devices are assigned to these configuration items. The physical devices are based on the Programmable Video Receiver and Video Subscription Card Physical Device specifications.

In the request, you specify the parameter name and corresponding parameter value as a PhysicalDeviceType structure. In the structure, you specify a physical device. If the specified physical device is found, it is assigned to the configuration item. If the specified physical device is not found, it is created based on the Physical Device specification supplied in the PhysicalDeviceType structure. If the name of the receiver or card is not provided, the name defaults to the concatenation of the modelNumber and physicalAddress attributes specified in the PhysicalDeviceType structure. The new physical device is then assigned to the configuration item.

featureHD, featureDVR

These parameters define configuration items that are used to establish the cable service. The Video Service Configuration specification defines several configuration items, including HD Enabled and DVR Enabled.

In the request, you specify the parameter name and corresponding parameter value as a Boolean, which determines whether or not the configuration item indicated by the parameter name is added. For example, if the boolean is true, the configure item is added, and if the boolean is false, the configuration item is not added. The default value is false.

channelMapId

This parameter defines a configuration item that describes the subscription channel map for this subscription on the video service. The Video Service Configuration specification defines several configuration items, including Subscription Channel Map. This configuration item is defined as a characteristic.

In the request, you specify the parameter name and corresponding parameter value as a String, which defines the value of the characteristic cited by the parameter name.

If channelMapId is not specified, it is not added to the subscription block within the video service.

subscriptionVideo

This parameter defines a configuration item that is used to support the cable service, and a minimum of one is required. The Video Service Configuration specification defines several configuration items, including Video Stream. A media stream is assigned to this configuration item, which is a Subscription Video specification.

In the request, you specify the parameter name and corresponding parameter value as a MediaStreamType structure. In the structure, you specify a media stream. If the specified media stream is found, it is assigned to the configuration item. If the specified media stream is not found, an error is thrown.

The request can specify multiple subscriptionVideo parameters.

changeUnsubscribeAll

The changeUnsubscribeAll action unassigns all devices and video streams. It also marks all subscription blocks with "<Removed>", leaving the headend profile contents unchanged. When the next service configuration is created, these subscription blocks are removed. This action also unsubscribes the party or subscriber associated to the video service.

The changeUnsubscribeAll action defines no parameters. For this action, you provide the interaction and item data, but for the service data, the only information needed to unsubscribe the service is the service id. The service id is defined within the service structure of the request, so parameters are needed.

About the Cable TV Test XML

The Cable TV Technology Pack contains test XML files that provide cable-specific examples of Service Fulfillment Web service requests. The XML files are located within the technology pack, within the ZIP file, within the test/WebServiceRequestXML directory.