Server Options - GBG Loqate

Server Options

The following commands can be used to control and manipulate the Loqate process or output. These are considered advanced functions, and we recommend that server options are used in custom workflows. CASS2 related server options added to the bottom of this list.

Server Option	Description
AddressLineSeparator	Used to specify the string which will separate the output address lines within the output Address field (default `<br>`).
AutocompleteIndexOnly	This option allows the user to specify whether the search process should use Powersearch auto-complete index ONLY. The default is `OFF`. The option should be set to 0 or `OFF` to allow search tool to also use the parser and match tool when the auto-complete index cannot find any results. The option should be set to 1 or `ON` to allow the search tool to use the Powersearch auto-complete index files. This can also be used as a process option.
CasingIgnoreFields	Used to specify the fields that should be ignored by the OutputCasing option. System default is “ID,PostalCode,PostalCodePrimary,PostalCodeSecondary,ISO3166-2,ISO3166-3,PostBox,PostBoxNumber,PostBoxType,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC,AQI,HyphenClass,MatchedFieldList,DPS,CountryCode,Outputstatus,FormattedAddress”. Additionally, the following datasets also add AdministrativeArea to the default values: AUS, BRA, CAN, ITA, MEX, CHE, and USA. Currently system defaults cannot be overridden, but country-level values will be ignored when CasingIgnoreFields is used. Please re-use “AdministrativeArea” as a value to retain the default behavior.
CassCompanyName	This option is set within the `loqate.ini` file. This will allow the Loqate engine to print the Company Name value in the CASS and PS3553 reports. Please note, if a value has not been specified, then the default value will be `LOQATE`.
CassSoftwareName	This option is set within the `loqate.ini` file. This will allow the Loqate engine to print the CASS software name value in the CASS and PS3553 reports. Please note, if a value has not been specified, then the default value will be `LOQATE ENGINE`.
CassSoftwareVersion	This option is set within the `loqate.ini` file. This will allow the Loqate engine to print the CASS software version in the CASS and PS3553 reports. Please note, if a value has not been specified, then the default value will be `20.13.04.N`.
CertifiedCountryList	Used to specify a comma-delimited list of countries where data should be processed using the relevant certified process. e.g. “USA,CAN,AUS” to give CASS, SERP, and AMAS certified output respectively.
CombinedSearchMethods	Specifies whether or not to use a word-based search algorithm similar to a web search engine approach. Default `Yes`.
CombinedVerifyMethods	If this option is set to YES or `ON` or `TRUE` or 1, the word-based search algorithm similar to a web search engine approach will be enabled during verification process. Default `Yes`.
ConfidenceThreshold	Used to specify the threshold at which to stop returning parse interpretations, as a percentage of the confidence of the top result. Default `90`.
ConfigurationFilename	Used to specify the name of the file that will attempt to be opened during the call to `lqtServer::init`. Default `loqate.ini`.
ConformToReference	Controls whether the output address fields should strictly conform to the values stored in the reference data. This option is particularly relevant when verifying Premise and SubBuilding fields. Options are “Yes” and “No” with the default being “No”. For example, given reference data: 14 Main St Ste 1 Input: 14A Main St Ste 1A Output with default No: 14A Main St Ste 1A Output with Yes: 14 Main St Ste 1
ContextResultCacheSize	Used to specify how many sets of context results should be cached in memory. This cache is a cost-based cache based on processing time, meaning that the slowest context analyses have their results cached. Default `0`. Values up to around 5,000 are relevant, but the memory usage and performance gain will be dependent on the supplied input data.
ContextCountryCacheSize	Used to specify the number of MRU countries to generate ContextResult caches for. On an unsorted multi-country file a value of around 10 may be relevant, but the memory usage and performance gain will be dependent on the supplied input data.
CountryFields	Used to specify the comma delimited list of fields to be searched for country information. This should be a subset of the ParseFields entry.
CustomFields	Used to specify the comma delimited list of custom fields to be searched for during the parse process.
CustomFieldConfidence	Used to specify the confidence to be applied to the recognition of any fields recognized through the CustomFields option.
DataDirectory	Used to specify the directory in which to find the Global Knowledge Repository, if other than the directory of the `loqate.ini` configuration file specified during the `lqtServer::init` call.
DefaultCountry	Used to specify the ISO 3166-1 alpha-3 code which should be used if no identifiable country can be found in an input record.
DuplicateHandlingMask	Used to specify the duplicate handling level, between 0 and 15. Default is `0`. When option is set, duplicate components in the input address are removed if it meets a certain criteria. For more details, please click this link.
EnhancedCountryTool	This option allows users to enable the Automatic Country Identification. To enable the option, set the value of the option to “`ON`” or “`True`”. To disable the option set the value to “`OFF`” or “`False`”. Default `False`.
FieldNameWeight	Used to specify the default field name weight, between 1 and 255. Default `10`. A larger value will give more precedence to the supplied field name, a smaller value will give more precedence to the GKR matches. Individual field name weights can also be declared using the syntax. For instance ‘Organization=240,AdministrativeArea=100,50’ would mean a field name weight of 240 for the Organization field, 100 for the AdministrativeArea field, and a default of 50 for all remaining fields. This option is only used during the initial Parse process, and not during the Match process.
FieldStatus	This option produces a status code for every returned field. Default is “false”; to see this value, set the option to “true”. Examples include Verified, Identified, or Added. Statuses are defined here.
FlexiconCountryList	This option allows the user to specify a comma separated list of ISO 3166-1 alpha-3 country codes for which phonetic lexicons is enabled for parsing. Default value is empty which means that the phonetic lexicons are not enabled for any country by default.
ForceCountry	Used to specify the ISO 3166-1 alpha-3 code which should be used for all input records.
FormatFields	A list of default field formats for those fields that can be derived from a combination of other fields. This can be overridden on a per-country basis, and should only be changed if requested by Support staff.
GeocodeCountryList	Used to specify a comma-delimited list of ISO 3166-1 alpha-3 codes of acceptable countries to geocode. Input records from other countries will not return geocodes. The default is to process data from all countries.
GeocodeMatchRules	A list of default match rules specifying how fields can be combined when attempting to generate a geocode match. This can be overridden on a per-country basis, and should only be changed if requested by Support staff.
IgnoreUnmatched	Allow unmatched input data within the address lines to be ignored during a Search process, meaning that a search can proceed matching only partial input data. Default `No`. We don’t recommend you use this server option on a Verify process, as it may reduce the accuracy of otherwise valid results.
LogFileName	Used to specify a filename for debug output. Must be specified before the `lqtServer::init` call.
MatchScoreAbsoluteThreshold	Used to specify the minimum matchscore a record must reach in the Match process to be taken into account as a candidate for matching. Default value is `60` and the maximum value is 100.
MatchScoreThresholdFactor	This is a value that is used as a factor of the highest matching result. The resulting value is then used as a cut-off for considering candidates for the results. The higher the value of the factor, the higher the chance of getting a good verification result. Default value is `95` and the maximum value is 100.
MaximumGeoDistance	Used to specify the maximum GeoDistance a geocode can reach and still be returned as a result. Default is -1 (no limit).
MaximumInstanceCount	Used to specify the maximum number of lqtServer instances to allow to run concurrently. Default is -1 (no limit). If using the single threaded library it is recommended to set this to 1 to ensure that no attempt to open multiple lqtServer instances can occur.
MaxResults	Used to specify the maximum number of results to return in the ProcessResults structure.
MinimumGeoAccuracyLevel	Used to specify the minimum GeoAccuracy level a geocode must reach in order to be returned as a result. Default is `0` (zero), valid values are 0-5.
MinimumMatchscore	Used to specify the minimum matchscore a record must reach in order to avoid reversion. Default is `0` (zero), valid values are 0-100.
MinimumPostcode	Used to specify the minimum postcode status a record must reach in order to avoid reversion. Default is `0` (zero), valid values are 0-8.
MinimumSimilarity	Used to specify the minimum similarity score that is needed to make a match to a candidate result. Default value is `70`.
MinimumVerificationLevel	Used to specify the minimum verification level a record must reach in order to avoid reversion. Default is `0` (zero), valid values are 0-5.
NativeAddressLineReverse	Used to specify whether to reverse the order of the input address lines when processing non-Latin data. Usually this is set on a per-country basis automatically, but can be overridden by setting the server option as appropriate. When set to `False`, any input Address lines are concatenated for parsing in normal order (e.g. Address1 + Address2 + Address3), when set to `True` any input Address lines are concatenated for parsing in reverse order (e.g. Address3 + Address2 + Address1).
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`.
OutputAddressFormat	Used to specify whether to output an extra field for the Address block fields with the suffix ‘Format’ showing how the hierarchical field positioning has occurred. Valid options are ‘`Yes`’ or ‘`No`’, default ‘`No`’.
OutputCasing	Used to specify the letter case to use for output fields. Valid options are ‘Upper’, ‘Title’, or ‘Lower’. The default will be Default: ‘Title’; unless the postal authority prefer a different case. For example, the postal authority in Spain prefer to have the Locality formatted in upper case.
OutputScript	Used to specify the language or character set (based on the ISO 15924 standard) in which the output should be encoded, from the following list of possible values: - 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) - Native - Output in the native script wherever possible
OutputSortType	Used to specify the order in which the Search output results should be sorted. To sort in alphabetical order use ‘Alphabetical’, or alternatively specify ‘AVC’ to sort from the highest verification level to the lowest verification level. The option can also be set to ‘Similarity’ giving an indication of the percentage of the input characters that have been matched in the output. Default ‘AVC’.
ParseFields	Specifies the list of fields to be parsed into word tokens.
PreferPrimaryValidAlias	When option is set to “Yes”, the engine will pick out the first valid alias it finds within the reference data. Default value is “No”.
QueryResultCacheSize	Used to specify how many sets of query results should be cached in memory. This cache is a cost-based cache based on query time, meaning that the slowest queries have their results cached. Default `0`. Values up to around 5,000 are relevant, but the memory usage and performance gain will be dependent on the supplied input data.
RangeDecompose	Used to specify how to expand ranges such as premise numbers and sub building numbers. Valid values are ‘Match’ (returning only the value matching the input query), ‘Range’ (returning a human-readable range, e.g. ‘1-9 Odd’), or ‘Full’ (expanding out the range into its constituent numbers, e.g. ‘1’, ‘2’, ‘3’, ‘4’, ‘5’).
ReferenceDatasetCacheSize	Used to specify the number of MRU reference datasets to cache. Default value is `5`.
ReferencePageCacheSize	Used to specify the number of MRU pages to cache from each individual reference dataset. Default value is `12`, each page equates to approximately 5Mb of memory use.
ReturnDataType	Valid values are Complete (default) or Verified. If set to Verified, the output from a Search process will only include data that has been verified against the available reference data.
ReturnVerifiedFieldsOnly	This option will return only verified fields, meaning that it will remove anything that isn’t verified from any field. SuppressUnmatched option will only suppress the unverified components in the Address field. Default `No`, meaning all fields will be returned. This can be specified on a per-country basis, with the added ability to specify fields to ignore during the check, using the following syntax. `ReturnVerifiedFieldsOnly=[:;;…;][,:;…;,…,]. e.g. ReturnVerifiedFieldsOnly=BE:SubBuilding;Premise,DE:SubBuilding;Premise,AT:SubBuilding;Premise or ReturnVerifiedFieldsOnly=US,CA,GB.` The former will return verified fields only in Belgium, Germany, and Austria, but will retain non-verified data in the Premise and SubBuilding fields, the latter will return verified fields only in USA, Canada, UK.
SearchAutocompleteIndexCheck	Specifies whether or not to use the ‘autocomplete index’ algorithm integral to Address Powersearch (this will not function if Address Powersearch is not installed). This algorithm returns a list of suggestions in record time for entries like ‘4916 eas’ in the US. For more information on Address Powersearch, please visit. Related to this option is the AutocompleteIndexOnly option which will prevent other algorithms from being called. Because the autocomplete index algorithm is much faster than the other algorithms, this guarantees a faster response time in all situations. Default `Yes`.
SearchLikeFieldCheck	Specifies whether or not to use the ‘like field’ algorithm. This option looks for an exact field match in the address field which is useful for single items like postcodes, building names, organization names, etc. Default `Yes`.
SearchMatchRules	A list of default match rules specifying how fields can be combined when attempting to generate a search. This can be overridden on a per-country basis, and should only be changed if requested by Support staff.
SearchReferenceTypes	Specifies the list of lexicon tagged field types that should be searched for in the reference data during a parse process. This should only be changed if requested by Support staff.
SimpleParse	Specifies whether or not to use the ‘simple parse’ algorithm. This option looks for something like premise + street in the address field, but is not particularly tolerant of invalid input data. Default `Yes`.
StrictReferenceMatch	This option helps to output results that are identical to what is found within the reference data. For example, if an input address has a premise of “08”, but the reference data contains “8”, the Premise would be verified with an Premise Number output of “08”. Turning on StrictReferenceMatch would have the output be “8”. Default `No`.
StrictRefMatchCountryList	This is a list of ISO2 countries that you would like to have the option StrictReferenceMatch turned on for.
SuppressAdditionFields	Used to specify the comma-delimited list of fields that should not be added to an output result if they do not appear in the input record.
SuppressAddressFields	Used to specify the comma-delimited list of fields that should be suppressed from the Address field output.
SuppressFields	Used to specify the comma-delimited list of fields that should be suppressed from the output.
SuppressMatchFields	Used to specify the comma-delimited list of fields that should be suppressed when determining the Address Verification Code.
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`.
TextFields	Specifies the list of field names, and the order in which they should be combined, to generate the combined word list for parsing. This should be a subset of the ParseFields entry.
TransliterationIgnoreFields	Used to specify the fields that should not be transliterated. Default “ID,ISO3166-2,ISO3166-3,_L,Latitude,Longitude,GeoAccuracy,GeoDistance,AVC”.
ToolInfo	Specify `Yes` to output extra debug information viewable using the getFieldInfo method.
UseCustomLexicons	Specify `Yes` to force the API to search for custom lexicons (lx__c.lfs files)
UseSymbolicTransliteration	Specify `No` to limit transliteration to complete field phrase matches. Default `Yes`.
VerifyCountryList	Used to specify a comma-delimited list of ISO 3166-1 alpha-3 codes of acceptable countries to process. Input records from other countries will return the unprocessed Address Verification Code `U00-U00-P0-000`. The default is to process data from all countries.
VerifyMatchRules	A list of default match rules specifying how fields can be combined when attempting to generate a verification match. This can be overridden on a per-country basis, and should only be changed if requested by Support staff.

Process Options

Server Option	Description
LogInput	Record the process input data to the specified debug log file.
LogOutput	Record the process output data to the specified debug log file.

Server Option	Description
CassAvcEnable	`Yes`/`No` (Default: `No`). The default will Z00-00-00-000 (AVC) and Z (AQI), but computing the report values can be forced. Please note that if returned, these fields may not accurately reflect the changes made in the record during the CASS process.
CassUrbFirst	`Yes`/`No` (Default: `No`). This specifies the Urbanization location on the address lines output (Puerto Rico only). The default will put the value after the address lines(s) with premise, thoroughfare, and sub-building.
CassZipFields	`Yes`/`No` (Default: `No`). Populate “Finance” and “AutoZoneIndicator”. If these fields are desired, customers will experience a moderate performance degradation (up to 20%).
CassCityAbbreviation	`Yes`/`No` (Default: `No`). If a Locality name is longer than 13 characters, this option can be used to return the official, short version. Both short and long versions are valid according to CASS.
CassFalsePosDir	`path_to_use` Allows you to control the directory where the `False` Positive file is created. For example: CassFalsePosDir=‘C:temp’ or CassFalsePosDir=‘/opt/temp’.
CassUseUSPSPreferredCity	`Yes`/`No` (Default: `No`). Setting this to `Yes` will return the USPS preferred city name. This server option only applies to on-premises installations. The default behaviour is for this option to be applied at the session level and will apply to all addresses. Use the CassMultiThreadedSettings to turn this server option on and off for individual addresses.
CassPreserveAlias	`Yes`/`No` (Default: `No`). By default, Verify will convert a thoroughfare alias (as recognised by USPS data) provided in an input address into the official USPS-approved thoroughfare name. Choose ‘Yes’ to preserve the alias and prevent it from being converted. This server option only applies to on-premises installations. The default behaviour is for this option to be applied at the session level and will apply to all addresses. Use the CassMultiThreadedSettings to turn this server option on and off for individual addresses.
CassMultiThreadedSettings	`Yes`/`No` (Default: `No`). Setting this to ‘Yes’ will enable CassUseUSPSPreferredCity and CassPreserveAlias server options to be applied for individual addresses.

Server Option	Description
SerpWesternStyle	`Yes`/`No` (Default: `No`). When `Yes`, the output Address/Delivery address lines will have the SubBuilding first, followed by a hyphen, the Premise, and remainder of the address. For example: Input: APT 200 – 6200 MCKAY AVE, BURNABY BC V5H 4L7 CAN. Output: Option ‘`No`’ or blank: 6200 MCKAY AVE APT 200, BURNABY BC V5H 4L7. Option ‘`Yes`’: 200-6200 MCKAY AVE, BURNABY BC V5H 4L7. This option only impacts addresses that are SerpStatusEx of ‘V’ (valid) or ‘C’ (correctable)

2024 Q1.1 API Minor release and 202403 Data release Notes

Product Update June 2022