Overview

This importer will update several elements of a service subscription rather than having to go to the user interface to modify data manually.

Business Rules

The following business rule applies:

If only the service ID is provided and nothing else, the importer should reject the row informing the user they need to provide at least one update.
This importer has the following unique features that are designed to help you better enable your access fee and service feature product rate overrides:
- If no start and end date is 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.
- It is possible to end date an existing end access fee override or a service feature subscription product rate override by providing the end date only. This is useful for when you want to stop overrides outright on a service.
- The importer has functionality to end date an old rate and create a new rate if you are updating the price of an access fee or feature price already present. This saves you from having to do one import to end date an old rate, then do another import to create a 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 then automatically gets end dated on the same date.
  - Note that in all cases in this auto end dating scenario, the start date cannot be less than or equal to today. If a charge is generated today based on a rate in force, the rate cannot be changed after the fact, or else there would be no easily viewable record of a rate in force at the time of cardline generation. In addition, it is not possible to re-rate access fees for service subscriptions and feature prices, so backdating after the fact would have no effect.

Emersion Knowledge Base > Service Subscription Detail Update Import > image2020-6-15_9-41-36.png

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

Click the Browse button and select the csv file containing the data you want to import.
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.
Press Submit
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:

Manually correct the data.
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.

Group	Data field	Description	Mandatory?	Mandatory within Group
All	SERVICE_ID	The ID of service Service Subscription of this service Must be either PreActive, Active, or PendingProvCancel	Yes
Service Qty	SERVICE_QTY	The quantity of service Cannot be below service plan multiplier minimum Cannot be above service plan multiplier maximum	No	Yes
Service Qty	SERVICE_QTY_DATE_EFFECTIVE	The effective date of service quantity Cannot set a service multiplier date more then 6 months in the future Cannot set a service multiplier date more then 6 months ago Cannot set a service multiplier date less than 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	No	Yes
Access Fee Override	*Please note, this row is not a field in the importer and is a header only.*	The service plan must be enabled to allow access fee overrides The account feature (Feature Key: SERV_ACC_FEE_ORIDE) for access fee overrides must be enabled The service type itself must permit access fee overrides
Access Fee Override	ACCESS_FEE_ORIDE_MARKUP	The markup of access fee override Percentage up to 7 decimal places	No	Yes, if price is not used
Access Fee Override	ACCESS_FEE_ORIDE_UNIT_PRICE_EX	The price of access fee override Number permitted up to seven decimal places Negatives Permitted	No	Yes, if markup is not used
Access Fee Override	ACCESS_FEE_ORIDE_TAX_TYPE	The short code of the tax type for access fee override	No	Yes, if price is used
Access Fee Override	ACCESS_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	No	Yes
Access Fee Override	ACCESS_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	No	No
Vanity Identifier	SERVICE_VANITY_IDENTIFIER	The vanity identifier of service Must honour field length limits Property type 'VANITY_IDENTIFIER' must be mapped to the service type associated with the service	No	No
Service Detail	SERVICE_DETAIL_FOR_INVOICE	The service detail for invoice Must honour field length limits Property type 'Service_Invoice_Details' must be mapped to the service type associated with the service	No	No
Service Feature Qty	*Please note, this row is not a field in the importer and is a header only.*	The feature type (Toggle Type: Freely Switch) must be editable in order for a service feature subscription to be editable. The dates relating to the Price, Markup and Tax will effectively be a product rate override. Any overrides saved in respect of service features will have a minimum quantity of 0 set.
Service Feature Qty	SERVICE_FEAT_SUB_ID	The ID of service feature subscription in active status	No	Yes
Service Feature Qty	SERVICE_FEAT_SUB_QTY	The quantity of service feature subscription If the Product attached to the service type does not allow decimals for quantity, this rule must be enforced	No	Yes
Service Feature Qty	SERVICE_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	No	Yes
Service Feature Price Override	SERVICE_FEAT_SUB_ORIDE_MARKUP	The markup of service feature subscription override Percentage up to 7 decimal places permitted	No	Yes, if price is not used
Service Feature Price Override	SERVICE_FEAT_SUB_ORIDE_UNI_PRICE_EX	The price of service feature subscription override Price cannot be less than 0	No	Yes, if markup is not used
Service Feature Price Override	SERVICE_FEAT_SUB_ORIDE_TAX_TYPE	The short code of the tax type for service feature subscription override	No	Yes, if price is used
Service Feature Price Override	SERVICE_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 an override overlapping an existing override	No	Yes
Service Feature Price Override	SERVICE_FEAT_SUB_ORIDE_DATE_END	The date end of access fee override in YYYY-MM-DD format Cannot be less than today	No	No

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.