Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddentrue

Learn to work with Conax Contego Web Services

Panel
nameblue

On this page

Table of Contents
maxLevel2

Overview

Conax Contego is a TV platform that streams content to Digital Video Broadcasting (DVB), Internet Protocol Television (IPTV) and Over the Top (OTT) based subscriptions.

CRM.COM provides a ready-made implementation of Conax Contego Web Services

...

Panel

Conax Contego Web Services - The Basics

Child pages (Children Display)
alltrue
styleh4
pageConax Contego Web Services - The Basics
excerpttrue

Panel

Conax Contego Web Services - The Advanced

Child pages (Children Display)
alltrue
styleh4
pageConax Contego Web Services - The Advanced
excerpttrue

...

Conax Contego Web Services - The Admin Stuff

...

Protocol, using the Conax Contego Web Services Provisioning module, which is primarily responsible for handling the activation and deactivation of signals transmitted to devices.

Major features

  • Integration to Conax Contego 7.5 Web Services.
  • Activation and deactivation of subscriptions is handled at real-time.
  • Option to manage subscriptions out of sync through a batch process or through a utility for a single subscription.
  • Send messages to all subscriber devices which can be displayed on the screen (OSM) or available in the device inbox.
  • Detect piracy by sending a fingerprint to all subscribers, to detect illegal usage or ones that are not abiding by the contract agreement.
  • Usage of utilities to handle one subscription at a time:
    • Synchronize subscription information on the CAS/OTT side (new or deleted services, activate or deactivate services).
    • Send a message to the subscriber device which can be displayed on the screen (OSM) or available in the device inbox.
    • Detect piracy by sending a fingerprint to all subscribers, to detect illegal usage or ones that are not abiding by the contract agreement.
    • Get information of how the subscription is on the CAS/OTT side, such as the device serial number, the services/channels that are activated etc.
    • Pair or un-pair devices such as a decoder and a smartcard.
    • Reset PIN on subscriber's device.

Using Conax Contego Web Services

  • Conax Contego Web Services implementation submits requests on Conax Contego system at real-time
    • Subscription actions update subscription provisioning state in CRM.COM and if associated with a change that should be also executed in CONAX,  a request is constructed using Conax commands and sent to Conax.
  • Subscription changes taking place during a downtime of Conax system, or any other communication issues between CRM.COM and Conax, a reset run is available that can identify all subscriptions that require update, construct a request using Conax commands and send to Conax.

Setting Up Conax Contego Web Services

Info
iconfalse

Billing > Provisioning > Conax Contego Web Services > Set Up Provisioning Provider

Provisioning Provider

Include Page
Provisioning Provider
Provisioning Provider

Related configuration areas

Include Page
Provisioning - Related Configuration Areas
Provisioning - Related Configuration Areas

 

Handling Subscriptions Through Batch Processes

Info

Billing > Provisioning > Conax Contego Web Services

Anchor
reset
reset
Resetting subscriptions out of sync

...

Include Page
Provisioning - Reset Subscription Runs
Provisioning - Reset Subscription Runs

Sending mail & bark messages

...

Include Page
Provisioning - Perform Mail Runs
Provisioning - Perform Mail Runs

The table describes the sections of Mail and Bark Messages Run Definition Data Entry page, and explains how the fields in the page are used.

 Mandatory   Configurable

Main Information
Name & Alternative Code

Input Settings 

Message Type:

  • Mail Message (Maximum number of characters 141)
  • Bark Message (Maximum number of characters 129)
  • Repeating Bark Message (Maximum number of characters 129)

Communication Queue External System: The Communication Queue External System that will be used to identify which 'Pending' communications must be processed by the run.

Start Indication Date Time: Defines the date and time on which the message should be shown to the subscribers.

Duration in Seconds: Defines the duration in seconds for which 'Bark' or 'Repeating Bark' messages will appear in the STB. If not specified, it defaults to '20'.

 

Repetition Count: Defines the number of times that the 'Repeating Bark' message will be displayed. Available for 'Repeating Bark' message type.
Repetition Interval in Second: Defines the time interval between each Repeating Bark Message. Available for 'Repeating Bark' message type
  • Allowed value range: 10-2550
  • Allowed values: 10 seconds increments (e.g. 10, 20, 110, 2540)

 

Sending fingerprinting

...

Include Page
Provisioning - Perform Fingerprinting Runs
Provisioning - Perform Fingerprinting Runs

The table describes the sections of Fingerprinting Run Definition Data Entry page, and explains how the fields in the page are used.

 Mandatory   Configurable

Main Information
Name & Alternative Code

Criteria

Included in Segment: A list of segments which includes the subscribers which will receive the fingerprint

Not included in Segment: A list of segments which includes the subscribers that will not receive the Fingerprint.

Input Settings

Determines the settings that will be used to identify and construct the 'Display Fingerprint' Provisioning Requests

Display Date Time: Defines the date and time that the STB will display the fingerprint. If not specified, then the fingerprint will be displayed immediately.

Display Duration in Seconds: Defines the duration of the fingerprint display. If not specified, it defaults to 10 seconds.

Position (X,Y): Defines the position of the fingerprint, measured in pixels. The X value, defines the horizontal position of the fingerprint, starting from the left side of the video frame. The Y value, defines the vertical position of the fingerprint, stating from the top side of the video frame. If not specified, then the position is set based on the CA system settings.

Height: Defines the height of the fingerprint in pixels. If not specified, it defaults to 12 pixels.

Fingerprint Slot:  Defines the CA client memory slot containing the fingerprint text to be displayed. The available options are: A = Slot A (default) and B = Slot B



 

Handling a Subscription Through a Utility

Info

Billing > Provisioning > Conax Contego Web Services

Utilities used to handle specified subscriptions.

Reset single subscription

...

Include Page
V4MANUAL:Provisioning - Reset Single Subscriptions/Recall Subscription
V4MANUAL:Provisioning - Reset Single Subscriptions/Recall Subscription

 

Get conax information

...

Include Page
Provisioning - Get Provider Information
Provisioning - Get Provider Information

Select the Type of the request and according to the type proceed by providing wither the smartcard or STB. The information retrieved depends on the Type of request, which can be one of the following:

  • Get Active Subscriptions: Retrieves all the services which are 'Active' on that smartcard. The following information is presented to the user:
    • The service CA ID, Code, Description
  • Get Pairing Status for Smartcard: Retrieves all the smartcards and STBs which are paired with the specified smartcard. The following information is presented to the user:
    • Smartcard CA ID, STBs CA ID, serial number, product code , product description
  • Get Pairing Status for STB: Retrieves all the smartcards and STBs which are paired with the specified STB. The following information is presented to the user:
    • Smartcard CA ID, STBs CA ID , serial number, product code , product description ,

Display fingerprinting

...

Include Page
Provisioning - Send Fingerprinting
Provisioning - Send Fingerprinting

Provide the information required by the utility and submit. 

Main Information

Determines the settings that will be used to identify and construct the 'Display Fingerprint' Provisioning Requests

Fingerprint Slot:  Defines the CA client memory slot containing the fingerprint text to be displayed. The available options are: A = Slot A (default) and B = Slot B

Height: Defines the height of the fingerprint in pixels. If not specified, it defaults to 12 pixels.

Smartcard: The smartcard on which the piracy test will be performed

Position (X,Y): Defines the position of the fingerprint, measured in pixels. The X value, defines the horizontal position of the fingerprint, starting from the left side of the video frame. The Y value, defines the vertical position of the fingerprint, stating from the top side of the video frame. If not specified, then the position is set based on the CA system settings.

Display Date Time: Defines the date and time that the STB will display the fingerprint. If not specified, then the fingerprint will be displayed immediately.

Display Duration in Seconds: Defines the duration of the fingerprint display. If not specified, it defaults to 10 seconds.

 

Pair smartcards & STBs

...

Include Page
Provisioning - Pair Smartcards & STBs
Provisioning - Pair Smartcards & STBs

Through the utility the following options are available:

New: If selected, a request of type Create Pairing is created and the smartcard and STB to be paired are specified. If the smartcard is already paired with another STB then it is cancelled.

When 'New' Type is selected then the smartcard on which the additional pairing will be done must be selected as well as the new smartcard and STB to be paired must be defined. On selecting the items the system provides you information associated to their current status and location

Update: If selected, a request of type Add to Existing Pairing is created. The smartcard that identifies the existing pair is specified as well as the smartcard and STB to be added to the pairing. This enables the pairing of multiple Smartcards and STBs.

When 'Update' Type is selected then the smartcard and the STB to be paired must be defined. On selecting the items the system provides you information associated to their current status and location.

 

Reset smartcard PIN

...

Include Page
Provisioning - Reset PIN
Provisioning - Reset PIN

Define the smartcard on which the reset will be performed. If you are resetting to a 'New Value' then you must also provide the new PIN, else the new PIN is reset to '1234'

 

Send mail & bark messages

...

Include Page
Provisioning - Send Mail Messages
Provisioning - Send Mail Messages

Start by selecting the Type of text to be sent and provide the rest of the required information Unlike Message Runs, no Communication is related to messages that are sent through the utility as the text to be included in the message is provided through the utility.

Main Information

Message Type:

  • Mail Message (Maximum number of characters 141)
  • Bark Message (Maximum number of characters 129)
  • Repeating Bark Message (Maximum number of characters 129)

 

Smartcard: The smartcard that should receive the message.

Text: The text which will be sent through the message

Start Indication Date Time: Defines the date and time on which the message should be shown to the subscribers.

 

Repetition Count: Defines the number of times that the 'Repeating Bark' message will be displayed. Available for 'Repeating Bark' message type.
Repetition Interval in Second: Defines the time interval between each Repeating Bark Message. Available for 'Repeating Bark' message type 
  • Allowed value range: 10-2550
  • Allowed values: 10 seconds increments (e.g. 10, 20, 110, 2540)
Display Duration in Seconds: Defines the duration in seconds for which 'Bark' or 'Repeating Bark' messages will appear in the STB. If not specified, it defaults to '20'.



Anchor
commands
commands
Conax Command Mapping

...

The table below displays the CRM.COM processes and actions that trigger each Conax command (a request) as well as the parameters sent for each request.

Conax Contego WEB Services Command

UsageTriggered by

Command Parameters

ADD_SUBSCRIPTIONS

Activates subscription services


CRM.COM Subscription Actions
  • Become subscriber

  • Activate subscription

  • Change subscription distribution (services added to new distributor)

  • End short term deactivation

  • Short term activation

  • End subscription resting

CRM.COM Service Actions

  • Swap installed item (to add new services)

  • Start service

  • Regret (Swap)

  • Swap service

  • Add service

  • The subscription provisioning distributor linked with The subscription service
  • The subscription service CA ID
  • The related smartcard CA ID
CANCEL_SUBSCRIPTIONS

Deactivates subscription services

Conax Contego Web APIs

CRM.COM Subscription Actions

  • Deactivate subscription
  • Terminate subscription
  • Rest subscription
  • End short term activation
  • Short term deactivation

CRM.COM Service Actions

  • Swap service
  • Regret (Swap)
  • Remove service
  • Stop service
  • Swap installed item (to cancel services)
  • Change subscription distribution (services and installed items removed from old distributor)

CRM.COM Installed Item Actions

  • Remove installed item
  • Swap installed item (to remove old)
  • The subscription provisioning distributor linked with The subscription service
  • The subscription service CA ID
  • The related smartcard CA ID
CREATE_PAIRINGPairs smartcards and STBs

Conax Contego Web APIs

Pair Smartcards & STBs utility

CRM.COM Subscription Actions

  • Become subscriber

  • Activate subscription

  • Change subscription distribution (services added to new distributor)

  • End short term deactivation

  • Short term activation

  • End subscription resting

  • Change subscription distribution (new item added to new distributor / old item removed from old)

CRM.COM Installed Item Actions

  • Add installed item
  • Swap installed item (to add new)

 

  • One or more of the following:
    • The subscription provisioning distributor linked with the smartcard (if applicable)
    • The related smartcard CA ID
  • One or more of the following:
    • The subscription provisioning distributor linked with the STB 
      (if applicable)
    • The related STB CA ID
ADD_TO_EXISTING_PAIRINGAdds a new STB to an existing pair of smartcard and STB.

Conax Contego Web APIs

Pair Smartcards & STBs utility

  • The subscription provisioning distributor linked with the smartcard which is already paired (if applicable)
  • The related smartcard CA ID which is already paired
    • One or more of the following:
      • The subscription provisioning distributor linked with the smartcard to be added in the pairing (if applicable)
      • The related smartcard CA ID to be added in the pairing
    • One or more of the following:
      • The subscription provisioning distributor linked with the STB to be added in the pairing  (if applicable)
      • The related STB CA ID to be added in the pairing
GET_ACTIVE_SUBSCRIPTIONSProvides a list of the active Subscription services in Conax Contego

Conax Information utility

  • The subscription provisioning distributor linked with the smartcard (if applicable)
  • The related smartcard CA ID
GET_PAIRING_STATUS_FOR_CARDGets the pairing status of a card. i.e. whether it is paired with a Set-Top Box.

Pair Smartcards & STBs utility

  • The subscription provisioning distributor linked with the smartcard (if applicable)
  • The related smartcard CA ID
GET_PAIRING_STATUS_FOR_PAIRING_MODULEGets the pairing status of a Set-Top Box.
i.e. whether it is paired with a Set-Top Box.
Pair Smartcards & STBs utility
  • The subscription provisioning distributor linked with the STB 
    (if applicable)
  • The related STB CA ID
SEND_MAIL_MESSAGE_TO_CLIENTSends a normal Mail Message to the customer's device, available in the inbox.

Mail & Bark Messages utility

Mail & Bark Message run

  • The subscription provisioning distributor linked with the smartcard (if applicable)
  • The related smartcard CA ID
  • The message that is sent to the subscriber
  • The start indication date time
  • The communication queue number that was processed by this Provisioning Request (if applicable)
SEND_BARK_MESSAGE_TO_CLIENTSends a Bark Message to the customer's device, available on the screen.

Mail & Bark Messages utility

Mail & Bark Message run

  • The subscription provisioning distributor linked with the smartcard (if applicable)
  • The related smartcard CA ID
  • The message that is sent to the subscriber
  • The start indication date time
  • The display duration in seconds
  • The communication queue number that was processed by this Provisioning Request (if applicable)
SEND_REPEATING_BARK_MESSAGE_TO_CLIENTSends a Bark Message to the customer's device, repeatedly, available on the screen.

Mail & Bark Messages utility

Mail & Bark Message run

  • The subscription provisioning distributor linked with the smartcard (if applicable)
  • The related smartcard CA ID
  • The message that is sent to the subscriber
  • The start indication date time
  • The display duration in seconds
  • The repetition count
  • The repetition interval in seconds
  • The Communication Queue Number that was processed by this Provisioning Request (if applicable).

DISPLAY_FINGERPRINT

Check subscriber's devices for piracy

Fingerprinting utility

Fingerprinting run

  • The subscription provisioning distributor linked with the smartcard (if applicable)
  • The related smartcard CA ID
  • The display date time
  • The display duration in seconds
  • The position (X,Y)
  • The Height
  • The Fingerprint Slot
UPDATE_CA_PIN_TO_DEFAULT_VALUEUpdates the CA PIN of a subscriber's device to the default value.

Conax Contego Web APIs

Reset smartcard PIN utility

  • The subscription provisioning distributor linked with the smartcard (if applicable)
  • The related smartcard CA ID 
UPDATE_CA_PIN_TO_GIVEN_VALUEUpdates the CA PIN of a subscriber's device to a value provided by the agent.

Conax Contego Web APIs

Reset smartcard PIN utility

  • The subscription provisioning distributor linked with the smartcard (if applicable) 
  • The related smartcard CA ID  
  • The new Pin Value

 

Conax Contego Web Services Business Examples

Subscription with multiple viewing points 

Panel
nameblue
titleConax Web Services Provisioning Distributors

Scenario 1

Company ZX offers to its customer's the option to have multiple viewing points per subscription. This enables its customers to have a separate box and card in each of the rooms, and choose between having the same channels or different channels available through boxes . The maximum number of viewing points that can be added to a subscription is 4.


Solution

For each set of box and card that will be made available to subscribers, CRM.COM must have a different provisioning distributor available, in order to set the channel availability and restrictions per box.

In order to support this, the following distributors must be set up in the Provisioning Provider.

  • Main
  • TWIN1
  • TWIN2
  • TWIN3

 

Provisioning of flexible and fixed bundle products

Panel
nameblue
titleHandling of Flexible and Fixed Bundle Products

Scenario 2

Company ZX offers its customers, flexible and fixed bundle products as well as single channels . Subscribers can request to switch between the available product offerings at any time. It is required that the agents can view the requests that are being sent, to ensure that the signals are provisioned to the customers.

 


Solution

Consider the following provisioning mapping:

  • Components of Flexible Bundle A
    • Geological CA ID = GFA1
    • Entertain CA ID = EFA2
  • Components of Flexible Bundle B
    • Religion CA ID = RFB1
    • Baby Channel CA ID = BFB2
  • Flat Products
    • Agriculture CA ID = AF1


Example 1: Provisioning of a Flexible Bundle

On provisioning a Flexible Bundle A, having Geological and Entertain, the following requests will be sent:

  • 1 Create Pairing (Smartcard and Decoder)
  • 2 Add Subscriptions ( Gold and Silver)
    • CA ID=GFA1 which represents the Geological channel
    • CA ID=PFA2 which represents the Entertain channel


Example 2: On swapping from Flexible Bundle to a flat product

On swapping Flexible Bundle A, to Agriculture the following requests will be sent:

  • 1 Add Subscription  
    • CA ID = AF1 which represents the Flat product channel
  • 2 Cancel Subscriptions
    • CA ID=GFA1 which represents the Geological channel
    • CA ID=PFA2 which represents the Entertain channel

Example 3: On upgrading the Flexible Bundle A to Flexible Bundle B with Geological and Religion

On upgrading from one Flexible Bundle to the other the following Requests will be sent:

  • 2 Add Subscription
    • CA ID = RFB1 which represents the Religion channel
    • CA ID = BFB2 which represents the Baby Channel
  • 2 Cancel Subscriptions
    • CA ID=GFA1 which represents the Geological channel
    • CA ID=EFA2 which represents the Entertain channel

Send mail messages to subscriber's box

Panel
nameblue
titleConax Web Services 'Mail & Bark Messages' Utility

Scenario 3

Company ZX would like to send personalised messages to its subscribers, that will be directly accessible via their Set-Top Boxes (STBs). Specifically, it wants to be able to send:

  1. Messages that can be accessed via the subscriber's STB inbox.
  2. Messages that are shown on the subscriber's TV.


Solution

Agents should use the "Mail & Bark Messages Utility" and the appropriate type for each of the above method of communication. The agents should type the message that they would like to send to the subscriber.

Messages that can be accessed via their STB inbox

Mail Message

Messages that are shown on their TV

Bark Message
Note
titleNotes
  • Use the WEB API to create and manage Conax Contego Web Services from an external system, such as a customer portal. Refer to the Conax Contego Web Services WEB API for a comprehensive list of available actions.

 

 

Panel
namegrey

Related Links

Filter by label (Content by label)
showLabelsfalse
spacesV4Manual
showSpacefalse
labelsglobal