Search Configuration¶

In the “Search configuration” tab you configure the search index for each database that will allow you to do quick searches over all the data of the databases’ views.

There are three types of indexes supported:

• Local: you have to specify the local path to an index created by an Aracne Index server. The index must be accessible through the file system of the machine where the ISST is running. This option should be used only with small indices (the searches in the index are executed locally by the JVM that is running the web container, and the memory required for those operations depends on the index size).

• ARN-Index: you have to specify an Aracne Index server and the name of an index contained in that server.

• Elasticsearch: you have to specify an Elasticsearch server and the name of an index contained in that server. This is the recommended option for big indices, using an Elasticsearch server running on cluster.

Note that, in order to use Aracne Index or Elasticsearch indices, you first have to add the index server, as shown in the figure Search Configuration, and then configure the corresponding Virtual DataPort database to use that server and the corresponding index contained in it.

To enable the search feature over a database, follow these steps:

1. Index the database using the VDPIndexer job type (see section Configuring New Jobs of the Scheduler Administration Guide) or the Global Search Crawler (see section Global Search Crawling Configuration of the Scheduler Administration Guide). When the volume of the data to be indexed is high it is recommended to use VDPIndexer jobs.

2. In the “Search configuration” tab:

   1. If you are not using a local index, first you need to add the index server to be used. Once you click the icon to add a new index server (see Search Configuration), a dialog is opened to specify the server configuration parameters (see Adding a new index server).

      1. First you have to choose the Type of index server: ARN-Index or Elasticsearch.

      2. The following parameters are common to both types or servers:

         1. Name and Description (optional) to be assigned to the server.

         2. Host and port where it is running.

         3. Login (optional) and password (optional) to connect to the server.

      3. In the case of the Elasticsearch servers you also may configure the Cluster Name (optional), which contains the index to be used.

         Note

         At any moment you can edit or delete the index servers using the corresponding icons of the Options column of the table.

   2. Click the edit icon of the pertinent database in the Edit column of the table and

      1. Select the Index Type: Local, Elasticsearch or ARN-Index.

      2. If the index type is Local enter the Path to the index folder.

      3. If the index type is Elasticsearch or ARN-Index select the Index Server previously configured (the dropdown will show only the names of the servers of the selected type) and enter the Index Name.

The two configuration options in the top of the Search tab allow configuring how many fields and results will be shown, by default, per each view, in the search results summary (see section Search). The fields will be selected randomly. It is possible to configure the fields to be shown per each view by clicking the icon of the column Select view fields. A dialog similar to the one of the Selecting view fields will be shown. This dialog shows, on the left side, the list of views contained in the index. Clicking the view name will show, on the right side, the fields of that view. Then, you can select the fields to be shown in the search results summary (clicking the check boxes) and its order (dragging and dropping them).

Search Configuration¶

Adding a new index server¶

Selecting view fields¶

Note that the index configured for a database may not contain all its views (i.e. some views could have been indexed, but not all of them), or all the data of all the views (i.e. some views could have been indexed partially). In this case, the searches in the database will be restricted to the indexed views and tuples.