field

This set of build time properties defines the dataset’s field formats. The properties are:

  • StreetName: Indicates the street column
  • PostCode: Indicates the postcode column
  • AreaName1: This property indicates the stateprovince column
  • AreaName1 (USA specific): Mapped to a column which is a state abbreviation
  • AreaName2: This property indicates the county column
  • AreaName3 : This property indicates the city column
  • AreaName4: This property indicates the locality column
  • StartingAddressNumber :This property indicates the starting number for address number ranges for the left and right sides of a road.
  • EndingAddressNumber: This property indicates the ending number for address number ranges for the left and right sides of a road.
  • StreetSideIndicator: This property indicates even and/or odd address number structures for the left and right sides of the road. The column being mapped should have one of the following values as supplied in the table below. Any other value being mapped may result in a data creation error.
    Column Value Description Example
    0 or 1 No address number range
    2

    Even Ranges

    From Left – To Left (2-10)

    2,4,6,8,10
    3

    Odd ranges

    From Left – To Left (1-9)

    1,3,5,7,9
    4

    Mixed

    From Left – To Left (1-10)

    1,2,3,4,5,6,7,8,9,10
  • geometry_name: This property pairs the key GeometryName with the value “GEOM.”
  • StreetAdditionalFields: This property indicates whether or not additional street candidate information is necessary
  • RangeAdditionalFields: This property indicates whether or not additional range information is necessary.
  • UnitAdditionalFields: This property identifies an additional field at the unit level.
  • PostalAdditionalFields: This property identifies an additional field at the administrative boundary level.

    The following properties are subordinate to the properties above.

    • Comments: Description about the property
    • keys: This property identifies single or multiple keys for a particular field. It nests under any of the above properties. Recommended not to change existing keys as generated. Addition is allowed for the additional fields at different levels.
    • values : This property indicates the name of the column to which the field is mapped in the custom data source. It nests under any of the above properties.
    • altValues: An optional field, and indicates alternate value to the key being mapped.

Canada-specific altValue: The postal code in Canada comprises 6 digits. Of these 6 digits, the 1st three digits are mapped to values, the last three digits are mapped to altValues.

"PostCode" : { 
   "keys": ["LeftPostCode", "RightPostCode"],
   "values": ["PostalCode", "PostalCode"],
   "altValues”: ["PostalCode_AddOn", PostalCode_AddOn"] 
   }
"PostCode" : { 
   "keys": ["LeftPostCode", "RightPostCode"],
   "values": ["PostalCode", "PostalCode"],
   "altValues”: ["PostalCode_AddOn", PostalCode_AddOn"] 
   }
 "PostCode" : {
      "Comments" : "Mapping for Post Code and Extended Post Code from source data.",
      "keys" : [ "LeftPostCode", "RightPostCode" ],
      "values" : [ "Left_postalcode_5", "Right_postalcode_5" ],                                                    
      "altValues" : [ "Left_postalcode_3", "Right_postalcode_3" ]
    },

Singapore: Postal codes are mapped in 2 columns. The first column contains the initial 2 digit postcode. The second column contains the last 4 digits.

For address points the value and altValue are postcode2, postcode4

For street data: l_postcode2/l_postcode4/r_postcode2/r_postcode4

"PostCode" : {
      "Comments" : "Mapping for Post Code and Extended Post Code from source data.",
      "keys" : [ "LeftPostCode", "RightPostCode" ],
      "values" : ["l_postcode2", "r_postcode2"],
      "altValues" : ["l_postcode4", "r_postcode4"]
    },

Example

"field": {
    "StreetName": {
"Comments" : "Mapping for Street Name and Street Name Alias from source data.",
     "keys" : "StreetName",
     "values" : "STRASSE",
	"altValues" : ""
    },
    "PostCode" : {
"Comments" : "Mapping for Post Code and Extended Post Code from source data.",
      "keys" : [ "LeftPostCode", "RightPostCode" ],
      "values" : [ "PLZ", "PLZ" ],
      "altValues" : [ "", "" ]
    },
    "AreaName3" : {
      "keys" : [ "LeftAreaName3", "RightAreaName3" ],
      "values" : [ "ORT", "ORT" ],
      "altValues" : [ "", "" ]
    },
    "AreaName4" : {
      "keys" : [ "LeftAreaName4", "RightAreaName4" ],
      "values" : [ "ORTSTEIL", "ORTSTEIL" ],
      "altValues" : [ "", "" ]
    },
    "StreetSideIndicator" : {
	  "Comments" : "Mapping for Street Side Indicator from source data.",
      "keys" : [ "LeftStreetSideIndicator", "RightStreetSideIndicator" ],
      "values" : [ "", "" ]
    },
    "StartingAddressNumber" : {
	  "Comments" : "Mapping for Starting Address Number from source data.",
      "keys" : [ "FromLeftStartingAddressNumber", "FromRightStartingAddressNumber" ],
      "values" : [ "HAUSNR_VON", "HAUSNR_VON" ]
    },
    "EndingAddressNumber" : {
	  "Comments" : "Mapping for Ending Address Number from source data.",
      "keys" : [ "ToLeftEndingAddressNumber", "ToRightEndingAddressNumber" ],
      "values" : [ "HAUSNR_VON", "HAUSNR_VON" ]
    },
	"StreetAdditionalFields" : {
	  "Comments" : "Mapping for Additional Fields at Street level from source data.",
      "keys" : [ "sub_locality", "sub_town" ],
      "values" : [ "ORTSTEIL", "ORT" ]
    },
    "RangeAdditionalFields" : {
	  "Comments" : "Mapping for Additional Fields at Range level from source data.",
      "keys" : [ "RangeIdentifier" ],
      "values" : [ "ORTSTEIL" ]
    },
	"UnitAdditionalFields" : {
	  "Comments" : "Mapping for Additional Fields at Unit level from source data.",
      "keys" : [ "UnitIdentifier" ],
      "values" : [ "ORTSTEIL" ]
    },
	"PostalAdditionalFields" : {
	  "Comments" : "Mapping for Additional Fields at Postal level from source data.",
      "keys" : [ "PostalIdentifier" ],
      "values" : [ "ORTSTEIL" ]
    },
    "geometry_name" : {
	  "Comments" : "Mapping for Geometry from source data.",
      "keys" : "GeometryName",
      "values" : ""
    }
  }