Release

Search

Broadband Internet access services

Link copied to clipboard

This handbook describes how you can use PortaBilling to provision and define rates for broadband Internet access services (such as DSL, ADSL, cable, etc.)

The most typical broadband package types that you can offer your clients include:

  • Fixed bandwidth (download and/or upload) and unlimited data transfer, for a fixed monthly fee.
  • Fixed bandwidth (download and/or upload) and a limited total data transfer amount, for a fixed monthly fee.
  • A pay-as-you-go plan, where the customer is charged based on the amount of data transferred (per kilobyte, megabyte or gigabyte).

In this handbook we will show you how to:

  • charge data transfers using tariffs;
  • implement packages with a fixed monthly fee using subscriptions assigned to products;
  • limit bandwidth for a product and /or an account;
  • limit data transfers using volume discount plans.

You will also learn how to assign a static IP to an account and restrict the number of simultaneous Internet sessions with the same Account ID.

As a good practice, we recommend that you configure your equipment to send keepalive messages to PortaBilling at least every 2 hours while using Internet access services.

Examples of broadband packages

Link copied to clipboard

As an example, we will create three packages with the following specifications:

  • Start: 128 kbps upload and 512 kbps download bandwidth for $15.00 monthly. To provide all of your customers with adequate Internet usage you can design a service usage policy that eliminates service abuse or illegal service usage. You can do this by limiting the quota of Internet traffic per day. For example, a customer will be unable to download more than 1 GB of data in a single day; after that, the Internet will be blocked until the following day.
  • Pro: 256 kbps upload, 1 Mbps download bandwidth and 20 GB of data transferred during peak hours and 30 GB of data transferred during nighttime hours for $30.00 monthly. You can limit upload / download bandwidth to 64 kbps after customer consumes his quota. 
  • Premium: 512 kbps upload, 2 Mbps download bandwidth and, data transfer up to 40 GB for $40.00 monthly. Data transfer above these thresholds is charged at $2.00 per gigabyte. Premium provides the rollover of unused traffic to the following month.

Please refer to the PortaBilling Help for detailed instructions on how to navigate and operate the web interface, along with detailed explanations of particular fields.

Checklist

Link copied to clipboard

Use this checklist 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.

Operation

Done

General configuration

Enable the NetAccess service type on the Configuration server

Create the symbolic destination NETACCESS

Create services

Network configuration

Add a Cisco NAS as a node on the web

Rating configuration (Vendor)

Create a tariff A, which describes your data transfer costs.

Insert rates in tariff A for the wildcard | (pipe) destination.

Create a vendor

Create a connection for this vendor with the Internet Access service type, using tariff A

Rating configuration (Customer)

Create a tariff B which will be applied to Internet users

Insert rates in tariff B for the symbolic NETACCESS destination

Create subscriptions

Create a destination group set

Create a destination group

Assign the NETACCESS prefix to this destination group

Create a volume discount plan

Define a quota within this volume discount plan

Create an Internet access policy

Create a product

Create one rating entry in the product, using the node you created and tariff B

Assign this discount plan as the default one for the product

Apply a subscription to the product

Apply an Internet access policy to the product

Account provisioning

Create a customer

Create accounts for this customer

Assign a static IP and restrict the number of simultaneous sessions for accounts

Set a bandwidth limit for accounts

Initial configuration of PortaBilling

Link copied to clipboard

If you have just installed the PortaBilling software or dedicated a new billing environment to configure the services described in this handbook, make sure to first perform the initial configuration of PortaBilling. To do this, use the PortaBilling Initial Configuration handbook.

Enable the NetAccess service type on the Configuration server

Link copied to clipboard
  1. On the Configuration server web interface, go to the Configurations tab.
  2. Clone the current configuration.

    Enable the NetAccess service type

  3. In the Configuration Tree, click on the BillingEngine node.
  4. On the Groups panel, select the NetAccess group.
  5. For the Enabled option, select Yes.
  6. Click Save and then Verify.
  7. Verify the new configuration and click the Check/Apply button.

Create destination

Link copied to clipboard

This step is only required if you have not defined the necessary destination previously. If not, you will need to create a symbolic NETACCESS destination.

  1. On the navigation menu, select Service catalog, select Rate codes, and then select Destinations.

    Dashboard

  2. Open the Create a destination panel and fill in the destination information:
    • Format – select Custom from the list.
    • Prefix – type in NETACCESS.
    • Description – enter useful information about the service being provided (e.g., Internet Access), since this is what your clients will see on their xDR Summary pages.

      Create a destination

  3. Click Save.

Create services

Link copied to clipboard

Services provide a way to define how charges are calculated (e.g., whether customers are charged based on the time they stay online, or the amount of data transferred) and how these are then presented on their invoices.

image005

  1. On the navigation menu go to Service catalog and select Services.
  2. Open the Create service panel.
  3. Fill in the required information:
    • Name – a short descriptive name for this service, it will be used in select menus and shown on customer self-care pages (e.g., Internet access)
    • Type – select Internet access.
    • Rating base – select upload+download (megabytes).
    • Base unit – select megabyte.
    • Billing unit – select gigabyte. This will be shown on statistics pages and on invoices.
    • Base ratio 1024.
    • Usage charge – select Yes here.
  4. Click Save.
  5. Repeat steps 2–4 if you need to create more services.

Create nodes

Link copied to clipboard

This step is only required if you have not previously entered your NAS into the system. In this case, you must enter your NAS as a node. PortaBilling requires some key information about your network equipment such as IP address, Node ID, Radius shared secret, etc.

  1. On the navigation menu select Infrastructure. Go to the Billing data sources link and click Nodes.
  2. On the Create node panel, fill in the node details:
    • Name – a short descriptive name for this node (e.g., Cisco NAS)
    • Node ID – cisco NAS host name (recommended hostname.domainname).
    • IP – the IP address of the node.
    • Manufacturer – select Cisco.
    • Type – select NAS.
  3. Click Save.

    Add a node

  4. On the Communication with billing section use the slider to enable Communication with billing option and fill in the node details:
    • Client protocol – select RADIUS to enable the NAS (node) to communicate with PortaBilling via RADIUS.
    • RADIUS key – enter the RADIUS secret key you specified in the configuration of the NAS.
    • RADIUS source IP – see the Node ID, IP and Radius source IP section of the PortaBilling Administrator Guide. Unless your NAS has multiple network interfaces, the value here will be the same as the IP.
    • POD Server – use the slider to enable interaction with this server on NAS. The system will send a special command to this server if an account runs out of balance, exceeds its data transfer limit, or expires. The POD server will then terminate the Internet session(s) opened by this account.

      Add a node

  5. Click Save.
  6. Repeat steps 2–5 until all of your nodes are entered.

Create a vendor tariff

Link copied to clipboard

This step is only required if you have not entered vendor information into the system before.

The tariff is a single price list for the use of internet access services. To successfully provide internet access services, a tariff with corresponding data costs should be created; this tariff is created as “Applied to: Vendor.”

To create the required tariff, follow the next steps:

  1. On the navigation menu on the left, select Service catalog and click Tariffs.

    Dashboard

  2. On the Create tariff panel, fill in the tariff details:
    • Name – a short name for the tariff object (e.g., Internet access); this is the name you will see in select menus.
    • Currency – choose the currency in which the vendor charges you.
      The currency for the tariff may be chosen only once, and cannot be changed later.
    • Service – select the services you created earlier (in our example Network access).
    • Applied to – choose Vendor in the Applied to list.

      Add a tariff

  3. Click Save.

Enter rates

Link copied to clipboard

This step is only required if you have not entered vendor information into the system before.

Add Rates

  1. Open the vendor tariff "Internet Access" and click Rates.
  2. On the Add rate panel, fill in the rate details:
    • Rate code – type in the ‘|’ (pipe) destination.
    • Rating mode – select Flat rate.
    • Rounding – leave the default “1” value for this example. See more info on the Rounding option in the UI help.
    • Unit price – price per billing unit (in this example, per gigabyte). If you don’t intend to calculate costs, specify zero “0” rate for this vendor tariff.
  3. Click Save.

Create a vendor

Link copied to clipboard

This step is only required if you have not entered information about your vendors into the system before.

  1. On the navigation menu, select Infrastructure, then select Vendors.

    Add a vendor

  2. On the Create vendor panel, fill in the vendor details:
    • Name – type a short name for the vendor object (for example, Internet Access).
    • Currency – leave the base currency.
    • For Opening balance and Billing period fields, leave the default values since this symbolic vendor is created only so that the system functions properly.
  3. Click Save.

Define a connection

Link copied to clipboard
  1. On your vendor’s panel (Internet Access), click Connections.

    Add a connection

  2. On the Create connection panel, fill in the connection details:
    • Description – type in a short description for this connection.
    • Service type – select Internet access.
    • Tariff – select the vendor tariff you created earlier.
    • Node – select the Cisco NAS which you previously added as a node.
    • Capacity – in the Capacity field specify the maximum number of sessions you anticipate handling on this NAS in the near future. This parameter is only used for correctly scaling the load graph for the connection.
  3. Click Save.

Define an off-peak period

Link copied to clipboard

You need to define an off-peak period for the Pro package. Please refer to the Creating a Service with Multiple Off-Peak Periods handbook for detailed instructions on how to define peak and off-peak periods.

Create customer tariffs

Link copied to clipboard

In our example, we need to create two customer tariffs: a joint one for the Start and Pro packages with a zero price per GB and another one for the Premium package with a $20.00 price per GB:

To create the required tariffs, follow the next steps:

  1. On the navigation menu, select Service catalog and click Tariffs.
  2. On the Create tariff panel, fill in the tariff details:
    • Name – type in a short name for the tariff object; this is the name you will see in the select menus.
    • Currency – select the currency in which you will charge your customers.
      The currency for the tariff is chosen only once, and cannot be changed later.
    • Service – select the service you created earlier (in our example, Internet access).
    • Applied to – select Customer as this tariff will be used to charge your customers.
    • Managed by – select Administrator only here.
  3. Click Save.

    Fill in the Premium customer tariff details

  4. On the customer tariff’s panel, click General info.
  5. On the General info panel, specify Default off-peak period that you created within the previous step. This off-peak period will be applied to Pro subscribers.
  6. Click Save.

    Fill in the Start + Pro customer tariff details

  7. Repeat steps 1–3 for the Premium tariff.

Enter rates

Link copied to clipboard

Add rates to Start + Pro tariff

Add rates to Premium tariff

  1. Open the customer tariff and click Rates.
  2. On the Add rate panel, fill in the rate details:
    • Rate code – type in the NETACCESS destination directly or select it from the list.
      The NETACCESS rate code you are creating a rate for must already exist in Destinations registry.
    • Rating mode – select Flat rate.
    • Rounding – leave the default “1” value for this example. See more info on the Rounding option in the UI help.
    • Unit price – the price per billing unit (in our example, per gigabyte). Leave a zero price for the Start + Pro tariff. Charge your Internet users who subscribe to the Premium package $2.00 per gigabyte for data transfer above the thresholds. Specify this price here.
  3. Click Save.

Create subscriptions

Link copied to clipboard

Subscriptions allow you to charge a certain periodic fee to accounts that belong to a certain product. Below we will show you how to create a monthly $15.00 subscription and apply it to a product. You will also need to create $30.00 and $40.00 monthly subscriptions and apply them to their corresponding products.

  1. On the navigation menu, select Service catalog and click Subscriptions.

    Add a subscription

  2. On the Create subscription panel, fill in the required information:
    • Name – name of the subscription plan that will be used on the Admin interface.
    • Subscription name visible to end users – Provide the name of the subscription plan that your customers will see on their self-care interfaces and invoices.
    • Currency – indicates which currency is used for pricing information. A subscription plan can only be applied to a product, account or customer using this same currency.
      The currency for the subscription plan may only be chosen once and cannot be changed later.
    • Managed by – if you want this subscription plan to be used for your reseller’s accounts so the reseller himself can change the parameters of the plan and apply it to his accounts, choose a customer name from the menu. Otherwise, choose Administrator only here.
    • Subscription charges applied – the default method is At the end of the billing period, so that subscription charges are applied to the account/customer balance when the billing period closes. Another option is Progressively, wherein a small portion of the total subscription fee is applied daily, so that the balance grows gradually. You can also choose to apply charges In advance.
    • Activation mode – defines when the subscription will be considered active (and charges begin to apply): either from the date it is entered into the system or it can be postponed until the actual date of the customer’s first usage of the account.
    • Activation fee – enter the value charged for every new subscription upon startup.
    • Monthly fee – specify the fee value that will be applied to your customers every month.
    • Can be applied more than once – select this checkbox to assign the same subscription multiple times to one account. You can only use this option when you are adding a new subscription plan. For new subscriptions, the Can be applied more than once option is off by default (so that subscription charges are not applied multiple times for the same account).
  3. Click Save.

    Specify the subscription details

  4. On the Subscription plan panel, click General configuration.
  5. On the General configuration panel, you can configure the following options:
    • Issue credits for the days when – here you can choose under which conditions to issue credits for a subscription fee. Customers may not have access to the service due to suspension, block, account expiration, or lack of funds. To exclude charges for the days when no service was provided, a subscription fee is charged in full and then credits are issued for the days when no service was available. By default, credits for a subscription fee are issued under all conditions: the account was expired, the account or customer was blocked, the customer was suspended, or no funds were available (the balance of a customer or an individual account reached the credit limit or ran out of available funds).Clear the checkboxes if you want to charge the subscription fee for these days.
    • Skip credits, charge in full – when one or several conditions are set to issue credits for a subscription fee, you can skip credits for the first, last, or/and regular billing periods by selecting the corresponding checkbox.
    • Description – you can specify an extended description of this subscription plan.

      Subscription plan general configuration

  6. Go to the Fees panel and fill in the required information:
    • Round up to – leave the default value unchanged if you want to calculate charges with the maximum available precision; otherwise, see the PortaBilling Help for more details about setting up rounding.
    • Activation tax transaction code – specify the internal tax transaction code from the list. PortaBilling will use this code to extract taxation codes for EZTax, Avalara, GST or SureTax taxation plug-ins and send them for tax processing for services covered by a subscription activation fee.
    • Monthly fee – click the image023 icon to select a specific billing period the periodic fee value will be defined for.

      timesaver You can manage the periodic fee value for different billing periods. When another billing period is selected in the Show rates for drop-down list, the Periodic Fee field is populated with auto-calculated fee values (e.g., if a $10.00 periodic fee is defined for customers with a monthly billing period, a $2.33333 periodic fee will be applied to customers with a weekly billing period, etc). Of course, you may change the actual values afterwards (e.g., make weekly billing more expensive by setting the fee to $3.00).

    • Prorate fee for the partial billing period – when a customer signs up for/cancels a subscription in the middle of a billing period, you can charge either a prorated or full periodic fee. By default, customers are charged a prorated fee based on the number of days the subscription is active during the first/last partial billing period.
      • First billing period – select the checkbox to charge a prorated fee for the first billing period. Clear the checkbox to charge customers a full periodic fee, no matter when they activate their subscription.
      • Last billing period – select the checkbox to charge a prorated fee for the last billing period. Clear the checkbox to charge customers a full periodic fee, no matter when they cancel their subscription.
        If you set up the non-prorated (full) fee, credits may still be issued for the days when a customer cannot use the service due to service suspension, block, having exceeded credit limit, etc. (credits are issued according to the Issue credits for the days when and Skip credits, charge in full options configuration).
    • Usage tax transaction code – specify the internal tax transaction code from the list. PortaBilling will use this code to extract taxation codes for EZTax, Avalara, GST or SureTax taxation plug-ins and send them for tax processing for services covered by the periodic subscription fees.
    • 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.
    • Early cancellation penalty – if the subscription is cancelled earlier than the minimum subscription period, a one-time fee is applied. The following options are available:
      • Fixed – a fixed charge is applied without taking account of when the subscription was cancelled.
      • Remaining subscription charges – the charge will depend on when the subscription was cancelled.
    • Cancellation tax transaction code – specify the internal tax transaction code from the list. PortaBilling will use this code to extract taxation codes for EZTax, Avalara, GST or SureTax taxation plug-ins and send them for tax processing for services covered by the subscription cancellation fee (e.g., administrative costs).

      Specify the periodic fee

  7. Click Save to save the Subscription plan.
  8. Repeat the above procedure for all your subscriptions.

Create a destination group set

Link copied to clipboard

In order to define discounts for your Internet service, you need to create a destination group set.

  1. On the navigation menu on the left, select Service catalog, Rate codes and click Destination group sets.

    Dashboard

  2. On the Create destination group sets panel, fill in the required information:
    • Name – type in a descriptive name for the destination group set (e.g., Internet Access);
    • Type – leave the default type Regular.

      Create a destination group set

  3. Click the Save button to save the destination group set.

Define a destination group

Link copied to clipboard

Now you need to create one destination group.

  1. After saving a destination group set, the Destination group page opens.
  2. On the Create destination group panel, type in the destination group name and provide a short description.

    Add a destination group

  3. Click the Save button to save the destination group.

Assign prefix to destination group

Link copied to clipboard
  1. On the Destination group page, click the default All destinations group.

    image030

  2. On Search filters panel specify the parameters (e.g., format, prefix) to find the required destination in the list and click Apply filters.

    Add a destination to the destination group

  3. On the Destination list panel select the prefix you want to include (e.g., NETACCESS) in the destination group and click Assign to group.

    Assign prefix to destination group

  4. Select the destination group (Internet Access) and click Assign. The selected prefixes will be added automatically to the destination group.

    image034

Create a volume discount plan

Link copied to clipboard

A volume discount plan contains definitions of all the applicable special discounts or service quotas offered to users of a certain product. We need to create three volume discount plans to provide a certain quota for each package.

  1. On the navigation menu on the left, select Service catalog, then Bundles and click Volume discount plans.

    Dashboard

  2. On the Create discount plan panel, fill in the volume discount plan details.
    • Name – a short descriptive name for this volume discount plan (e.g., Start Quota, Pro Quota, Premium Quota).
    • Currency – select the currency in which you charge your customers.
      The currency for the volume discount plan may be chosen only once (at creation) and cannot be changed later
    • Apply discounts to – leave the default value here Individual combinations of Services/Destination Group
    • Destination group set – choose the destination group set you created in the previous steps.
    • Destination group lookup type – select Same destination as rate here.
    • Managed by – if you want this volume discount plan to be used for your reseller’s accounts, so that the reseller himself can change the parameters of this tariff and create new accounts using this product, choose a customer name from the menu. Otherwise, choose Administrator only here.
    • Description – specify an extended discount description.

      Create Volume discount plan

  3. Click Save.
  4. Repeat steps 1–3 to create volume discount plans for Pro and Premium packages.

Define quotas within a volume discount plan

Link copied to clipboard

While on the Edit discount plan panel, click the VDP configuration link.

Start package

Link copied to clipboard
  1. On the Create volume discount group panel fill in the following information:
    • Type – select Quota.
    • Service – select Internet access here.
    • Volume measured – as the discount levels will be based on the total amount of transferred data, choose Service used, gigabyte. For more details about different discount level options, see the PortaBilling Administrator Guide.
    • Destination group – select the destination group from the list that this discount will apply to (Internet Access in our example).
    • Reset threshold counters – select Daily.

      Define quota for Start Quota plan

  2. Click Save. You are redirected to the quota configuration panel.
  3. On the Advanced configuration panel, configure the following:
    • Internet access mode when quota is exhausted – select Blocked. When quota is exhausted, the service becomes unavailable until the following day.

      Define quota for Start Quota plan

  4. On the Thresholds configuration panel, configure the following:
    • Peak period thresholds – specify 1 GB threshold value.

      image041

  5. Click the Save button in the toolbar to save the changes.

Pro package

Link copied to clipboard
  1. On the Create volume discount group panel of Pro package, fill in the following information:
    • Reset threshold counters – select Monthly.
    • Click Save.

      Define quota for Start Quota plan

  2. On the Advanced configuration panel of Pro package, configure the following:
    • Internet access mode when quota is exhausted – select Limited. This makes it possible to reduce the speed of Internet traffic once the quota is used up.

      Define quota for Pro Quota plan

  3. On the Thresholds configuration panel of Pro package, configure the following:
    • Peak period thresholds – specify 20 GB threshold value here.
    • Enable Use separate thresholds for the first off-peak period – specify 30 GB threshold value for off-peak periods.

      Define quota for Pro Quota plan

  4. On the Notifications configuration panel of Pro package, configure the following:
    • Notify end user when … Remaining peak/off-peak period quota is, gigabyte … – define the warning threshold value; the end user will be notified when their remaining traffic approaches a discount threshold.

      Define quota for Pro Quota plan

  5. Click the Save button in the toolbar to save the changes.

Premium package

Link copied to clipboard
  1. On the Create volume discount group panel of Premium package, fill in the same information as for Pro package.

    Define quota for Premium Quota plan

  2. On the Thresholds configuration panel of Premium package, configure the following:
    • Peak period thresholds – specify 40 GB threshold value here.

      Define quota for Premium Quota plan

  3. On the Advanced configuration panel of Premium package, configure the following:
    • Prorate thresholds for first usage period – use the slider to enable this option. It will prorate volume discount thresholds according to the number of days remaining in the first usage period after volume discount assignment.
    • Allowed number of rollovers – if at the end of the month there is unused traffic, it can be rolled over to the next usage period. Type in 1 here.
    • Internet access mode when quota is exhausted – select Not restricted. When the quota is exhausted, the Internet speed remains the same.

      Define quota for Premium Quota plan

  4. Click the Save button in the toolbar to save the changes.

Create a service policy

Link copied to clipboard

An Internet access policy allows you to restrict the amount of available bandwidth or prohibit Internet access based on a specific time of day or day of the week. For example, you may allow Internet access only at night and for 24hrs during the weekend and/or restrict the bandwidth for data transfer to 1 Mbps.

  1. On the navigation menu, select Service catalog and click Service policies.
  2. On the Create service policy panel, fill in the Service policy details:
    • Name – a short descriptive name for this Service policy. Type in Pro here.
    • Service type – select Internet access.
  3. Click Save.

    Internet Access Policy

  4. On the Access policy panel, use the slider to disable unlimited option and fill in the download and upload rates for all access types:
    • Regular – a regular bandwidth rate that is used most of the time. In our example, the Download Rate for the Pro package is 256 kbps, the Upload Rate is 1 Mbps.
    • Turbo – this defines a bandwidth rate for off-peak times. In our example, the values for this row are the same as for the Regular access type.
    • Limited – this usually restricts the bandwidth to an extremely low value, so that the customer can only access the Internet for checking his bill, making a payment, etc. Let’s specify 64 kbps here for the Download Rate and 64 kbps for the Upload Rate.
    • Blocked – this access type prohibits Internet access (this rate cannot be changed).
  5. Configure the access type of usage on the grid that shows all of the week’s hours. Simply click several times on a cell within the grid to set a certain access type for that particular hour.

    Edit the Internet Access policy

  6. On the Attributes panel, adjust your service provisioning based on the specifics of your gateway (Cisco-NAS in our example) and specify the default values for the Radius response attribute:
    • Enable RADIUS response on Cisco NAS panel and click Set default.
      If you use different network equipment to provide Internet service which supports authorization via the RADIUS protocol, be sure to configure the default radius response values for it.

       

      Specify the attribute values

  7. On the Hotlining panel configure the hotlining parameters:
    • Captive portal URL – specify a hotline portal address your users will be redirected to if account is out of funds or/and if account is suspended or blocked.
  8. Click Save.

    Configure Hotlining

  9. Repeat steps 1–8 for the Start and Premium packages.

Create a product

Link copied to clipboard

Accounts for accessing your services will be issued for a specific product. Products are a powerful tool that defines different ways to bill an account. Product definition is always realized through these steps: product definition, service definition and configuration and creation of a rating list.

In this case, you need to create three products:

  • Start
  • Pro, and
  • Premium.
  1. On the navigation menu, select Service catalog and click Products.
  2. On the Create product panel, fill in the product details:
    • Name – type in a short name for the product object; this is the name you will then see in the select menus.
    • Name visible to end users – specify the name of this product that your customers will see on their self-care interface.
    • Product type – select Main product here.
    • Currency – choose a currency the product will be priced in.
    • Managed by – select Administrator only here, since we are setting up a service without the involvement of resellers.
    • Account default ACL – choose an Access Control List (ACL) for accounts with this product assigned. ACLs control which objects end users can access to and which actions they can perform.
    • Account role – select User@domain from the list since this product is intended for accessing the Internet.
  3. Click Save.

    Create a product

Services

Link copied to clipboard

Define which service types are included in the product. A service type is a description of the physical service provided to end users.

To add a service type:

  1. On your product’s panel, click Services.
  2. On the Services panel, click Add a service.
  3. In the Select services to add dialog box, select Network access and click Add.

    Add a service

Service configuration

Link copied to clipboard

Define the default values of the service attributes for all the accounts that this product will be assigned to.

  1. Go to the Internet access configuration page and configure the following:
    • Static IP – use a slider to enable the option to assign a static IP to the account.
    • Session limit – use a slider to enable the option to define a specific number of simultaneous sessions.
    • Access policy – use a slider to enable the option to define an Internet access policy and set different bandwidths for different times of day.
    • Internet access policy – select the access policy you created earlier(e.g., Start).

      Internet access configuration

Usage charges

Link copied to clipboard

The rating list has two functions: it defines permitted access points (nodes and access numbers) and specifies which tariff should be used for billing in each of these points.

  1. On your product’s panel, click Charges, then click Usage charges.
  2. On the Usage charges panel, click Add.
  3. Fill in the required information:
    • Service – select Network access.
    • Node – select the Cisco NAS node.
    • Access code – leave this field empty.
    • Tariff – select the tariff that applies to your customers when they use the Internet service.
    • Overdraft protection – to configure overdraft protection for this product, consult the Configure Overdraft Protection Section within the Product section in the Overdraft Protection Configuration handbook.
  4. Click Save.

    Add usage charges

Charges

Link copied to clipboard

On the General info panel, you can define special pricing such as volume discounts, regular payments such as subscriptions and also set up overdraft protection.

  1. To access this panel, click Charges on your product’s panel, then click General info.
    Overdraft protection
    Link copied to clipboard
    • Use the slider to turn on/off overdraft protection. For obvious reasons, turning off overdraft protection is not recommended for general use.
    Default discount plan
    Link copied to clipboard
    • Default discount plan – select the volume discount plan to be associated with the Start package (Start Quota in our example). For the other two packages, select the corresponding volume discount plans.
    Subscription
    Link copied to clipboard
    • Subscriptions – this panel allows you to choose a subscription plan for the product. This subscription plan is then automatically applied to every account with this product assigned. Select the corresponding subscription plan from the list of subscription plans (Internet Access Start in our example).

      Add usage charges

  2. Click the Save button to save the Product.

Create a customer class

Link copied to clipboard

A customer class provides the ability to define the business model and a group of parameters in a centralized manner, and then apply those parameters to many customers simultaneously.

  1. On the navigation menu, select Sales, then select Customer classes.

    Dashboard

  2. On the Create a customer class panel, fill in the customer class details:
    • Name – type a short name for this customer class.
    • Business model – select which customers this customer class will apply. Select Internet access from the list.
    • Currency – specify in which currency you charge the customers of this customer class. When specified, this customer class can only be assigned to customers with the same currency. Note that you can define the currency only when you create the customer class and can't change it later.
    • Managed by – select Administrator only. Create a customer class.
  3. Click Save.
  4. On your customer class panel, click Finances, then click General info.
  5. On the General info panel, fill in general information about the customer class:
    • The billing period is closed – select Automatically.
    • Configure the Statistics parameters:
      • Generate invoices – leave this option enabled to generate invoices for customers who belong to this customer class.
      • Send statistics via email – define how you will provide statistics to your customers.
    • Configure the Status change parameters:
      • Suspend customers – enable so that PortaBilling check whether the customer has sufficient funds for their subscription charges.
      • Block debit accounts – enable so that PortaBilling check whether a debit account has sufficient funds for their subscription charges.

        Create a customer class

  6. On your customer class panel, click Finances, click Invoicing, then click Regular invoices.
  7. On the Regular invoices panel, specify the invoicing parameters for the customer class:
    • Use regular invoices – enable this parameter to generate regular invoices for customers who belong to this customer class.
    • Invoice template – select the appropriate template which will be used to create a .pdf file with the invoice for your customers (e.g., Internet Access invoice template).
    • Generate invoice pdf – leave the default option At the end of billing period selected.
    • Send invoices via email – select Automatically to automatically send an invoice to a customer at the end of a billing period.
    • Configure other Regular invoices parameters for customers. Click image065Help for a description of parameters available here.

      Reegular invoice configuration.

  8. On the Invoicing panel click Out-of-turn invoices and specify the invoicing parameters for the customer class as described in the previous step.
  9. On your customer class panel, click Finances, click Invoicing, and then click Taxation.
  10. On the Taxation panel, select one of the available taxation methods and specify the taxation parameters for it. Click image067Help for a description of parameters available here. For the Fixed VAT rate or Custom taxation methods, enable the Taxes included into rates/fees option and taxes that are calculated (for the Custom taxation method).

    Specify the taxation parameters.

  11. Click Save.

Create a customer

Link copied to clipboard

A customer is an owner of accounts. The customer’s contact information is used to distribute account usage information, internet access statistics, invoices, and so on. You will usually need to create one customer for each postpaid broadband user.

  1. On the navigation menu, select Sales, then select Customers.
  2. On the Create customer panel, fill in the customer details:
    • Name – type a short name for the customer object; this will be used on the web interface.
    • Balance control – specify the way the customer will pay for the service: Postpaid – after consuming the services; Prepaid – prior to consuming the services. Select Postpaid in this field.
    • Currency – choose the currency in which this customer will be billed.
    • Credit limit – assign a credit limit for the customer.
    • Business model ­– a business model defines what type of service is to be provided to the customer. Select Internet access for this customer.
    • Customer class – customer class allows you to define a policy for automated payment collection. By choosing a specific class here the customer will automatically inherit all of the class properties (grace period, invoice template, etc.). Select the previously created customer class.
    • Billing period – choose a billing period for the customer. A billing period defines the frequency of invoicing for this customer.
    • Billing period time zone – choose a time zone in which customer’s billing period will be closed and invoices will be generated.
  3. Click Save.

    Create a customer

Create accounts

Link copied to clipboard
  1. On your customer’s panel, click Accounts.
  2. On the Create an account panel, specify the account’s details:
    • ID – this is the ID that will be used to authorize a user for Internet access. Specify the user’s email address (e.g., johndoe@gmail.com)
    • Account role – select User@domain.
    • Product – select the main product that you want this account to have (e.g., Start).
    • Activation date – the date from which the account is usable.
    • Service password – the account ID and this password are used to authenticate Internet users. Make sure you choose a password that is difficult to guess or crack. Use the Auto button next to the Service password field to generate a secure password.
    • Type – select Credit for your postpaid Internet users.
    • Balance control – select Subordinate from the list.

      tips TIP: You may use the MAC address of the user’s device as an account ID (e.g., when provisioning Internet access via MAC bridges). To do this, make sure to select Universal from the Account role list both during product configuration and during account creation.

  3. Click Save.

    Create an account

  4. On the Account page, click Services and select Service configuration.
  5. On the Service configuration panel, select Internet access and configure the following parameters:
    • Static IP – use a slider to enable the parameter if you want to assign a static IP to this account (the default setting is Disabled).
    • Static IP – if you have Enabled for the previous field, type in an IP.
    • Static IP netmask – type in a netmask (e.g., 255.255.255.0).
    • Routed networks – leave the field empty or type in the route for your IPv4 network in the CIDR notation format – X.X.X.X/Y Z.Z.Z.Z where:
      • X.X.X.X is the IPv4 address that defines the network prefix;
      • Y is the decimal length of the network prefix mask;
      • Z.Z.Z.Z is the gateway IP address; it must belong to the network range.
        Any incorrect adjustment of the last parameter may affect the entire ISP network so please be sure that your settings are correct.
  6. Click Save.

    Account's service configuration

  7. Repeat steps 1–3 to create more accounts for the customer. For instance, a company to which you supply broadband services may have several internet users.

Check current volume discount statistics for account

Link copied to clipboard
  1. On your customer’s panel, click Accounts.
  2. Perform an account search and, when the required account is displayed, click on the account ID.
  3. On the Account page, click Services and select Bundles.

    Check current volume discount statistics for account

  4. On the Bundles panel, select Quotas and view the following information:
    • Service – shows the service type for which the discount is valid
    • Destination group – the destination group to which this discount applies.
    • Peak level – the peak level type this discount applies to (peak, off-peak or 2nd off-peak). In case of N/A, no off-peak levels are defined for the destination group in this volume discount plan and the same discount always applies.
    • Discount plan – the name of the volume discount plan that applies to this account.
    • Precedence – this is the priority level for the current volume discount plan that specifies the order in which certain discounts are applied.
    • Used…of…– shows the current value of both consumed and remaining discount volume (in minutes/megabytes or funds). The progress bar graphically reflects how much of the discounted service has been consumed.
    • Expires, days – shows the time left for the discount to be reapplied to the account.

Verify broadband event history for account

Link copied to clipboard

You can view transaction records (xDRs) for your account subscribers on their respective xDR History pages. To check how much time they have spent on the Internet or how much data they have uploaded/downloaded, go to their Service Usage Details pages. Account subscribers can do the same by visiting their self-care interfaces.

Viewing xDR history

Link copied to clipboard

To view an account’s xDRs, go to the Account page and click the xDRs button. On the Search panel choose the date range, select the service (Network access) and click Apply filters.

Viewing xDR History

tips You can also go to the account self-care page (accessible via the Accounts menu item in the Home popup menu).

Log in with the account’s web access login and password. After that, you will be able to see the account’s dashboard interface.

Log in to account self-care interface

In the Billing Information tab, click Transactions. Choose the date range that you want to see a list of access to the internet instances and click Show Records.

Define search parameters

In the results table you will see charges and other fees, such as maintenance fees or refunds (if any). The report can be downloaded by clicking the Download button.

Viewing service usage

Link copied to clipboard

While on Search panel choose the date range, select the service (Network access) and click Apply filters. Go to the Results panel, select the xDR and click the image078 Details icon.

Select the xDR

On the Netaccess session details page that opens, you can view the account’s statistics for chosen service type:

Brows the xDR details

On this page

Release
What's new
Admin manuals
Handbooks
API
UI help
Back to main menu
Search