Siren Platform User Guide

Enhanced search results visualization

Enhanced search results is a visualization that shows the documents matched by a query on an Elasticsearch index, similar to the stock Discover table.

In addition to column configuration, the visualization provides the following features:

  • To hide the time column, which represents a time field of the Elasticsearch index, select the Hide time column check box.
  • IYou can set a page size which is a count of rows displayed each page. To enable top pagination, select the Show top paginator check box.
  • To use aliases in place of the column names in the data, see ???.
  • It is possible to enable a column that indicates whether a search result is matched by a query on an external datasource. For more information, see ???.
  • It is possible to define click handlers on the cells in a column, for example to open the URL displayed in a cell. For more information, see ???.
  • To create filters from table rows, see ???.
Configuration view of the Enhanced search results table.

Rename columns

It is possible to create an alias and set a minimum width for each column.

To enable renaming columns, select the Enable column rename check box.

Rename columns

To configure the names of columns, you can set these parameters:

  • Alias (required): The column alias that is displayed as a column name.
  • Min width (optional): The minimum width of the column.

Relational column

The relational column can be used to display if a search result is matched by a query on an external datasource.

To enable the relational column, select the Enable Relational Column check box.

The following image shows the configuration of a relational column named Why Relevant? where the value of a cell depends on the query Top 50 companies (HR count): if the value of the label index field of a document matches the value of the label variable in at least one record returned by the query, the name of the query will be displayed inside the cell.

Relational column configuration.
Relational column example.

To configure the relational column, you must set these parameters:

  • Column name: the column name that will be displayed in the table header.
  • Source Field: the name of the index field that will be compared to a variable in the query results.
  • Target query: the name of the query to execute.
  • Target query variable name: the name of the query variable that will be compared to the index field specified in Source field.

Click handlers

It is possible to define two different actions when clicking a cell;

  • Open a URL defined in the corresponding index field.
  • Select an entity in an external datasource matching the corresponding index field.

Follow URL

Select the Follow URL action to open a URL stored in an index field in a new window.

For example, the following configuration defines a handler that opens the URL stored in the field homepage_url when clicking the cell displaying the label field.

Follow URL on click

To configure a click handler, you must set the following parameters:

  • Column: The name of the column to which the handler will be bound.
  • On click I want to: The action to perform on click. Select Follow the URL here.
  • URL field: The name of the field containing the URL.
  • URL format: A custom format string to compose the URL, where @URL@ is replaced with the value of the field set in URL field.

URL format can be used to create dynamic URL. The following image shows a configuration in which the value of the id field is used to define the path of a URL on example.org.

With this configuration, if the id field is set to 11 the resulting URL will be http://example.org/11 .

Follow URL with a custom format on click.

Select an entity

Select the Select an entity action if you want to select an entity stored in an external datasource matching the selected Elasticsearch document; for more information about entity selection, see 3.12. Legacy REST datasources.3.12. Legacy REST datasources

To configure an entity selection action you must set the following parameters:

  • Column: The name of the column to which the handler will be bound.
  • On click I want to: The action to perform on click. Select Select the document here.
  • Redirect to dashboard: If set, clicking the cell selects the entity and displays the specified dashboard.
Configuration of an entity selection handler.

Row filters

It is possible to create filters from table rows.

To enable the row filters, select the Enable row filters check box.

Enable row filters.

Then, select rows which you wanted to create filters from and click Create Filter.

Row filters.