Difference between revisions of "Data Import/Included Value Import"
| Line 1: | Line 1: | ||
| + | = Importing Customer or Services Notes into Emersion = | ||
| + | This feature provides an easy and fast way to import either account (customer) or service notes into Emersion via a bulk upload tool. | ||
| + | |||
| + | 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 10,000 notes that can be created using this import tool. If you need to import more than 10,000 notes 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:customer_or_service_note_import template.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: | ||
| + | |||
| + | == Data Dictionary == | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 47: | Line 70: | ||
|- | |- | ||
|} | |} | ||
| + | |||
| + | = See Also = | ||
| + | |||
| + | * [[Service Plans | Service Plans]] | ||
| + | * [[ServicePlans/ServicePlans/Included_Value | Service Plan Included Value ]] | ||
Revision as of 11:28, 31 July 2015
Contents
Importing Customer or Services Notes into Emersion
This feature provides an easy and fast way to import either account (customer) or service notes into Emersion via a bulk upload tool.
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.
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 10,000 notes that can be created using this import tool. If you need to import more than 10,000 notes 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:Customer or service note import template.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:
Data Dictionary
| Data field | Description |
| ID | The ID of the included value of the service plan. This is found via Packages and Plans > Management > Service Plans > Included Value tab.
If left blank, a new included value allowance for the service plan will be created. If an ID is provided, the included value corresponding to the ID will be updated. (optional field) |
| NAME | A name for the included value allowance. (mandatory field) |
| INCLUDED_VALUE | An integer, representing the amount of included value. (mandatory field) |
| IS_SHARED | A flag denoting if any available quota which remains at the end of the period can be shared with other services on the same account with similar shared subscriptions. Accepted values are:
If left blank, 0 will be set. (optional field) |
| FALLBACK_RATECARD_ID | The ID of the rate card that is used once the included value is reached and excess charges commences. The rate card must exist in Emersion. (optional field) |
| INCLUDED_VALUE_TYPE_ID | The type of included value. Accepted values are:
These fields are case sensitive (mandatory field) |
| SERVICE_PLAN_ID | Service plan this included value is for. The service plan must exist in Emersion, (mandatory field) |
| INCLUDED_VALUE_SLOT_TYPE_ID | The corresponding slot number. Accepted values are:
These fields are case sensitive (mandatory field) |
| EXTERNAL_NAME | The ‘external’ name is the vanity name for this included value allowance that will be used on any external or public facing interface or invoice. (mandatory field) |
| INCVAL_PRORATA | A flag denoting whether the allowance is pro-rated when a short period exists. Accepted values are:
If left blank, 1 will be set. (optional field) |
| SHARE_KEY | When shared (Is Shared = 1), sharing the included value is achieved via a key. The share key is a string of alphanumeric characters. If Is Shared = 0, this information will be discarded. If Is Shared = 1, this is mandatory. |
