Overview
For service providers with large numbers of records in Quarantine, cleansing or writing off usage via Cumulus may not be practical. Due to performance reasons, Cumulus restricts users from being able to display and take action on more than 1,000 records at a time. If you need to update more records, this feature provides an easy and fast way to achieve that objective.
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 20,000 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 > Cleanse BMS Quarantine
- 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.
To complete your data import file, you will need access to some reference data. Go to Reports > List > Quarantine and download the following reports:
- Quarantine - BMS Data Quarantine Report (Detail)
- Quarantine - BMS Telephony Quarantine Report (Detail)
- Quarantine - BMS Misc Quarantine Report (Detail)
| Data field | Description | Mandatory? |
|---|---|---|
| QUARANTINE_ID | The ID of the record to be updated. The underlying usage record must be of status 'Quarantined'. | Yes |
| USAGE_TYPE | Valid entries are:
These are not case sensitive. E.g Telephony, telephony and TELEPHONY are all valid data entries. | Yes |
| SERVICE_IDENTIFIER | The service identifier the usage record is for. (optional field) Maximum for a telephony record: 35 characters Maximum for a data record: 200 characters Maximum for a misc record: 256 characters | No |
| TARIFF_KEY | The tariff key. (optional field) Maximum of 128 characters | No |
| CONNECTOR_ID | The ID of the Connector. This can be retrieved using any of the reports listed above. | Yes |
| USAGE_ACTION | Valid entries are:
These are not case sensitive. E.g. Writeoff, writeoff and WRITEOFF are all valid data entries. | 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
Access Control
The following powers are used to govern access to this tool
| Power | Description |
|---|---|
| Bulk Cleanse Quarantine | Use the bulk import process to mass update quarantine cleansing (or write off). |