The documentation below describes Maintenance Release %XX%. Click here for the documentation on the latest software version.
IPTV Services
Configure PortaBilling® via the Configuration Server Web Interface
Create a Customer and Accounts
This highly customizable IPTV solution enables PortaOne customers to generate additional revenue, raise profits, and increase customer satisfaction by delivering advanced television services.
Activation of the IPTV service in PortaBilling® is done using the ESPF (External Systems Provisioning Framework) service provisioning framework. This makes it easy to provide the IPTV service to your customers and eliminates additional manual work. PortaBilling® currently supports the following platforms:
· MatrixStream
· Minerva
· Telebreeze
It is possible to configure multiple MatrixStream, Minerva and / or Telebreeze instances within your PortaSwitch® installation. However, an individual virtual billing environment can have only one instance of either platform running on it. Therefore, if you wish to have several IPTV instances running at the same time, configure each one in a separate virtual billing environment.
Video on demand (VOD) and pay per view (PPV) features configurations require separate approaches and are therefore out of the scope of this handbook. If you wish to use these features, please contact our support team.
When a new or existing customer signs up for the IPTV service, the available channel information (based on the assigned subscription) is provisioned into the IPTV delivery platform via an extensible XML API. If a customer’s product configuration changes, or a customer is blocked (e.g. due to non-payment), PortaBilling® transfers this information to the IPTV delivery platform.
An IPTV service is activated for the subscriber when:
· A new account assigned to the IPTV product is created in PortaBilling®.
· An already existing account assigned to the IPTV product is unblocked in PortaBilling®.
· A product assigned to an already existing account is changed to a new product with IPTV.
An account in PortaBilling® corresponds to a subscriber in MatrixStream.
An IPTV provider uses MatrixStream with the following assets:
· Channel packages (for example, Basic and Premium).
· Subscriptions (for example, “BasicTV” to charge for the Basic channel package, and “PremiumTV” to charge for the Gold channel package).
1. When a customer is suspended in PortaBilling® or the account is blocked or switched to the product that no longer has IPTV services included, his “subscriber” record is maintained in MatrixStream, although it is disabled.
2. When a customer is terminated in PortaBilling®, the account is deleted in MatrixStream.
3. PortaBilling® adds information to the customer’s bill about services provided and charges incurred.
An account in PortaBilling® corresponds to a customer in Minerva.
An IPTV provider uses Minerva with the following assets:
· Channel packages (for example, Basic and Premium).
· Service packages. (While Minerva’s channel packages include sets of IPTV channels only, service packages can include both channel sets and additional services such as VOD catalogue, WHDVR or Caller ID presentation.)
· Subscriptions (for example, “BasicTV,” to charge for the Basic channel package, the Start service package, and “PremiumTV,” to charge for the Gold channel package).
1. When a customer is suspended in PortaBilling®, the account is blocked or switched to the product that no longer has IPTV services included. Their “subscriber” record is maintained in Minerva, although it is disabled.
2. When a customer is terminated in PortaBilling®, the account is deleted in Minerva.
3. PortaBilling® adds information to the customer’s bill about services provided and charges incurred.
An IPTV provider uses the Telebreeze IPTV platform with the following assets:
· An account in PortaBilling® that corresponds to a customer in Telebreeze.
· Channel packages (for example, Basic and Premium).
· Subscriptions (for example, “BasicTV,” to charge for the Basic channel package, and “PremiumTV” to charge for the Gold channel package). Video-on-demand and pay-per-view services are solely handled by Telebreeze.
· Customers are authenticated in Telebreeze by either device ID or Telebreeze login / password. This information is defined in an account’s custom fields.
1. When a customer is suspended (e.g. has no available funds) in PortaBilling®, the account is blocked or switched to the product that no longer has IPTV services included – their “subscriber” record is maintained in Telebreeze.
2. When a customer is terminated in PortaBilling®, the customer record is deleted in Telebreeze.
As an example, we will create two products with the following service configuration (note that service packages are applicable only for the Minerva platform users):
· Basic TV (30 basic channels (the Basic channel package), 5 sport channels (the Sport channel package), WHDVR and VOD catalogue (the Start service package): $30 monthly).
· Premium TV (30 basic channels plus 10 sport, 10 movie and 10 music channels (the Gold channel package), WHDVR and VOD catalogue (the Start service package), Caller ID presentation: $40 monthly).
Channel and service packages are created via the IPTV platform interface and the charges for them are assigned via PortaBilling®.
Print the following page and use it to check off the operations you have completed while performing the system setup according to the instructions in this chapter. Please be sure to perform all of the operations in the order designated (all of the boxes should be checked), otherwise the service will not work. Depending on which platform you work with, you have to set up accordingly MatrixStream or Minerva platform.
|
Operation |
Done |
|
Set up the IPTV Platform: Matrix, Minerva or Telebreeze |
[ ] |
|
Configure PortaBilling® via the configuration server web interface |
[ ] |
|
Create a customer tariff |
[ ] |
|
Create corresponding subscriptions |
[ ] |
|
Create corresponding products |
[ ] |
|
Account provisioning |
|
|
Create custom fields for Telebreeze IPTV service provisioning |
[ ] |
|
Create a customer class and define the custom fields within |
[ ] |
|
Create a retail customer |
[ ] |
|
Create an account for this customer |
[ ] |
Initial configuration is performed via MatrixStream GUI:
· Create all channels / lineups.
· Create the Basic (30 basic channels), Sport (5 sport channels) and Gold (30 basic channels plus 10 sport, 10 movie and 10 music channels) channel packages.
Please refer to MatrixStream for guidelines on how to set up the MatrixStream Platform.
Initial configuration is performed via Minerva GUI:
· Create a region.
· Create all channels.
· Create the required lineups.
· Associate lineups with the appropriate region.
· Create the Basic (30 basic channels), Sport (5 sport channels) and Gold (30 basic channels plus 10 sport, 10 movie and 10 music channels) channel packages.
· Create the Start (WHDVR and VOD catalogue) and Caller ID presentation service packages.
Preparation:
· Create (import) all devices.
Please refer to MinervaNetworks for guidelines on how to set up the Minerva Platform.
Initial configuration is performed via Telebreeze GUI:
· Configure the Telebreeze middleware.
· Create all channels / lineups.
· Create the Basic (30 basic channels), Sport (5 sport channels) and Gold (30 basic channels plus 10 sport, 10 movie and 10 music channels) channel packages.
Please refer to Telebreeze for guidelines on how to set up the Telebreeze Platform.
1. Go to the Configurations tab.
2. Clone the current configuration.
3. From the Configuration Tree, select the Admin node.
4. On the Environments panel, select the required environment.
5. On the Groups panel, select the IPTV group.
6. For the Provider option, select an IPTV provider for this environment: MatrixStream, Minerva or Telebreeze.
Then, depending on which platform you use, perform one of the following sets of actions:
1. Go to the Configurations tab.
2. Clone the current configuration.
3. From the Configuration Tree, select the Admin node.
4. On the Environments panel, select the required environment.
5. On the Groups panel, select the IPTV_MatrixStream group.
6. Provide the following information:
· API_URL – URL for MatrixStream API access.
· ISPID – User ID specified in MatrixStream settings.
7. Click the Save button and then the Verify button.
8. Verify the new configuration and click the Check / Apply button.
1. Go to the Configurations tab.
2. Clone the current configuration.
3. From the Configuration Tree, select the Admin node.
4. On the Environments panel, select the required environment.
5. On the Groups panel, select the IPTV_Minerva group.
6. Provide the following information:
· API_URL – URL for Minerva API access.
· CustomerID_Provisioning_Format – Format of the data to be provisioned as a customer ID for Minerva. Select {account_id}_{i_env} to use a combination of a PortaBilling® account ID and a billing environment index number. This format is to become the default in the near future.
· Password – Password for the Minerva API access.
· RegionID – The region to which the customer is added.
· Username – Username for the Minerva API access.
7. Click the Save button and then the Verify button.
8. Verify the new configuration and click the Check / Apply button.
1. Go to the Configurations tab.
2. Clone the current configuration.
3. From the Configuration Tree, select the Admin node.
4. On the Environments panel, select the required environment.
5. On the Groups panel, select the IPTV_Telebreeze group.
6. Provide the following information:
· API_URL – The URL for Telebreeze API access.
· Operator_ID – The login specified in the Telebreeze settings.
· Signature – The signature API specified in the Telebreeze settings.
7. Click the Save button and then the Verify button.
8. Verify the new configuration and click the Check / Apply button.
To successfully provide the IPTV services, you need to create a customer tariff. However, you don’t need to add rates to this tariff.
To create the required tariff, follow the next steps:
1. In the Rating section of Main Menu page, click Tariffs.
2. On the Tariff Management page toolbar, click 
Add.
3. On the Add Tariff page, provide the following information:
· Name – A short name for the tariff entity; this is the name you will see in the select menus. Type “IPTV-T.”
· Currency – The currency in which you charge your customers. Select USD.
· Applied To – Select Customer, as this tariff will be used to charge your customers.
· Service – Select IPTV.
4. Click 
Save.
Create the “BasicTV” subscription.
1. In the Rating section of the Main Menu page, click Subscription Plans.
2. On the Subscription Plan Management page, click the Add icon.
3. Fill in the fields at the top of the Add Subscription Plan page:
· Subscription Plan Name – Name of the subscription plan which is to be used on the admin interface.
· Subscription Plan Name visible to End User – Provide the name of the subscription plan that your customers will see on their self-care interfaces and invoices.
· Currency – Select the currency in which you charge your customers.
· Managed By – Select Administrator Only.
4. On the General Info tab, provide the following information:
· Charge Suspended Customers – Check this check box if you want to always apply the subscription fee to your customers.
· Can be applied more than once – Leave this check box clear.
· Subscription Is Activated – Defines when the subscription will be considered active (and charges will begin to apply): either simply from the date it is entered into the system, or you may postpone it until the date when the customer actually uses the account for the first time. Select At the given start date.
· Activation Fee – The value charged for every new subscription upon startup. Leave this field empty to waive the activation fee.
· Minimum Subscription Period – Time (in months) during which the customer must keep the subscription plan active in order to avoid penalties. Leave this field empty to create a subscription plan that can be closed at any time.
· Subscription Charges Applied – Select At the end of the billing period, to apply subscription charges to the account / customer balance when the billing period is closed.
· Round Charged Amount – Leave the default value.
· Description – Type “30 basic, 5 sport channels. WHDVR, VOD catalogue.”
5. On the Periodic Fee tab, provide the following information:
· Periodic Fee – The default fee value that will be applied to your customers. Type “30.”
· Show rates for … billing periods – A billing period the periodic fee value will be defined for. Select monthly.
6. Click 
Save or 
Save & Close.
To create the “PremiumTV” subscription, repeat steps 1–6, but in the Description field in step 4 type “30 basic, 10 sport, 10 movie and 10 music channels. WHDVR, VOD catalogue, caller ID presentation” and in the Periodic Fee field in step 5, type“40.”
Create the “Basic TV” product.
1. In the Rating section of the Main Menu page, click Products.
2. On the Product Management page, click the 
Add icon.
3. Fill in the fields at the top of the New Product page:
· Product Name – Type in a short name for the product; this is the name you will see in the select menus.
· Product Name Visible to End User – Specify the name of this product that your customers will see on their self-care interface.
· Account Role – Select Universal from the list.
· Currency – Select the currency in which you charge your customers.
· Product Type – Select Main Product here.
· Managed By – Select Administrator Only here, since we are setting up a service without the involvement of resellers.
4. On the Included Services tab, select the IPTV check box.
5. Click Next.
NOTE: When Next is clicked, the product and all of the changes performed in the product configuration are saved.
6. On the Service Configuration tab, make the following configurations:
· Feature Status – Select Enabled.
· Service Package – Applicable only for the Minerva platform. This list contains predefined sets of services created earlier via the Minerva interface. Select Start from the list.
· Channel Package – This list contains predefined sets of channels that allow you to set different channel packages created earlier via the Minerva, MatrixStream or Telebreeze interface. Select Basic from the list. Click 
Add to add another channel package field. Select Sport for this field.
7. Click Next.
8. On the Usage Charges tab, add a rating entry for the product. The rating entry is a combination of the service available to users, the access point (node) and the tariff used for billing for this service at this access point. To add a rating entry, complete the following steps:
· Click Add and fill in the following information:
o From the Node list, select Any node.
o The Access Code field should be left empty.
o From the Service list, select IPTV.
o From the Tariff list, select the IPTV-T.
· Click Update.
9. Click Next.
10. On the Recurring Charges tab, bundle the required subscription with the product to charge your customers for the IPTV service. To do this, select BasicTV from the Subscriptions list. You will see brief information about this subscription below.
11. Click Done.
To create the Premium TV product, repeat steps 1–13, but:
· from the Channel Packages list in step 6, select Gold Package; for Minerva, add another service packages field and select Caller ID Presentation for it.
· from theSubscriptions list in step 12, select the PremiumTV subscription.
When you create an account in PortaBilling® using a related product, a corresponding subscriber will automatically be created on the IPTV platform side:
· in MatrixStream, the Subscriber ID corresponds to the Account ID in PortaBilling®.
· in Minerva, the customer ID corresponds to either a combination of a PortaBilling® account ID and a billing environment index number ({account_id}_{i_env}) or a PortaBilling® account index number ({i_account}). Either the Minerva or MatrixStream service plan corresponds to the PortaBilling® product.
· in Telebreeze, the Customer ID corresponds to a combination of a PortaBilling® account ID and a billing environment index number ({account_id}_{i_env}.
An end-user who uses IPTV services via Telebreeze is authenticated by either a device ID or Telebreeze login / password. This information is defined in custom fields.
1. In the 
Management section of the Main Menu page, select Web Interface.
2. Click 
Add to add a new custom field.
3. Fill in the following information:
· Object – Select Account.
· Name – Type Password.
· Type – Leave Text.
· Mandatory – Enable this check box to make this field mandatory.
· Visible to the End User – Enable this check box to allow users to edit this field.
4. Click 
Save.
5. Repeat steps 1–4 to create a custom field for the device ID. In step 3, leave the Mandatory check box empty.
By having a customer class, you have the ability to define a group of parameters in a centralized manner and then apply those parameters to many customers simultaneously.
1. In the 
Billing section of the PortaBilling® main page, choose Customer Classes.
2. On the Customer Class Management page, click 
Add.
3. Fill in the customer class general parameters for the customer class:
· Name – Type a short name for this customer class.
· Currency – Specify the currency in which you want to set the Collection Threshold. When specified, this customer class can only be assigned to customers using the same currency. Once the currency selection is saved, it cannot be changed.
· Business Model – Select which customers this customer class will apply to. Select Universal from the list.
· Description – Your comments about the intended use for this customer class.
· Taxation Method – Select one of the available taxation methods.
4. Configure other parameters for the customer class as described in the Basic Residential VoIP Services handbook.
5. Click Save.
6. On the Custom Fields tab, select the custom fields you have created.
7. Click 
Save & Close.
Create a customer (“John Doe”) who will use IPTV services:
1. In the Participants section of the Main Menu page, select Customers.
2. On the Customer Management page, click Add. (In this example, we assume that you are creating the customer manually, so select Manually from the list (do not use any of the Quick Form options).)
3. At the top of the Add Customer page, fill in the following fields:
· Customer ID – A short name for the customer; this will be used on the web interface. Type “Joe Doe.”
· Currency – The currency in which this customer will be billed. Select USD – US Dollar.
· Balance Control – Specify the way the customer will pay for the service: after consuming the services or prior to consuming the services. Select Postpaid.
· Permanent Credit Limit – Assign a credit limit for the customer. Type “100.”
· Customer Class – Either select the customer class you have created or leave the Default customer class.
4. On the Address Info tab, provide the following information:
· Email – Enter the customer’s email address here. If the customer ever forgets their password for the self-care interfaces, they will be able to reset it, and a new password will be sent to this email address.
5. On the Web Self-Care tab, provide the following information:
· Login – Customer login for self-care interface.
· Password – Password for the customer self-care interface.
· Time Zone – The time zone for customer self-care interface.
· Web Interface Language – The language to be used on the customer self-care interface.
6. Click Save.
Add an account under the created customer. This account will use the Basic TV product:
1. Click Accounts on the Edit Customer page toolbar.
2. On the Accounts of Retail Customer page toolbar, click the Add icon.
3. At the top of the Add Account page, fill in the following field:
· Account Role – The intended usage of the account. Select General from the list.
· Account ID – The ID which will be used to authorize IPTV access.
· Main Product – Select the Basic TV from the list.
4. On the Account Info tab, provide the following information:
· Type – Select Credit for your postpaid IPTV user.
· Balance Control – Choose the way the balance of the account is controlled. Subordinate – The balance will directly depend on the customer; Individual Credit Limit – This account may have its own balance and credit limit (the customer credit limit still applies). Select Subordinate.
· Service Password – The account ID and this password will be used to authenticate users. Make sure you choose a password which is difficult to guess or crack. Use the Auto button next to the Service Password field to generate a secure password.
5. On the Subscriber tab, provide the following information:
· Last Name – Type the end user’s last name.
· Address – Type the end user’s street address.
· City – Type the end user’s city.
· Postal Zip – Type the end user’s postal zip.
· Phone – In Minerva, phone numbers can be used as activation codes for the auto provisioning of set-top boxes (STB). To provision the phone number to Minerva, type it in this field. This phone number will then be sent to Minerva’s homePhone field.
6. On the Service Configuration tab, provide the following information:
· Activation PIN – Applicable only for the MatrixStream platform. Type a numeric code to be entered from end user’s STB (Set-Top Box) remote controller to activate IPTV services.
7. Click 
Save & Close.
Let’s assume that John Doe wants to use one more STB, this time with the Gold channel package and additional Caller ID Presentation service package. Then repeat steps 1–8, but in step 5 select Premium TV as the main product.