Content Search¶

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:

• Scheduler Index.

• 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:

1. Create a search index for the server using the VDPIndexer job in Scheduler.

2. 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.

   

   Dialog to configure the index servers¶

3. 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 Scheduler Index or 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.

   

   Dialog to add an index server¶

4. 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.

   

   Dialog to configure the search index for the registered Virtual DataPort servers¶

   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:

   The search index is properly configured

   The search index is unreachable or is not properly configured

   The search index has not been configured yet

5. Click the icon next to a Virtual DataPort server in order to configure its search index. The following dialog will appear.

   

   Dialog to assign a search index to a Virtual DataPort server¶

   Fulfill the form as follows:

   • Index type. Select the type of the search index between Scheduler Index or 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.

6. Optionally, you can configure the snippets shown as a preview in the search results for the current server.

   In the Assign index server section, you can configure the fields that will be used in the search result snippet for a specific view:

   1. Click the Configure search snippets button next to the Virtual DataPort server you are connected to. You will see the following dialog.

      

      Dialog to configure the fields in the search result snippet for a view¶

      The Views panel lists all the views contained in the search index following the pattern <view name> (database name).

      Note

      You need the METADATA privilege on a view for it to appear in the Views panel.

   2. Select a view from the list. The All fields panel will appear showing all the fields indexed for that view.

   3. 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.

      • To add several fields to the search result snippet, select them and click the icon.

      • To remove a field from the search result snippet, click the icon next to its name.

      • To remove several fields from the search result snippet, select them and click the icon.

      • To reorder the fields in the search result snippet, select some fields and use the and icons to move them upwards or downwards.

   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.

   

   Dialog to configure the global parameters for the search results snippets¶