ServicePlans/ServicePlans/Included Value

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.

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:

1. Service Subscription Cap Threshold Notification Event
2. Service Bolt-on Subscription Cap Threshold Notification Event

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.

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 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

Package Plans

Navigate: Package and Plans > Management > Package Plan

Below is a screenshot of the Package Plan configuration screen showing support for caps. The Group Cap feature will be removed:

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 Plans

Navigate: Package and Plans > Management > Service Plan

The existing ‘Usage Cap’ and Share Cap fields will be removed from Service Plan

They are being replaced with a new tab, called Service Plan Included Value

Rate Cards

Navigate: Packages and Plans > Management > Rate Card > Add Rate

A new field is being added to the list, called Included Value Slot Type

When editing a rate, you must:

• mark the rate ‘In Cap’
• choose the Included value slot for which the rate is applicable

Remember that rate cards may be linked to more than 1 service plan, each with their own Included Value Configuration.

edit-rate-included-value-settings.png

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.

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. Please be aware that we have displayed the labels for variables. Underlying variable %%tags%% 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 has changed 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 at a date 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 (and will not) be changed.

Bolt-On Subscription Notification Variables

Cap variable	Included Value Variable	Description and Notes
Cap Base Amount	N/A	This variable will be removed.
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.
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 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)
Period ratio	N/A	This variable has been removed.
Current Usage	N/A	This variable has been removed.
Current Usage Left	N/A	This variable has been removed.

I have plan caps now - What do I have to do?

As part of the upgrade on the 24th, 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. There is no changes you need to do to with package plans, service plans and rate cards.

If you are using the service subscription threshold notification event, on the morning of Tuesday 25th February, you will need to review your template settings and ensure that your template is not referring to any ex-tax amounts as these are no longer supported.

If you are using the bolt-on subscription threshold notification event, you should remove from the template any variable that has been flagged for removal from the table above. If you do not remove these variables from the template, your customers are at risk of receiving incorrect or incomplete information. This should be done no later than COB Tuesday 10 March, 2015.