Overview
The Bulk Package Cancellation importer allows service providers to cancel package subscriptions and backdate their cancellations to any date in the past (so long as the date is validated as per the business rules below).
Unlike other cancellation methods, this process will then reopen any periods that come after this cancellation and generate prorated credits, if applicable.
Any preactive subscriptions under the package subscription (including any service subscriptions, features, bolt ons or data bolt ons) will be automatically aborted.
Business Rules
The following validation is performed:
Account Validation
The account must be a customer of the service provider account you are logged in as
Package Subscription Validation
The Package Subscription must be valid and exist, and be owned by the account id
The Package Plan must belong to the account that you are logged in as
The Package Subscription must be the lowest level
The Package Subscription must be active and not have an end date set
The Package Subscription cannot have a 'followed by id' (ie be the package being migrated from in a migration)
The end date provided must not be prior to the start date
There cannot be any service subscriptions that were cancelled after the Package Subscriptions end date
Any service subscriptions that are active, pending cancellation or pending prov cancel must have started before the end date
There can be no attached features, bolt ons or data bolt ons that are cancelled after the end date, or start after it
Licensing
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 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.
Importing The Data
To access the import tool:
Admin > Bulk Import > Bulk Package Cancellation
- 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
Bulk Import Validation
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 data 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 QR ticket. Emersion will provide an estimate of the work and a quote. Quote must be approved in writing before any work commences.
Data Definition
This section contains a list of the required fields and a definition of what the system considers as valid inputs.
Column Heading | Description | Mandatory |
|---|---|---|
PACKAGE_SUBSCRIPTION_ID | The Package Subscription being cancelled | Yes |
ACCOUNT_ID | The account to which the Package Subscription belongs to | Yes |
END_DATE | The desired end date for the Package Subscription | Yes |
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.
Package subscriptions can be found via Customer > Package Subscriptions tab.
Access Control
The following powers are used to govern access to this tool
- Bulk Import - Package Cancellation