Overview
This article covers how to create a bolt-on add-on plan.
This article is one part of a series that covers the plan construction of bolt-on add-on plans.
At the conclusion of the steps presented below, steps 6 and 7 of the process to construct a bolt-on add-on plan and prepare it for sale will be achieved.
Create a Bolt-On Add-On
Packages & Plans > Management > Bolt-On Add-Ons
A list of all existing bolt-on add-ons will be displayed.
Click the Create New button.
The Create New Bolt-on Add-on page will be shown.
Complete the following fields:
| Field Label | Description | Editable When Active? |
|---|---|---|
| Internal Name | Internal name for the bolt-on add-on plan. | Yes |
| External Name | A name for the add-on plan. This will be used on the invoice and on the external portals. | Yes |
| Reference Name | Only use when instructed by Emersion. | Yes |
| Reference Key | Only use when instructed by Emersion. | Yes |
| Import Reference | Optional field referring to the bolt-on add-on if it has been sourced from another system. | Yes |
| Description | A description for the bolt-on add-on. | Yes |
| External Description | A customer-facing description of the plan. | Yes |
| Buy or Sell | Defines whether the bolt-on add-on is defined as a BUY or SELL plan. | No |
| Service Type | Select the service type the bolt-on add-on is for. | No |
| Bolt-on Category | Select the bolt-on category. | No |
| Tariff | Select the tariff for this bolt-on add-on. | No |
| Included Value Type | Select the type of included value you want for the bolt-on add on. | No |
When you are happy with the settings, click the Next button. At this point, the new add-on plan is saved.
The remaining configuration of this plan is completed in the Edit Bolt-on Add-on management screen.
Complete the rest of the fields.
| Field Label | Description | Editable When Active? |
|---|---|---|
| Is Provisioned? | If the add-on belongs to a service type that is automatically-provisioned on the network, tick the flag. If used, a provisioning key needs to be supplied. This will be provided by your supplier/carrier. | No |
| Provisioning Method | If the add-on belongs to a service type that is automatically-provisioned on the network, choose whether it is By Period or By Subscription. | No |
| Provisioning Key for Supplier | If the add-on belongs to a service type that is automatically-provisioned on the network, enter the provisioning key provided by your supplier/carrier. | No |
| Recurring Plan | Set the bolt-on add-on to either recur or not recur. | No |
| Setup Fee | Define the set up fee. If there is no set up fee, leave blank. | Yes |
| Access Fee | Define the access fee. If there is no access fee, leave blank. | Yes |
| Pro Rata | Define if the add-on will be prorated. If not, the included value will not be prorated should a subscription be purchased during the middle of the billing cycle. If yes, it applies to both the allocation and the access fee combined. | No |
| Saleable From | Defines what date the add-on is made available to be sold via the ordering process. | No |
| Saleable To | Defines an end date for the plan. It cannot be sold after this date. | Yes |
| Approval Status | Choose an approval status. | Yes |
| Prevent Multiple Preactive Subscriptions | Using this flag will prevent multiple preactive add-ons subscriptions to this add-on from occurring concurrently. | No |
Emersion strongly recommends creating all plans as a draft until they are fully constructed, peer reviewed and are ready to be formally approved.
Included value fields
| Field Label | Description | Editable When Active? |
|---|---|---|
| Bonus Type | Choose which type of bonus applies. | No |
| Included Value | Enter the numerical value of the bonus. | No |
| Weight | Provides the ability to define which add-on takes priority over others. | Yes |
Availability fields - Applicable for SELL bolt-on add-ons only
| Field Label | Description | Editable When Active? |
|---|---|---|
| Available in User Portal | tick the box to make this bolt-on add-on available via the API. | Yes |
| Available in API | tick the box to make this bolt-on add-on available via the end user portal. | Yes |
Press the Save button to save the plan.
<<< Previous Step
Next Step >>>
Once you have constructed the BUY (if applicable) and SELL bolt-on add-on plans, the next step is to add each add-on plan to a bolt-on add-on group. This covers steps 8 and 9 of the process to construct a bolt-on add-on plan and prepare it for sale.