Data Import/Package Migration - Revision history

Scarpenter: Replaced content with "{{DISPLAYTITLE: Package Migrations in Bulk}} =This Content Has Moved House= This article has been moved to our new home for documentation and help content, the new Emersi..."

2017-10-16T03:48:54Z

Replaced content with "{{DISPLAYTITLE: Package Migrations in Bulk}} =This Content Has Moved House= This article has been moved to our new home for documentation and help content, the new Emersi..."

Rlusher: /* Bulk Package Migration Data Definition */

2017-07-05T01:02:39Z

‎Bulk Package Migration Data Definition

Scarpenter: /* Preparing your Data */

2017-06-28T04:56:15Z

‎Preparing your Data

Scarpenter: /* Preparing your Data */

2017-06-28T02:03:14Z

‎Preparing your Data

Scarpenter: Created page with "{{DISPLAYTITLE: Package Migrations in Bulk}} = Overview = This feature provides an easy and fast way to perform package migrations in Emersion via a bulk upload tool. This t..."

2017-06-27T05:03:25Z

Created page with "{{DISPLAYTITLE: Package Migrations in Bulk}} = Overview = This feature provides an easy and fast way to perform package migrations in Emersion via a bulk upload tool. This t..."

New page

{{DISPLAYTITLE: Package Migrations in Bulk}}
= Overview =
This feature provides an easy and fast way to perform package 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. 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.

The system utilises the '''Bulk upload processing notification event''' to send a notification with the results of the import attempt. See below for further information.

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

== Preparing your Data ==
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.

There is a hard limit of 2,000 migrations that can be performed using this import tool. If you need to migrate more than 2,000 packages at a time, please create multiple import files.
A single import file can have up to 9999 rows of data plus the header row.

[[file:package_migration_import.zip]]

Enter the data into the import sheet. Leave no rows blank. You must ensure the data meets all validation requirements. These are contained in the data definition table below. When you submit the data file for import, the system will parse the file looking for errors. If the system finds no errors, the system will import the notes into the system. The file needs to be error-free in order to import the data. In the event errors are found, no data will be imported into Emersion. Review the bulk upload processing notification email, correct the file and try again.

== Importing your Data ==

To access the note import tool:

# Log into Cumulus.
# '''Nav: 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.

<strong>'''The system can parse for invalid data but it cannot check for data accuracy. Therefore it is strongly recommended that you check a few random records to ensure that the import was a success. If you find an problem, you cannot roll back the import.'''</strong>

You have two options should this occur:

# Manually correct the data.
# Request Emersion fix the errors for you. This can be submitted via [[Support_and_help_from_Emersion#Work_Orders | work order ticket]]. Please include a note import file with the records that need to be corrected. Do not include details of any records that do not need correcting.

= Bulk Package Migration Data Definition =
This section contains a list of the required fields and a definition of what the system considers as valid data.

{| class="wikitable"
|+Bulk Package Migration Data Definition table
|Data field ||Description
|-
|ACCOUNT_ID ||The ID of the customer. '''MANDATORY'''
|-
|PACKAGE_SUBSCRIPTION_ID ||The old (source) package subscription ID.
|-
|NEW_PACKAGE_PLAN_ID ||The ID of the package plan for the new (destination) package subscription. '''MANDATORY'''
|-
|NEW_CONTRACT_TYPE_ID ||Provide a contract type ID if this customer's subscription has a contract. '''OPTIONAL'''
|-
|NEW_CONTRACT_END_DATE|| Give the contract against the destination subscription an optional end date '''OPTIONAL'''
|-
|FORCE_COMPLETE ||This is a boolean flag and tells the system to process the migration immediately or not. Enter:
* 0 = NO
* 1 = YES
'''MANDATORY'''
|}

== Viewing the 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 Bulk upload processing notification event ==
Most of the bulk upload tools utilise the '''Bulk upload processing notification event''' to send a notification containing the results of the import attempt. An event template must be created and the event must be enabled before the import tool can be used.

@@ Line 33: / Line 33: @@
 A single import file can have up to 9999 rows of data plus the header row.
-[[Media:package_migration_import.zip]]
+[[Media:Package_migration_import.zip]]
 Enter the data into the import sheet. Leave no rows blank. You must ensure the data meets all validation requirements. These are contained in the data definition table below. When you submit the data file for import, the system will parse the file looking for errors. If the system finds no errors, the system will import the notes into the system. The file needs to be error-free in order to import the data. In the event errors are found, no data will be imported into Emersion. Review the bulk upload processing notification email, correct the file and try again.

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE: Package Migrations in Bulk}}
-= Overview =
+=This Content Has Moved House=
-This tool comes with a ''force_complete'' flag that can be used to process the migration immediately regardless of any dates set. When the flag is used, these are the expected actions:
+This article has been moved to our new home for documentation and help content, the new Emersion Knowledge Base.
-* Source package subscription is cancelled effective immediately.
+We are sorry for the untidiness while we are shifting locations and we appreciate your patience during the transition to out new home.
-When the ''force_complete'' flag is not used, the following actions will occur:
+[https://resources.emersion.com/display/EKB/Package+Migrations Take me to the Emersion Knowledge Base article]
-* Source package sub is placed into a PendingProvCancel state, pending cancellation.
+[[file:new_home_sm.jpg|900px]]

@@ Line 65: / Line 65: @@
 |ACCOUNT_ID	||The ID of the customer. '''MANDATORY'''
 |-
-|PACKAGE_SUBSCRIPTION_ID	||The old (source) package subscription ID.
+|PACKAGE_SUBSCRIPTION_ID	||The old (source) package subscription ID. '''MANDATORY'''
 |-
 |NEW_PACKAGE_PLAN_ID	||The ID of the package plan for the new (destination) package subscription. '''MANDATORY'''