errata

These build time properties define the pattern of Formatted Street, Formatted Location and SearchFields.

Use the following convention for defining fields, placing a space or comma between fields. Add or remove field names as needed in each property to meet a country's standard address format.

  • Adding field names: use square brackets; for example [StreetName]
  • Adding a space between fields: use curly brackets around the space; for example [Field1]{ }[Field2]
  • Adding a comma between fields: use curly brackets around the comma; for example [Field1]{,}[Field2]

Properties

  • Formatted Street: Use this property to define the pattern of Formatted Street in the output address. By default, the pattern is:
    "Formatted Street" : "[HouseNumber]{ }[StreetName]"

    In output, this displays as “123 XYZ Street”.

    • If PlaceName is required in the output, the pattern is:
      "Formatted Street" : "[PlaceName]{ }[HouseNumber]{ }[StreetName]"
    • If an additional field (StreetAdditionalFields or RangeAdditionalFields) is required in the output, add the field's Key to the pattern. For example, adding the case-sensitive key [Language] from the StreetAdditionalFields section :
      "Formatted Street" : "[Language]{ }[HouseNumber]{ }[StreetName]"
  • Formatted Location: Use this property to define the Formatted Location pattern in the output address. By default, the pattern is:
    "Formatted Location" : "[AreaName3]{, }[AreaName1]{, }[PostCode]"

    In output, this displays as “Town, State, PostCode”.

  • SearchFields: Use this comma-separated property to define which fields display typeahead search results. By default, the pattern is:
    "SearchFields" : "StreetName,AreaName4,AreaName3,PostCode"
    To enable search on a specific field, add the field name to the list of fields.
    • Enable search on PlaceName:
      "SearchFields": "PlaceName,StreetName,AreaName4,AreaName3,PostCode"
    • Enable search on an additional field (StreetAdditionalFields or RangeAdditionalFields), add the field's Key to the pattern. For example, this will enable search on the additional field mapped with a "language" key:
      "SearchFields": " Language,StreetName,AreaName4,AreaName3,PostCode"
    • Enable search on an address number:
      "SearchFields": "HouseNumber,StreetName,AreaName4,AreaName3,PostCode"