|
|
| (5 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | == Bolt-On Add-On Overview == | + | =This Content Has Moved House= |
| | | | |
| − | A Bolt-on Add-on is designed to compliment bolt on subscriptions and allow for additional mini quotas (included value) to be added on underneath. Bolt-on add-ons are associated with bolt-ons in order to extend the capability of the bolt-on.
| + | This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base. |
| | | | |
| − | === Key Features ===
| + | We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to our new home. |
| | | | |
| − | * Bolt-on add-ons can be set up to recur or not recur.
| + | [https://resources.emersion.com/display/EKB/Bolt-On+Add-Ons+Construction+Overview Take me to the Emersion Knowledge Base article] |
| − | * Bolt-on add-ons have a BUY and SELL component like Bolt Ons, Package Plans, Service Plans, etc.
| |
| − | * Bolt-on add-ons can be purchased or acquired throughout the month and provide full bolt-on value for the remainder of the billing period.
| |
| − | * Some service types can automatically provision bolt on add-ons. This depends on the presence or absence of automatic provisioning between Emersion and the carrier/service provider.
| |
| − | * The multiple included value quotas provide for more than one type of quota to be defined. Up to four different types of included value are supported.
| |
| | | | |
| − | === Bolt-on Add-ons - An Addition to the Hierarchy of a Bolt-On ===
| + | [[file:new_home_sm.jpg|900px]] |
| − | | |
| − | If you use want to setup the complete structure from Package plan -> Bolt-on add-on, you will need to create both a buy and sell structure in accordance with the following diagram.
| |
| − | | |
| − | [[file:bolton-addon-overall-structure.png]] | |
| − | | |
| − | '''Wholesale Service Providers''': You will need to complete both the BUY and SELL sections of these articles
| |
| − | '''Retail Service Providers: Construction of the BUY side of the following sections is not required if you purchase your services from Wholesalers that exist in Emersion.
| |
| − | | |
| − | To complete this structure end-to-end you will need to complete these steps in order:
| |
| − | | |
| − | # Build the BUY Service Plan and BUY Package plan and link them.
| |
| − | # Build the SELL Service Plan and SELL Package plan and link them.
| |
| − | # Build the BUY Bolt-on.
| |
| − | # Build the SELL Bolt-on.
| |
| − | # Place the SELL bolt-on(s) into a bolt-on group. This step is required to link bolt-on(s) to a service plan.
| |
| − | # Build the BUY Bolt-on Add-on.
| |
| − | # Build the SELL Bolt-on Add-on.
| |
| − | # Place the BUY Bolt-on Add-on into a bolt-on add-on group. This step is required to link bolt-on(s) '''AND''' related bolt-on add-on(s) to a service plan.
| |
| − | # Place the SELL Bolt-on Add-on into a bolt-on add-on group. This step is required to link bolt-on(s) '''AND''' related bolt-on add-on(s) to a service plan.
| |
| − | # Link the BUY Bolt-on & bolt-on Add-on to the BUY Service Plan.
| |
| − | ## Includes setting the ''Included Value Allowances'' of the BUY Bolt-on Add-on.
| |
| − | # Link the SELL Bolt-on & bolt-on Add-on to the SELL Service Plan.
| |
| − | ## ## Includes setting the ''Included Value Allowances'' of the SELL Bolt-on Add-on.
| |
| − | | |
| − | Steps 1-5 above are not covered by the articles in this section. You can find how to create packages plans, service plans and bolt-ons in other sections of this Wiki, and the Packages & Plans User Guide.
| |
| − | | |
| − | == Building a Bolt-On Add-On ==
| |
| − | | |
| − | This section covers steps 6 and 7 in completing the hierarchy.
| |
| − | | |
| − | '''Navigate: Packages & Plans > Management > Bolt-On Add-On'''. A list of all existing Bolt On Add-Ons will be displayed. Click the '''Create New''' button.
| |
| − | | |
| − | The following fields are available:
| |
| − | | |
| − | [[file:1.CreateNewBoltOnAddOn.png]]
| |
| − | | |
| − | * '''Name''': Internal name for the Bolt-on Add-on.
| |
| − | * '''External Name''': A name for the Bolt-on Add-on. This will be used on the invoice and in the End User Portal.
| |
| − | * '''Reference Name''': Only use when instructed by Emersion.
| |
| − | * '''Reference Key''': Only use when instructed by Emersion.
| |
| − | * '''Import Reference''': Optional field referring to the bolt-on add-on if it has been sourced from another system.
| |
| − | * '''Description''': A description for the bolt-on add-on.
| |
| − | * '''Buy or Sell''': Defines whether the bolt-on add-on is defined as a BUY or SELL.
| |
| − | * '''Service type''': Select the Service Type the bolt-on add-on is for.
| |
| − | * '''Bolt-On Category''': Select the Bolt-on category.
| |
| − | * '''Tariff''': Select the tariff for this bolt-on add-on.
| |
| − | * '''Included Value Type''': Select the type of included value you want for the bolt-on add on.
| |
| − | | |
| − | When you are happy with the settings, click the '''Next''' button. This bolt-on add-on will be saved, but is not yet ready to be used.
| |
| − | | |
| − | Complete the rest of the fields.
| |
| − | | |
| − | [[file:2.CreateNewBoltOnAddOn-2ndScreen.png]]
| |
| − | | |
| − | * '''Is Provisioned''': If yes, you will need to supply the '''provisioning key''' that will be sent to the the supplier.
| |
| − | * '''Recurring Plan''': Set the bolt-on add-on to either recur or not recur
| |
| − | * '''Set up fee''': Define the set up fee. If there is no set up fee, leave blank.
| |
| − | * '''Access fee''': Define the access fee. If there is no access fee, leave blank.
| |
| − | * '''Pro Rata''': Define if the bolt-on add-on will be prorata. If no, the included value will not be prorated should a subscription be purchased during the middle of the billing cycle. If yes, the prorata applies to both the allocation and the access fee combined.
| |
| − | * '''Saleable from''': Defines what date the bolt-on add-on is made available to be sold via the ordering process.
| |
| − | | |
| − | ''Included value fields''
| |
| − | | |
| − | * '''Bonus type''': Choose which type of bonus applies.
| |
| − | * '''Included value''': Enter the numerical value of the bonus.
| |
| − | * '''Weight''': Enter the weighting.
| |
| − | | |
| − | ''Availability fields - Applicable for SELL bolt-on add-ons only''
| |
| − | | |
| − | * '''Available In API''': tick the box to make this bolt-on add-on available via the API
| |
| − | * '''Available In User Portal''': tick the box to make this bolt-on add-on available via the End User portal
| |
| − | | |
| − | == Placing Bolt-on Add-ons into Bolt-on Add-on Group ==
| |
| − | | |
| − | Once you have constructed BUY and SELL Bolt-on Add-on (step 6 & 7), you will need to add each to a bolt-on add-on group.
| |
| − | This step covers Step 8 & 9 in the hierarchy and is mandatory to enable the ability to link them to their respective service plans later in the process.
| |
| − | | |
| − | The '''Bolt-On Add-Ons Group tab''' contains search criteria find the bolt-on add-ons that are already attached to the bolt-on. This will be relevant should the number on Bolt-On Add-ons attached to the bolt-on becomes large. You can search on Internal and External names to locate the bolt-on add-on you are looking for.
| |
| − | | |
| − | === Adding the BUY Bolt-On Add-On to a group ===
| |
| − | | |
| − | '''Navigate: Packages & Plans > Management > Bolt-ons'''
| |
| − | # Find and open the BUY bolt-on that the bolt-on add-on is for.
| |
| − | # Click the ''Bolt-On Add-Ons Group'' tab.
| |
| − | # Clicking the '''Display list of available Bolt-on Add-ons''' button to display the list of bolt-on add-ons that can be linked to this bolt-on.
| |
| − | # Under the ''Action'' column, select the BUY bolt-on add-on that was created in step 6.
| |
| − | # Press the '''Save''' button.
| |
| − | | |
| − | === Adding the SELL Bolt-On Add-On to a group ===
| |
| − | | |
| − | ''Navigate: Packages & Plans > Management > Bolt-ons''
| |
| − | # Find and open the SELL bolt-on that the bolt-on add-on is for.
| |
| − | # Click the ''Bolt-On Add-Ons Group'' tab.
| |
| − | # Display the list of bolt-on add-ons that can be linked to this bolt-on by clicking the ''Display list of available Bolt-on Add-ons'' button. This will show you a list of bolt-on add-ons you can add to this bolt-on plan.
| |
| − | # Under the ''Action'' column, select the BUY bolt-on add-on that was created in step 6.
| |
| − | # Press the '''Save''' button.
| |
| − | | |
| − | Once you have finished your page should look like this
| |
| − | | |
| − | [[file:Add-bolton-addon-to-bolton-addon-group.png]]
| |
| − | | |
| − | == Linking a Bolt-on & Bolt-on Add-on to a Service plan ==
| |
| − | | |
| − | Linking a Bolt-on Add-on to a Bolt-on and then associating them with the relevant Service Plan is done via the process below. This is steps 10......xxxxxxxxx
| |
| − | | |
| − | By the end of the process you will have achieved the following:
| |
| − | | |
| − | * Create the associations between the Service Plan, the Bolt-On and the Bolt-On Add-on.
| |
| − | * Set the Bolt-on Add-on Plan Allowance(s).
| |
| − | * Optionally set Add-On exclusivity rules. These rules can prevent two add-ons coexisting at the same time.
| |
| − | | |
| − | This step requires you to have added the bolt-on(s) to a bolt-on group(s) (steps 8 & 9). If you have not completed all the steps correctly in the previous sections, you will be unable to link the bolt-on and the bolt-on add-on to the service plan and you may need to double-check your configuration.
| |
| − | | |
| − | === Link the BUY bolt-on & bolt-on Add-on to the BUY Service Plan ===
| |
| − | | |
| − | '''Navigate: Packages and Plans > Management > Service Plan
| |
| − | | |
| − | 1. Search for the BUY service plan you want to link the bolt-on and bolt-on add-on to. Remember to ensure BUY is selected in the '''Plan type''' field before hitting the '''Search''' button.<br />
| |
| − | 2. Drill into the Service plan to open it.<br />
| |
| − | 3. Click the '''Bolt-on Configuration''' tab. A list of the bolt-ons that are associated with this service plan will be displayed.<br />
| |
| − | | |
| − | '''!! Important''': If you have previously linked the Bolt-On to the Service plan, you cannot edit the settings to include the bolt-on add-on. You need to delete the link and recreate it. Use the '''Delete''' function under the Actions column to remove the bolt-on from the service plan.
| |
| − | | |
| − | 4. Click the '''Link Bolt-on''' button and Search for the buy Bolt-on. The bolt-on will appear in the ''Search Results'' section.<br />
| |
| − | 5. Select the desired bolt-on behaviour from the options in the list.<br />
| |
| − | | |
| − | ''Bolt-On Behaviour options''<br>
| |
| − | '''Forced, irremovable''': The bolt-on is a mandatory component of the service subscription and cannot be removed.<br>
| |
| − | '''Forced, removable''': The bolt-on is mandatory when an order is placed for a subscription to the service, but can be removed later.<br>
| |
| − | '''Completely Optional''': The bolt-on is optional.
| |
| − | | |
| − | 6. Expand the ''Bolt-On Add-On Plan Information'' section by clicking the magnifying glass icon.<br />
| |
| − | | |
| − | [[file:Link-bolton-with-addon-2.png]]
| |
| − | | |
| − | 7. Select from the list of available bolt-on add-ons the one you want to link.<br />
| |
| − | 8. Click the '''Attach Bolt-On Add-On Plan''' button.
| |
| − | | |
| − | This will display the Add-on Plan section where you can set the included value allowances.
| |
| − | | |
| − | ''Allowance Settings''<br>
| |
| − | '''Bolt-On Add-On Max Occurrence:''' Defines how many bolt-on add-ons can be purchased against this service.<br>
| |
| − | '''Bolt-On Add-On Description:''' Enter an optional description. This is not shown outside Cumulus (e.g On an Invoice or the End User Portal)
| |
| − | | |
| − | 9. When you are happy with the allowance settings, click the '''Add Bolt-On Allowance''' button to save the settings.
| |
| − | | |
| − | Once you have completed all the steps to link the bolt-on and bolt-on add-on to the Service Plan, your screen should look like this below.
| |
| − | | |
| − | [[file:Link-bolton-with-addon-3-finished.png]]
| |
| − | | |
| − | | |
| − | --------
| |
| − | | |
| − | === Link the SELL bolt-on & bolt-on Add-on to the SELL Service Plan ===
| |
| − | | |
| − | Linking the SELL bolt-on & bolt-on Add-on to the SELL Service plan follows the same steps for the BUY plan, except you are linking SELL Service Plans with SELL Bolt-ons and SELL Bolt-on Add-ons.
| |
| − | | |
| − | '''Navigate: Packages and Plans > Management > Service Plan
| |
| − | | |
| − | 1. Search for the SELL service plan you want to link the bolt-on and bolt-on add-on to. Remember to ensure SELL is selected in the '''Plan type''' field before hitting the '''Search''' button.<br />
| |
| − | 2. Drill into the Service plan to open it.<br />
| |
| − | 3. Click the '''Bolt-on Configuration''' tab. A list of the bolt-ons that are associated with this service plan will be displayed.<br />
| |
| − | | |
| − | '''!! Important''': If you have previously linked the Bolt-On to the Service plan, you cannot edit the settings to include the bolt-on add-on. You need to delete the link and recreate it. Use the '''Delete''' function under the Actions column to remove the bolt-on from the service plan.
| |
| − | | |
| − | 4. Click the '''Link Bolt-on''' button and Search for the buy Bolt-on. The bolt-on will appear in the ''Search Results'' section.<br />
| |
| − | 5. Select the desired bolt-on behaviour from the options in the list.<br />
| |
| − | | |
| − | ''Bolt-On Behaviour options''<br>
| |
| − | '''Forced, irremovable''': The bolt-on is a mandatory component of the service subscription and cannot be removed.<br>
| |
| − | '''Forced, removable''': The bolt-on is mandatory when an order is placed for a subscription to the service, but can be removed later.<br>
| |
| − | '''Completely Optional''': The bolt-on is optional.
| |
| − | | |
| − | 6. Expand the ''Bolt-On Add-On Plan Information'' section by clicking the magnifying glass icon.<br />
| |
| − | 7. Select from the list of available bolt-on add-ons the one you want to link.<br />
| |
| − | 8. Click the '''Attach Bolt-On Add-On Plan''' button.
| |
| − | | |
| − | This will display the Add-on Plan section where you can set the included value allowances.
| |
| − | | |
| − | ''Allowance Settings''<br>
| |
| − | '''Bolt-On Add-On Max Occurrence:''' Defines how many bolt-on add-ons can be purchased against this service.<br>
| |
| − | '''Bolt-On Add-On Description:''' Enter an optional description. This is not shown outside Cumulus (e.g On an Invoice or the End User Portal)
| |
| − | | |
| − | 9. When you are happy with the allowance settings, click the '''Add Bolt-On Allowance''' button to save the settings.
| |
