Command line parameters

Top  Previous  Next

The Zoom Indexer accepts command line parameters if you wish to use it with an automated scheduling program or just to create a convenient shortcut in Windows. The usage definition is:

ZoomIndexer [auto-run options] <config-file> [incremental options]

 
Auto-run options

-s

Auto-run in spider mode, start indexing as soon as the application loads. This option requires that a config-file be specified also.

-o

Auto-run in offline mode, and start indexing as soon as the application loads. This option requires that a config-file be specified also.

-r

Auto-run Statistics Report Generator. This will automatically create the search statistics page based on the report options saved in the config file specified.

-c

Console mode (Enterprise Edition only). When using this mode, Zoom will run without a GUI, and output all log messages to stdout. See "Integrating Zoom in your own applications" for more information.

 

<config-file>

The configuration file to load on start up

Auto-run options are mutually exclusive and only one can be selected at any one time. For example, the following is not valid: “ZoomIndexer –s –o zoom.zcfg”. If you need to schedule an indexing session and also generate a report, then you will have to index two separate tasks.

Incremental indexing options

The following command-line options allow you to call upon the "Incremental indexing" features along with the auto-run options. This allows developers to call Zoom to perform these operations via external scripts or applications (eg. you could have a server-side script which calls Zoom to add a new start point to an existing index when a user submits them via a web page).

-update

This will perform an incremental update (as described above) on the specified ZCFG file. You must also specify the index mode (offline or spider) and the config file like so:

 

ZoomIndexer.exe -s zoom.zcfg -update

-addpage

This will add a specific page to the existing index specified by the config file and index mode. eg.

 

ZoomIndexer.exe -s zoom.zcfg -addpage http://www.mywebsite.com/newpage.html

 

Note that if you are using offline mode, you will need to specify a base URL following the addpage URL with a semi-colon (";") character, eg.

 

ZoomIndexer.exe -o zoom.zcfg -addpage C:\mywebsite\newpage.html;http://mywebsite.com/

-addpages

This is the same as -addpage but allows you to specify a text file containing a list of new pages (rather than calling it for one page only). eg.

 

ZoomIndexer.exe -s zoom.zcfg -addpages newpages.txt

 

Note that if you are using offline mode, you will need to specify a base URL following the filename with a semi-colon (";") character, eg.

 

ZoomIndexer.exe -o zoom.zcfg -addpages newpages.txt;http://mywebsite.com/

-addstartpt

This option will perform an incremental add start point operation on the specified config file and index mode. eg.

 

ZoomIndexer.exe -s zoom.zcfg -addstartpt http://www.mynewsite.com/

 

Offline mode will expect a base URL following the start directory, separated by a semi-colon (";") character, eg.

 

ZoomIndexer.exe -o zoom.zcfg -addstartpt C:\mynewwebsite\;http://www.mynewwebsite.com/

-addstartpts

This is the same as -addstartpt but allows you to specify a text file containing a list of start points.

 

In spider mode, the format of this text file is the same as the "Import start points" feature, which allows you to specify spidering options such as "index and follow" or "index only", etc. As well as allowing you to specify a Limit of the number of pages to index for each start point. See the chapter on "Importing and exporting additional URLs" in the Users Guide for more information.

-deletepage

This parameter will delete the specified page from the index as configured by the ZCFG file given and the index mode specified. eg.

 
ZoomIndexer.exe -s zoom.zcfg -deletepage http://www.mywebsite.com/oldnews.html