These settings are found in the server ini file, qawserve.ini.
The dataset prefix is optional for this setting. Specifying a dataset prefix will override the global setting for that dataset only.
Format:
{Dataset Code}EngineTimeout={Integer}
Default:
Purpose:
The length of time (in milliseconds) that Pro API will spend on a search before it returns a timeout flag. A setting of 0 sets the timeout to infinity.
Examples:
To set a global timeout period of 30 seconds (30,000 milliseconds), set EngineTimeout=30000
To set a timeout period of 30 seconds for the USA dataset (30,000 milliseconds), set USAEngineTimeout=30000
Format:
SearchTermDelimiter={Character}
Default:
| or , (either will be accepted if not set)
Purpose:
You can customise the API to use a different search term delimiter. For example, you can set the premises entry line to be divided from the street entry line with a pipe (|) character. You should use a character that is unlikely to be returned within an address.
Example:
SearchTermDelimiter=|
The dataset prefix is optional for this setting. Specifying a dataset prefix will override the global setting for that dataset only.
Format:
{Dataset Code}EngineIntensity={Integer}
Default:
1
Purpose:
The keyword controls the degree of 'fuzzy' matching which is used when searching for addresses as specified by the input search terms. Possible values are as follows:
Ini Keyword | Description |
---|---|
0 | Exact |
1 | Default fuzzy matching |
2 | Extensive fuzzy matching |
The fuzzy matching engine will start at the default setting, and look for a match to the input search terms.
This can be CPU intensive if it is above 0 (Exact). If no matches are found, it will proceed through the levels up to and including level 2 (or until EngineTimeout occurs) before giving up.
Examples:
EngineIntensity=1
USAEngineIntensity=1
Format:
InputLineCount={Integer}
Default:
0
Purpose:
This keyword is used to define the number of lines your input addresses contain. The format of each individual address line is specified with the InputLineN keyword. Note that any lines not covered by your specified input address format will not be constrained to match to specific reference address element types.
Example:
InputLineCount=4
This tells Pro API that each input address should contain four lines.
This keyword affects the Verification engine and the Default prompt set only.
Format:
InputLine1=<element list>
InputLine2=<element list>
InputLineN=<element list>
Default:
Blank
Purpose:
This keyword specifies which address element is to appear on which line in the input address. If you want a line on your address entry page always to contain the same type of address element (for example, line 4 always contains a town name), you can mark that line with an element code. This improves the speed and quality of matching.
<element list> represents a comma separated list of element codes, either dataset-specific or generic. By specifying an element code, you tell the engine what element to expect on that line (if the element exists in the matched address).
It is important not to supply non-address information to the engine (where possible), as this may compromise the address matching process. In particular, supplying additional non-address numeric values can cause confusion when matching against premises information.
If you are using a defined input layout, you should set the search term delimiter to the pipe (|) character using the SearchTermDelimiter setting. This will avoid Pro API treating any commas within input address lines as line-breaking characters.
Example:
InputLine1=O00
This instructs the engine to expect organization names on line 1 of the input address.
The generic element codes are listed in the following table, in the order in which they will appear in a formatted address (unless you fix them in a different order on the address line).
Order | Element Code | Description |
---|---|---|
1 | O00 | Organization |
2 | P00 | Premises |
3 | S00 | Street |
4 | B00 | PO box |
5 | L00 | Place |
6 | C00 | Postcode |
7 | X00 | Country name |
See the Data guide supplied with your data for a list of dataset-specific element codes.