sf_result-ui

This bundle enables support for the map.apps result-ui to display results from a smart.finder query.

The app "sf-result-ui" provides a default app configuration to use the result-ui instead of the standard smart.finder result list. This app can be extended, serve as a template for a new app or be used as a reference for the configuration of an existing app.

Configuration of the bundle "sf_result-ui"

To configure the columns which are shown in the result-ui adjust the following configuration in the app.json. An empty list means, that all available fields are shown.

"sf_result-ui": {
    "Config": {
        "columns": ["id", "title", "source", "type"]
    }
}

Required configurations for an app with the result-ui

To use the result-ui in an app, additional bundles must be configured. These configurations are already made in the “sf-result-ui” app, please refer to its app.json. The required configurations of the app are described in the following sections.

For more information about the configuration of the bundles, please refer to the documentation of the respective bundle.

allowedBundles

Ensure that the bundle set sf_bundle-set_result-ui is included in the list of allowed bundles. This bundle set contains the required bundles.

Bundle search-ui

The map.apps bundle search-ui provides certain actions which are triggered when a search is performed. smart.finder provides an action called "forward" which is used to perform a new smart.finder search. So at least the action "forward" must be configured in the search-ui bundle.

Bundle sf_routing

This bundle provides smart.finder relevant routes. The configuration must be like in the "sf-result-ui" app.

Bundle sf_search-ui-connector

This bundle connects the search-ui with smart.finder and uses the routes provided by the sf_routing bundle. The configuration must be like in the "sf-result-ui" app.

Bundle sf_store

To provide data to the result-ui, there must be one SuggestStore and one DocumentStore configured. At the moment smart.finder supports, when using the result-ui, only one SuggestStore and one DocumentStore. The "sf-result-ui" app contains a configuration that points to the Solr core named "core0".

Bundle sf_resultsmodel

To prevent the default fetching of results from the sf_resultsmodel bundle, the ResultsFetcherFactory, which provides the ResultFetchercomponent must be deactivated. This is done by setting the componentEnabled property to false. The ResultsFetcher is not needed when using the result-ui.

To disable the component add the following configuration to the app.json:

"sf_resultsmodel": {
    "ResultsFetcherFactory": {
        "componentEnabled": false
    }
}

Bundle templates

To show the smart.finder facet filter widget, a window definition must be configured in the templates bundle. The widgetRole has to be "sfRoot" and the dockTool "sf_openFacetsFilter". The other properties can be used to customize the window like described in the map.apps documentation.

Conditional configurations for an app with the result-ui

The following configurations and all others included in the "sf-result-ui" are recommended but not required.

Bundle sf_result-ui

To configure the columns of the result-ui see the section above where the configuration of the bundle is described.

Bundle result-api

The bundle map.apps bundle result-api provides options to configure the result-ui. For smart.finder the following options are relevant. More information can be found in the documentation of the bundle result-api.