Overview
The purpose of this import is to allow bulk churns of NBN services to the Vocus NBN platform. Orders for new services are not supported. Prior to import, we strongly recommend you inform us in advance. This is so that our team can help monitor the status of churns that you have imported.
Business Rules
The following business rules apply when using this tool.
- Customer Account ID
- Must be present
- Must exist in Emersion
- Must belong to the caller's wholesaler account (via any RSP)
- NBN Location ID
- Must be present
- Must not be duplicated within the file
- Must be valid.
- Password must be present
- Realm (if provided)
- Must not exceed 40 characters.
- Must exist as a service identifier realm against the parent of provided account
- Username (if provided)
- Must not exceed 100 characters.
- Must not already exist against the service type and realm
- Package Plan ID
- Must be present
- Must be an approved Sell plan.
- Must be owned by Seller (Seller would be parent of the provided customer account id)
- Service Level, if provided, should be within the allowed list of values
- TC1, if provided, is allowed against the profile, technology and speed
- TC2, if provided, is allowed against the profile, technology and speed
- Data Port Number
- Is only allowed for FTTP & FW technologies
- Must be a number between 1-4
- NCD Install
- May only be present if Technology is FTTC and the Service Class is 33
- Must be SI, PI or Null (SI = Standard Install, PI = Professional Install, Null means NCD not required)
- NTID
- If the technology type for the specified location is HFC, an NTDID or "New" must be provided.
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 501 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.
Download the sample_file.csv import template
Importing The Data
To access the import tool:
Admin > Bulk Import > Vocus NBN Bulk Ordering
- 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.
| Data field | Description | Data Type | Mandatory? |
|---|---|---|---|
| ACCOUNT_ID | Account number to which the service will belong to. | Integer | Yes |
| NBN_LOCATION_ID | NBN Location ID of the service to be churned. | String | Yes |
| USERNAME | Username for the service. Note that if nothing is set, the LocationID will be set as the username | String | Yes |
| PASSWORD | Password for the service. | String | Yes |
| REALM | Some service providers have more than one realm. If this is the case, you should specify the realm here. Otherwise if the RSP only has one realm, you can leave this field blank and it will use this realm by default. | String | No |
| PACKAGE_PLAN_ID | Package Plan ID that the service is being ordered against. | Integer | Yes |
| SERVICE_LEVEL | Any additional service levels for the service, above and beyond "STANDARD". Values may include the examples below. Note your service plan must support these additional levels of service. NBN Service Enhanced-8 | String | Yes |
| TC1 | Traffic Class 1 value, which ensures that certain bandwidth is allocated to Voice Priority Service. Please note that this traffic class must be supported by the relevant service plan. Values may include the examples below: 0K | String | No |
| TC2 | Traffic Class 2 value, which ensures that certain bandwidth is allocated to Symmetrical Data Priority Service. Please note that this traffic class must be supported by the relevant service plan. Values may include the examples below: 0M | ||
| DATA_PORT_NUMBER | This is the data port number used to transfer an existing FTTP based NBN service. Valid values are from 1 to 4. | Integer | No |
| NCD_INSTALL | Indicates whether a NCD (Network Connection Device) install is required. Acceptable values are "SI" (Standard Install), or "PI" Professional Install. If no value is presented it will be assumed no install is required. | String | No |
| MODEM_REQUIRED | Indicates whether a new modem is required. Values are true, false, 1, 0, Yes, No | Boolean | No |
| NTD_ID | For HFC orders, you must provide the NTD_ID of the connection device (for example, NTD400018430853), or "NEW" if a new device is required. | String | No |