Data Import/Service Qualification Addresses

From Emersion
Revision as of 18:03, 2 October 2014 by Scarpenter (talk)
Jump to: navigation, search

Address-based Service Qualification Tool - Importing and Configuring Addresses

Emersion provide an address based SQ (designed around GNAF) and service/location tracking management for service providers that provide NBN-like services, including site device and port management.

This article is for customer who want to populate the address-based service qualification ('SQ') tool with an available list of addresses and their service availability status. Please note that Emersion does not have a database of every address in Australia (or elsewhere) that is ready to use for this purpose. For any given address, the availability status may vary between service providers. In order to use the SQ tool the service provider must supply all addresses and their serviceability status to Emersion for loading into the Emersion database. Once loaded, these addresses will be available for use by the address-based SQ tool.

Prerequisites

Service Availability Descriptions

If you do not wish to use the existing service availability descriptions, you can supply your own. If this is the case, below is a CSV file you will be required to complete. It contains our existing codes. Please remove the examples we have provided in the file before submitting if you want us to add customised descriptions for your use. If you do not do this, the file cannot be used to import and the file will be returned to you. See the SQ Serviceability Descriptions Data Definition table at the end of this article for a description of the data fields.

Download the service availability descriptions File:Service availability-descriptions.zip

Service Type Codes that are needed to complete this import sheet can be found in Cumulus. Navigate: Reports > Reference > Service Type Code List

GNAF Address data in the Emersion Format for the SQ Tool

You will need to prepare your address data in the required format ready to import. Data provided in a different format will be returned to you as incomplete. The import sheet is a generic template that caters for all different types of addresses, with both long and short forms supported. Not all fields will be used for each address, and as such, no address field is mandatory. Please pay very close attention to filling in this import sheet. Emersion data consultants will sight your data for technical compliance, not content accuracy. Emersion will not be held liable for correcting mistakes made due to data being provided to us that is discovered to be incorrect. You will be invoiced for any corrections needed. See the GNAF Address Data Definition table table at the end of this article for a description of the data fields.

Download the GNAF addresses import sheet File:Gnaf addresses-importsheet.zip

Code definitions needed to complete the GNAF addresses import sheet can be found in Cumulus. Navigate: Reports > Reference > Physical Address Reference Data

Submitting your Request for Import Services with Emersion

Presently, there is no support for Service Providers to load addresses into Emersion's database via Cumulus. Raise a work request ticket via the Emersion Support Portal or via email to workorders@emersion.com.au and include your import sheet and service availability descriptions. Please be aware that all work requests attract a fee. We provide a rough estimated quote of 1 hour's T&M labour time which accounts for a single pass through the data import process as described below. If we need to help you with your data, or we have to proceed through the import process more than once, you will incur further charges.

Please allow up to 14 days for your request to be processed once we have all the requirements. Estimated delivery dates can be subject to vary during busy times.

The Data Import Process

  1. Emersion will review the data you have provided to ensure it is technically compliant and is in a state ready for import. If the data is not ready to import, it will be returned back to you to correct and resubmit.
  2. Once the file passes, Emersion will import your data into a test environment and perform a sanity check.
  3. Emersion will then export this data from the database and return it back to you for validation.
    1. If the data needs correcting, please make a new version of the import sheet and submit it to Emersion via the ticket.
    2. If the data does not need correcting, provide written sign off. Emersion will not import data into Production without written sign off.
  4. Emersion will then load the data into the Production (Live) database and notify you accordingly.


SQ Serviceability Descriptions Data Definition table

SQ Servicability Descriptions Data Definition table
Data field Description Mandatory
CLASS_NUMBER A numerical value that can be used to test for a pass or fail SQ result. E.g. Fails are descriptions of class number 1, 2 and 3. the SQ will produce a pass if the address is class 4 or greater No
DESCRIPTION The service availability description Yes
SERVICE_TYPE_ID Service type ID applies if the description applies only to a single service type. In many cases, service types are used by multiple Service Providers. Service availability descriptions is reference data used globally. They will be able to be seen and used by other Service Providers if they are also using the address-based SQ when placing orders for the same service type. Emersion reserves the right to refuse service availability descriptions that are too customer-specific or are unsuitable for use globally. No

GNAF Address Data Definition table

GNAF Address Data Definition table
Data field Description
EMERSION_ID A unique key assigned by the Emersion database automatically. Leave this field empty
GNAF_PID A unique key assigned by the Emersion database automatically. Leave this field empty
UNIT_NUMBER Enter a numerical value in this field if the address has a unit number
UNIT_NUMBER Enter a numerical value in this field if the address has a unit number
UNIT_TYPE_CODE Refer to the Physical Address Reference Data report
LEVEL_NUMBER Enter a numerical value in this field if the address has a level number
LEVEL_TYPE_CODE Refer to the Physical Address Reference Data report
ADDRESS_SITE_NAME Enter a text value in this field if the address has an address site name
ROAD_NUMBER_1 Enter a numerical value in this field if the address has a street number (e.g. 285-289 Hope Road)
ROAD_NUMBER_2 Enter a numerical value in this field if the address has a 2nd road number (e.g. 285-289Hope Road)
LOT_NUMBER Enter a numerical value in this field if the address has a lot number
PLAN_NUMBER Enter a numerical value in this field if the address has a plan number
ROAD_NAME Enter a text value in this field if the address has a road name
ROAD_SUFFIX_CODE Refer to the Physical Address Reference Data report
ROAD_TYPE_CODE Refer to the Physical Address Reference Data report
LOCALITY_NAME Enter a text value in this field if the address has a locality name
STATE_TERRITORY_CODE Refer to the Physical Address Reference Data report
HISTORICAL_FOOTPRINT Leave this field empty
LAST_UPDATED Leave this field empty
SERVICE_CLASS Leave this field empty
QAS fields Only complete these fields if Emersion integrates with your external invoice printing and distribution company.
CARRIER_LOCATION_AVAIL_ID Leave this field empty
GNAF_CARRIER_LOCN_PROFILE_ID Leave this field empty
CARRIER_LOCATION_IDENT Leave this field empty
SERVICE_AVAILABILITY_DESC_ID The Id of the service availability description