Back to Getting Started Guides for CRM.COM
Table of Contents
Getting Started
Are you in the OTT-based Subscriptions business? This is a good starting point. All you need to do is go through this Getting Started guide to find out how you can quickly set up CRM.COM software to support your OTT business. This Guide focused on Setting up the System for using OTT Services.
Before you start with OTT-related configurations, view Getting Started with CRM.COM to complete the basic System configurations regardless of your line of business. Additional Guides on Pricing, Rewards and managing Subscriptions can be found in the related Getting Started User Guides.
- /wiki/spaces/WIP/pages/10008366
- /wiki/spaces/WIP/pages/10008363
- /wiki/spaces/WIP/pages/10008364
- /wiki/spaces/WIP/pages/10008365
Note that the System must also be configured to support Subscription Management. Choose between /wiki/spaces/WIP/pages/10008366 used for Subscriptions following a Normal Billing method and /wiki/spaces/WIP/pages/10008363 used for Subscriptions following a Prepaid Billing method.
What you need to get started
In this Getting Started Guide you will discover the following modules, which are required for Setting up and supporting an OTT business model:
- Products
Set up all the Products your company provides to customers, whether these are Services or hardware. - Provisioning Provider
Set up the Provisioning Provider that represents the Conditional Access System or Video Platform you cooperate with, responsible for handling the streaming of signals to the subscriber devices. - Usage Service Catalogs
Set up your Usage Service Catalogs, and add all the Usage Services (Pay Per View (PPV) and Video on Demand (VOD) events), along with the pricing and airtime for each. - Usage Detail Records
Set up Usage detail Records (UDRs) used to keep information about ordered Usage Services.
We have divided each module's configuration tasks into two Classifications: Fast Track and Complete Configuration.
- Fast Track: To set up CRM.COM with the necessary basic functionality to get started, configure the sub-modules that are marked by the Fast Track icon.
- Complete Configuration: To get the most out of CRM.COM configure all the sub-modules, marked by the Fast Track and Complete Configuration icons.
Configuration Type determines whether the module is found under an Application or Configuration Section.
Setting up Products
Products are Physical Goods or Services used by business transactions within the System. Services represent any intangible commodity which is provided to customers, such as telephony, TV channels, repairs, installations or deliveries. Physical Goods represent any tangible commodity which is provided/sold to customers, such as cameras, decoders or magazines.
What Comes First
To start using Products, configure the System to support your business model. In the following table, find the configuration modules related to Products.
Sub-module | Type | Classification | Navigation | Dig In |
---|---|---|---|---|
Product Types | Configuration | CONFIGURATIONFOUNDATION APPLICATIONPRODUCTSPRODUCT TYPES | Products | |
Products | Application | FOUNDATIONPRODUCTSMANAGE PRODUCTS | Products | |
Product Families | Configuration | CONFIGURATIONFOUNDATION APPLICATIONPRODUCTSSET UP FAMILIES | Products | |
Product Brands | Configuration | CONFIGURATIONFOUNDATION APPLICATIONPRODUCTSSET UP BRANDS | Products | |
Product Categories | Configuration | CONFIGURATIONFOUNDATION APPLICATIONPRODUCTSSET UP CATEGORIES | Products |
Step 1: Setting up Product Types
Start by configuring the Product Types which will be used as your base for creating the various types of Products.
Product Types are used to define and implement the behaviour of Products. Product Types are used when Products are created or modified. Products can have only one Type, through which you can distinguish between the following:
- Classification: Whether the Product is a Service (intangible commodity such as a TV channel or movie) or a Physical Good (tangible commodity such as a Smartcard, modem or decoder).
- Service Type: Available only if the Product Type is classified as a Service, and determines whether it is a One Time Service, a Usage Service, a Termed Service or an Expense. One Time Services and Expenses are provided just once and are billed just once; e.g. an installation Service.
Termed Services are provided continuously and billed on a recurring basis, regardless of their usage; e.g. a recurring Pay TV Service which includes specific channels.
Usage Services are provided upon customer request and are billed based on their usage; e.g. a Pay Per View movie or Telephony Calls. - Physical Good Type: Available only if the Product Type is classified as a Physical Good, and determines whether the Physical Good is Traceable or Non-Traceable.
Traceable Physical Goods can be traced through a unique identifier which is usually a serial number; e.g. a decoder with a unique serial number.
Non-traceable Physical Goods are not traced to a single instance and are measured based on their quantity; e.g. 10 meters of cable. - Composition: Determines whether the Product is a Flat, Flexible Bundle or Fixed Bundle Product.
- Flexible Bundle Products are available if the Classification is defined as Termed Service.
- Fixed Bundle Products are available if the Classification is defined as Termed Service or Physical Good.
- Used for Provisioning: Determines whether Products of that Type are used for provisioning purposes by third-party providers.
Step 2: Creating your Product
Once the Product Types are defined, you can start creating your Products (Steps below referring to the additional configuration can be omitted).
Physical Goods and Services can be created through CRM.COM Products Module.
- Specify the Type of each Product and provide a Product Code, Alternative Code and Description.
- Specify the VAT rate that should be applied on each of your Services or Physical Goods.
- Define the price rates and the Price Plans that the Product will be available from.
- Define the component restrictions and rules of Flexible or Fixed Bundle Products (Bundle Products are made up of multiple other component Products).
- Use the Brand, Family and Categories to group your Products and apply specific business rules and restrictions.
Step 3: Setting up Product Brands, Categories, Families
Configure the following modules for additional functionality and categorisation
- Product Families are groups of Products derived from a common Product platform, using similar or identical Production processes and having similar physical or behavioural characteristics. Product Families in CRM.COM follow a hierarchical tree structure.
- Product Brands are used to define trademarks or distinctive names that identify a specific Product or Product line.
- Product Categories are used to classify Products into generic groups based on common attributes. Categories are configurable in the System (there can be hundreds). Categories follow a hierarchical tree structure.
Do it Yourself!!
Let's see how you can quickly set up the System to start using the Products module.
No configuration is necessary for the modules, sections and attributes not mentioned below.
Create the following Product Types
Product Types | Classification | Physical Good Types | Service Type | Composition Method | Used For Provisioning |
---|---|---|---|---|---|
Usage Services | Service | Usage | Flat | Yes | |
Termed Services | Service | Termed | Flat | Yes | |
Smartcards | Physical Good | Traceable | Flat | Yes | |
Decoders | Physical Good | Traceable | Flat | Yes | |
Non-Traceable | Physical Good | Non-Traceable | Flat | No | |
One Time Service | Service | One Time | Flat | No | |
Expenses | Service | Expense | Flat | No |
Create Products
Product | Type | VAT Rate | Information |
---|---|---|---|
Gold | Termed Services | 10% | This is a main Service (mandatory to be added on a Subscription). |
Eurosport 1 | Termed Services | 10% | This is an additional Service (optional to be added on a Subscription). |
PPV Movies | Termed Services | 10% | This Service will be used to authorise the usage of addition of PPV movies on the Subscription. |
Braveheart | Usage Service | 10% | You must create one Product per PPV movie you would like to make available. Usage Services are not added in Price Plans but in Usage Service Catalogs. |
Serendipity | Usage Service | 10% | You must create one Product per PPV movie you would like to make available. |
Limitless | Usage Service | 10% | You must create one Product per PPV movie you would like to make available. |
Samsung Smartcard | Smartcards | 10% | Create the different Smartcards that you provide to your subscribers. |
Thomson Decoder | Decoders | 10% | Create the different Decoders that you provide to your subscribers. |
Thomson Remote Control | Non-Traceable | 0% | Create the remote control Products provided with the Decoders. |
Antenna | Non-Traceable | 10% | Create the antenna products. |
Start Up Fee | Expenses | 10% | Create the Start Up fee charged on creating a new Subscription. |
Repairs | One Time Service | 10% | Create the Repairs product used for charging for repairs based on duration. |
Installation Service Fee | One Time Service | 10% | Create the Installation Service Fee used for charging for installation based on duration. |
Setting up Provisioning Provider
Provisioning is used for a full integration with Conditional Access (CA) and OTT (Over The Top) platforms. It is used to retrieve and manage the provisioning adapters that were developed to integrate with third party CA systems and OTT systems.
What Comes First
To start using Provisioning Providers configure the System to support your business model. In the following table, you can find the configuration modules related to Provisioning Providers. CRM.COM is integrated with multiple Providers. Choose the one that you cooperate with and set up accordingly.
Sub-module | Type | Classification | Navigation | Dig In |
---|---|---|---|---|
Provider | Application | BILLINGPROVISIONINGPERCEPTIONSET UP PROVISIONING PROVIDER The above link is related to Perception Provider. Select the Provisioning System that you cooperate with and navigate to the respective Provider link, available under: BILLINGPROVISIONING
| The manual is related to Perception Provider. Select the Provisioning System that you cooperate with and refer to the respective Provider manual from Provisioning. | |
Application | BILLINGPROVISIONINGCONAX CONTEGO WEB SERVICESPROCESS PROVISIONING REQUESTS The above link is related to Conax Contego Web Services Provider. Select the Provisioning System that you cooperate with and navigate to the respective Process Run link, available under: BILLINGPROVISIONING | The manual is related to Conax Contego Web Services. Select the Provisioning System that you cooperate with and refer to the respective Provisioning Run manual, if one is available, from Provisioning |
Step 1: Setting up a Provider
The Provisioning Provider module allows you to:
- Configure connection parameters which are needed to access the Provider, such as the endpoint URL, username and password as well as the provisioning protocol.
- Map the Subscription Services which are provisioned by the Provider and set their CA ID.
- Map the Physical Goods which are used by the Provider.
Step 2: Setting up Provisioning Request Run
Provisioning Requests Run Definitions are used to determine the business rules used to identify Subscriptions that must be activated or deactivated, hardware that must be paired, pending messages that must be sent to the Provider, and to create and send the necessary commands to the Provider for that purpose.
Runs are only required for specific Providers that work with Batch Processing Communication.
Do it Yourself!!!
In this example, we have used Nagra Vision SMS Gateway Provider
Let's see how you can quickly set up the System to start using the provisioning module for Nagravision SMSgw.
No configuration is necessary for the modules, sections and attributes not mentioned below.
Create Nagravision SMSGW Provisioning Provider
Provisioning Provider | Provisioning Protocol | Connection Parameters | Encoding | Distributors | Services | Physical Goods |
---|---|---|---|---|---|---|
Nagravision SMSgw | Nagravision SMSgw Services | Request from CRM.COM | UTF-8 | Nagravison SMSGW Main | Add Services which are provisioned by Provider and set their CA ID. | Add the Physical Goods which are provisioned by the Provider: Smartcards and Decoders. |
Provisioning Request Run Definition
Name | Input Settings | Scheduling Settings |
---|---|---|
Daily Pairing | Skip all except:
|
|
Setting up Usage Detail Records
Usage Detail Records (UDRs) hold raw information on the use of Usage Type Subscription Services. Each UDR represents a single occurrence of Service use.
What Comes First
To start using Usage Services configure the System to support your business model. In the following table, you can find the configuration modules related to UDRs required for ordering Usage Services.
Sub-module | Type | Classification | Navigation | Dig In |
---|---|---|---|---|
UDR Types | Configuration | CONFIGURATIONBILLING APPLICATIONBILLINGSET UP UDR TYPE | Configuring UDR Types | |
UDR Usage Method | Configuration | CONFIGURATIONBILLING APPLICATIONBILLINGSET UP UDR USAGE METHODS | Configuring UDR Usage Methods | |
UDR DEVICE | Configuration | CONFIGURATIONBILLING APPLICATIONBILLINGSET UP UDR DEVICES | Configuring UDR Devices | |
UDR Destination Category | Configuration | CONFIGURATIONBILLING APPLICATIONBILLINGSET UP UDR DESTINATION CATEGORIES | Configuring UDR Destination Categories | |
UDR Source Category | Configuration | CONFIGURATIONBILLING APPLICATIONBILLINGSET UP UDR SOURCE CATEGORIES | Configuring UDR Source Categories | |
UDR Source System | Configuration | CONFIGURATIONBILLING APPLICATIONBILLINGSET UP UDR SOURCE SYSTEMS | Configuring UDR Source Systems |
Step 1: Setting up Usage Detail Record Types
Start by configuring the available Usage Detail Record (UDR) Types. UDR Types are used to classify and group UDRs based on their business application. Users must select UDR Types when adding new Usage Services to a Subscription by using the Add Service Usage Action. UDR Types can be used to define restrictions, such as mandatory UDR information for each Type. For example, if the UDR Source Category is defined as 'Mandatory' on the Type, the user must provide an 'Allowed' Source Category when ordering the Usage Service.
UDR Types can also be used as conditions for Tiered Rates in Usage Service Catalogs or Additive Discounts.
To create a UDR Type:
- Define the mandatory information for the UDR Type such as name and alternative code.
- Define which of the other UDR attributes (optional configuration modules) must be considered as mandatory when creating UDRs of this Type.
- Define the formatting to be used when users provide the free-text Source ID and Destination ID fields on UDRs of this Type (e.g. the IDs could be used to represent Telephone numbers, with a specific format and structure).
Step 2: Setting up Usage Detail Record additional configuration modules
Configure the following modules for additional functionality and categorisation:
- UDR Destination Categories: UDR Destination Categories are used to classify the UDR destination that received the Service into generic groups based on specific similar attributes.
- UDR Source Categories: UDR Source Categories are used to classify the UDR source that initiated the Service into generic groups based on specific similar attributes.
- UDR Devices: UDR Devices are used to identify the device on which the UDR will be provisioned.
- UDR Source Systems: UDR Source Systems are used to identify the source system that created each UDR.
- UDR Usage Methods: The usage method that will be used to provision the Usage Service; such as download or rental.
Setting up Usage Service Catalogs
Usage Service Catalogs are used to maintain information related to Usage Services, which are provided upon customer request and charged based on their usage. Information included in Usage Service Catalogs includes the pricing of the Service, the Service provider and their identifier, as well as information related to the validity of the Services. The Over-The-Top (OTT) business model is supported by using Usage Service Catalogs.
What Comes First
To start using Usage Service Catalogs configure the System to support your business model. In the following table, you can find the configuration modules related to Usage Service Catalogs.
Usage Service Catalogs do not have optional configuration modules. However, Usage Detail Records optional configuration modules can be used by the Usage Service Catalogs Definition and Usage Service Catalogs.
A related setting in Billing Term Definitions is provided under the configuration of Usage Service Catalogs, as it is directly related to the Billing of Usage Services ordered through the Usage Service Catalogs.
Sub-module | Type | Classification | Navigation | Dig In |
---|---|---|---|---|
Usage Service Catalogs Definitions | Configuration | CONFIGURATIONBILLING APPLICATIONUSAGE SERVICE CATALOGSSET UP USAGE SERVICE CATALOG DEFINITIONS | Usage Service Catalogs | |
Usage Service Catalogs | Application | BILLINGUSAGE SERVICE CATALOGSMANAGE USAGE SERVICE CATALOGS | Usage Service Catalogs | |
Billing Term Definition | Configuration | CONFIGURATIONBILLING APPLICATIONBILLINGSET UP BILLING TERM SCHEMES | Subscriptions |
Step 1: Setting up Usage Service Catalogs Definitions
First, you must set up the Usage Service Catalog Definitions.
Usage Service Catalogs Definitions are a set of business rules used to control the behaviour of Usage Service Catalogs throughout their Life Cycle.
Through the Definition you can:
- Define the values of related allowed entities.
- Usage Service Types: the Product Types which can be included in Usage Service Catalogs. Only Product Types which are classified as Usage Services can be specified in this section.
- Provisioning Providers: the Providers who can be used for processing the Provisioning Requests.
- Define Default values for Services of specific Types.
Also provide default rates for Service Types in the Definition. These (updatable) rates will be automatically selected when creating new Catalogs using the specific Services.
Step 2: Creating Usage Service Catalogs
With Usage Service Catalog Definitions in place you are ready to start creating your Usage Service Catalogs, through which you can define the following:
- The Provisioning Provider that will be responsible for the provisioning Usage Services defined in the specific Usage Service Catalog.
- The period for which the Catalog will be valid. Multiple periods or always valid can be defined.
- All the Usage Services that should be provided (the services created in the Products module).
For each Service, define the following:- Base Rate: The price of the Service for Billing.
- Provisioning ID: The CA ID required by the Provisioning Provider to identify each Service.
- Start and End Time: the periods for which the Service should be available for ordering.
Tiered Rates: You have the option to provide conditional rates which are different than the specified Base Rate. For example, provide a different rate for the Service if it is used during a specific period or provided via specific devices.
Usage Detail Record configuration modules must be configured to define related conditions for the Tiered Rates.
- Define conditions related to Subscriptions or Accounts Receivable which will determine whether the Usage Service Catalog is available for selection.
Usage Service Catalogs will be filtered (when adding a Service on the Subscription) based on the conditions defined in the Usage Service Catalog.
Step 3: Setting up Billing Term Definition Rules
Billing Term Definition Rules include validations and restrictions that will be used across Billing Terms, regardless of their Scheme. Specifically, through Billing Term Definitions you can define the Billing Rules that should be applied on Usage Services based on a set of conditions. These rules are only applicable for Normal Billing Term Schemes. If the Usage Service is added on a Prepaid Subscription then it is billed immediately after execution of the Action.
Configure the following section according to your requirements.
- Billing Term Definitions - Usage Service Billing Term Rules (For Normal Subscriptions)
- Maximum unbilled amount threshold: Define the maximum rated total amount of all Usage Services that needs to be reached in order for them to be included in a Bill.
Maximum number of unbilled UDRs: Defines the maximum number of unprocessed Usage Detail Records required in order for Usage Services to be included in a Bill.
Do It Yourself!
Let's see how you can quickly set up the System to start using Usage Service Catalogs and the UDRs module for OTT business. In our example, we will create a catalog for the three Usage Services that were created in the products example. The three movies which can be provisioned via Nagra Media Live Provider are normally charged €3 and €2 if ordered between 00:01 and 6:59. Every time a movie is ordered it is billed directly.
No configuration is necessary for the modules, sections and attributes not mentioned below.
Usage Detail Record Type
UDR Type |
---|
Usage Services |
Usage Service Catalog Definition
Life Cycle State | Allowed Attributes | Default Rates per usage service Type | ||||
---|---|---|---|---|---|---|
Usage Service Types | Provisioning Providers | Service Type | Base Rate | Tiered Rate | Conditions | |
Active | Usage Services | Nagra Media Live | Usage Services | 3 | 2 |
|
Usage Service Catalog and Αdd Usage Services
Provisioning Provider | Validity | Usage Services | Subscription Conditions | ||||
---|---|---|---|---|---|---|---|
Usage Service | Base Rate | Provisioning ID | Tiered Rate | Conditions | |||
Nagra Media Live Platform | Always Valid | Braveheart | 3 | 1AQ8 | 2 |
| Termed Subscription Service: PPV Movies |
Serendipity | 3 | 1AQ9 | 2 |
| |||
Limitless | 3 | 1BQ1 | 2 |
|
Using the Software
Having set up CRM.COM based on your business requirements, you are ready to experience the capabilities of the System. View our Application Manuals area, which includes manuals dedicated to each submodule and discover the functionality of each CRM.COM Module designed to help you complete your business transactions, or remain in this section to learn to work with OTT Subscriptions.
Managing Subscriptions
Existing and new subscribers can be managed through the Subscriptions module.
Module | Navigation | Dig In |
---|---|---|
Manage Subscriptions | BILLINGSUBSCRIPTIONSMANAGE SUBSCRIPTIONS | Managing Subscriptions |
Add Service Usage | BILLINGSUBSCRIPTIONSMANAGE SUBSCRIPTIONS | /wiki/spaces/WIP/pages/10008632 |
Bill Subscriber | BILLINGSUBSCRIPTIONSMANAGE SUBSCRIPTIONS | /wiki/spaces/WIP/pages/10008686 |
The module describes a variety of business processes which can be performed to manage the Subscriptions, such as the addition of new Services and Physical Goods, the activation, deactivation and termination of Subscriptions, the starting or stopping of individual Services, the upgrading or downgrading of Services and many more.
Adding Usage Services on Subscriptions
Usage Services can be ordered and added to 'Effective' Subscriptions already having an 'Effective' Termed Service, with which the Usage Services will be associated. To add Services to the Subscription the "Add Service Usage" Action is used which is available in the Action Panel of the Subscription Data Entry page. The Action allows you to make a selection from the available Usage Services defined in one of the 'Active' Usage Service Catalogs.
The available Usage Services are filtered based on conditions set in the Usage Service Catalogs, as well as the Validity date of the Catalog which is compared to the date that Services are scheduled to be added.
Usage Services are submitted and related to a Termed Subscription Service. Therefore the selection of a Termed Subscription Service is mandatory as well as of a UDR Type. Additional information that will be used for the creation of the UDR such as usage method, device, source system, usage amount, source category and destination category, can be defined in this section.
Billing Usage Services on Subscriptions
There are three ways in which a Subscription on which Usage Services have been added can be billed:
- Through the Billing Run, where multiple Subscriptions are billed simultaneously.
- Immediately, once the Action is executed, according to the "Usage Service Billing Rules" set in the 'Active' Billing Term Definition.
- Through the Subscriptions page "Bill Subscriber" Action, where specific Subscriptions can be billed one by one.
Depending on the Billing model you follow, slightly different logic applies to the Billing of Subscription Services.
Integrating with CRM.COM
Are you a web developer? Are you interested in integrating with CRM.COM?
Click on the links below for a complete description of the available Web APIs
- Products
- Usage Service Catalogs
- Usage Detail Records
- Nagra Media Live Platform
- Subscriptions