Difference between revisions of "ServicePlans/ServicePlans/Included Value"

From Emersion
Jump to: navigation, search
(→‎Bolt-on Subscription Cap Threshold Notification Event)
(→‎Service Plan Included Value Settings:)
 
(32 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
== Included Value Overview ==
+
{{DISPLAYTITLE: Included Value for Service Plans}}
 +
= Included Value Overview =
  
−
As of Tuesday 24th February 2015, Emersion will remove support for 'caps' on Package Plans and Service Plans and replaced it with 'included value'. While included value is similar in nature to plan caps, they are not identical. Included value introduces features not supported under the plan cap feature.  
+
With subscription-based services, it is very common to see a subscription include a limited (or unlimited) amount of value of whatever service that is being offered. This is commonly referred to as 'Included Value'.
  
−
The upgrade also requires important updates to the following Subscription threshold notification events, also often referred to as TCP Alerts. The events that will be changed are:
+
Examples of included value might be:
  
−
# Service Subscription Cap Threshold Notification Event
+
* A mobile subscription with $300.00 worth of Australian calls
−
# Service Bolt-on Subscription Cap Threshold Notification Event
+
* A 4G service with up to 3GB of data a month
 +
* A mobile subscription with 500 SMS/MMS per month.
 +
* unlimited texting
 +
* A subscription to cloud storage with 1TB of storage
  
−
''You will need to review and update the Service Subscription Cap Threshold Notification Event templates immediately after the release. Failure to do so may result in incorrect information being sent to your customers.''
+
Specifically for the Australian telco market, the term 'included value' has a defined meaning. [http://www.acma.gov.au/theACMA/what-is-an-included-value-plan-acma See More..]
  
−
== Features of Included Value ==
+
In Emersion, the included value features provides a way for service providers to offer their customers a plan with a single included value option. The type of value that can be included can be:
−
 
 
−
Under caps, Emersion provided support for a single dollar-based cap against a plan. There was no support for multiple caps, or caps that were not dollar-based amounts.
 
−
Included value introduces multiple included value amounts. Furthermore, you can have different types of included value. The types of included value are:
 
 
* dollar
 
* dollar
 
* kilobytes
 
* kilobytes
Line 19: Line 20:
 
* seconds (converted to HH:MM:SS when presented to users)
 
* seconds (converted to HH:MM:SS when presented to users)
  
−
For each plan, Emerson can support up to 4 included value amounts. By default, Emersion will enable 1 included value amount for you to use. If you would like to have additional included value amounts for your plans, please raise a sales ticket in the Emersion Support portal and the sales team will be glad to provide a quote.  
+
For example, a plan can be set up to include:
 +
 
 +
* a mobile phone service with $300.00 worth of calls within Australia; OR
 +
* an ADSL service that includes up to 50GB of data a month; OR
 +
* 500 SMS/MMS per month.
 +
 
 +
== Single vs Multiple Included Value ==
 +
 
 +
By default, all Emersion clients can set up a plan with a ''single'' included value amount. A single amount of a single type can be configured per plan. <br />
  
−
=== Included Value Plan Settings ===
+
Multiple included value extends this support to allow up to 4 included value options on a service plan and a single included value option on a package plan. The type of included value you can offer on a plan is also extended to more than one type.
  
−
The settings page of Package Plans and Service plans is updated so that cap settings are replaced with Included value settings. Editing or creating a new Rate inside a rate card has also been changed so you can allocate a tariff to be
+
Extending the 'single' examples from above, multiple included value allows you to support a package plan that includes:
  
−
==== Package Plans ====
+
* a mobile phone service with $300.00 worth of calls within Australia; AND
 +
* an ADSL service that includes up to 50GB of data a month; AND
 +
* 500 SMS/MMS per month.
 +
<br />
 +
'''Multiple included value amounts for your plans require an additional subscription. Should you wish to offer multiple included values, please contact Emersion Sales by emailing [mailto:sales@emersion.com.au sales@emersion.com.au]'''
  
−
'''Navigate: Package and Plans > Management > Package Plan'''
+
== Included Value Settings ==
  
−
Below is a screenshot of the Package Plan configuration screen showing support for caps. The Group Cap feature will be removed:
+
The settings pages of Package Plans, Service plans and Rate Cards all contain settings relevant to configuring a plan with included value correctly. Once configured, a tariff inside a rate card can be allocated to an '''included value slot''. Multiple tariffs can be mapped to the same slot. If a tariff is mapped to a slot, the usage for that tariff is counted towards the customer's included value quota.  
  
−
[[file: package-plan-cap-settings.png]]
+
The slot is then allocated to a service plan.
  
−
Below is a screenshot of the Package Plan configuration screen showing the 4 new Included Value options. By default, Emersion offers a single included value option with all types (dollar, kilobytes, units, seconds).
+
=== Service Plan Included Value Settings: ===
  
−
[[file: package-plan-included-value-settings.png]]
+
* Included Value Slot Type: Select the slot from the available list.
 +
* Included Value Pro Rata: Select Yes if you want the included value to be pro rated. (eg. If set to Yes and the included value offering is $100 and that service starts in the middle of a 1 month period, the service would only have approx $50 available included value)
 +
* Value and type: The amount or value that will be included each period. Enter a number into the value field and select the type from the options available in the drop down.
 +
* Internal name: Give your included value a name (e.g. 50 SMSs, $400 Australian calls, etc).
 +
* External name: This name will be displayed in place of the name wherever it is presented externally. E.g. On an invoice, in the End User portal.
 +
* Is Excess Sharing activated for this slot?: Tick this option if any excess usage is to be distributed across multiple services (of the same service type) that belong to the same account. This requires all services to be on a plan that is also configured to allow usage excess sharing.
 +
** Note: If this is enabled, you have the optional ability to specify a 'Share Key'. Setting this restricts excess sharing to plans that have the same share key only.
  
−
==== Service Plans ====
+
For an example of configuring Included Value, see --> [https://wiki.emersion.com/wiki/index.php/ServicePlans/ServicePlans/Included_Value/Included_Value_Settings Configure a plan with Included Value]
  
−
'''Navigate: Package and Plans > Management > Service Plan'''
+
=== Included Value Types ===
  
−
The existing ‘Usage Cap’ and Share Cap fields will be removed from Service Plan
+
The following types of included value can be set up.
  
−
[[file: service-plan-cap-settings.png]]
+
'''Dollars:''' Displays with a dollar sign $ and will be rounded to 2 decimal places. Usage is stored as an ex-tax figure but in the event notifications is rendered to customers.  
  
−
They are being replaced with a new tab, called Service Plan Included Value
+
'''Kilobytes:''' Kilobytes will display GB, MB, or KB depending on the figure. For example, 1572864 kilobytes would be displayed at 1.5 Gigabytes, while 2855 kilobytes would displayed as 2.79 MB.  This is dynamic depending on how much data is available.
  
−
[[file: service-plan-included-value-settings.png]]
+
'''Units:''' Displays the number of units.
 +
 
 +
'''Seconds:'''  Like Kilobytes, time is recorded as seconds internally, but will be converted to hours/minutes/seconds.  600 seconds would show as 10 minutes, where 2700 seconds would show as 2 hours. 8774 seconds would be displayed as 2hrs 26min 14sec.
  
 
== Changes to Subscription Threshold Notification Events (TCP Alerts) ==
 
== Changes to Subscription Threshold Notification Events (TCP Alerts) ==
  
−
In order for the subscription threshold notification events to support included value and bolt-on add-ons, Emersion upgraded the two existing events and will shortly release an additional event for clients who subscribe to bolt-on add-ons.
+
In order for the subscription threshold notification events to support included value and bolt-on add-ons, Emersion upgraded the two existing events and will in the next release, include an additional subscription threshold notification event for clients who subscribe to [[ServicePlans/BoltOnAddOn|bolt-on add-ons]].
  
 
=== Service Subscription Cap Threshold Notification Event ===
 
=== Service Subscription Cap Threshold Notification Event ===
Line 63: Line 84:
 
* Some variables can no longer be supported and will be deprecated.
 
* Some variables can no longer be supported and will be deprecated.
  
−
Variable changes are highlighted in the table below. If the variable is not listed, it has not been changed. Please be aware that we have displayed the labels for variables. Underlying variable %%tags%% may not have changed.
+
Variable changes are highlighted in the table below. If the variable is not listed, it has not been changed.  
 +
 
 +
''Note Labels for variables are displayed in the table below. The underlying variable as seen in the template as %%tags%% may or may not have changed''.  
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 94: Line 117:
 
The following changes apply to this event:
 
The following changes apply to this event:
  
−
* The name of this event has changed to '''Bolt-On Included Value Threshold Notification'''.
+
* The name of this event will change to '''Bolt-On Included Value Threshold Notification'''.
 
* Some variable labels have been changed to make them consistent with other events and better describe their function. Please note that no underlying %%tags%% have been changed. These are label changes only.
 
* Some variable labels have been changed to make them consistent with other events and better describe their function. Please note that no underlying %%tags%% have been changed. These are label changes only.
 +
* Some variables will be removed after Tuesday 10 March, 2015.
 
* New variables will be added in the coming weeks.
 
* New variables will be added in the coming weeks.
−
* Some variables will be removed in the coming weeks.
 
  
−
Variable changes are highlighted in the table below. If the variable is not listed, it has (and will not) be changed.
+
Variable changes are highlighted in the table below. If the variable is not listed, it has not been changed.
 +
 
 +
''Note Labels for variables are displayed in the table below. The underlying variable as seen in the template as %%tags%% may or may not have changed''.  
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|+Bolt-On Subscription Notification Variables
 
|+Bolt-On Subscription Notification Variables
−
|'''Cap variable''' || '''Included Value Variable''' || '''Description and Notes'''
+
|'''Cap variable Variable''' || '''Included Value Variable''' || '''Description and Change Notes'''
 
|-
 
|-
−
|Cap Base Amount || N/A || This variable has been removed.
+
|Cap Base Amount in MB || Included value total || No longer supporting only data usage with a conversion to megabytes, this variable now supports all included value types and converts the data to a client-friendly format, taking into account any prorata amount. If the type is dollar-based it will be inclusive of tax.
−
|-
 
−
|Cap Base Amount MB || Included value total || No longer supporting only data usage with a conversion to Megabytes, this variable supports all included value types and converts the data to a client-friendly format, taking into account any prorata amount.
 
 
|-
 
|-
 
|Cap Amount || Included value prorata || The included value taking into account any prorata period.
 
|Cap Amount || Included value prorata || The included value taking into account any prorata period.
Line 113: Line 136:
 
|Max Type Name ||  Included value type || The type of included value (Dollars, Kilobytes, Seconds & Units). Templates found using '''Max Type Name''' will be automatically transitioned to the Included Value equivalent variable.
 
|Max Type Name ||  Included value type || The type of included value (Dollars, Kilobytes, Seconds & Units). Templates found using '''Max Type Name''' will be automatically transitioned to the Included Value equivalent variable.
 
|-
 
|-
−
|Current Usage MB ||Included value used ||  The amount of usage that has been used in the period so far. This data is converted to a client-friendly format based on the type. Templates found using '''Current Usage MB''' will be automatically transitioned to the Included Value equivalent variable.
+
|Current Usage in MB ||Included value used ||  The amount of usage that has been used in the period so far. This data is converted to a client-friendly format based on the type. Templates found using '''Current Usage MB''' will be automatically transitioned to the Included Value equivalent variable.
 
|-
 
|-
 
|Current Usage Left in MB ||Included value remaining || The included value remaining taking into account any prorata period. Templates found using '''Current Usage Left in MB''' will be automatically transitioned to the Included Value equivalent variable.
 
|Current Usage Left in MB ||Included value remaining || The included value remaining taking into account any prorata period. Templates found using '''Current Usage Left in MB''' will be automatically transitioned to the Included Value equivalent variable.
Line 125: Line 148:
 
|Included value type  ||  New variable || The type of included value (Dollars, Kilobytes, Seconds & Units)
 
|Included value type  ||  New variable || The type of included value (Dollars, Kilobytes, Seconds & Units)
 
|-
 
|-
−
|Period ratio || N/A || This variable has been removed.
+
|Cap Base Amount || N/A || This variable will be removed.
 
|-
 
|-
−
|Current Usage  || N/A || This variable has been removed.
+
|Period ratio || N/A || This variable will been removed.
 
|-
 
|-
−
|Current Usage Left || N/A || This variable has been removed.
+
|Current Usage  || N/A || This variable will been removed.
 +
|-
 +
|Current Usage Left || N/A || This variable will been removed.
 
|}
 
|}
  
−
== I have plan caps now - What do I have to do? ==
+
= See Also =
 +
 
 +
[https://wiki.emersion.com/wiki/index.php/ServicePlans/ServicePlans/Included_Value/Included_Value_Settings Included Value Settings]
  
−
As part of the upgrade, Emersion will migrate your existing plan cap settings to the new included value equivalent settings. This will ensure a seamless transition so you can continue selling plan subscriptions with no interruption.  
+
[https://resources.emersion.com/display/EKB/Included+Value+Allowances+for+Service+Plans Importing Included values against existing service plans]
  
−
If you are using the subscription threshold notification events you will need to ensure that your template is reviewed carefully and updated immediately following the release to ensure that notifications received by customers are correct and accurate.
+
[https://wiki.emersion.com/wiki/index.php/ServicePlans/Telephony/SharedCap Shared Cap]

Latest revision as of 10:00, 27 March 2019

Included Value Overview

With subscription-based services, it is very common to see a subscription include a limited (or unlimited) amount of value of whatever service that is being offered. This is commonly referred to as 'Included Value'.

Examples of included value might be:

  • A mobile subscription with $300.00 worth of Australian calls
  • A 4G service with up to 3GB of data a month
  • A mobile subscription with 500 SMS/MMS per month.
  • unlimited texting
  • A subscription to cloud storage with 1TB of storage

Specifically for the Australian telco market, the term 'included value' has a defined meaning. See More..

In Emersion, the included value features provides a way for service providers to offer their customers a plan with a single included value option. The type of value that can be included can be:

  • dollar
  • kilobytes
  • units
  • seconds (converted to HH:MM:SS when presented to users)

For example, a plan can be set up to include:

  • a mobile phone service with $300.00 worth of calls within Australia; OR
  • an ADSL service that includes up to 50GB of data a month; OR
  • 500 SMS/MMS per month.

Single vs Multiple Included Value

By default, all Emersion clients can set up a plan with a single included value amount. A single amount of a single type can be configured per plan.

Multiple included value extends this support to allow up to 4 included value options on a service plan and a single included value option on a package plan. The type of included value you can offer on a plan is also extended to more than one type.

Extending the 'single' examples from above, multiple included value allows you to support a package plan that includes:

  • a mobile phone service with $300.00 worth of calls within Australia; AND
  • an ADSL service that includes up to 50GB of data a month; AND
  • 500 SMS/MMS per month.


Multiple included value amounts for your plans require an additional subscription. Should you wish to offer multiple included values, please contact Emersion Sales by emailing sales@emersion.com.au

Included Value Settings

The settings pages of Package Plans, Service plans and Rate Cards all contain settings relevant to configuring a plan with included value correctly. Once configured, a tariff inside a rate card can be allocated to an 'included value slot. Multiple tariffs can be mapped to the same slot. If a tariff is mapped to a slot, the usage for that tariff is counted towards the customer's included value quota.

The slot is then allocated to a service plan.

Service Plan Included Value Settings:

  • Included Value Slot Type: Select the slot from the available list.
  • Included Value Pro Rata: Select Yes if you want the included value to be pro rated. (eg. If set to Yes and the included value offering is $100 and that service starts in the middle of a 1 month period, the service would only have approx $50 available included value)
  • Value and type: The amount or value that will be included each period. Enter a number into the value field and select the type from the options available in the drop down.
  • Internal name: Give your included value a name (e.g. 50 SMSs, $400 Australian calls, etc).
  • External name: This name will be displayed in place of the name wherever it is presented externally. E.g. On an invoice, in the End User portal.
  • Is Excess Sharing activated for this slot?: Tick this option if any excess usage is to be distributed across multiple services (of the same service type) that belong to the same account. This requires all services to be on a plan that is also configured to allow usage excess sharing.
    • Note: If this is enabled, you have the optional ability to specify a 'Share Key'. Setting this restricts excess sharing to plans that have the same share key only.

For an example of configuring Included Value, see --> Configure a plan with Included Value

Included Value Types

The following types of included value can be set up.

Dollars: Displays with a dollar sign $ and will be rounded to 2 decimal places. Usage is stored as an ex-tax figure but in the event notifications is rendered to customers.

Kilobytes: Kilobytes will display GB, MB, or KB depending on the figure. For example, 1572864 kilobytes would be displayed at 1.5 Gigabytes, while 2855 kilobytes would displayed as 2.79 MB. This is dynamic depending on how much data is available.

Units: Displays the number of units.

Seconds: Like Kilobytes, time is recorded as seconds internally, but will be converted to hours/minutes/seconds. 600 seconds would show as 10 minutes, where 2700 seconds would show as 2 hours. 8774 seconds would be displayed as 2hrs 26min 14sec.

Changes to Subscription Threshold Notification Events (TCP Alerts)

In order for the subscription threshold notification events to support included value and bolt-on add-ons, Emersion upgraded the two existing events and will in the next release, include an additional subscription threshold notification event for clients who subscribe to bolt-on add-ons.

Service Subscription Cap Threshold Notification Event

The following changes apply to this event:

  • The name of this event has changed to Service Included Value Threshold Notification.
  • Some variables will undergo a name change to make them consistent across events and better describe their function and purpose.
  • Ex-Tax versions of dollar-based variables are no longer supported.
  • New variables have been added.
  • Some variables can no longer be supported and will be deprecated.

Variable changes are highlighted in the table below. If the variable is not listed, it has not been changed.

Note Labels for variables are displayed in the table below. The underlying variable as seen in the template as %%tags%% may or may not have changed.

Service Subscription Notification Variables
Cap variable Variable Included Value Variable Description and Change Notes
Cap Base Amount Included value Formerly, this variable's output a dollar-based ex-tax value. This variable now gives the raw total included value amount. If the included value is dollar based the value is inclusive of tax. It not take into account any prorata amount. Regardless of the included value type, it displays a numerical figure.
Cap Base Amount Inc Tax Removed Templates found using Cap Base Amount Inc Tax will be automatically transitioned to the Included value variable.
Cap Amount Included value prorata Formerly, this variable's output a dollar-based ex-tax value. This variable now gives total included value amount (inclusive of tax if dollar-based) converted to a client-friendly format based on the type. Takes into account any prorata amount.
Cap Amount Inc Tax Removed Templates found using the Cap Amount Inc Tax will be automatically transitioned to the Included value prorata variable.
Cap Amount Left Included value remaining Formerly, this variable's output a dollar-based ex-tax value. This variable now gives the included value remaining taking into account any prorata period. If the included value is dollar-based it is inclusive of tax.
Cap Amount Left Inc Tax Included value remaining The included value remaining taking into account any prorata period. Templates found using Cap Amount Left Inc Tax will be automatically automatically transitioned to the Included value remaining variable.
Service name New variable External name of the Service
Included value name New variable External Name of the Included Value
Included value used New variable The amount of usage that has been used in the period so far. This data is converted to a client-friendly format based on the type.
Included value type New variable The type of included value (Dollars, Kilobytes, Seconds & Units)

Bolt-on Subscription Cap Threshold Notification Event

The following changes apply to this event:

  • The name of this event will change to Bolt-On Included Value Threshold Notification.
  • Some variable labels have been changed to make them consistent with other events and better describe their function. Please note that no underlying %%tags%% have been changed. These are label changes only.
  • Some variables will be removed after Tuesday 10 March, 2015.
  • New variables will be added in the coming weeks.

Variable changes are highlighted in the table below. If the variable is not listed, it has not been changed.

Note Labels for variables are displayed in the table below. The underlying variable as seen in the template as %%tags%% may or may not have changed.

Bolt-On Subscription Notification Variables
Cap variable Variable Included Value Variable Description and Change Notes
Cap Base Amount in MB Included value total No longer supporting only data usage with a conversion to megabytes, this variable now supports all included value types and converts the data to a client-friendly format, taking into account any prorata amount. If the type is dollar-based it will be inclusive of tax.
Cap Amount Included value prorata The included value taking into account any prorata period.
Max Type Name Included value type The type of included value (Dollars, Kilobytes, Seconds & Units). Templates found using Max Type Name will be automatically transitioned to the Included Value equivalent variable.
Current Usage in MB Included value used The amount of usage that has been used in the period so far. This data is converted to a client-friendly format based on the type. Templates found using Current Usage MB will be automatically transitioned to the Included Value equivalent variable.
Current Usage Left in MB Included value remaining The included value remaining taking into account any prorata period. Templates found using Current Usage Left in MB will be automatically transitioned to the Included Value equivalent variable.
Bolt-on name New variable External name of the bolt-on
Included value name New variable External Name of the Included Value
Included value used New variable The amount of usage that has been used in the period so far. This data is converted to a client-friendly format based on the type.
Included value type New variable The type of included value (Dollars, Kilobytes, Seconds & Units)
Cap Base Amount N/A This variable will be removed.
Period ratio N/A This variable will been removed.
Current Usage N/A This variable will been removed.
Current Usage Left N/A This variable will been removed.

See Also

Included Value Settings

Importing Included values against existing service plans

Shared Cap

Retrieved from "https://mediawiki.emersion.com.au/wiki/index.php?title=ServicePlans/ServicePlans/Included_Value&oldid=6427"