Overview of all update notes

3.0

No longer supported properties

solr.solr.home

Directory path to solr.home.

New properties

solr.server.url

URL to the Apache Solr instance used.

Default value: http://localhost:8983/solr

Renaming of Java packages

The basic Java packages have been renamed from de.conterra.finder to de.conterra.smartfinder.

This change also affects the configuration files of the respective indexes (conf/solrconfig.xml and conf/schema.xml ), as the Java classes are referenced here (e.g. RequestProcessorFactory, FieldType, etc.).

The map.apps Smart Search Extension is now part of smart.finder. In the course of the integration, small optimizations were made to the configuration and naming, which are documented below.

Renaming of the Solr index

The Solr index has been renamed from smartsearch to featuresearch.

Integration of map.apps Bundle

The functionality of the map.apps bundle sf_smartsearch has been integrated into the bundle sf_store.

The following adjustments were made.

Component SmartSearchStore

The SmartSearchStore component has been renamed FeatureDocumentStore and is now part of the sf_store bundle.

The following properties could be configured on the SmartSearchStore component up to smart.finder version 3.x. As of smart.finder version 3.x, these properties are no longer supported. The configuration is now carried out using Search templates (QueryTemplates).

  • editDistance

    The fuzzy search is now defined within a search template. This is configured in the FeatureDocumentStore component using the queryTemplate property.

    See also: Fuzzy Search or in the Documentation of the sf_store bundle.

  • singleBoostWeight, groupedBoostWildcardWeight, groupedBoostWeight

    These properties were used to influence the weighting of search results. The weighting is now used within a search template (QueryTemplate). The FeatureDocumentStore component contains a predefined search template, which contains the original default values. This search template can be customized using the queryTemplate property.

    See also: search templates or in the documentation of the sf_store bundle.

Please note that when migrating from map.apps Smart Search Extension 2.x to smart.finder 3.x, the server component must be migrated, as Apache Solr is no longer delivered as part of smart.finder. The setup of Apache Solr is described in the following section.

Client application

A map.apps instance is required to use the smart.finder bundles and apps.

The installation of the smart.finder bundles and apps is described here.

Apache Solr configuration

The provision of an Apache Solr instance is required to operate smart.finder. Information on the installation and configuration of Apache Solr can be found at https://solr.apache.org/.

Use the full variant as Apache Solr distribution. The ‘slim’ variant does not contain the required modules and is therefore not suitable.

As Apache Solr is now operated as an external service, this results in the following changes for smart.finder:

solr.home configuration

The indexes are managed and persisted in the SOLR_HOME directory. The SOLR_HOME directory is located under [SOLR_INSTALL_DIR]/server/solr by default.

You can also start Apache Solr with a different directory. In this case, you must adapt this accordingly. The following options are available here:

  • in the file [SOLR_INSTALL_DIR]/bin/solr.in.sh (Linux) or [SOLR_INSTALL_DIR]/bin/solr.in.cmd (Windows)

  • as a system environment variable

  • when starting Apache Solr with the parameter --solr-home <dir>

Copy the contents of the directory [RELEASE-ORDNER]/solr/cores into the SOLR_HOME directory. You will then see the following directory structure:

/SOLR_HOME
 /core0
 /featuresearch
 /indexingmanagement
 /lib
 /...

Now copy the file SOLR_HOME/lib/jts-core-[VERSION].jar into the directory [SOLR_INSTALL_DIR]/server/solr-webapp/webapp/WEB-INF/lib. The presence of this library in exactly this location is predefined by Apache Solr.

Migration of existing indexes

To migrate existing indexes, it must be ensured that the conf/solrconfig.xml file of the respective cores matches the files supplied in version 3.

If you have made changes to the conf/solrconfig.xml and conf/schema.xml files or use completely customised cores, it is recommended that you compare these files with the version 3 files supplied and make any necessary changes.

After changing the conf/schema.xml file, the respective indexes must be rebuilt.

2.8

None.

2.7

Changed CSS classes in the detail view

As of version 2.7.0, some CSS classes for the layout of the detail view have been changed to improve the content division of the page. The following diagram shows the current areas of the detail view and their CSS classes.

css smartfinder

Update of the schema for core0

The placeholder and full text search has been optimized. An explicit FieldType is now used for token generation in the placeholder search. This means that punctuation, for example, is no longer taken into account, which leads to clearer results.

2.6

New mandatory Solr Properties

As of version 2.6.1, two new system variables must be set as follows due to changes in Apache Solr.

System properties
solr.enableRemoteStreaming=true
solr.enableStreamBody=true

Here is an example for Linux:

Setting system properties in Java/Tomcat
export JAVA_OPTS="$JAVA_OPTS -Dsolr.enableRemoteStreaming=true -Dsolr.enableStreamBody=true"

Change of index scheme in core0

In core0 the index scheme has changed. If you want to migrate the indexed documents from your current smart.finder installation, follow the migration instructions for the version update.

New bundle sf_bootstrap

A new bundle sf_bootstrap has been added, which loads the basic components of smart.finder when the app starts. This bundle is necessary for the start of smart.finder.

  • If you are using a custom app that already contains one of the collection bundles (starting with sf_bundle-set_…​), you do not need to do anything further. The bundle sf_bootstrap is automatically loaded in this case.

  • If the app does not contain any of the collection bundles sf_bundle-set…​, please add the bundle sf_bootstrap to your app as shown in the following example:

    {
  "allowedBundles": [
    "sf_bootstrap",
    "..."
  ]
}

TBD

2.5

Password in security mode 'INTEGRATED'

For security reasons, the administrator password in security mode INTEGRATED is no longer preset in the delivery. Set this using the security.user.admin.pw property to enable logging in to the smart.finder.

Change of the index scheme in indexingmanagement.

In indexingmanagement the index scheme has changed. Follow the information in migration guide for the version update.

Change of index scheme in core0.

In core0 the index scheme has changed. If you want to migrate the indexed documents from your current smart.finder installation, follow the migration instructions for the version update.

sf_search-ui-connector-Bundle

The SearchAnythingSearchTermResetAction component has been removed. You can now control the behaviour of the search with an empty search term through the searchAllOnEmptySearchTerm property of the ResultListPageForwarder component. See the sf_search-ui-connector bundle documentation for additional information.

sf_resultlist.SortConfig component

Due to the new sorting component the configuration schema of the SortConfig component in the sf_resultlist bundle has been changed. So if you made adjustments to this component in your app.json files, see the sf_resultlist bundle documentation for details on how to update you configuration to the current schema.

Dropped leading dot in cookie domain

In prior versions of smart.finder the cookie domain in the configuration property security.sso.cookie.domain required a leading dot. This dot is no longer supported. So specify the domain without a leading dot in compliance with RFC 6265. Example:

security.sso.cookie.domain=sub.example.com

2.4

Password in security mode 'INTEGRATED'

For security reasons, the administrator password in security mode INTEGRATED is no longer preset in the delivery. Set this using the security.user.admin.pw property to enable logging in to the smart.finder.

Change of the index scheme in indexingmanagement.

In indexingmanagement the index scheme has changed. Follow the information in migration guide for the version update.

Change of index scheme in core0.

In core0 the index scheme has changed. If you want to migrate the indexed documents from your current smart.finder installation, follow the migration instructions for the version update.

sf_search-ui-connector-Bundle

The SearchAnythingSearchTermResetAction component has been removed. You can now control the behaviour of the search with an empty search term through the searchAllOnEmptySearchTerm property of the ResultListPageForwarder component. See the sf_search-ui-connector bundle documentation for additional information.

sf_resultlist.SortConfig component

Due to the new sorting component the configuration schema of the SortConfig component in the sf_resultlist bundle has been changed. So if you made adjustments to this component in your app.json files, see the sf_resultlist bundle documentation for details on how to update you configuration to the current schema.

Dropped leading dot in cookie domain

In prior versions of smart.finder the cookie domain in the configuration property security.sso.cookie.domain required a leading dot. This dot is no longer supported. So specify the domain without a leading dot in compliance with RFC 6265. Example:

security.sso.cookie.domain=sub.example.com

2.3

sf_search-ui-connector-Bundle

The SearchAnythingSearchTermResetAction component has been removed. You can now control the behaviour of the search with an empty search term through the searchAllOnEmptySearchTerm property of the ResultListPageForwarder component. See the sf_search-ui-connector bundle documentation for additional information.

sf_resultlist.SortConfig component

Due to the new sorting component the configuration schema of the SortConfig component in the sf_resultlist bundle has been changed. So if you made adjustments to this component in your app.json files, see the sf_resultlist bundle documentation for details on how to update you configuration to the current schema.

2.1

If you want to continue using your existing index, you only have to let the property solr.solr.home point to the location of the index. Then restart Tomcat. Now all search results and indexing jobs should be available again.

If the search boxes are not displayed for a core, enter the following command in the browser:

https://<yourserver>/smartfinder-search/<CORENAME>/suggest?suggest.build=true

The suggestions will then be displayed again.

2.0

2.0.3

Due to the update to Apache Solr 8.6.2 the internal initialisation of the backend service has changed. Therefore, the following steps are necessary:

  1. the JNDI entry solr/home in /META-INF/context.xml, which refers to the index directory, is no longer used. For this purpose a new property solr.solr.home is provided.

    If you have changed the location of solr.home, you must apply these changes by using the solr.solr.home property.

  2. In the configuration files of the cors used [SOLR_HOME]/[CORE_NAME]/conf/solrconfig.xml, you must ensure that the XML element luceneMatchVersion has the value 8.6.2:

    solrconfig.xml
    <?xml version="1.0" encoding="UTF-8" ?>
<config>
    <luceneMatchVersion>8.6.2</luceneMatchVersion>
[...]
</config>

    If you are using a customized file, make sure that the value matches.