Overview

This importer will update several elements of a service subscription. It also handles changes to some of the underlying objects of a service subscription.

Its features are grouped into the objects they work with.

Services and Service Subscriptions

Business Rules

  • If only the service ID is provided for a specific record, the import will fail and advise the user they must make at least one one update to the service subscription.
  • It is possible to end an existing service subscription access fee override by providing the end date only.  This is useful for when you want to stop overrides on a subscription.

Service Features and Service Feature Subscriptions

  • apply service feature quantities (with their start and end dates) to a service feature subscription. These are also known as service feature access fee multipliers.
  • create, update or end a rate override.

Business Rules

  • If no start and end dates are provided on a service feature subscription rate override, and the service is preactive, the importer will allow you to import a preactive rate.  If you update the price of the same feature service subscription and do not provide a start and end date, it will update the existing rate already present.
  • As with services, end an existing service feature subscription product rate override by providing the end date only.  This is useful for when you want to stop overrides on a subscription.


If you are looking to apply an access fee override to a package subscription, you must use this import tool.  

Expected Behaviours

If you are updating the price of an access fee or a service feature subscription override, the importer will end the old override and create a new rate. This replicates is normal Cumulus behaviour in these scenarios.  Users do not have to perform an import to end an old rate, then perform a subsequent import to create the new rate.

The screenshot below illustrates how this works.  Originally, the rate was imported with a start date of the 1st of June.  Another import was done with a start date of the 13th of June.  In this example, the old rate automatically had it's end date set to the 13th of June. We can see this same mechanism applied to the service feature pictured in this screenshot.  The original start date was the 15th of June.  A new price was imported with a start date of the 20th of June.  The old rate automatically gets end dated on the same date.

In all cases in these similar scenarios, the start date cannot be less than or equal to 'today'.  If a charge is generated today based on a given rate, the rate cannot be changed after the fact.

It is not possible to re-rate access fees for service subscriptions and feature prices, so backdating has no effect or impact.

Licencing

This feature is available to subscribers of the following:  

  • Emersion Core
  • Optional Modules 
  • Upon Request (please contact your Account Manager)


Import Result Notification

This feature utilises the Bulk upload processing notification event (event type 963) to send a notification to the user containing the results of the import attempt. 

  • If the import is successful, the email notification will advise you when the import process is complete. 
  • If the import is not successful, the email notification will send details of the records that failed validation and why.

An event template must be created and the event must be enabled before the import tool can be used.


Preparing The Data for Import

To prepare your data for import, you will need to create a CSV import file or you can download the import file below. You will need to extract the csv file and save it.

A hard limit of 500 rows is supported via this tool, including the header row. 

If you need to import more than this, create multiple import files and process them one-by-one.

Download the service subscription detail update import template



Importing The Data

To access the import tool:

Admin > Bulk Import > Service Subscription Detail        

  1. Click the Browse button and select the csv file containing the data you want to import.
  2. If you want the bulk upload processing notification email to be sent to a different email address than the address defined in the event template, tick the Override? checkbox and enter an alternative email address. This will only apply for this upload. To change the email address for all future imports, you will need to change the recipient defined in the event template.
  3. Press Submit
  4. The system will validate the data and if no errors are found, the system will import the data. When the notification email is received, the process has been completed.

Validating the Import

The system will parse the data for invalid formatting only. It cannot check for data accuracy. It is strongly recommended that you check the imported data to ensure that the import was accurately imported. To do this, divide your import records into groups of 20. Check a single record in each group. If an error is found, check each previous record for the group until you find the one that was imported incorrectly.

If you find an problem, you cannot roll back the import. You have two options should this occur:

  1. Manually correct the data.
  2. Request Emersion fix the errors for you.

Any request to correct imported data must be submitted via a ticket. Emersion will provide an estimate of the work and a quote. The quote must be approved and paid in advance before any restorative work commences. 



Data Definition

This section contains a list of the required fields and a definition of what the system considers as valid inputs.

GroupData fieldDescriptionMandatory?Mandatory within Group
AllSERVICE_ID

The ID of service

  • Service Subscription for the service must be in one of these statuses: Preactive, Active, or PendingProvCancel.

Yes


Vanity IdentifierSERVICE_VANITY_IDENTIFIER

The vanity identifier of service

  • This field is subject to field length limits.
  • The Vanity Identifier field must be available to the service type. 
NoNo
Service DetailSERVICE_DETAIL_FOR_INVOICE

The Service Invoice Details string for invoice 

  • This field is subject to field length limits.
  • The Service Invoice Details field must be available to the service type. 
NoNo
Service QtyThis row is not a field in the importer. It is to group related fields in this article.
  • Requires that the service type is enabled for service access fee multipliers.


Service QtySERVICE_QTY

The service quantity for the service

  • Cannot be above service plan multiplier maximum
  • Cannot be above service plan multiplier maximum

No

Yes
Service QtySERVICE_QTY_DATE_EFFECTIVE

The effective date of the service quantity

  • This date must be within 6 months of 'today'.
  • This date cannot be before the service start date, unless the service is Preactive
  • Cannot be less than or equal to the date effective of a service quantity already present, unless the service is Preactive
NoYes
Access Fee OverrideThis row is not a field in the importer. It is to group related fields in this article.

Access Fee OverrideACCESS_FEE_ORIDE_MARKUP

The markup of access fee override

  • supports up to 7 decimal places
NoYes, if price is not used
Access Fee OverrideACCESS_FEE_ORIDE_UNIT_PRICE_EX

The price of access fee override

  • supports up to 7 decimal places
  • Negatives are permitted
NoYes, if markup is not used
Access Fee OverrideACCESS_FEE_ORIDE_TAX_TYPE

The short code of the tax type for access fee override

NoYes, if price is used
Access Fee OverrideACCESS_FEE_ORIDE_DATE_START

The date start of access fee override in YYYY-MM-DD format

  • Cannot be prior to service start date
  • Cannot overlap an existing override
NoYes
Access Fee OverrideACCESS_FEE_ORIDE_DATE_END

The date end of access fee override in YYYY-MM-DD format

  • The end date must be after the current date.
  • Cannot overlap an existing override
NoNo
Service Feature QtyThis row is not a field in the importer. It is to group related fields in this article.
  • The feature type (Toggle Type: Freely Switch) must be editable in order for a service feature subscription to be editable.
  • The fields price, markup and tax are used together to grant a rate override for a service feature.
  • All service feature rate overrides are set with a minimum quantity of 0.


Service Feature QtySERVICE_FEAT_SUB_ID

The ID of service feature subscription in active status

No

Yes
Service Feature QtySERVICE_FEAT_SUB_QTY

The quantity of service feature subscription

  • If the product does not allow decimals, this rule is enforced
NoYes
Service Feature QtySERVICE_FEAT_SUB_QTY_DATE_EFFECTIVE

The date effective of service feature subscription

  • Cannot be equal to, or prior to an existing service feature quantity record
NoYes
Service Feature Price OverrideSERVICE_FEAT_SUB_ORIDE_MARKUP

The markup of service feature subscription override

  • supports up to 7 decimal places
NoYes, if price is not used
Service Feature Price OverrideSERVICE_FEAT_SUB_ORIDE_UNI_PRICE_EX

The price of service feature subscription override

  • Price cannot be a negative number
NoYes, if markup is not used
Service Feature Price OverrideSERVICE_FEAT_SUB_ORIDE_TAX_TYPEThe short code of the tax type for service feature subscription overrideNoYes, if price is used
Service Feature Price OverrideSERVICE_FEAT_SUB_ORIDE_DATE_START

The date start of access fee override in YYYY-MM-DD format

  • Cannot be prior to service start date
  • Cannot be the same as an identical override with the same start date
  • Cannot have a new override overlapping an existing override
NoYes
Service Feature Price OverrideSERVICE_FEAT_SUB_ORIDE_DATE_END

The date end of access fee override in YYYY-MM-DD format

  • Cannot be before 'today'
NoNo



Viewing Imported Data

After importing data it is important to validate it was imported correctly. Choosing a random records and performing a visual check in Cumulus should reveal any mistakes relatively quickly that would be harder to see in an import sheet.

Services can be found via Services > List All.


Access Control

No powers are used to govern access to this tool.


Related Pages