In the Content search dialog you configure the search index for a Virtual DataPort server, which will enable the search by content in all the views of that server.
Data Catalog supports two types of index servers:
Elasticsearch. This is the recommended option for big indices, using an Elasticsearch server running on cluster.
To enable the search by content for a Virtual DataPort server, follow these steps:
Create a search index for the server using the VDPIndexer job in Scheduler.
Log in the Data Catalog with an administrator account and go to Administration > Set-up and management > Content search. In the Index servers tab you can configure the index servers.
Click the Add server button to register the index server you used to create the search index and enter the following values:
Name. The name of the index server.
Description. A description for the index server.
Type. Select between
Elasticsearch 5.6+ / 6.x / 7.x.
Host. The hostname of the machine where the index server is running.
Port. The port of the index server.
Login and Password. The credentials of the account used to connect to the server index. They are optional.
Use secure connection. Enable this option to connect to the index server through a SSL/TLS channel. This option is only available for Elasticsearch servers.
Go to the Configuration tab. In the Assign index server section you can configure the search index assigned to each Virtual DataPort server registered in Data Catalog.
The table lists all registered Virtual DataPort servers. The Configured column indicates if the Virtual DataPort server has a search index configured or not, with one of the following values:
Fulfill the form as follows:
Index type. Select the type of the search index between
Elasticsearch 5.6+ / 6.x / 7.x.
Index server. Select the index server you have previously configured in the step #3. The dropdown will only show the name of the servers of the selected type.
Index name. Enter the name of the search index you have created in the step #1.
Optionally, you can configure the snippets shown as a preview in the search results.
In the Assign index server section, you can configure the fields that will be used in the search result snippet for a specific view:
Click the Configure search snippets button next to a Virtual DataPort server. You will see the following dialog.
The Views panel lists all the views contained in the search index following the pattern
<view name> (database name).
You need the
EXECUTIONprivilege on a view for it to appear in the Views panel.
Select a view from the list. The All fields panel will appear showing all the fields indexed for that view.
Compose the list of fields in the search result snippet for the view as follows:
To add a field to the search result snippet, drag-and-drop it to the Selected fields panel.
In the Global parameters section, you can configure the following settings, which will affect all the snippets in the search results:
Default number of fields in search results summary. If you have not configured the search result snippet for a view, the number of fields to be shown. The fields are chosen according to its order in the view schema.
Maximum number of results per entity in search results summary. The maximum number of rows to be shown in the search result snippet.
Note that the search index configured for a server 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 will be restricted to the indexed views and tuples.