Skip to end of banner
Go to start of banner

Conax Contego SMS Services

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

On this page

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 SMS Services Protocol, using the Conax Contego SMS Services Provisioning module, which is primarily responsible for handling the activation and deactivation of signals transmitted to devices.  The module can also be used to send messages to the subscriber devices. 

Major features

  • Integration to Conax Contego 2.0 SMS 
  • Activation and deactivation of multiple subscriptions simultaneously
  • Errors are logged and can be reviewed within the CRM.COM Software.
  • Sending of messages to multiple subscribers simultaneously
  • Requests not submitted to Conax, can be reviewed through an error file while taking the necessary actions to update CRM.COM accordingly
  • Usage of utilities to handle one subscription at a time to pair devices or send messages
  • Option to archive old provisioning requests. For more information refer to Utilities

Using Conax Contego SMS Services

  • Conax Contego SMS Services implementation submits requests on Conax Contego system asynchronously using FTP.
    • Subscription actions update subscription provisioning state.
    • Provisioning Requests run identifies all subscriptions whose provisioning state must be updated in CONAX Contego system and creates 'Pending' requests
    • 'Pending' requests coming from CRM.COM are grouped together into a file which is then transferred through FTP in order to be processed. 
  • Conax provides 'Accepted' and 'Rejected' requests to CRM.COM through 'Error Handling' runs and CRM.COM subscriptions are updated accordingly.

 

Setting Up Conax Contego SMS Services

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

Provisioning Provider

In the Provisioning Provider you can provide the parameters necessary to access the CA/OTT platform and map the CRM.COM services and physical goods to be provisioned. 

Provider fields

The table describes the sections of Provisioning Provider Data Entry page, and explains how the fields in the page are used.

 Mandatory   Configurable

Main Information
Povider Information

Name and Alternative Code of the provider

Provisioning Protocol: The protocol of the provider you would like to set up and use.

Life Cycle State: A 'Not Effective', state denotes that commands will not be sent to the CA/OTT platform.

Connection Parameters

End Point: The endpoint used for communicating with provisioning provider

User Name & Password: Credentials used to login to the

Character Set Encoding: The encoding that will be used by the Web Services. It defaults to UTF-8 if not specified

Operations Parameters

Maximum Number Of Records in Each File: The maximum number of client IDs that can be included in each file, which cannot exceed 20000 (the default value set automatically if no other value is specified).

Renewal Frequency in Months: A subscription sent to CONAX SMS always has an end date (calculated using the Add Subscription End Period in Months).
To ensure that a subscription will not be deactivated once the end date is reached a 'Renewal request' must be sent.
Define how often the renewal of each subscription should be handled. It defaults to '1' and cannot exceed '35'.

Add Subscription End Period in Months: The period to calculate the end date of a subscription service when a request is sent to activate it. If not specified, it defaults to '1' and it cannot exceed '36'.

Cancel Subscription End Period in Months: The period to calculate the end date of the deactivation. months used to set the Cancel Subscription End Date. If not specified, it defaults to '1' and it cannot exceed '36'.

Renew Subscription End Period in months: The period to calculate the subscription's end date once the 'Renewal request' is sent. If not specified, it defaults to '1' and it cannot exceed '36'.

Distributors

Distributors are used to relate services and devices (installed items) of a subscription to the provisioning provider. Multiple distributors on a subscription represent multiple viewing points with same or different services available from each device. For example, in a pay-tv subscription, two distributors can represent

  • the decoder and channels available in a household's living room
  • the decoder and channels available in the bedroom

Create the distributors which can be provisioned through the provider. At least one provisioning distributor is required for a provider to be 'Effective'. 

ADD a new distributor and provide the related information in the modal

Main Information

Name & Alternative Code for the provisioning distributor.

Allowed Services

Defines a list of services which can be distributed by the distributor. This is used as a filter once the distributor is selected when adding subscription services to a subscription.

Two options are supported:

  • All Provisioned Services: If this option is selected, then all the services provisioned by the provider can be distributed by the distributor.
  • Specific Provisioned Services: If this option is selected, then only the services included in the list will be allowed to be distributed by the distributor. 

The services that can be added are filtered and validated against the services that can be provisioned by the related provisioning, defined in the Services section.

Restrictions

Minimum and Maximum optional and mandatory service restrictions control the number of services that can be added to the distributor.

Restrictions Per Service Type: Define minimum and maximum number of services allowed to be added to the distributor, from specific service types

Restrictions Per Physical Good Type: Define minimum and maximum number of installed items allowed to be added to the distributor, from specific physical good types

Dependencies

Service dependencies define services, service types, physical goods or physical good types that must be added to the distributor, if enabled.

 

Services

At least one service mapping is needed for an 'Effective' Provider.

Service: Termed and usage services that can be provisioned by the provider.

CA ID: The unique ID that identifies the service at the CA/OTT platform

If the service added is a non-provisioning service (i.e. Product Type is not set as "Used for Provisioning") then the ID is not mandatory.


Physical Goods

A list of devices which are required for provisioning through the provider. For example, a decoder and a smartcard, or just a decoder, or a modem. Depending on the provider you are setting up specific device type may be mandatory.

When communicating a device to the CA/OTT platform its ID is represented by the Installed Item Alternative Code

 

Back to top

Related configuration areas

Mandatory modules must be configured for the provisioning module to work.

Manual LinkArea DescriptionConfiguration
Products
  • Physical Good Types
  • Service Types
  • Physical Goods
  • Services

Configure the physical good and service types, and the physical goods and services that will be offered to subscriptions, by adding them to the provisioning provider.

 Mandatory
CommunicationsCommunication Queue External SystemSet up the external system that will be used to handle mail messages created for the provider.Optional

Back to top 

Handling Subscriptions Through Batch Processes

Billing > Provisioning > Conax Contego SMS Services

Processing provisioning requests


Provisioning request runs are used to create and submit new provisioning requests when a modification to a subscription affects its activation status.  When the process is executed, the system searches for subscriptions that meet the following criteria and sends the respective requests to the CA/OTT platform (so that the services, hardware and status of the subscriptions match on the two systems):

  • Subscriptions have services that should be activated ('Active' in CRM and 'Inactive' in CA/OTT platform).
  • Subscriptions have services that should be deactivated ('Inactive' in CRM and 'Active' in CA/OTT platform).
  • Subscriptions have a set of installed items that are defined in CRM and not in CA/OTT platform.

The process also gathers and submits to the CA/OTT platform all requests that are pending in CRM.COM, which were created by one of the following (if supported by the provisioning provider):

  • Web APIs
  • Provisioning provider utilities that are not set to be executed immediately.
  • Batch processes, such as mail runs or fingerprint runs, that are not set to be executed immediately.

Provisioning request runs are created when a provisioning request process run definition is submitted. 

Back to top 

Handling rejected requests 


Once the provisioning processing run is executed, the respective provisioning requests sent to Conax through FTP, remain in a 'Pending' life cycle state.  Once Conax is updated it creates the responses for CRM.COM (i.e. such as reports on whether requests have been rejected or have failed). 
CRM.COM is then synchronized to Conax Contego based on these responses which are handled by Error Handling Files Runs reverting changes done to subscriptions in case of an error in Conax.

Error Handling file runs are created through the 'error handling run definition' once submitted.

 

Sending mail & bark messages


Mail runs are used to send messages to subscriber devices.  The messages can be displayed in the set-top box (STB) mailbox or directly on the screen (once or repeatedly).

Messages can be scheduled to appear as soon as they are sent or at a specific time.

The process run does not create the messages; the messages are created in the system as communications (through notifications) and remain 'Pending' in the communication queue until the mail run is executed.  The mail run identifies the communications that should be handled by matching each entry in the communication queue 'Communication Queue External System' with one defined in the mail run.

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: The type of the message that will be sent, which can be 'Mail Message' or 'Bark Message'

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

Sequence: The sequence that should be used to send the message. This is the order by which the messages will be handled by Conax. 
If not specified, then the System defaults to '255'.

Duration in Seconds: Defines the duration in seconds for which bark messages appear on the subscriber's screen. If not specified, then the system defaults to '20'.

Process Immediately: Determines if the request will be sent directly to Conax or created and processed subsequently by the provisioning request processing run

Back to top 

Handling a subscription through a utility

Billing > Provisioning > Conax Contego SMS Services

Utilities are used to handle one subscription at a time.

Pair Smartcards & STBs


Pairs a smartcard with an STB (New) or add a single STB to an existing pairing (Update).

Specify the smartcard and the STB which should be paired. If the selected smartcard or the STB are already paired then the existing paired device is automatically loaded. Select 'Express' Priority if you need the pairing to be handled by Conax as soon as possible.

If the request is successful then each 'item subscription provisioning distribution' is updated by setting the 'Item is initialized' to 1

 

Back to top 

Send mail & bark messages


Sends on-screen or inbox messages to a subscriber device.

Start by selecting the Type of message 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: The type of the message that will be sent, which can be 'Mail Message' or 'Bark Message'

Smartcard: The smartcard that should receive the message.

Text: The text which will be sent through the message

Sequence: Defines the sequence that should be used to send the message. If not specified then the system Defaults to '255'.

Display Duration in Seconds: Defines the duration in seconds for which bark messages will appear in the STB. If not specified, then the system defaults to '20'.

Back to top 

Conax Contego SMS Services Command Mapping


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

Activation and deactivation commands are not directly triggered by the execution of Subscription Actions.  Once the Provisioning Request Processing Run Definition is executed, the system is checked against the logic available under the Trigger Logic column, and the respective Conax Contego command is created, provided the necessary conditions are met. 

Command

Usage
Triggered by
Trigger Logic
Command Parameters
Add Subscription

Activates subscription services

Has at least one 'Effective' or 'Short Term Effective' subscription service, which is not authorized1.

  • The subscription provisioning distributor linked with the subscription service
  • The subscription service CA ID
  • The smartcard  CA ID
Cancel Subscription

Deactivates subscription services

Has at least one 'Not Effective', 'Regretted', 'Swapped', 'Removed', 'Cancelled', 'In Resting' or 'Short Term Not Effective' subscription service, which is authorized1.

  • The subscription provisioning distributor linked with the subscription service
  • The subscription service CA ID
  • The smartcard CA ID
Renew Subscription

Renews subscription services

Has at least one 'Effective' or 'Short Term Effective' subscription service, which is authorized1.

The subscription provisioning distributor's authorization date AND the 'Renewal Frequency' defined in the Provider's configuration is less than or equal to the current date.

  • The subscription provisioning distributor linked with the smartcard (if applicable)
  • The smartcard and STB CA ID
  • The subscription provisioning distributor linked with the STB (if applicable)

Create PairingPairs Smartcards and STBs
  • Has at least one 'Effective' or 'Short Term Effective' subscription service distributed to at least one smartcard or STB which is not initialized2.
  • The subscription provisioning distributor linked with the smartcard (if applicable)
  • The smartcard and STB CA ID
  • The subscription provisioning distributor linked with the STB (if applicable)

Send Message

Send messages to subscribers
  • Mail & Bark message utility
  • Mail & Bark message run
  • Provisioning request processing run

For requests through the mail & bark definition

    • Entries exist in the communication queue in a 'Pending' life cycle state.
    • External system of the provider is equal to the External System specified on the Mail & Bark Message Run Definition.
    • The related communication is classified as 'Outgoing'.
    • The related communication refers to a subscription or notification having the subscription in the notification Information.
  • The subscription provisioning distributor linked with the smartcard  
  • Smartcard CA ID
  • Text that will be sent to the subscriber
  • Type of Message which can be 'Mail' or 'Bark'
  • Communication queue number processed by the provisioning request (if applicable)
  • Sequence that should be used to send the message. This is the order by which the messages will be handled by Conax. 
  • The duration in seconds that the Bark message will be shown on the subscriber's screen.

1. 'Authorized' is a field kept in CRM.COM for every subscription service which represents its state at the provider.

  • authorized = active (1)
  • not authorized = inactive (0)

2. 'Initialized' is a field kept in CRM.COM for every installed item which represents its state at the provider.

  • initialized= registered (1)
  • not initialized= not registered (0)


Back to top
 

Conax Contego SMS Services Business Examples

Subscription with multiple viewing points 

Provisioning Distributors

Scenario 1

Company ZX offers to its customers 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.

To support this, the following distributors must be set up in the Provisioning Provider.

  • Main
  • TWIN1
  • TWIN2
  • TWIN3

Back to top 

Send mail messages to subscriber's box

Conax Web Services 'Mail & Bark Messages' Utility

Scenario 2

Company ZX would like to send personalized 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

Notes

  • Use the WEB API to create and manage Conax Contego SMS Services provisioning requests from an external system. Refer to the  Conax Contego SMS Services WEB API for a comprehensive list of available actions.

 

Glossary

CRM.COM TermDefinition
CAStands for Conditional Access (system), which in this case is Conax Contego.
Mail MessageA message sent by the provider to the customer, that appears in the Set-Top Box (STB) mailbox, either when received or at a specific time.
Bark MessageA message sent by the provider to the customer, that appears directly on the screen, either when received or at a specific time.
DVBStands for Digital Video Broadcasting and is a suite of internationally accepted open standards for digital television.
IPTVInternet Protocol Television delivers television content using the internet Protocol, instead of the traditional terrestrial satellite signal.
OTTStands for Over The Top and is media content, such as audio or video, which is delivered over the internet with no intervention from the service Provider.
FTPStands for File Transfer Protocol.
Provisioning State

The provisioning state of a Subscription service (i.e. a channel) that can be either 'Active' or 'Inactive'.

  • 'Active' State: Provisioning signals are sent to the subscriber's device.
  • 'Inactive' State: No Provisioning signals are sent to the subscriber's device.
Service CA ID or Provisioning IDThe ID that is used in Conax Contego to identify The subscription service for which signals should be sent to the subscriber's device.
  • No labels