Overview
This feature provides an easy and fast way to perform package subscription migrations in Emersion via a bulk upload tool.
This tool comes with a force_complete flag that can be used to process the migration immediately regardless of any dates set.
The force_complete flag MUST ONLY be used for manually-provisioned service types. If the service is provisioned on the carrier's provisioning system via an integration with Emersion's system, this flag must NOT be used.
When the flag is used, these are the expected actions:
- Source package subscription is cancelled effective immediately.
- Source package subscription's end date was set to the future date given in the import file.
- Destination package subscription is created and activated immediately.
- Package Subscription note created. This note can be seen in Cumulus:
- under the Customer > Notes tab.
- under source Package Subscription > Package Subscription Notes tab.
When the force_complete flag is not used, the following actions will occur:
- Source package sub is placed into a PendingProvCancel state, pending cancellation.
- Destination package subscription created and Preactive.
- Package Subscription note created. This note can be seen in Cumulus:
- under the Customer > Notes tab.
- under source Package Subscription > Package Subscription Notes tab.
- Back dated migrations are not supported by this tool. Setting the migration date as the current date (today) is treated like a future dated migration and not supported.
- Custom first period end dates are not supported by this tool. These end dates can only be configured in the user interface.
- If the user intends to set the First Period End Date, the relevant package plan must have the Honour First Period End Date if Set setting enabled.
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.
Importing The Data
To access the import tool:
Admin > Bulk Import > Package Migration
- 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 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.
| Data field | Description | Mandatory? |
|---|---|---|
| ACCOUNT_ID | The ID of the customer. | Yes |
| PACKAGE_SUBSCRIPTION_ID | The old (source) package subscription ID. | Yes |
| NEW_PACKAGE_PLAN_ID | The ID of the package plan for the new (destination) package subscription. | Yes |
| MIGRATION_DATE | Desired date of the migration. (If left empty the migration date will be "now") Suggested format: YYYY-MM-DD HH24:MI:SS (eg. 2018-05-30 14:00). Cannot be in the past. | No |
| FIRST_PERIOD_END_DATE | The format of this field is YYYY-MM-DD. Requires that the relevant package plan has the Honour First Period End Date if Set setting enabled. | No |
| NEW_CONTRACT_TYPE_ID | Provide a contract type ID if this customer's subscription has a contract. | No |
| NEW_CONTRACT_END_DATE | Give the contract against the destination subscription an optional end date. | No |
| FORCE_COMPLETE | This is a boolean flag and tells the system to process the migration immediately or not. Enter:
Please note: An empty value, or the use of any character other than 1 will result in this flag not being set and the migration not being force completed. | No |
| RETAIN_CURRENT_CONTRACT | This is a boolean flag and tells the system to retain the existing contract if set. If not provided, it would be assumed to be false and the existing contract will be end dated | 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.
The overview section of this article contains the expectations of what is changed in both source and destination package subscriptions. Emersion recommends checking both the source and destination side of the migration process. Customer package subscriptions can be found via Customer > Package Subscriptions. We recommend also checking the creation of the note, under Customer > Notes.
Access Control
The following powers are used to govern access to this tool
| Power | Descriptions |
|---|---|
| Bulk Package Migrate | Allows users to access the package migration bulk update facility |