> ## Documentation Index
> Fetch the complete documentation index at: https://docs.loqate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Interactive Test Client Guide

## What is lqtInter

`lqtInter` is a tool used to provide platform agnostics. This is an interactive address testing facility for a command-line based tool that can run single addresses. It is similar to `lqtDemo.exe` but in the form of a simple "SQL-like" interface.

You can specify the path to the Loqate Global Knowledge Repository via the command line. You can also specify server options via the command line. If run without specifying the Global Knowledge Repository, `lqtInter` will prompt for the path on start up. A valid path must be specified and `lqtInter` will exit if a valid repository is not found.

```bash theme={null}
Usage: lqtInter <options>
–d : directory containing the loqate data
–o : Server options to set "option=value"
```

## Platform-Specific Instructions

### Windows

Please ensure `lqtcr.dll` is located in the same directory as `lqtInter` or add the path to `lqtcr.dll` to the `PATH` environment variable. If `lqtInter` is 64-bit then `lqtcr.dll` must also be 64-bit.

`lqtInter` can be invoked from Windows Explorer or the command prompt. Users may experience an issue with non-ASCII text. To display it properly please configure the command prompt to use a compatible font. `lqtInter` will attempt to output UTF-8, we have found that "NSimSun" seems to work for many countries. Older versions of Windows may not be able to display non-ASCII text.

### Linux

Please set `LD_LIBRARY_PATH` to point to the folder that contains the Loqate library. Then `lqtInter` can be run from the command prompt. If `lqtInter` is 64-bit then the Loqate library must be 64-bit also.

In order to display UTF-8 characters properly set the command window to a suitable font.

### AIX

Please set `LD_LIBRARY_PATH` to point to the folder that contains the Loqate library. Then run `lqtInter` from the command prompt. If `lqtInter` is 64-bit then the Loqate library must be 64-bit also.

In order to display UTF-8 characters properly set the command window to a suitable font.

## LqtInter Commands

Commands to `lqtInter` are specified by `#` followed by the command and can be entered at any of the normal prompts (`OPTIONS`, `SELECT`, `FROM`, `WHERE`).

| Command                              | Description                                     |
| ------------------------------------ | ----------------------------------------------- |
| `#?`                                 | Displays the command help.                      |
| `#EXIT`                              | Exits the application.                          |
| `#OPTIONS`                           | Set Loqate server options.                      |
| `#RESET`                             | Abandons the current search and starts again.   |
| `#` key followed by the first letter | Used as a shortcut key for any of the commands. |

## Input Syntax Queries

A query to the Loqate engine consists of three parts: the output fields, the tools to use, and the input data. Once the input data is specified, then the selected tools are run and the requested fields are output. It is possible to get multiple results; each set of results will be displayed.

### Example

```
SELECT AVC
FROM Search
WHERE Address1="The Foundation,Heronsway,Chester Business Park,Chester",Country="UK"

Results 0:
AVC="V54-I55-P3-100"

Results 1:
AVC="V54-I55-P3-100"
```

## The SELECT Prompt

The `SELECT` prompt is used to specify the Loqate output fields to be displayed for the query. To display the quick help menu, enter `?` (this can be used at any of the prompts).

Please note field names are case sensitive. To display all output fields, enter `*` at the select prompt. Using `*` will return multiple results, it is recommended to specify the fields of interest in order to display the expected results.

See [Appendix A](#appendix-a-field-list) for a list of common field names.

```
SELECT ?
Enter a comma separated list of fields to output. Enter * to output all fields.
Note field names are case sensitive.
```

**Example:** `SELECT Address,AVC`

<Frame caption="">
  <img src="https://mintcdn.com/loqate/bZ7DNdFBXsoQxP4T/images/4f7d5739-SELECT-1-300x47.png?fit=max&auto=format&n=bZ7DNdFBXsoQxP4T&q=85&s=18d682dd5b1075442b192dbe800e2833" width="300" height="47" data-path="images/4f7d5739-SELECT-1-300x47.png" />
</Frame>

## The FROM Prompt

The `FROM` prompt is used to select the tool of choice, i.e. Verify, Geocode, etc. You can enter `?` to obtain quick help (this can be used at any of the prompts).

See [Appendix C](#appendix-c-tool-list) for a list of common tools.

```
FROM ?
Enter a comma separated list of tools.
Example: Verify, Geocode
```

**Example:** `FROM Verify`

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/a4548c4b-FROM-1-300x37.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=abfca4fa01563e0160fec4e7c8a66c07" width="300" height="37" data-path="images/a4548c4b-FROM-1-300x37.png" />
</Frame>

## The WHERE Prompt

The `WHERE` prompt is where you specify the input fields to Loqate. This is usually the address as address lines or elements. Please note the field names are case sensitive. To obtain quick help enter `?` (this can be used at any of the prompts).

```
WHERE ?
Enter a comma separated list of input fields of format fieldname="value".
```

**Example:**

```
WHERE Address1="The Foundation,Heronsway,Chester Business Park,Chester CH4 9GB",Country="UK"
```

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/a225fb97-WHERE-300x33.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=adba3d9ea193cbfc275d0aa6352e8594" width="300" height="33" data-path="images/a225fb97-WHERE-300x33.png" />
</Frame>

## Setting Server Options

Server options can be specified by entering `#OPTIONS` (shortcut `#O`). This will bring up the options prompt. See [Appendix B](#appendix-b-server-option-list) for a list of commonly used server options.

Once a server option is set it will stay in effect for the current session of `lqtInter` or until overridden with a new value. Setting server options does not carry over between sessions. Once server options have been specified (or nothing entered) `lqtInter` will return to the point it was invoked from.

To obtain quick help enter `?` (this can be used at any of the prompts).

```
OPTIONS ?
Enter a comma separated list of server options of format option=value.
```

**Example:** `OPTIONS OutputCasing=Lower,DefaultCountry=UK`

<Frame caption="">
  <img src="https://mintcdn.com/loqate/wwkAPZOZpT3jkoyU/images/f57ed559-OPTIONS-300x83.png?fit=max&auto=format&n=wwkAPZOZpT3jkoyU&q=85&s=a2ab13b63736021c08cab13fa806375e" width="300" height="83" data-path="images/f57ed559-OPTIONS-300x83.png" />
</Frame>

***

## Appendix A: Field List

A list of Loqate fields can be found [here](/field-descriptions/addfields/). Please note that field names are case sensitive and should be specified exactly as shown.

## Appendix B: Server Option List

A list of server options can be found [here](/documentation/server-options/).

## Appendix C: Tool List

The following is a list of commonly used tools. It is not a full list.

* Parse
* Match
* Format
* Verify
* Search
* Geocode
* Enhance