|
Timeout
|
The time in seconds after which an inactive session will expire. An
inactive session is one in which the gaserver has received no
communication from the Trillium Geolocation Server. The default is
3600 seconds (30 minutes).
|
|
DefaultCountry
|
The default country to be used if an address is passed to Trillium
Geolocation for processing and the country is not specified. Each
session (that is, each client connection to the gaserver) can
specify a different default country setting. The country is
specified by its three character ISO code. The default is GBR. If
set to an empty string, the default country feature is disabled; an
error code is returned if the country cannot be identified.
|
|
MatchKeyCode
|
Specifies the Match Key code that the server will use when generating
Match Keys. Refer to Match Key Code for a description of Match Key codes.
|
|
Default Options
|
Default options determine various aspects of the behavior of the
Trillium Geolocation Server for this session. Default options
include numeric options, boolean option masks, casing options, and a
transliteration option.
Numeric Options
The following numeric options can be specified using the syntax
option=numeric value, for example:
City Matchscore Weight=10
Valid numeric options are:
- Salutation Language - The language used to generate salutations.
0, which is the default, indicates that the country-specific
language is to be used. The position of a language in the
ordered list returned by the GetLanguageList method, described
in GetLanguageList Method, determines its numeric
value.
- Country Language - The country-specific language.
- Override Salutation Language - Use the language of the title
field instead of the salutation language. 0, which is the
default, indicates no override.
- Name Word Check - Check for vulgar words. The default is 0
(off).
- Address Word Check - Check for vulgar words. The default is 0
(off).
- Name Flag Bad Word - Mark vulgar words found in the name fields
with *>word<*. The default is 0 (off).
- Address Flag Bad Word - Mark vulgar words found in the address
fields with *>word<*. The default is 0 (off).
- Cautious Update - Only allow the validation engine to update
those fields where the difference between the input data and the
reference data is very small. The default is 0 (off).
- Enforce Blanks - Update fields with reference data even if that
data is empty. Use this option for only those countries where
the reference data is complete for all fields. The default is 0
(off).
- Dedupe Common Errors - Correct common address standardization
and validation errors by performing cross-component matching.
The default is 1 (on).
- Company Matchscore Weight - Allows the weight and relative
importance of the company field to be altered when generating
the inner matchscore. The higher the weight, the lower the
matchscore will be if changes have been made to the company
field. The default is 1.
|
|
Default Options (continued)
|
- Street Matchscore Weight - Allows the weight and relative
importance of the street field to be altered when generating the
inner matchscore. The higher the weight, the lower the
matchscore will be if changes have been made to the street
field. The default is 10.
- City Matchscore Weight - Allows the weight and relative
importance of the city field to be altered when generating the
inner matchscore. The higher the weight, the lower the
matchscore will be if changes have been made to the city field.
The default is 8.
- Postcode Matchscore Weight - Allows the weight and relative
importance of the postcode field to be altered when generating
the inner matchscore. The higher the weight, the lower the
matchscore will be if changes have been made to the postcode
field. The default is 5.
- Shuffle Lines - Reserved for future use.
- Concatenation Lines - Reserved for future use.
- Outer Matchscore Lines - The number of address lines to analyze
in the generation of the outer matchscore. The range is 1 to 8;
the default is 8.
- Carry Standardisation Changes - Specifies whether or not
standardization changes such as ‘ROAD’ -> ‘RD’ should be
reported. The default is 1 (Yes).
- Apply Reference Accents - This option is obsolete.
- Return User Data - Specifies whether the server should return
non-validated user data along with the validated reference data.
The default is 0 (No).
- Search Timeout - The maximum amount of time in seconds for each
individual search. The default is 5. Setting this option to 0
disables the timeout.
- Validated Data Only - Specifies whether to return address
components for which a unique value can be determined, or
whether to return only those components listed in the firing
validation rule. The default is 0 (derive components if
possible).
- Standardisation Debug Output - Specifies whether to return extra
standardization information in the URL1, URL2, Email1, and
Email2 Contact object fields. The default is 0 (no).
- Format Search Results - Specifies whether to format the address
for each search result. The default is 0 (no).
- Phonetic Alias Match - Reserved for future use.
- Ignore EOLs - Reserved for future use.
- Return Premise Ranges - If set to 1, specifies that searches
will return a single result for each range of premise numbers,
rather than individual results for each premise number within
the range. The default value is 0.
- Concatenate Validation Rules - If set to 1, specifies that
validation rule codes will be concatenated when the same contact
object is processed by multiple datasets by sequential calls to
ProcessAddress, ValidateAddress or EnhanceContact. If set to 0,
each dataset that processes the contact object will overwrite
any existing validation rule code. The default value is 0.
- Address Validation Rule OFT - Specifies the field in the contact
object that will receive the validation rule code from calls to
ProcessAddress or ValidateAddress. The default value is 32
(TCR).
|
|
Default Options (con’t)
|
- Enhance Validation Rule OFT - Specifies the field in the contact
object that will receive the validation rule code from calls to
EnhanceContact. The default value is 32 (TCR).
- Exhaustive Validation - Multiple address datasets from different
providers can be installed on Trillium Geolocation server for
the same country.
If set to 1, this option specifies that
calls to ProcessAddress or ValidateAddress will attempt to
validate the input data against all available datasets and
return the best result, based on the ACR code.
If set
to 0, the server will use the dataset with the most detailed
reference data (unless the priority order of the datasets
has been overridden by the administrator of the
server).
The default value is 1.
- Exhaustive Enhancement - Multiple enhancement datasets
containing the same type of data for the same country can be
installed on the Trillium Geolocation server for the same
country. For example, geocode (latitude/longitude) data sets
from different providers may be installed.
If set to 1, this
option specifies that calls to EnhanceContact where a
dataset type (such as GEOCODE) is specified will attempt to
enhance the input data against all available datasets and
return the best result, based on the validation rule code.
Calls to EnhanceContact where a dataset name is specified
will not be affected.
If set to 0, the server will use
the dataset with the most detailed data (unless the priority
order of the datasets has been overridden by the
administrator of the server).
The default value is
1.
- Exhaustive Search Address - Multiple address datasets from
different providers can be installed on a Trillium
Geolocation server for the same country.
If set to 1, this
option specifies that calls to SearchAddress will attempt to
search for the input data against all available datasets
until some results are found. Once some results are found,
no further datasets will be searched; all results will be
from the same dataset.
If set to 0, the server will use
the dataset with the most detailed reference data (unless the
priority order of the datasets has been overridden by the
administrator of the server).The default value is 1.
|
|
Default Options (con’t)
|
- Geocode Search Results - Specifies whether results from
SearchAddress will be automatically geocoded. A suitable
geocoding data set must be available. The default is 0
(off).
- Strict Select - Specifies whether calls to the Select follow
strict semantics. If set to 1, then criteria which do not match
any results are enforced, so the Select call will not return any
results. If set to 0, then criteria which do not match any
results are ignored. The default value is 0.
- Business Flag Search Results - Reserved for future use.
- Enhanced Data Only - Specifies whether calls to EnhanceContact
(for example, for geocoding) should strip address components
that are not used to produce the enhancement result. The default
is 0 (retain all address components).
- Use Reference Data Dictionary - Specifies whether the Reference
Data Dictionary tool is used during parsing. This tool improves
parsing accuracy in most scenarios, but can be disabled if
required. The default is 1 (on).
- Advanced Address Line Deduplication - Improves the removal of
duplicated address lines during the parsing process for most
forms of input, but can be disabled if required. The default is
1 (on).
- Use Per Field Casing - Specifies whether the address-wide casing
option (‘Address Casing’) or the per-field casing options
(‘Street Casing, ‘City Casing’, and so on) should be used when
applying casing to an address. The default is 0 (use the
address-wide casing option).
Boolean Option Masks
The following boolean option masks can be specified using the syntax
Option Component=True|False, for example:
Output Format Mask City=False
Valid values are:
- Force Update Mask
- Output Format Mask
- Standardize Component Mask
- Populate Component Mask
- Replace Alias Mask
- Compare Field Mask
|
|
Default Options (con’t)
|
Casing Options
The following casing options can be specified using the syntax
Option=Case, for example:
Address Casing=US ASCII Upper Case
Valid casing values are:
- Proper Case
- Upper Case
- Lower Case
- Country Case
- US ASCII Upper Case
Valid casing options are:
- Name Casing - The casing to use when formatting name data. The
default is proper case.
- Address Casing - The casing to use when formatting address data.
Requires that ‘Use Per Field Casing’ is set to 0 (false). The
default is proper case.
The following casing options require that ‘Use Per Field Casing’ is
set to 1 (true). The default is proper case:
- Department Casing - The casing to use when formatting the
Department field.
- Company Casing - The casing to use when formatting the Company
field.
- Building Casing - The casing to use when formatting the Building
field.
- Sub Building Casing - The casing to use when formatting the Sub
Building field.
- Premise Casing - The casing to use when formatting the Premise
field.
- Street Casing - The casing to use when formatting the Street
field.
- Sub Street Casing - The casing to use when formatting the Sub
Street field.
- PO Box Casing - The casing to use when formatting the PO Box
field.
- Sub City Casing - The casing to use when formatting the Sub City
field.
- City Casing - The casing to use when formatting the City
field.
- Region Casing - The casing to use when formatting the Region
field.
- Principality Casing - The casing to use when formatting the
Principality field.
- Postcode Casing - The casing to use when formatting the Postcode
field.
- Extra Postcode Casing - The casing to use when formatting the
Extra Postcode field.
- Extra City Casing - The casing to use when formatting the Extra
City field.
- Country Casing - The casing to use when formatting the Country
field.
|
|
Default Options (con’t)
|
Transliteration Option
The following Transliteration option can be specified using the
syntax Transliteration=TransliterationType, for
example:
Transliteration=Retain Diacritics
Valid transliteration types are:
- Retain Diacritics (default)
- Strip Diacritics
- Transliterate
|