Integrating Zoom in your own applications

Top  Previous  Next

Software developers looking to include a search engine feature as part of their own applications can integrate Zoom Indexer into their software and provide dynamic indexing and searching on demand.

lightbulb

Note: A single license of Zoom is required for each copy of the Zoom Indexer application installed on a computer. This does not permit you to distribute the registered version of the Zoom Indexer software. A special distribution license (and a custom built version of Zoom) must be purchased separately if you wish to distribute Zoom Indexer with your software. Please contact us for more details.

Console mode (Enterprise Edition only)

The Enterprise Edition of Zoom allows the Indexer to run in "console mode". When Zoom is running in this mode, it will not display a GUI nor require any user interaction. With the use of pre-configured .ZCFG files, the Zoom Indexer can then be spawned as a process to index files as needed.

All indexing progress, and error messages will be written to “stdout” and you can capture the output for internal analysis, or display to the user as you wish. The Indexer will also return an exit code indicating the outcome of the indexing.

Console mode must be specified alongside an AutoRun option, and a configuration filename. The following example will run the Indexer in console mode, indexing offline, using the configuration settings defined in "zoom.zcfg":

ZoomIndexer.exe -c -o zoom.zcfg

lightbulb

Note: If "stdout" is not redirected to a pipe or file, Zoom will automatically create a console window to display the output. Note also that Zoom will always display a splash screen, even in console mode. We can provide a custom build without the splash screen for developers who have purchased the special distribution license. Please contact us for more details.

Redirecting stdout

This can be done programatically (by the software spawning this process) or via the command line with the use of the greater than sign (">"). eg. redirecting stdout to file:

ZoomIndexer.exe -c -o zoom.zcfg > output.txt

Exit codes

The Indexer will also return an exit code indicating the outcome of the indexing. The possible exit codes are:

0

Indexer executed successfully.

1

Indexing completed with the maximum unique words limit having been reached.

2

Indexing completed with the maximum pages limit having been reached.

3

Invalid configuration

4

Indexing failed

5

Writing the index data output failed

6

Report generating failed

7

FTP upload failed

8

Installation error