Global Address Object:FAQ: Difference between revisions
Jump to navigation
Jump to search
Created page with "← Global Address Object {{CustomTOC}} ==What are the DLLs required for the global address engine to work?== mdGlobalAddr.dll is the main global ..." |
No edit summary |
||
| Line 61: | Line 61: | ||
|Hang||Hangul (South Korea) | |Hang||Hangul (South Korea) | ||
|} | |} | ||
==Result Codes== | |||
===How do I use Results Codes for the Global Address Object?=== | |||
:The Global Address Object will return a number of codes to inform you of the status of an global address. These codes can be divided into AV codes for status, AE codes for errors, and AC codes for changes. | |||
===AV Codes=== | |||
:These codes tell you how good the returned address is. They are slightly different than the AS codes you are used to in our US only products. | |||
:*AV2X denotes an address that has been fully verified. | |||
:*AV1X denotes a partially verified address, but something was invalid. | |||
:*The second number (X) indicates the level of verification to which the output address is valid up to. The possible values from between 1 to 5. | |||
:[[File:TUT WS GlobalAV AVChart.jpg|450px]] | |||
:;For example: | |||
:#AV25 indicates the output address was fully verified to the SubPremises(level 5.) | |||
:#AV24 indicates the output address was fully verified to the Premises(level 4.) | |||
:#AV22 indicates the output address was fully verified to the Locality(level 2.) but we did not have data above the locality. | |||
:#AV14 indicates the output address was partially verified but is good up to the Premises(level 4.) You can imply that this means something was wrong with the sub-premise. | |||
:#AV13 indicates the output address was partially verified but is good up to the Thoroughfare(level 3.) You can imply that this means something was wrong with the premise. | |||
====AV24 vs AV25==== | |||
:Both of these codes are similar in that they tell you the address is fully good down to the delivery address. You will get an AV24 if the destination address is a house or building without any sub-premises (therefore level 5 is impossible). AV25 means the address was fully good and that the destination address does contain sub-premises. If you have a apartment complex and you enter a wrong suite, you will get an AV14 (partially good address, good to the premise). | |||
====Using the AV Codes==== | |||
:One use of the AV codes is to simply look for AV2. This will indicate that all addresses have been fully verified with no errors up to the data available. However, if you want to ensure all addresses are correct down to the delivery address, you should look for AV24 or AV25. | |||
===AE Codes=== | |||
:AE codes will tell you what type of error occurred when verifying the address. It is possible to get AE codes along with AV codes (like Sub-premise invalid, multiple match) or AE codes by themselves (postal code error). | |||
===AC Codes=== | |||
:AC codes will tell you what we changed in the output address when compared to the input address. Standardizations (Street to St) do not count as changes. | |||
==Inputs== | |||
The Global Address Object has a number of different input fields. They include AddressLines 1-8 as well as parsed input fields like locality, administrative area, postal code, etc. You can pass an address into the global Object in two ways: | |||
;1. Pass the entire address using just the Address Lines | |||
:Address1: 2 Holt Street | |||
:Address2: Surry Hills | |||
:Address3: NSW 2010 | |||
:Country: AU | |||
;2. Pass the delivery address in the Address Lines and the area information in using the parsed inputs. | |||
:Address1: 2 Holt Street | |||
:Locality: Surry Hills | |||
:AdministrativeArea: NSW | |||
:PostalCode: 2010 | |||
:Country: AU | |||
===Additional Tips=== | |||
:#If you have the area information parsed out already and you trust it, pass it into the input parsed fields (method #2 above). We do not want to lose that piece of information and making the service re-parse introduces an unnecessary area for errors. If you are not sure that your parsed area information is correct, pass it into the address lines. | |||
:#Be wary of duplicate information. Try not to pass in duplicate information if possible. A common example is the address lines containing the locality and also passing the same value into the input locality. | |||
:#Country input is required. It can contain a country name or an ISO 3166 code, but it must be there. | |||
<!-- | |||
==Outputs== | |||
The Global Address Object has a decent number of output fields. These fields can return duplicate information so it is important to understand exactly what each field returns. Please see the [[Global Address Object:Output Parameters|Output Parameters]] for more detailed information. For this FAQ, we will focus on which pieces will return you back a full address: | |||
===Normal Mode=== | |||
:;FormattedAddress | |||
::Returns the mailing address in one line. | |||
:;Organization + AddressLine1-8 | |||
::Returns the full address back in multiple lines | |||
:;ParsedAreaFields | |||
::Returns the parsed area fields. These fields do not constitute a full address and its data duplicated in FormattedAddress and AddressLines1-8. This data can be used for profiling or de-duping. | |||
::(These are the additional fields which include: locality, dependent locality, administrative area, sub administrative area, sub national area, & postal code.) | |||
===DeliveryLines Options=== | |||
:This option must be turned on. Please see [[Global Address Verification:Request#DeliveryLines|the DeliveryLines option]] for information on how to do this. | |||
:;formattedAddress | |||
::Returns the mailing address in one line. | |||
:;Organization + AddressLine1-8 | |||
::Returns just the delivery address (including the dependent locality). Any area information locality or larger is not included. | |||
:;ParsedAreaFields | |||
::Returns the area information in their individual fields not included in AddressLine1-8. | |||
::(These are the additional fields which include: locality, dependent locality, administrative area, sub administrative area, sub national area, & postal code.) | |||
==Encoding== | |||
The Global Address Object uses UTF-8. Make sure you are storing your address data in Unicode (nvarchar) and passing them to the object in UTF-8. Be on the lookup for question marks (?), squares (▖) or other weird characters like �. They may be an indication of encoding issues and may result in data loss. | |||
--> | |||
[[Category:FAQ]] | [[Category:FAQ]] | ||
[[Category:Global Address Object]] | [[Category:Global Address Object]] | ||
Revision as of 23:21, 25 January 2018
What are the DLLs required for the global address engine to work?
mdGlobalAddr.dll is the main global address engine that the application program will be accessing. mdAddr.dll, mdGeo.dll, mdRightFielder.dll are helper libraries used by mdGlobalAddr.dll in certain cases. These libraries are not to be used directly.
What are the default locations for global address engine DLLs?
The default location for these DLLs is address\windows\dll_64bit
Where are the data files located?
The location on the download is \address\data. When the product is installed, it defaults to D:\Program Files\Melissa DATA\DQS\Data unless the path is changed in the setup prompt.
Which architecture do these DLLs support?
There is support only for 64-bit architecture.
What are the operating systems that the object supports?
The object is currently available across windows and linux platforms.
What are the programming languages in which the application can be designed in order to use these objects?
For windows platform, there are wrappers available for Java, .NET and Python. For linux platform, there are wrappers available for Java, Perl, PHP, Python and Ruby.
How does the update process work?
For each update, the two items that will change are the dll’s and the data files. Those are the files that must be updated, and should be updated in conjunction. To perform the update, you can do either of the following steps:
- Run the installer. The installer will automatically copy over the new dll’s and new data files.
- Manually copy the dll’s and data files. To do this, follow these steps:
- Go to /address/windows/dll_64bit or /address/linux/dll_64bit and copy all the object (.dll for windows, .so for linux) and replace your current objects.
- Go to /address/data and copy all files and/or directories over your current data files.
Note that the update process will likely require that any applications using the objects or data files be restarted.
What are the languages/scripts supported by the Global Address Object?
Global Address Object supports the native language and script for each country that we support. For countries with native languages that does not use latin script, transliterated version of the address can be provided. We currently support the following languages:
| Output Value | Definition |
|---|---|
| Latn | Latin (English transliteration wherever possible) |
| Cyrl | Cyrillic (Russia) |
| Grek | Greek (Greece) |
| Hebr | Hebrew (Israel) |
| Hani | Kanji (Japan) |
| Hans | Simplified Chinese (China) |
| Arab | Arabic (United Arab Emirates) |
| Thai | Thai (Thailand) |
| Hang | Hangul (South Korea) |
Result Codes
How do I use Results Codes for the Global Address Object?
- The Global Address Object will return a number of codes to inform you of the status of an global address. These codes can be divided into AV codes for status, AE codes for errors, and AC codes for changes.
AV Codes
- These codes tell you how good the returned address is. They are slightly different than the AS codes you are used to in our US only products.
- AV2X denotes an address that has been fully verified.
- AV1X denotes a partially verified address, but something was invalid.
- The second number (X) indicates the level of verification to which the output address is valid up to. The possible values from between 1 to 5.
- For example
- AV25 indicates the output address was fully verified to the SubPremises(level 5.)
- AV24 indicates the output address was fully verified to the Premises(level 4.)
- AV22 indicates the output address was fully verified to the Locality(level 2.) but we did not have data above the locality.
- AV14 indicates the output address was partially verified but is good up to the Premises(level 4.) You can imply that this means something was wrong with the sub-premise.
- AV13 indicates the output address was partially verified but is good up to the Thoroughfare(level 3.) You can imply that this means something was wrong with the premise.
AV24 vs AV25
- Both of these codes are similar in that they tell you the address is fully good down to the delivery address. You will get an AV24 if the destination address is a house or building without any sub-premises (therefore level 5 is impossible). AV25 means the address was fully good and that the destination address does contain sub-premises. If you have a apartment complex and you enter a wrong suite, you will get an AV14 (partially good address, good to the premise).
Using the AV Codes
- One use of the AV codes is to simply look for AV2. This will indicate that all addresses have been fully verified with no errors up to the data available. However, if you want to ensure all addresses are correct down to the delivery address, you should look for AV24 or AV25.
AE Codes
- AE codes will tell you what type of error occurred when verifying the address. It is possible to get AE codes along with AV codes (like Sub-premise invalid, multiple match) or AE codes by themselves (postal code error).
AC Codes
- AC codes will tell you what we changed in the output address when compared to the input address. Standardizations (Street to St) do not count as changes.
Inputs
The Global Address Object has a number of different input fields. They include AddressLines 1-8 as well as parsed input fields like locality, administrative area, postal code, etc. You can pass an address into the global Object in two ways:
- 1. Pass the entire address using just the Address Lines
- Address1: 2 Holt Street
- Address2: Surry Hills
- Address3: NSW 2010
- Country: AU
- 2. Pass the delivery address in the Address Lines and the area information in using the parsed inputs.
- Address1: 2 Holt Street
- Locality: Surry Hills
- AdministrativeArea: NSW
- PostalCode: 2010
- Country: AU
Additional Tips
- If you have the area information parsed out already and you trust it, pass it into the input parsed fields (method #2 above). We do not want to lose that piece of information and making the service re-parse introduces an unnecessary area for errors. If you are not sure that your parsed area information is correct, pass it into the address lines.
- Be wary of duplicate information. Try not to pass in duplicate information if possible. A common example is the address lines containing the locality and also passing the same value into the input locality.
- Country input is required. It can contain a country name or an ISO 3166 code, but it must be there.