ServicePlans/ServicePlans/Included Value
Contents
Features of Included Value
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
- kilobytes
- units
- 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.
Included Value Plan Settings
The settings pages of Package Plans, Service plans and Rate Cards will be updated so that cap settings are replaced with Included value settings. A rate inside a rate card has also been changed so you can allocate a tariff to an included value slot. This means that usage for that tariff is counted towards the customer's included value quota.
Read about Included Value settings in Packages, Plans and Rate Cards
Included Value Types
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.
| 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.
| 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. |
