Global Address Object:Interface Use - Revision history

Admin at 23:44, 20 June 2022

2022-06-20T23:44:50Z

← Older revision		Revision as of 23:44, 20 June 2022
Line 60:		Line 60:

	==Functions for Processing Input==		==Functions for Processing Input==
	There are 3 functions that process data provided to the Global Address Object, but only '''VerifyAddress''' utilizes the input parameters set in [[#Setting ~~Paramters~~ for Input\|Setting ~~Paramters~~ for Input]]. '''TranslateText''' and '''TransliterateText''' are utilized to map or move any input value and language combination to another output value and language combination.		There are 3 functions that process data provided to the Global Address Object, but only '''VerifyAddress''' utilizes the input parameters set in [[#Setting Parameters for Input\|Setting Parameters for Input]]. '''TranslateText''' and '''TransliterateText''' are utilized to map or move any input value and language combination to another output value and language combination.

	===VerifyAddress===		===VerifyAddress===

Admin at 20:03, 3 January 2019

2019-01-03T20:03:34Z

← Older revision		Revision as of 20:03, 3 January 2019
Line 73:		Line 73:
	The return integer ''intval'' from this call has no determination or value related to the results of the call. The return only defined a 0 or 1 for the success or failure of the function call itself. Getting to the results of the '''VerifyAddress''' call itself, is the job of '''GetOutputParameter''' and '''GetOutputParameterNames'''.		The return integer ''intval'' from this call has no determination or value related to the results of the call. The return only defined a 0 or 1 for the success or failure of the function call itself. Getting to the results of the '''VerifyAddress''' call itself, is the job of '''GetOutputParameter''' and '''GetOutputParameterNames'''.

			<!--
	==Moving Between Alphabets and Character Sets (Not Yet Available)==		==Moving Between Alphabets and Character Sets (Not Yet Available)==
	'''<span style="color:red">Currently not available. This will be enabled soon in a future update.</span>'''		'''<span style="color:red">Currently not available. This will be enabled soon in a future update.</span>'''
Line 114:		Line 114:

	The function takes very similar inputs but the outputs are different, '''Москва''' explicitly transliterated to Latin is Moskva, not Moscow. Melissa Data utilizes the best of transliteration with transcription as well as translation in address validation and correction and will produce the best Latin match of Moscow.		The function takes very similar inputs but the outputs are different, '''Москва''' explicitly transliterated to Latin is Moskva, not Moscow. Melissa Data utilizes the best of transliteration with transcription as well as translation in address validation and correction and will produce the best Latin match of Moscow.
			-->

	==Getting Results and Output==		==Getting Results and Output==

Admin at 18:43, 16 December 2016

2016-12-16T18:43:38Z

← Older revision		Revision as of 18:43, 16 December 2016
Line 15:		Line 15:
	The first set of steps is to initialize the instance of the GlobalAddr Interface.		The first set of steps is to initialize the instance of the GlobalAddr Interface.

	<li>If necessary, call '''SetLicenseString''' and pass the ~~license string~~ as mentioned in [[Global Address Object:Licensing#Parameter\|Licensing]]. Again, this is not necessary if the ~~license string~~ is provided as the recommended environment variable.</li>		<li>If necessary, call '''SetLicenseString''' and pass the License Key as mentioned in [[Global Address Object:Licensing#Parameter\|Licensing]]. Again, this is not necessary if the License Key is provided as the recommended environment variable.</li>

	<li>Call the '''SetPathToGlobalAddrFiles''' function with file a path as a parameter pointing to the location of the Global Address Object reference data files.</li>		<li>Call the '''SetPathToGlobalAddrFiles''' function with file a path as a parameter pointing to the location of the Global Address Object reference data files.</li>

Admin at 17:46, 23 July 2015

2015-07-23T17:46:18Z

@@ Line 1: / Line 1: @@
-[[Global Address Object:Reference|&larr; Global Address Object Reference]]
+{{GlobalAddressObjectNav
+|InterfaceCollapse=
-{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
+}}
 {{CustomTOC}}

Admin at 17:29, 23 July 2015

2015-07-23T17:29:06Z

← Older revision		Revision as of 17:29, 23 July 2015
Line 159:		Line 159:
	===TransliterateText===		===TransliterateText===
	The '''TransliterateText''' function utilizes character set mapping of the input data to arrive at the appropriate output/destination language/alphabet. This is accomplished through the extensive reference data Melissa Data uses for address quality and in most cases maintains the meaning in the destination alphabet.		The '''TransliterateText''' function utilizes character set mapping of the input data to arrive at the appropriate output/destination language/alphabet. This is accomplished through the extensive reference data Melissa Data uses for address quality and in most cases maintains the meaning in the destination alphabet.

	~~<span style="color:red">~~
	~~<INSERT EXAMPLE OF A CSMT table for an alphabet from Latin to another alphabet like Cyrillic>~~
	~~</span>~~

	The code here looks similar but the results can be different:		The code here looks similar but the results can be different:
Line 177:		Line 173:

	The function takes very similar inputs but the outputs are different, '''Москва''' explicitly transliterated to Latin is Moskva, not Moscow. Melissa Data utilizes the best of transliteration with transcription as well as translation in address validation and correction and will produce the best Latin match of Moscow.		The function takes very similar inputs but the outputs are different, '''Москва''' explicitly transliterated to Latin is Moskva, not Moscow. Melissa Data utilizes the best of transliteration with transcription as well as translation in address validation and correction and will produce the best Latin match of Moscow.

	~~<span style="color:red">~~
	~~<Do we want to have a transliteration option of explicit to say it will force Moskva?>~~
	~~</span>~~

Admin at 17:25, 23 July 2015

2015-07-23T17:25:08Z

← Older revision		Revision as of 17:25, 23 July 2015
Line 113:		Line 113:
	Notice that the input in this case is in an address line format. Global Address Object will attempt to field and parse these address lines before processing the verification and correction of the address data.		Notice that the input in this case is in an address line format. Global Address Object will attempt to field and parse these address lines before processing the verification and correction of the address data.

	Setting the '''~~requestedOutputType~~''' parameter tells the Global Address Object to return the results based on the language/alphabet parameter specified. This is accomplished via either translation, transliteration, or a combination of both.		Setting the '''outputPreference''' parameter tells the Global Address Object to return the results based on the language/alphabet parameter specified. This is accomplished via either translation, transliteration, or a combination of both.

	Once we have our parameters set, we are ready to make the processing call to do some work on the input address data.		Once we have our parameters set, we are ready to make the processing call to do some work on the input address data.

Admin at 17:23, 23 July 2015

2015-07-23T17:23:58Z

← Older revision		Revision as of 17:23, 23 July 2015
Line 112:		Line 112:

	Notice that the input in this case is in an address line format. Global Address Object will attempt to field and parse these address lines before processing the verification and correction of the address data.		Notice that the input in this case is in an address line format. Global Address Object will attempt to field and parse these address lines before processing the verification and correction of the address data.

	~~Here is a secondary input example with more discrete input of address elements.~~

	~~;Sample Address~~
	~~:Viale Avignone 9~~
	~~:53100 Siena Siena~~
	~~:ITALY~~

	~~Here is the fielded version of this address:~~

	~~;Sample Address~~
	~~:House number = 9~~
	~~:Postal Code = 53100~~
	~~:Street = Viale Avignone~~
	~~:Administrative Area = Siena~~
	~~:City/Locality = Siena~~
	~~:Country Name = ITALY~~

	~~To pass this fielded address data to the object as parameters the following calls would be coded:~~

	~~<pre>~~
	~~Result = addPtr.SetInputParameter(“inputCountry”, “ITALY”)~~
	~~Result = addPtr.SetInputParameter(“premiseNumber”, “9”)~~
	~~Result = addPtr.SetInputParameter(“PostalCode”, “53100”)~~
	~~Result = addPtr.SetInputParameter(“AdministrativeArea”, “Siena”)~~
	~~Result = addPtr.SetInputParameter(“Locality”, “Siena”)~~
	~~Result = addPtr.SetInputParameter(“thoroughfareName”, “Viale Avignone”)~~
	~~</pre>~~

	~~As this input is fielded there is no need for the Global Address Object to parse the input address elements and they will be utilized as fielded for verification and/or correction.~~

	Lastly, when setting the input parameter(s) there is also the need to specify some configuration values related to what you want the Global Address Object to do with the input address during processing. For example if you would like the results in a different alphabet than originally submitted the output options need be to be specified as a value.

	~~;Sample Address~~
	~~:Москва Москва Мо Мещанский Улица Троицкая 9 Корп 1 Оф. 133 Подъезд 3 129090~~
	~~:RUSSIAN FEDERATION~~

	~~:House number = 9~~
	~~:Street = Улица Троицкая~~
	~~:Postal Code = 129090~~
	~~:Administrative Area = Москва~~
	~~:City/Locality = Москва~~
	~~:Country Name = RUSSIAN FEDERATION~~

	~~To pass this fielded address data to the object as parameters the following calls would be coded:~~

	~~<pre>~~
	~~Result = addPtr.SetInputParameter(“requestedOutputType”, “Native”)~~
	~~Result = addPtr.SetInputParameter(“inputCountry”, “RUSSIAN FEDERATION”)~~
	~~Result = addPtr.SetInputParameter(“premiseNumber”, “9”)~~
	~~Result = addPtr.SetInputParameter(“PostalCode”, “129090”)~~
	~~Result = addPtr.SetInputParameter(“AdministrativeArea”, “Москва”)~~
	~~Result = addPtr.SetInputParameter(“Locality”, “Москва”)~~
	~~Result = addPtr.SetInputParameter(“thoroughfareName”, “Улица Троицкая”)~~
	~~</pre>~~

	Setting the '''requestedOutputType''' parameter tells the Global Address Object to return the results based on the language/alphabet parameter specified. This is accomplished via either translation, transliteration, or a combination of both.		Setting the '''requestedOutputType''' parameter tells the Global Address Object to return the results based on the language/alphabet parameter specified. This is accomplished via either translation, transliteration, or a combination of both.

Admin at 17:20, 23 July 2015

2015-07-23T17:20:35Z

← Older revision		Revision as of 17:20, 23 July 2015
Line 106:		Line 106:

	<pre>		<pre>
	Result = addPtr.SetInputParameter(~~“countryName”~~, “Spain”)		Result = addPtr.SetInputParameter(“inputCountry”, “Spain”)
	Result = addPtr.SetInputParameter(“inputAddressLine1”, “Carretera Rioseco 2”)		Result = addPtr.SetInputParameter(“inputAddressLine1”, “Carretera Rioseco 2”)
	Result = addPtr.SetInputParameter(“inputAddressLine2”, “34170 Villamartín De Campos Palencia”)		Result = addPtr.SetInputParameter(“inputAddressLine2”, “34170 Villamartín De Campos Palencia”)
Line 133:		Line 133:

	<pre>		<pre>
	Result = addPtr.SetInputParameter(~~“countryName”~~, “ITALY”)		Result = addPtr.SetInputParameter(“inputCountry”, “ITALY”)
	Result = addPtr.SetInputParameter(“premiseNumber”, “9”)		Result = addPtr.SetInputParameter(“premiseNumber”, “9”)
	Result = addPtr.SetInputParameter(“PostalCode”, “53100”)		Result = addPtr.SetInputParameter(“PostalCode”, “53100”)
Line 160:		Line 160:
	<pre>		<pre>
	Result = addPtr.SetInputParameter(“requestedOutputType”, “Native”)		Result = addPtr.SetInputParameter(“requestedOutputType”, “Native”)
	Result = addPtr.SetInputParameter(~~“countryName”~~, “RUSSIAN FEDERATION”)		Result = addPtr.SetInputParameter(“inputCountry”, “RUSSIAN FEDERATION”)
	Result = addPtr.SetInputParameter(“premiseNumber”, “9”)		Result = addPtr.SetInputParameter(“premiseNumber”, “9”)
	Result = addPtr.SetInputParameter(“PostalCode”, “129090”)		Result = addPtr.SetInputParameter(“PostalCode”, “129090”)
Line 269:		Line 269:

	<pre>		<pre>
	Result = addPtr.SetInputParameter(~~“countryName”~~, “Australia”)		Result = addPtr.SetInputParameter(“inputCountry”, “Australia”)
	Result = addPtr.SetInputParameter(“premiseNumber”, “91”)		Result = addPtr.SetInputParameter(“premiseNumber”, “91”)
	Result = addPtr.SetInputParameter(“PostalCode”, “4000”)		Result = addPtr.SetInputParameter(“PostalCode”, “4000”)

Admin at 19:19, 21 October 2014

2014-10-21T19:19:41Z

← Older revision		Revision as of 19:19, 21 October 2014
Line 14:		Line 14:
	\|-		\|-
	\|[[Global Address Object:Licensing\|Licensing]]		\|[[Global Address Object:Licensing\|Licensing]]
	\|-
	~~\|[[Global Address Object:Result Code Use\|Result Code Use]]~~
	\|}		\|}
	\|-		\|-

Admin at 19:05, 21 October 2014

2014-10-21T19:05:51Z

← Older revision		Revision as of 19:05, 21 October 2014
Line 45:		Line 45:
	{\| class="mw-collapsible mw-collapsed" style="width:100%;"		{\| class="mw-collapsible mw-collapsed" style="width:100%;"
	\|- align="left"		\|- align="left"
	! style="color:black;"\|~~[[Global Address Object:~~Parameters~~\|Parameters]]~~		! style="color:black;"\|Parameters
	\|-		\|-
	\|[[Global Address Object:Input Parameters\|Input Parameters]]		\|[[Global Address Object:Input Parameters\|Input Parameters]]