Release

Search

Online web signup configuration

Link copied to clipboard

Introduction

Link copied to clipboard

Online signup allows for automated account creation. Once an end user fills in a subscription form with their credit card information, the account is created in PortaBilling and the end user receives the credentials necessary for making phone calls.

In its current implementation, the online signup service is provided via the reseller entity. Note that only one reseller per installation can provide this service.

The online signup is provided in PortaBilling as an example. You can use the current implementation of the service or customize it for your needs using the PortaBilling API.

Scenario

Link copied to clipboard

A service provider wants to create an online signup page, where all comers will be able to pick up a phone number, specify the device they will use and sign up for the service.

Signing up for the service costs 5.00 USD. There is no recurring fee for the service; end users are only charged for calls according to predefined tariffs.

One of the following devices can be provisioned for users for free:

  • Sipura 1001
  • Sipura 2000
  • Linksys SPA-941

After sign up, end users will have the “SuperCall” product assigned to them.

“Best DIDs” vendor supplies available phone numbers.

Actions that must be performed via the admin interface

Link copied to clipboard

Preconditions

Link copied to clipboard

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

Create a dummy reseller

Link copied to clipboard

You will use this entity for providing service.

Create a tariff to charge a dummy reseller

Link copied to clipboard

Though this is a dummy entity and you are not really going to charge it, a tariff is still required to ensure proper billing for users who have signed up for the service.

The tariff created in this step is named “BaseResTariff.”

To create a reseller tariff, perform the following:

  1. On the navigation menu, select Service catalog and then Tariffs.

    Open the Tariffs panel.

  2. On the Create tariff panel, fill specify the basic tariff information:
    • In the Name field, type “BaseResTariff.”
    • From the Currency list, select USD.
    • From the Service list, select Voice calls.
    • From the Applied to list, select Reseller.

      Create reseller tariff

  3. Click Save.

Enter rates to the tariff

Link copied to clipboard
  1. While on the Edit Tariff panel, click Rates.
  2. On the Add rate panel fill in the rate details:
  3. Type ‘|’ (pipe) in the Destination field and set zero as the price. Leave the other fields in the form as they are, because there are no actual costs associated with the reseller.

    Add rate

    Tariff rate list

  4. Click Save to save the rate.

Create a dummy reseller

Link copied to clipboard
  1. On the navigation menu, select Sales, then Sales agents and then click Resellers.
  2. On the Add reseller panel, specify the basic reseller information:
    • In the Name field, type the reseller name (e.g., “CallLeague.”)
    • From the Currency list, select USD.
    • Select the tariff you have created to charge the reseller in the The default tariff for voice calls list.
    • Leave other fields with their default values.
    • Click Save.

      Add a reseller

  3. On the Edit reseller panel navigate to the Web self-care panel.
  4. Specify the credentials on the reseller self-care interface:
    • In the Login field, type “callleague.”
    • Click the image008 Auto icon next to the Password field to auto-generate a password.

      Specify credentials

  5. Click the Save button to save the customer configuration.

Create a product to assign to end users

Link copied to clipboard

Create a tariff to charge end users for voice calls

Link copied to clipboard

Create a “SuperCallTariff” tariff that will be used to charge end users subscribed to the service via online web signup. Since these users are considered to be the reseller’s customers, create the tariff as managed by that reseller.

To create this tariff, complete the steps described in the Create a tariff to charge a dummy reseller section, but in step 2:

  • Type “SuperCallTariff” in the Name field,
  • From the Applied to list, select Customer.
  • From the Managed by list, select your dummy reseller (CallLeague in our example).

    Add customer tariff

Add rates to the tariff
Link copied to clipboard

To upload rates, follow the instructions provided in the Rate import handbook.

To add rates one-by-one, do the following:

  1. On the edit Tariff panel, click Rates.

    Add a rate

  2. On the Add rate panel fill in the rate details:
    • Destination – select a destination prefix from the list or type it in directly.
    • Rating mode – select Flat rate here.
    • First interval, seconds – type a first billing unit in seconds.
    • Next interval, seconds – type the next billing unit in seconds.
    • First price – type a per minute price for a first interval.
    • Next price – type a per minute price for the next interval.
  3. Click Save.
  4. Repeat these steps for all the rates.

Create a subscription to charge end users for service activation

Link copied to clipboard

When you charge for service activation, you need to create a subscription plan that has and define an activation fee within.

  1. On the navigation menu, click Service catalog and then Subscriptions.
  2. On the Create subscription panel, specify the basic subscription information:
    • In the Name field, type “SignupActivation.”
    • In the Subscription name visible to end users field, type “Super Call Activation.”
    • From the Currency list, select USD.
    • From the Managed by list, select CallLeague.
    • In the Activation fee field, type “5.00.”
    • In the Monthly fee field, type “9.99.”

      Create subscription plan

  3. Click Save.

Create a product

Link copied to clipboard
  1. On the navigation menu, select Service catalog and click Products.
  2. On the Create product panel specify the basic product information:
    • In the Name field, type “SuperCall.”
    • In the Name visible to end users field, type “SuperCall.”
    • For Product type, select the Main product option.
    • From the Currency list, select USD.
    • From the Managed by list, select CallLeague.
    • From the Account role list, select Phone line.

      Add a product

  3. Click Save.
  4. Go to the Services panel.
  5. Click Add a Service and select the Voice calls checkbox.
  6. Click Add.

    Add service

  7. Go to the Usage charges panel.
  8. Click Add.
  9. Specify the charging parameters:
    • From the Service list, select Voice calls.
    • From the Node field, select the PortaSIP node.
    • From the Tariff list, select SuperCallTariff.
    • Select the tariff you have previously created for to the dummy reseller from the Reseller tariff list. You can leave the Default tariff entry since it corresponds to the reseller’s tariff.

      Add usage charges

  10. From the Charges section click General info.
  11. On the Charges panel, select SignupActivation from the Recurring charges list.

    image017

  12. Click Save.

Add provisioned devices

Link copied to clipboard

End users are able to choose the device they will use during online web signup.

Create CPE profiles

Link copied to clipboard
  1. On the navigation menu, select Infrastructure, then select Inventory and click Phones/CPEs.
  2. On the CPEs Inventory panel, select CPE profiles. On the Create a profile panel that opens, specify the basic CPE profile information:
    • Name – type “Sipura 1001.”
    • Device model – select “Sipura 1001” from the dropdown list.
    • Managed by – select CallLeague.

      Add provisioned devices

  3. Click Save.
  4. If necessary, change the profile configuration.

    Configure the profile

  5. Click Save.
  6. Repeat steps 2–5 for Sipura 2000 and Linksys SPA-941, providing corresponding names and types in step 2.

Add CPE devices

Link copied to clipboard

In this step, you will add devices that will be used by your end users.

A device name should correspond to a certain pattern. For example, for Sipura 1001 the pattern looks like this: % Sipura 1001 %. Thus, the device name can be specified as Sipura 1001_1 or _1 Sipura 1001 _1 or _1 Sipura 1001, etc.

  1. On the navigation menu, select Infrastructure, then select Inventory and click Phones/CPEs.
  2. On the CPEs Inventory panel, select Phones/CPEs list. On the Create CPE panel that opens, specify the basic CPE device information:
    • Device ID – type Sipura 1001_1 here.
    • Device model – select Sipura 1001 from the dropdown list.
    • MAC address – specify the MAC address of this device.
    • Managed by – select CallLeague from the dropdown list.
    • CPE profile – select Sipura 1001.

      image020

  3. Click Save.
  4. Repeat these steps for all of the devices, providing their corresponding names, models, profiles and required MAC addresses as in step 2.

Upload DID numbers that will be used for sign-up to the DID inventory

Link copied to clipboard

Upload DID numbers to the DID inventory

Link copied to clipboard

Perform the Create a DID supplier vendor, Create a DID batch for the vendor, Upload DID numbers and Release DID numbers to the DID pool steps as described in the Managing DIDs for customers manually (DID inventory) handbook.

Grant access to the DID pool to the dummy reseller

Link copied to clipboard

Create a pricing batch that will be assigned to the dummy reseller

Link copied to clipboard
  1. On the navigation menu, select Infrastructure, then Inventory and click DID inventory.
  2. On the DID inventory panel, click Pricing batches.
  3. On the Create a pricing batch panel, specify the following information:
    • In the Name field, type “NY_DIDs.”
    • From the Applied to list, select Reseller.
    • In the Type list, select Inventoried.

      image022

  4. In the Pricing parameters section, specify the following information:
    • Select USD - US Dollar from the Currency list.
    • In the Additional activation fee field, type “0.”
    • In the Additional recurring fee field, type “0.”
    • In the Recurring fee markup, % field, type “0.”
  5. Click Save at the bottom of the panel.

Assign a pricing batch to the dummy reseller

Link copied to clipboard
  1. On the navigation menu, select Sales, then Sales agents and then click Resellers.
  2. On the Reseller list panel, click CallLeague.
  3. On the Edit Reseller panel, select Company info > General info and then click Additional info.
  4. On the Additional info panel from the Auto-Provision DIDs via Batch list, select NY_DIDs.

    image023

  5. Click Save on the toolbar.

Actions that must be performed via reseller self-care

Link copied to clipboard

Log in to a reseller self-care interface

Link copied to clipboard
  1. On the navigation menu, select Sales, then Sales agents and then click Resellers.
  2. On the Reseller list panel, click CallLeague.
  3. On the Edit Reseller panel, select Company info > General info and then click Web self-care page.
  4. Click the image025 Login icon next to the Login field.

Create DID pricing batches

Link copied to clipboard

At this step, you need to create two pricing batches: a free owner batch and the one with the DID markup.

Create a free pricing batch

Link copied to clipboard
  1. On the Main Menu page, click DID Inventory.
  2. On the DID Inventory page, click Pricing Batches on the toolbar.
  3. On the DID InventoryPricing Batches page, click Add on the toolbar.
  4. Specify the following information:
    • Specify the batch name in the Name field, (e.g., “NY_DIDs_User.”)
    • From the Applied To list, select Customer.

      Create a pricing batch

  5. Click the Pricing Parameters link in the header of the corresponding column.
  6. In the DID Pricing Parameters dialog, specify the following information:
    • In the DIDs section, select Use already Inventoried.
    • In the Pricing Parameters section, select FREE DIDs.

      Create a pricing batch

  7. Click Save.
  8. Click the save Save icon.

Add DID numbers to a free pricing batch

Link copied to clipboard
  1. On the Main Menu page, click DID Inventory.
  2. On the DID Inventory page, click Pricing Batches on the toolbar.
  3. In the left-hand section of the page, select the Assign Pricing Batch option and select NY_DIDs_User from the corresponding list.

    Add DID numbers to a free pricing batch

  4. Click Apply.

Create a pricing batch with pricing parameters

Link copied to clipboard

When DID numbers are not supplied on demand, this pricing batch is only used for technical needs in the configuration.

  1. On the Main Menu page, click DID Inventory.
  2. On the DID Inventory page, click Pricing Batches on the toolbar.
  3. On the DID Inventory - Pricing Batches page, click Add on the toolbar.
  4. Specify the following information:
    • Type the batch name in the Name field (e.g., “NY_DIDs_User_Paid.”)
    • From the Applied To list, select Customer.
  5. Click the Pricing Parameters link in the header of the corresponding column.
  6. In the DID Pricing Parameters dialog box, specify the following information:
    • In the DIDs section, select Use already Inventoried.
    • In the Pricing Parameters section:
      • Currency – choose the currency used to charge for DID usage.
      • Additional Activation Fee – specify an amount you want to charge in addition to a DID provider’s activation fee. Type 3 here.
      • Additional Recurring Fee – specify an amount that is always included in the recurring (e.g., monthly) charge. Type 1 here.
      • Recurring Fee Markup – specify a markup that will be included in the recurring amount charged to the customer in addition to the actual DID cost (charged by a DID vendor). Type 0 here.
      • Round the Final Charge Amount – specify the rounding pattern to obtain “marketable” figures. This will specify the last “pre-set” digits in the figure.

        Create a pricing batch with pricing parameters

  7. Click Save.
  8. Click the save Save icon.

Add a payment system

Link copied to clipboard

To enable end users to pay for their service online, you need to add a payment system for your dummy reseller and then connect it to a currency.

You can use only payment systems that do not require external authorization.

Configure a payment system

Link copied to clipboard

As an example, an AuthorizeNet payment processor is used and that the CVV check is not required. For more information on how to configure the payment system, please see the Credit card payments handbook.

Note that for your dummy reseller, you can use the same payment processor and credentials as you use on the admin interface. However, you must give a different name to the payment system configured on the reseller self-care.

  1. On the Main Menu page of the admin interface, click E-Payment Systems.
  2. On the E-Payment Systems page, click Add on the toolbar.

    Add a payment system

  3. In the dialog box specify the following information:
    • Name – type in “AuthorizeNet”.
    • Payment processor – select AuthorizeNet.  
    • Login – type in “Auth_Login”.
    • Password – type in “auth_pass”.
    • Select Visa or MasterCard checkboxes.
    • CVV required – leave this checkbox clear.
  4. Click Add.

Assign a payment system for a particular currency

Link copied to clipboard
  1. On the Main Menu page of the reseller self-care interface, click Currencies.
  2. On the Currencies page, choose USD.
  3. Click the Edit icon.
  4. Specify the following information:
    • Payment System – select AuthorizeNet.
    • Minimum Payment – type “5.”

      image033

  5. Click Save.

Actions that must be performed via the Configuration server web interface

Link copied to clipboard

Configure signup

Link copied to clipboard

Enable signup

Link copied to clipboard
  1. Clone the current configuration.
  2. In the Configuration Tree, click ClusterSuite and select Web Cluster.
  3. In the Environments panel, click Global.
  4. In the Groups panel, click VirtualHostsSignup.
  5. For the enabled option, select Yes.

    Enable online web signup

  6. Click the Save button and then the check_apply Verify button.
  7. Verify the new configuration and click the check_apply Check/Apply button.

Configure signup options

Link copied to clipboard
  1. Clone the current configuration.
  2. In the Configuration Tree, click the Admin node.
  3. In the Environments panel, click Global.
  4. In the Groups panel, click Signup and define the following options:
    • activation_price – this is how much service activation costs. It must be the same amount as that specified for the activation fee in the subscription plan assigned to the end user product. Type “5.00.”
    • currency – here you can define the currency in the iso_4217 format in which customers will be created. Leave the default “USD” value here.
    • did_owner_batch_name – this pricing batch defines how end users are charged for DIDs. Type “NY_DIDs_User.”
    • did_provision_batch_name – type “NY_DIDs_User_Paid.”
    • login – type the login for the dummy reseller self-care, i.e., “callleague.”
    • password – type the password for the dummy reseller self-care, i.e., “callleague1.”
    • product_price – this is how much service usage costs (in addition to charges for the calls themselves). This must be the same amount as the one specified for the recurring fee in the subscription plan assigned to the end user product. Type “0.00.”
    • device_list – add the following lines here:
      • device=sipura1001;name=Sipura_1001;price=0;product_name=SuperCall
      • device=sipura2000;name=Sipura_2000;price=0;product_name=SuperCall
      • device=Linksys;name=Linksys SPA-941;price=0;product_name=SuperCall.

        image037

  5. Click Verify.
  6. Click Check/Apply and apply the configuration.

The online web signup configuration is done. To test it and sign up for the service online, please refer to the Performing online web signup handbook.

On this page

Release
What's new
Admin manuals
Handbooks
API
UI help
Search