Results

Format:

SLMaxMatches={Integer}

Default:

1000

Purpose:

This defines the maximum number of matches (picklist entries) that can be returned by the single-line search engine. The maximum value is 1000. If this is set to 0, the maximum value will be used.

The higher the limit set, the longer the search will be if many suitable results are found, and, correspondingly, more system resources will be used.

Example:

SLMaxMatches=100

Format:

[identifier]PicklistSize={Integer}

Default:

None

Purpose:

Defines the number of results that will be returned by the Singleline search. The minimum value that can be assigned is 1 and the maximum is 100. When no value is set (or is 0), this setting will not be applied.

Example:

GBRPicklistSize=30

Format:

VerMaxFlattenedMatches={Integer}

Default:

1000

Purpose:

This setting controls the behaviour of Verification searches in flattened mode which return large picklists. It specifies the maximum number of matches which can still be considered reasonable matches.

If a Verification search returns a picklist with more entries than the value specified by VerMaxFlattenedMatches, then the Verification level will be reduced to 'None' and no results will be returned. This setting can be overridden with the VerOverrideMaxMatches setting.

Example:

VerMaxFlattenedMatches=250

Format:

VerOverrideMaxMatches={Boolean}

Default:

False

Purpose:

This setting is used to override the behaviour of Verification searches in flattened mode which return large picklists.

If VerOverrideMaxMatches is set to False then a Verification search which returns a picklist with more than the maximum number of results (set by VerMaxFlattenedMatches), will have the Verification level reduced to 'None' and no results will be returned. If VerOverrideMaxMatches is set to True then the Verification level will not be changed, and results will be returned up to the limit specified by SLMaxMatches.

The limit specified by SLMaxMatches only applies to the number of items that are displayed in the picklist, not the number of results returned. For example, if you specify SLMaxMatches=5 and your search matches 6 addresses, only five items are visible in the picklist. However, refining on the results takes into account all six results.

Example:

VerOverrideMaxMatches=True

Format:

NoMatchesMessage={text string}

Default:

Address not recognised (type '!' to accept).

Purpose:

The Primary API uses this setting to define the prompt to display when returning property level information that cannot be matched against an address. If this setting is left blank, then the feature is disabled. Note that the accept character, '!' by default, is set with the ForceAccept setting.

Example:

NoMatchesMessage= Unrecognised address (type $ to accept)

Format:

{Dataset Code}ForceAcceptOnStepIn={boolean}

Default:

No

Purpose:

This keyword alters the behaviour of the informational prompt when you refine on a non-existent premises (for a specific dataset). This enables you to accept your input address even if it has not been matched.

ForceAcceptOnStepIn is turned off by default, if you wish to turn it on we recommend that you set it for each individual dataset by using the correct dataset prefix.

Examples:

USAForceAcceptOnStepIn=Yes

Format:

UPIThreshold={Integer}

Default:

25

Purpose:

This setting defines the number of matches (picklist items) that can be displayed in a picklist returned by the search engine.

To improve the performance, the Intuitive engine's upper threshold is limited to a maximum of 100 matches.

If this limit is exceeded, an informational prompt will be displayed, requesting the user to enter refinement text or to select the informational prompt to display all available matches.

The maximum value for this setting is 1000.

Example:

UPIThreshold=35

Format:

ShowAllThreshold={Integer}

Default:

750

Purpose:

When a picklist is returned in Pro API that contains more items than the picklist threshold, one of two informational prompts will be displayed.

If the number of potential picklist items is below the ShowAllThreshold setting, the first "Continue typing (or select to show all matches)" prompt is displayed. The user can step into the informational prompt to display all available matches.

If the number of potential matches is above the ShowAllThreshold value, the second "Continue typing (too many matches)" prompt is displayed instead. The user must continue typing to refine the search and so decrease the number of potential matches. When the number of potential matches falls below the ShowAllThreshold value, they can then step into the informational prompt to show all matches.

The maximum value for the ShowAllThreshold setting is 1000. The higher the limit that is set when you are running the Pro API in Client/Server mode, the more network resources will be used.

A certain amount of approximation applies to this limit due to the way that common matches can get merged together to form single picklist entries.

Example:

ShowAllThreshold=50

The dataset prefix is optional for this setting. Specifying a dataset prefix will override the global setting for that dataset only.

Format:

{Dataset Code}VerifyInputRetain={Boolean}

Default:

Yes

Purpose:

This keyword controls whether additional unmatched information that is searched upon using the Verification engine will be retained in the result address for the two match types that do not involve picklists:

• Verified
• Interaction required

Experian recommend that you leave this setting as Yes, to enable users to specify additional non-PAF address elements such as flats or units that should be captured by Pro Web.

Example:

For example, searching on "Richard Jones, Experian, 2-3 Clapham Common North Side, London, SW4 0QL" when Yes will return the following:

Richard Jones
Experian, George West House,
2-3 Clapham Common North Side
London
SW4 0QL

When No, the search will return the following:

Experian, George West House,
2-3 Clapham Common North Side
London
SW4 0QL