Search Screen

The Search Screen allows users to search STEP data via a modern faceted search experience powered by the Elasticsearch search engine, based on criteria within the Elasticsearch configuration.

Additional information can be found in the following topics:

Furthermore, Elasticsearch allows for the use of full-text search capabilities for SaaS and on-premises installations, while the use of In-Memory is strongly suggested. For those with an on-premises installation and additional search options, refer to the Full Text Indexable Attributes topic in the System Setup documentation.

Prerequisites

  1. Configuring this screen requires Web UI Designer basic concepts and appropriate privileges. For more information, refer to the Designer Access topic.
  2. Install and configure the Elasticsearch search engine, then configure and invoke the event processor as defined in the Elasticsearch Setup in the System Setup documentation.

Note:

If required, in the sharedconfig.properties file on the STEP application server, the case-sensitive Elasticsearch.IncludeSearchScreen property allows you to define the Web UIs that include a faceted search icon on the Global Navigation Panel. By default, when the ui-search component is installed, all Web UIs include two search buttons () on the Global Navigation Panel. The faceted search button is at the top and the standard search button is next (refer to the Global Navigation Panel topic for details). To specify which Web UIs include the faceted search button, add a comma-separated list of those Web UI IDs to the property. Do not include spaces between the IDs, as shown below:

Elasticsearch.IncludeSearchScreen=CustomerWebUI,BuySideSellSide_Supplier,GDSNReceiver

In this example, only the Web UIs listed will include both the faceted search button and the standard search button. The Web UIs not specified in the property include only the standard search button.

Configuration

  1. In the Designer, create a new screen by selecting New. In the 'Add Screen' dialog, type 'Search' in the Filter parameter to limit the list displayed. In the Screen ID parameter create a name, select the Search Screen option, and click the Add button. In the example below, the Screen ID is named 'Search Screen' and will be selected later.

  2. From the Home Page configuration screen (shown in the image below), in the Child Components section, add a Widget Grid or double-click the Widget Grid that is displayed. For more information, refer to the Adding Widgets to a Homepage topic.

  3. On the Widget Grid configuration screen (also shown in the image below), in the Child Components section Widgets field, add a Links Widget or double-click the Links Widget that is displayed. For more information, refer to the Homepage Widgets topic.

  4. On the Links Widget configuration screen (shown in the image below), in the Child Components section Rows field, click the Add button to display the Add Component dialog. Select the 'Screen Navigation' component and click the Add button.

  5. On the Screen Navigation configuration screen (shown in the image below), in the Screen parameter select the Search Screen created earlier in this process. Make edits to the additional parameters as desired. Click the Add button.

  6. Click Save to confirm all selections and click Close to leave the designer.

  7. On the homepage, verify the new Search Screen option displayed in the Links widget.

  8. Update your Global Navigation Panel settings to define the search functionality per Web UI as defined in the Global Navigation Panel topic.

  1. Verify or set privileges for users who will access the Search Screen:

  2. For more information on using the Search Screen, refer to the Search Screen Details topic.