Optima Option Number (OON) Enumeration - trillium_geolocation - 15.21

SalutationLanguage

This is the language used to generate salutations. 0 (default) means use the country-specific language. The position of a language in the ordered list returned by the GetLanguageList method, described on page 75, determines its numeric value.

CountryLanguage

This option is reserved for future use.

OverrideLanguage

Override the salutation language by using the language of the title field. 0 (default) means do not override.

NameCasing

The casing to use when formatting name data, specified using the OCO enumeration. Default is proper case.

UsePerFieldCasing

Specifies whether the address-wide casing option (‘AddressCasing’) or the per-field casing options (‘StreetCasing, ‘CityCasing’, and so on) should be used when applying casing to an address. The default is 0 (use the address-wide casing option).

AddressCasing

The casing to use when formatting address data, specified using the OCO enumeration. Requires that ‘UsePerFieldCasing’ is set to 0 (false). The default is proper case. Default is proper case.

DepartmentCasing

The casing to use when formatting the Department field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

CompanyCasing

 The casing to use when formatting the Company field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

BuildingCasing

The casing to use when formatting the Building field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

SubBuildingCasing

The casing to use when formatting the Sub Building field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

PremiseCasing

The casing to use when formatting the Premise field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

StreetCasing

The casing to use when formatting the Street field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

SubStreetCasing

The casing to use when formatting the Sub Street field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

POBoxCasing

The casing to use when formatting the PO Box field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

SubCityCasing

The casing to use when formatting the Sub City field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

CityCasing

The casing to use when formatting the City field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

RegionCasing

The casing to use when formatting the Region field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

PrincipalityCasing

The casing to use when formatting the Principality field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

PostcodeCasing

The casing to use when formatting the Postcode field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

ExtraPostcodeCasing

The casing to use when formatting the Extra Postcode field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

ExtraCityCasing

The casing to use when formatting the Extra City field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

CountryCasing

The casing to use when formatting the Country field. Requires that ‘UsePerFieldCasing’ is set to 1 (true). The default is proper case.

TelephoneCasing

This option is for future use.

NameWordCheck

Check for vulgar words and report in the WCR (Word Correction Result) field.

AddressWordCheck

Check for vulgar words and report in the WCR field.

TelephoneWordCheck

This option is for future use.

ForceUpdate1

(Option mask, set using ForceUpdate1)

Allow the validation engine to update a particular field irrespective of the original contents.

Deprecated1

This field is obsolete.

NameFlagBadWord

Mark vulgar words found in the name fields with *>word<*.

AddressFlagBadWord

Mark vulgar words found in the address fields with *>word<*.

TelephoneFlagBadWord

This option is for future use.

SwapStreetFields

CautiousUpdate

Only allow the validation engine to update those fields where the difference between the input data and the reference data is very small. Default is 0 (off).

EnforceBlanks

Update fields with reference data even if that data is empty. WARNING: only use this option for those countries where the reference data is complete for all fields. Default is 0 (off).

DedupeCommonErrors

Correct common address standardization and validation errors by performing cross-component matching. Default is 1 (on).

FormatComponents1

(Option mask, use FormatComponents1)

These specify which components should be included in the output address lines, correctly formatted for the relevant country.

StandardiseComponents1 (Option mask, use StandardiseComponents1)

These specify which components to consider when standardizing an address from the address lines.

ValidateComponents1(Option mask, use ValidateComponents1)

These specify which components to include, and possibly update, in the address validation process.

CompanyWeight

This 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. Default 1.

StreetWeight

This 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. Default 10.

CityWeight

This 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. Default 8.

PostcodeWeight

This 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. Default 5.

ShuffleLines

Reserved for future use.

ConcatenationLines

This option is for future use.

OuterMatchscoreLines

The number of address lines to analyze in the generation of the outer matchscore. The range is 1 to 8; the default is 8.

CarryStandardisationChanges

This specifies whether or not standardization changes such as 'ROAD' -> 'RD' should be reported in the ACR code. Default 1 (Yes).

ApplyReferenceAccents

This option is obsolete.

ReturnUserData

This specifies whether a call to SearchAddress should return non-validated user data along with the validated reference data. Default 0 (No).

SearchTimeout

This is the maximum amount of time in seconds for each individual search within ProcessAddress, ValidateAddress, SearchAddress, Select, SelectAlias, SelectUnique, or GetAlternatives. Default 5. Setting this option to 0 disables the timeout.

ReplaceAlias1(Option mask, use ReplaceAlias1)

These specify which components should have values replaced with the master reference value, if applicable.

ValidatedDataOnly

This 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. Default 0 (Derive components if possible).

StandardisationDebugOutput

This specifies whether to return extra standardization information in the URL1, URL2, Email1, and Email2 Contact object fields. Default 0 (No).

FormatSearchResults

This specifies whether to internally call Format Address for each result to a SearchAddress call. Default 0 (No).

CompareField1(Option mask, use CompareField1)

These specify which components will be used to generate the result of a CompareContacts call.

AlwaysShow1(Option mask, use Always Show1)

Specifies which fields will always be present in an initialized OptimaSearchSession, whether or not validating data exists for them. By default this includes Premise, Street, PO Box and City.

StandardiseComponents

This option is reserved for future use.

Remove Numerics

This option is reserved for future use.

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).

BusinessFlagSearchResults

This option is reserved for future use.

Transliterate

The transliteration method to use when formatting data, specified using the OTO enumeration. The default is Retain Diacritics.

StrictSelect

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.

PhoneticAliasMatch

This option is reserved for future use.

IgnoreEOLs

This option is reserved for future use.

ReturnPremiseRanges

If set to 1, specifies that calls to SearchAddress (or calls to Select where Premise is specified as a return field) 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.

ConcatenateValidationRules

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.

AddressValidationRuleOFT

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).

EnhanceValidationRuleOFT

Specifies the field in the contact object that will receive the validation rule code from calls to EnhanceContact. The default value is 32 (TCR).

ExhaustiveValidation

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.

ExhaustiveEnhancement

Multiple enhancement datasets containing the same type of data for the same country can be installed on the Trillium Geolocation server. 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.

ExhaustiveSearchAddress

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.

EnhancedDataOnly

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).

UseReferenceDataDictionary

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).

ReferenceDataDictionaryInput1 (option

mask, use ReferenceDataDictionaryInput1)

Specifies which address component fields should be used as inputs to the Reference Data Dictionary tool when they are populated on input. The default settings are recommended, but they can be changed if required.

By default this option is enabled for all address components except Department, Company, Building and SubBuilding. (Address Line fields are always used in Reference Data Dictionary searches).

AdvancedAddressLineDeduplication

Improves the removal of duplicated information in address lines during the parsing process for most forms of input, but can be disabled if required. The default is 1 (on).

NumOptionsPlusOne

This is used to determine the total number of options.