These settings are found in the server ini file, qawserve.ini. They control how Pro API returns and displays multiple results, and can be used to conserve system/network resources.
Format:
SLMaxMatches={
Default:
Purpose:
This defines the maximum number of matches (picklist entries) that can be returned by the single-line search engine. The maximum value is
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.
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:
SLMaxMatches=100
Format:
NoMatchesMessage={
Default:
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=
Format:
UPIThreshold={Integer}
Default:
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:
{Dataset Code}ForceAccept={character}
Default:
Blank
Purpose:
The Primary API uses this keyword to define the character that the user can type at the end of the premises/sub-premises information, to force the data to be accepted as a match. If you do not define a character, the feature is disabled.
Alternatively you can use the vsExtra parameter of QA_FormatResult.
ForceAccept is disabled by default. If you wish to use it, we recommend that you set it for each individual dataset by using the correct dataset prefix.
When using French datasets (FRA, FRH, FRP, FRX), automatic force accept is enabled by default. Explicitly setting this for these datasets will disable the automatic force accept functionality and require the use of the specified character.
Examples:
USAForceAccept=!
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
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
Format:
MultiElementLabels={boolean}
Default:
No
Purpose:
This keyword defines whether or not to return address labels, where multiple address elements have been fixed to a single line.
If this keyword is set to Yes, the address elements are returned separated by commas. If it is set to No, blank labels are returned for such address lines.
Example:
MultiElementLabels=Yes
Format:
OemCharacterSet={text string} [NoDiacritics]
Default:
ANSI
Purpose:
The Pro API includes support for character sets that contain non-standard characters, such as diacritics (for example, accents and umlauts). The API also provides the ability to remove diacritic characters on address output.
The API needs to know which (OEM) character set the calling application is using. The character set can be configured using the following values in the qaworld.ini file:
The following character sets are supported by Pro. They are 8-bit character sets and can support diacritics and multiple code pages:
Family | Description |
---|---|
ANSI | The character sets as defined by the American National Standards Institute. |
ASCII | As above but without diacritics. |
DOS | DOS code page 850. |
Example:
OemCharacterSet=DOS NoDiacritics