Usage Detail Records
On this page
Overview
Usage Detail Records provide information on the use of subscription services ordered by clients. The information is used for billing purposes and consists of records of individual events. For example:
- Watching a movie
- Placing a telephone call
- Playing a game
- Filling up a vehicle with petrol
Usage Detail Records (UDRs) Features
- UDRs are generated by the system, when usage services are ordered for a subscription through the Add Service Usage subscription action.
- UDRs are processed by the billing engine, in real-time or during billing runs.
- Billing information for usage services is sourced from usage service catalogs.
- UDRs can be adjusted or cancelled before and after they have been processed for billing.
- Processed UDRs can be imported into CRM.COM from third-party systems in order to apply additional discounts. Usage services billed by another system are defined as 'Rated' in usage service catalogs.
Setting Up UDRs
Types
Types are used to classify UDRs and group them based on their business application. They can be used to define constraints. For example, defining a UDR source category as 'mandatory' ensures the user will select one of the allowed categories when ordering the service. Types must be selected when new usage services are added to a subscription through the Add Service Usage action.
Configure the following entities before creating UDR types; then add those that you would like to make available for each type.
Source systems: Used to identify the system from which the usage service was ordered and which triggered the creation of the UDR (e.g., decoder, IVR, laptop).
Usage methods: Used to identify how the service was used (e.g., streamed or downloaded).
Devices: Used to identify the devices on which the UDR will be provisioned (e.g., from a laptop, smartphone, television)
Source categories: Classify the UDR source that initiated the service into generic groups with similar attributes. Source categories can be copied from existing destination categories that are already configured in the system.
Destination categories: Classify the UDR destinations into generic groups with similar attributes. Destination categories can be copied from existing source categories already configured in the system.
Unit of measurement: Configures the unit that expresses the quantity of the service (e.g., minutes, seconds, kilos or liters).
All UDR configurations can be used as conditions when defining tiered rates in Usage Service Catalogs or Additive Discounts.
Type fields
The table describes the sections of the Usage Detail Record Types Data Entry page and explains how the fields in the page are used.
Mandatory Configurable
Main Information | |
---|---|
Unit of Measurement: Defines the unit that expresses the quantity of the service used in the UDR. E.g., 'liters' for petrol or 'minutes' for a phone call. In case of a film, then no UoM should be defined. | |
Restrictions | |
Mandatory Information | Select the information that should be mandatory for UDRs of each type. 'Allowed' values (except for Source and Destination ID) must be defined in the respective section. The information is validated during the submission of the Add Service Usage action. |
Formatting | Defines formatting restrictions for 'Source' and 'Destination' ID that are applicable on UDRs of each type. IDs can be numeric or alphanumeric. The number of characters in an ID can be specified. |
Allowed Attributes | |
The tabs for Allowed Source Systems, Allowed Usage Methods, Allowed Devices, Allowed Source Categories and Allowed Destination Categories are used to define preconfigured attributes that will be available when creating UDRs of each type. If the attribute has been defined as 'mandatory' in the Restrictions section, one or more records must be defined per type. |
Related configuration areas
Mandatory modules must be configured for the Usage Detail Records module to work.
Optional modules may be configured for the Usage Detail Records module to operate at its full capacity.
Module Link | Area | Description | Configuration Type |
---|---|---|---|
Usage Service Catalogs | Usage service catalog definitions Usage service catalogs | Define a set of business rules, dependencies and prerequisites that determine which services can be offered to subscribers, their rates and the conditions that make them available.
| Mandatory |
Billing term scheme | Define the rules related to the billing of UDRs on normal subscriptions. Prepaid subscriptions billing takes place as soon as the Add Service Usage action is submitted. | Optional |
Using UDRs
Billing > Billing > Manage Usage Detail Records
Usage Detail Records are created by the system. The UDR Data Entry screen is a read-only page (for information).
UDR fields
The table describes the sections of the Usage Detail Records Data Entry page and explains how the fields in the page are used.
Mandatory Configurable
Main Information (Provides information on the ordered usage service) | |
---|---|
Type of ordered UDR. Usage Service that resulted in UDR. Usage Amount: quantity consumed as it appears in the UDR. Total Amount: The expense resulting from the consumption. Number: An auto-generated unique ID. Life Cycle State: reflects the progress or status of the UDR.
Customer Information Accounts Receivable: the account associated with the subscription that placed the order and will be billed. Subscription No. for which the Add Usage Service action was executed and for which the usage service was ordered. Termed Subscription Service used as a base to order a usage service. E.g., the recurring billed service that lets a subscriber order pay-per-view (PPV). Usage Service Information Usage Service Catalog: source for UDR service that supplied the rate. Usage Method: how the service was obtained. E.g., rental or download. Destination ID that received the service. E.g., the phone number that received a call. Added on: date/time on which the usage service was added to the subscription. Usage Service that is being used. Device: through which the service was used. E.g., Roku Box or Apple TV. Destination Category that received the service. Added by Subscription Action: the number that triggered the UDR. Usage Amount: quantity consumed as it appears in the UDR. Source System that generated the UDR. E.g., Interactive Voice Response (IVR) system or agent. Performed by Unit (of UDR). Usage From and To Date: the period during which the service was consumed. Source ID that initiated the service. E.g., the phone number that placed a call. Scheduled to Be Executed on: date/time on which the Add Service Usage action is scheduled to be executed. Source Category that initiated the service. Executed on: date/time on which the Add Service Usage action was executed. Billing Information Billing Directive: How the billing engine should handle the UDR ('To Be Billed', 'To Be Credited' or 'Not To Be Billed'). Discount Amount applied on the UDR. Billing Effective Date: the date on which UDR will be considered by the billing run. VAT Amount included in the Total. Rating Type: whether the UDR is 'Post-Rated' or 'Pre'-Rated'. Tax Amount included in the Total. Rating State: can be 'Pending' (UDR not rated yet, or rated but rated billing item was cancelled) or 'Completed' (UDR already rated). Total Amount: the total expense resulting from the consumption. Included in Bill: the number of the bill that contains the UDR. |
Creating and processing UDRs
Validations take place before an action is initiated (prerequisite) or after it is submitted (postcondition).
Selecting and creating a UDR
Specify the criteria that match the Usage Detail Record you are interested in to view the available information.
Adjusting a UDR
Adjust incorrect information captured on the UDR before or after it is billed. If already billed, the system will handle the adjustment by debiting or crediting the associated account with the adjusted UDR.
Billing UDRs creates rated billing items (RBIs), which have to be cancelled (by creating an identical RBI of opposite value) when a billed UDR is adjusted. When the adjusted UDR is billed, a new RBI is created.
A UDR can be adjusted from the Data Entry page by using the respective action available from the Actions menu.
- Adjust the following as necessary:
- Product: the service that was used
- Usage Amount: the quantity consumed
- Source: the system that generated the UDR (filtered on UDR Type)
- UDR Type
- UDR Billing Effective Date
- From and To Date: the period during which the service was used
- Click on SAVE on the Modal.
Prerequisites | The UDR must be in a 'Posted' life cycle state |
---|
Cancelling a UDR
Billed UDRs can be cancelled, debiting or crediting the associated account in the process (a UDR that credited an account will debit it when cancelled and vice versa). Cancellations can be used to settle a customer complaint by offering a usage service free of charge.
A UDR can be cancelled from the Data Entry page by using the respective action available from the Actions menu.
Additional Information
The billing of UDRs creates rated billing items (RBIs). These have to be cancelled when a billed UDR is cancelled (by creating identical RBIs of opposite value).
Prerequisites | The UDR must be in a 'Posted' life cycle state |
---|
Changing the billing directive of a UDR
The billing directive is set by the system and instructs the billing engine on how to handle the UDR, providing it with three options:
- Not To Be Billed (exclude the UDR from billing)
- To Be Billed (debit the related account)
- To Be Credited (credit the related account)
The user can update the directive to manage billing, by using three actions available from the Data Entry page Actions menu:
- Set As Billable
- Set As Creditable
- Set As Not To Be Billed
Additional Information
The billing of UDRs creates rated billing items (RBIs). These have to be cancelled when the billing directive changes. Once the action is submitted an identical RBI of opposite value is created and handled in the next billing run.
Action | Set As Billable | Set As Creditable | Set As Not To Be Billed |
---|---|---|---|
Prerequisites |
| Billing Directive must not be 'To Be Credited' |
|
Billing of usage services details
The procedure for billing usage services involves processing UDRs and is different in Prepaid and Normal Subscriptions.
In prepaid subscriptions, billing of usage services results in debiting a wallet associated with the subscription. UDRs are processed as soon as the Add Service Usage subscription action is submitted. The service can be added, provided there are sufficient funds in the subscriber's wallet.
In normal subscriptions, billing of usage services results in debiting of the accounts receivable associated with the subscription. UDRs are processed either during the next billing run or as soon as the maximum number of unbilled UDRs or maximum unbilled amount is reached, as configured in the Billing Term Scheme.
Already processed UDRs can be imported into CRM.COM from third-party systems using the WEB API. In this case, CRM.COM only handles the provision of additional discounts (not the billing). Usage services billed by another system are defined as 'Rated' in usage service catalogs. Refer to Usage Service catalogs for more information.
UDR Business Examples
Scenario 1
Company ZX has introduced new packages for (over-the-top) OTT subscribers. The OTT packages include several PPV (pay-per-view) movies.
• Movies are charged €5.00 when provided between 00:01 and 6:59 and €10.00 during the rest of the day.
• Older movies are always charged €3.00.
• To order a PPV movie, subscribers must have an 'Effective' PPV service on their subscription.
• Movies are free for VIP subscribers.
• Movies should be billed instantly.
Customers can place their orders from their decoders or by calling the call center.
Solution
To meet the above requirement:
• Product types of classification 'service' and service type 'usage' and 'termed' must be configured.
• Movies must be imported or created in the system with a usage service classification product type.
• Provider must be configured (provisioning IDs for each OTT Service should be defined).
• Usage service catalog definitions must be configured and activated.
• Two usage service catalogs must be created including the available movies, one for VIP and one for normal subscribers.
• Normal billing term scheme and usage service billing rules must be set for billing to take place whenever one or more movies are added.
Configuration
Product Types
Product Types | Classification | Service Type | Composition Method | Used For Provisioning |
---|---|---|---|---|
Usage Services | Service | Usage | Flat | Yes |
Termed Services | Service | Termed | Flat | Yes |
Products
Product | Type | Information |
---|---|---|
PPV Service | Termed Services | Necessary in order to authorize the addition of PPV movies to the subscription. |
PPV movies | One product must be created for each available PPV movie. Usage services are added in usage service catalogs (not price plans). | |
Lord of the Rings 1 | Usage service | |
Serendipity | Usage service | |
Limitless | Usage service |
Provisioning Provider example
NagraVision Media Live provider
Provisioning Provider | Provisioning Protocol | End Point | Username | Password | Encoding | Distributors | Services | Physical Goods |
---|---|---|---|---|---|---|---|---|
Nagra Media Platform | Nagra Media Live Platform | http://ott.nagra.com/customer/VTV/api/smsservice_1.2?wsdl | Request password | Request password | UTF-8 | Nagra Media Live Main | Define through usage service catalogs | Thomson decoders |
Usage Service catalog Definitions
Life Cycle State | Allowed Attributes | Default Rates by Usage Service Type | ||||
---|---|---|---|---|---|---|
Usage Service Types | Provisioning Providers | Service Type | Base Rate | Tiered Rate | Conditions | |
Active | Usage Services | Nagra Media Live | Usage Services | €10.00 | €5.00 |
|
Usage Service catalog for Normal Subscribers
Provisioning Provider | Validity | Usage Services | |||||
---|---|---|---|---|---|---|---|
Usage Service | Base Rate | Provisioning ID | Tiered Rate | Conditions | Comments | ||
Nagra Media Live Platform | Always Valid | Lord of the Rings | €10.00 | 1AQ8 | €5.00 |
| Usage service details will be set automatically according to the definition (base rate, tiered rate, tiered rate conditions). |
Nagra Media Live Platform | Always Valid | Limitless | €10.00 | 1BQ1 | €5.00 |
| Usage service details will be set automatically according to the definition (base rate, tiered rate, tiered rate conditions). |
Nagra Media Live Platform | Always Valid | Serendipity (old movie) | €5.00 | 1BQ4 | Usage service details will be set automatically, according to the definition (base rate, tiered rate, tiered rate conditions); the user must manually update the base rate to €5.00 and remove any tiered rates.
|
Usage Service catalog for VIP Subscribers
Provisioning Provider | Validity | Usage Services | Accounts Receivable Conditions | |||||
---|---|---|---|---|---|---|---|---|
Usage Service | Base Rate | Provisioning ID | Tiered Rate | Conditions | Comments | |||
Nagra Media Live Platform | Always Valid | Lord of the Rings | €0.00 | 1AQ8 | €0.00 | - | Usage service details will be set automatically according to the definition (base rate, tiered rate, tiered rate conditions); the user must manually update all to 0 and remove tiered rates. | Classification = VIP |
Nagra Media Live Platform | Always Valid | Limitless | €0.00 | 1BQ1 | €0.00 | -
| Usage service details will be set automatically according to the definition (base rate, tiered rate, tiered rate conditions); the user must manually update all to 0 and remove tiered rates. | Classification = VIP |
Nagra Media Live Platform | Always Valid | Serendipity (old movie) | €0.00 | 1BQ4 | €0.00 | - | Usage service details will be set automatically according to the definition (base rate, tiered rate, tiered rate conditions); the user must manually update all to 0 and remove tiered rates. | Classification = VIP |
Normal Billing Term Scheme
Usage Services Billing Rules |
---|
Maximum number of unbilled UDRs |
1 |
User Process
Subscribers can order PPV movies through:
- A portal that can be integrated to CRM.COM using its WEB API library
- A subscriber device that is integrated with CRM.COM
- The CRM.COM User Interface, using Add Service Usage.
Notes
- If you are using a previous release, view CRM.COM Release Changes.
- Use the Usage Detail Records WEB API to create and manage Usage Detail Records from an external system, such as a customer portal. View the Usage Detail Records WEB API for a complete list of actions available through the WEB API.
Glossary
CRM.COM Term | Definition |
---|---|
Usage Service Catalog (USC) | Catalogs for products that are offered on customer request and charged based on their consumption. USCs contain information on pricing and service validity as well as information used by third-party provisioning systems. USCs support the over-the-top (OTT) business model. |
Over-the-top (OTT) | A broadcasting model where media (video, audio) are transmitted on the internet as standalone products, without the need for a cable or satellite operator. |
Accounts Receivable | A ledger of the financial transactions carried out between a company and its customers, such as invoices and payments. |
Wallet | A customer account whose credit balance is used to fund transactions within CRM.COM. |
Subscription | A selection of customer services billed on a recurring, usage or one-time basis. |
Job | A small project initiated by the operator for customers, involving the delivery and billing of services, products and activities. Customer requests and orders, such as that for a new subscription, can be initiated and registered through a job. |
Termed Service | A service that is provided continuously and billed for a recurring period, regardless of usage. |
Rated Billing Item (RBI) | Information on services, physical goods and the billing period, generated by the billing engine during the rating step of the normal billing run, before the transaction takes place. RBIs let the user make amendments or corrections before (a binding) financial transaction is created. |