2015Q3.0 Release Notes

Release Notes

We are pleased to present our 2015Q3.0 release. New in this release are:

  • Updates to Enhancement Data
    • Updated enhancement data set for ISO2 Administrative Areas
    • PAF-DPS Enhancement Data
  • Duplicate Input Handling
  • Reverse Geocoding
  • South Korea data with new format

Check out our 2015Q3.0 Release Webinar held on July 23rd, 2015:

In this video, Loqate Director of Engineering Uma Ramamurthy and Product Manager Elie Challita take the time to discuss the new features of the Q3 release which include updates to the Enhancement Data and South Korean data as well as the addition of duplicate input handling and reverse geocoding functionality.

This document describes these changes in greater detail along with things to be aware of and other helpful tips.

Local API Updates

Updates to Enhancement Data

Updates to Enhancement Data set for ISO2 Administrative Areas
In the 2015Q2 release, GBG Loqate introduced an enhancement data set for ISO 3166-2 Administrative Area codes. This data set allowed users to obtain ISO2 Administrative Area codes for an input address that contains an Administrative Area in the output address from the verification process. The 2015Q2 release’s data set contained ISO codes only for the US and Argentina.

In the 2015Q3 release, the data set has been expanded to include Canada, Germany, Brazil, Colombia, and France.

The ISO2 Administrative Area codes can be obtained by looking up the lqtProcessResult for a field named “AdministrativeAreaISO2”. The status field for the ISO2 Administrative Area codes is called “AdministrativeAreaISO2Status”.

This data set will be available as a single world wide data set under the product code DSEWWI.

PAF-DPS Enhancement Data
In this release, GBG Loqate introduced an enhancement data set for Delivery Point Suffixes for UK Addresses. The DPS is a unique 2 digit code that, when appended to a UK postcode, allows each live Delivery Point to be uniquely identified.
The output fields are as follows:

  • PostcodeType
  • DPS
  • Organization Key
  • Address Key

Please refer to the online documentation for more details on these output fields.

This data set will be available under the product code DSEGBRD. It can be licensed as an addition to any of our UK data packs.

Duplicate Input Handling

GBG Loqate has introduced a new feature in its parsing engine to handle duplicates in input. Address elements that contain duplicates in input cause slower processing and complicate parsing. With the new feature, GBG Loqate’s engine can handle some of the duplicate information that is encountered upon user input.

Duplicate input handling is currently hidden behind an option (DuplicateHandlingMask) which is not enabled by default. The option can be configured by enabling various levels of handling duplicate inputs. When duplicates are removed at any level, the removed information is updated in an output structure called DuplicateInfo, for further inspection.

The option and the level information are described below under the section titled “New Server Options.” Please refer to the online documentation for detailed explanation of each of the levels and examples.

Reverse Geocoding

In this release, GBG Loqate is introducing a Beta program for our Reverse Geocoder. The Reverse Geocoder takes a latitude, longitude and country as input and outputs the highest address available for that geocode in that country. This feature has an associated process named “ReverseGeocode.” The following fields need to be supplied as input:

  • Latitude
  • Longitude
  • Country

Reverse Geocoding data packs are required to be installed in the data folder along with Geocoding data packs for the process to work.

In this release, reverse geocoding data packs are available for most of the major countries. We encourage partners to contact Product Manager Elie Challita at elie.challita@loqate.com to sign up for the Beta program and provide feedback to assist our development effort.

South Korea: New Postal Format

South Korea has recently changed its postal address format. The new format includes different numbering systems, thoroughfare types, and a shift from 6-digit postcodes to 5-digit postcodes. Starting with the 2015Q3 release, GBG Loqate is now compatible with the new format.

The new format is automatically included in the standard Korean data set DSVKOR. The functionality is as follows:

  • Input addresses that are compliant with the new format will be verified and output according to the new format, including all new names and 5-digit postcodes.
  • Input addresses that are compliant with the old format will be verified and output according to the old format. However, if the address’ 6-digit postcode has been replaced by a 5-digit postcode then the 5-digit postcode will be output instead.

The change in formats has caused a regression in GBG Loqate’s ability to geocode addresses in Korea. We observed a 9% regression rate in our release tests. This will be addressed in the upcoming weeks, and an updated Geocode data pack fixing these regressions for Korea will be available for download by the end of July.

New Server Options

DuplicateHandlingMask
This option allows users to specify the various levels at which duplicates can be removed. These levels are not mutually exclusive.

The levels are as follows:

  • If the DuplicateHandlingMask is set to 1 (called Single Field Level), the engine will pre-process the input and remove duplicates that occur in a single field.
  • If the DuplicateHandlingMask is set to 2 (called Cross Field Level), the engine will pre-process the input and remove duplicates across all fields.
  • If the DuplicateHandlingMask is set to 4 (called Tag Field Level), the engine will pre-process the input and remove duplicates in fields which have not been internally tagged.
  • If the DuplicateHandlingMask is set to 8 (called Field Status Level), the engine will post-process the output from verification and remove duplicates from non-verified fields.

Since these values are non-exclusive, combinations may be enabled by adding the values. For instance, Single Field Level and Cross Field Level can be enabled by setting the DuplicateHandlingMask to 3. For best results, set the DuplicateHandlingMask to 11 which is a combination of Single Field Level, Cross Field Level, and Field Status Level.

SuppressUnmatched

  • If this option is set to TRUE or ON, unverified fields will not be output in Address fields (Address, Address1, Address2, etc.). Default option is FALSE or OFF.

NewSearchPrefered

  • If this option is set to TRUE or ON, New Search is executed before the Old Search during execution of the Search Process. Typically if the input is nearly complete, New Search is preferred to complete the search and the option should be set to TRUE or ON. If the input is quite partial and is not nearly a complete address, Old Search is preferred and the option should be set to FALSE or OFF. Default option is FALSE or OFF.

Other Local API Updates

Please visit https://support.loqate.com/support/releasenotes/2015q3cases for a list of cases resolved in this release. If you would like more details on any of the solved cases listed, please contact support@loqate.com for further information.

Cloud API Updates

The Loqate Cloud will be updated to 2015Q3.0 along with the general release. Please visit https://support.loqate.com/support/releasenotes/2015q3cases for a list of new features available through our Cloud APIs.

Country Updates

We are continually improving our country data and rules/lexicons to support them. Please visit https://support.loqate.com/support/releasenotes/2015q3cases for a list of cases involving improvements and enhancements for a particular country.

The table below shows which countries have been enhanced, and how, in this release.

  • Reference Data = 197 countries
  • Lexicons = 14 countries
  • Context Rules = 6 countries
Country Name ISO Code Context Rules Lexicons Reference Data Address Format
AFGHANISTAN AF              x
ÅLAND ISLANDS AX
ALBANIA AL              x
ALGERIA DZ              x
AMERICAN SAMOA AS              x
ANDORRA AD              x
ANGOLA AO              x
ANGUILLA AI              x
ANTARCTICA AQ              x
ANTIGUA AND BARBUDA AG              x
ARGENTINA AR
ARMENIA AM
ARUBA AW              x
AUSTRALIA AU            x           x              x
AUSTRIA AT              x
AZERBAIJAN AZ
BAHAMAS BS
BAHRAIN BH              x
BANGLADESH BD              x
BARBADOS BB              x
BELARUS BY              x
BELGIUM BE
BELIZE BZ              x
BENIN BJ              x
BERMUDA BM
BHUTAN BT              x
BOLIVIA, PLURINATIONAL STATE OF BO              x
BONAIRE, SINT EUSTATIUS AND SABA BQ
BOSNIA AND HERZEGOVINA BA
BOTSWANA BW              x
BOUVET ISLAND BV
BRAZIL BR              x
BRITISH INDIAN OCEAN TERRITORY IO              x
BRUNEI DARUSSALAM BN              x
BULGARIA BG
BURKINA FASO BF              x
BURUNDI BI              x
CAMBODIA KH
CAMEROON CM              x
CANADA CA           x              x
CAPE VERDE CV              x
CAYMAN ISLANDS KY              x
CENTRAL AFRICAN REPUBLIC CF              x
CHAD TD              x
CHILE CL              x
CHINA CN           x

x

CHRISTMAS ISLAND CX              x
COCOS (KEELING) ISLANDS CC              x
COLOMBIA CO              x
COMOROS KM              x
CONGO CG              x
CONGO, THE DEMOCRATIC REPUBLIC OF THE CD              x
COOK ISLANDS CK              x
COSTA RICA CR              x
CÔTE D’IVOIRE CI
CROATIA HR              x
CUBA CU              x
CURAÇAO CW              x
CYPRUS CY              x
CZECH REPUBLIC CZ              x
DENMARK DK              x
DJIBOUTI DJ              x
DOMINICA DM              x
DOMINICAN REPUBLIC DO
ECUADOR EC
EGYPT EG
EL SALVADOR SV              x
EQUATORIAL GUINEA GQ              x
ERITREA ER              x
ESTONIA EE              x
ETHIOPIA ET
FALKLAND ISLANDS (MALVINAS) FK              x
FAROE ISLANDS FO              x
FIJI FJ              x
FINLAND FI              x
FRANCE FR           x              x
FRENCH GUIANA GF              x
FRENCH POLYNESIA PF              x
FRENCH SOUTHERN TERRITORIES TF
GABON GA
GAMBIA GM              x
GEORGIA GE              x
GERMANY DE              x
GHANA GH              x
GIBRALTAR GI
GREECE GR            x           x              x
GREENLAND GL

x

GRENADA GD              x
GUADELOUPE GP              x
GUAM GU              x
GUATEMALA GT              x
GUERNSEY GG
GUINEA GN              x
GUINEA-BISSAU GW              x
GUYANA GY
HAITI HT              x
HEARD ISLAND AND MCDONALD ISLANDS HM
HOLY SEE (VATICAN CITY STATE) VA
HONDURAS HN              x
HONG KONG HK              x
HUNGARY HU
ICELAND IS              x
INDIA IN              x
INDONESIA ID              x
IRAN, ISLAMIC REPUBLIC OF IR              x
IRAQ IQ

x

IRELAND IE           x
ISLE OF MAN IM
ISRAEL IL
ITALY IT           x              x
JAMAICA JM              x
JAPAN JP            x           x              x
JERSEY JE
JORDAN JO              x
KAZAKHSTAN KZ
KENYA KE              x
KIRIBATI KI              x
KOREA, DEMOCRATIC PEOPLE’S REPUBLIC OF KP              x
KOREA, REPUBLIC OF KR            x           x              x
KUWAIT KW              x
KYRGYZSTAN KG              x
LAO PEOPLE’S DEMOCRATIC REPUBLIC LA              x
LATVIA LV
LEBANON LB              x
LESOTHO LS              x
LIBERIA LR              x
LIBYA LY              x
LIECHTENSTEIN LI
LITHUANIA LT              x
LUXEMBOURG LU              x
MACAO MO              x
MACEDONIA, THE FORMER YUGOSLAVREPUBLIC OF MK              x
MADAGASCAR MG              x
MALAWI MW
MALAYSIA MY
MALDIVES MV              x
MALI ML              x
MALTA MT              x
MARSHALL ISLANDS MH              x
MARTINIQUE MQ              x
MAURITANIA MR              x
MAURITIUS MU              x
MAYOTTE YT              x
MEXICO MX
MICRONESIA, FEDERATED STATES OF FM              x
MOLDOVA, REPUBLIC OF MD              x
MONACO MC
MONGOLIA MN
MONTENEGRO ME              x
MONTSERRAT MS
MOROCCO MA              x
MOZAMBIQUE MZ              x
MYANMAR MM              x
NAMIBIA NA              x
NAURU NR              x
NEPAL NP              x
NETHERLANDS NL              x
NEW CALEDONIA NC              x
NEW ZEALAND NZ              x
NICARAGUA NI              x
NIGER NE              x
NIGERIA NG              x
NIUE NU              x
NORFOLK ISLAND NF              x
NORTHERN MARIANA ISLANDS MP              x
NORWAY NO              x
OMAN OM              x
PAKISTAN PK              x
PALAU PW              x
PALESTINIAN TERRITORY, OCCUPIED PS
PANAMA PA
PAPUA NEW GUINEA PG              x
PARAGUAY PY              x
PERU PE              x
PHILIPPINES PH              x
PITCAIRN PN              x
POLAND PL              x
PORTUGAL PT           x              x
PUERTO RICO PR

x

QATAR QA

x

RÉUNION RE
ROMANIA RO              x
RUSSIAN FEDERATION RU              x
RWANDA RW              x
SAINT BARTHÉLEMY BL              x
SAINT HELENA, ASCENSION AND TRISTANDA CUNHA SH              x
SAINT KITTS AND NEVIS KN              x
SAINT LUCIA LC              x
SAINT MARTIN (FRENCH PART) MF              x
SAINT PIERRE AND MIQUELON PM              x
SAINT VINCENT AND THE GRENADINES VC              x
SAMOA WS              x
SAN MARINO SM
SAO TOME AND PRINCIPE ST              x
SAUDI ARABIA SA
SENEGAL SN              x
SERBIA RS
SEYCHELLES SC              x
SIERRA LEONE SL              x
SINGAPORE SG              x
SINT MAARTEN (DUTCH PART) SX              x
SLOVAKIA SK
SLOVENIA SI              x
SOLOMON ISLANDS SB              x
SOMALIA SO              x
SOUTH AFRICA ZA              x
SOUTH GEORGIA AND THE SOUTH SANDWICHISLANDS GS              x
SOUTH SUDAN SS              x
SPAIN ES              x
SRI LANKA LK              x
SUDAN SD              x
SURINAME SR              x
SVALBARD AND JAN MAYEN SJ              x
SWAZILAND SZ              x
SWEDEN SE              x
SWITZERLAND CH              x
SYRIAN ARAB REPUBLIC SY              x
TAIWAN, PROVINCE OF CHINA TW            x           x
TAJIKISTAN TJ              x
TANZANIA, UNITED REPUBLIC OF TZ
THAILAND TH           x
TIMOR-LESTE TL              x
TOGO TG              x
TOKELAU TK              x
TONGA TO              x
TRINIDAD AND TOBAGO TT              x
TUNISIA TN              x
TURKEY TR              x
TURKMENISTAN TM              x
TURKS AND CAICOS ISLANDS TC              x
TUVALU TV              x
UGANDA UG              x
UKRAINE UA              x
UNITED ARAB EMIRATES AE              x
UNITED KINGDOM GB           x              x
UNITED STATES US            x           x              x
UNITED STATES MINOR OUTLYING ISLANDS UM              x
URUGUAY UY              x
UZBEKISTAN UZ
VANUATU VU              x
VENEZUELA, BOLIVARIAN REPUBLIC OF VE              x
VIET NAM VN              x
VIRGIN ISLANDS, BRITISH VG              x
VIRGIN ISLANDS, U.S. VI              x
WALLIS AND FUTUNA WF              x
WESTERN SAHARA EH
YEMEN YE              x
ZAMBIA ZM
ZIMBABWE ZW              x

 

Need Help?

Many answers to your questions may be found in our support pages. Please make sure to register at: https://support.loqate.com/wp-login.php?action=register so that you may have full access to all technical information on our website. If you have a general question or if you have an issue or enhancement request you would like to report, please fill out the web form to submit a case at https://support.loqate.com/support/file-a-case/.

If you still have questions, please contact Loqate Support at support@loqate.com or your account manager.

™GBG Loqate and EverythingLocation are trademarks of GBG Loqate, Inc. All other trademarks are the property of their respective owners.