The FileSearchService is used for indexing documents and searching for them.

For this purpose, so-called nodes are defined, from which to search for documents and index their contents. It is possible to keep the indexing in the main memory alone or to store it in a database, which will make sure the indexing will not be lost after a restart of the Integration Server.

XML configuration

Important note: The availability of a service depends on the license purchased and whether the service has been registered in the configuration file ./etc/factory.xml of the Service Factory (changes require server restart!). There you will also find the responsible configuration file for a service, otherwise you can also edit the configuration file of the service directly in the GUI of the service (changes require a service restart!).

Setting the directory for the index files

The following XML fragment sets the base directory in which the FileSearchService stores index files, provided that indexing is not just taking place in the main memory.

<Set name="indexDB">./index/</Set>

The directory can be specified with a relative or absolute path. If the directory does not exist, it will be created automatically.

Setting the indexing language

Since the type of indexing depends on the language in which the documents were written, the language must be set accordingly if necessary. The following XML fragment sets the expected language.

<Set name="language">en_GB</Set>

The language is specified according to the Java Locale notation. It consists of the two-letter country code according to ISO 639 and the two-letter cultural area code according to ISO 3166. These two values are separated by an underscore.

Adding a directory to be indexed

The following XML fragment adds a directory to be indexed to the internal list of directories.

<Call name="addSearchRoot">
	<Arg>c:/docs/</Arg>
</Call>

The directory can be specified relative to the working directory of the Integration Server or absolute.

Adding a file to be Indexed

The following XML fragment adds a file to be indexed to the internal list of files.

<Call name="addFile">
	<Arg>c:/dummydir/dummyfile.txt</Arg>
</Call>

The file can be specified relative to the working directory of the Integration Server or absolute.

Deactivation of the permanent indexing

If the indexing should only be kept in the main memory and not stored in the file system, this is set with the following XML fragment.

<Call name="indexOnlyInRAM"/>

Of course, this means that the indexing run must be re-executed each time the Integration Server or FileSearchService is started.

General settings

images/download/attachments/189461529/Services_16_EN-version-1-modificationdate-1737965715385-api-v2.png

(1) The indexing language and the index directory.

(2) Here directories and files for indexing can be added or deleted. With the context menu entry Reindex, the indexing is restarted for the selected entry.

Log level dependencies

Changes to the log level of the LogService have no influence on the logging behaviour of the FileSearchService.

If the Verbose verbose is set, the names of newly added documents are reported.