Übersicht aller Update-Hinweise

3.0

Nicht mehr unterstützte Properties

solr.solr.home

Verzeichnispfad zum solr.home.

Neue Properties

solr.server.url

URL zur verwendeten Apache Solr Instanz.

Umbenennung von Java Packages

Die Basis-Java Packages wurden von de.conterra.finder in de.conterra.smartfinder umbenannt.

Diese Änderung betrifft auch die Konfigurationsdateien der jeweiligen Indexe (conf/solrconfig.xml und conf/schema.xml ), da hier die Java-Klassen referenziert werden (z.B. RequestProcessorFactory, FieldType, etc.).

Die map.apps Smart Search Extension ist nun Teil von smart.finder. Im Zuge der Integration wurden kleine Optimierungen an Konfiguration und Namensgebung durchgeführt, die im Folgenden dokumentiert werden.

Umbenennung des Solr-Index

Der Solr-Index wurde von smartsearch in featuresearch umbenannt.

Integration map.apps Bundle

Die Funktionalität des map.apps Bundles sf_smartsearch wurde in das Bundle sf_store integriert.

Hierbei wurden folgende Anpassungen vorgenommen.

Komponente SmartSearchStore

Die Komponente SmartSearchStore wurde in FeatureDocumentStore umbenannt und ist nun Bestandteil des Bundles sf_store.

Die folgenden Properties konnten an der Komponente SmartSearchStore bis smart.finder Version 3.x konfiguriert werden. Ab smart.finder Version 3.x werden diese Properties nicht mehr unterstützt. Die Konfiguration erfolgt nun mithilfe von Suchvorlagen (QueryTemplates).

  • editDistance

    Die fuzzy Suche wird nun innerhalb einer Suchvorlage definiert. Diese wird an der Komponente FeatureDocumentStore über die Property queryTemplate konfiguriert.

  • singleBoostWeight, groupedBoostWildcardWeight, groupedBoostWeight

    Diese Properties wurden genutzt, um die Gewichtung von Suchergebnissen zu beeinflussen. Die Gewichtung wird nun innerhalb einer Suchvorlage (QueryTemplate) definiert. Die Komponente FeatureDocumentStore enthält eine vordefinierte Suchvorlage, die die ursprünglichen Standardwerte enthält. Diese Suchvorlage kann mit der Property queryTemplate angepasst werden.

Beachten Sie, dass bei einer Migration von map.apps Smart Search Extension 2.x auf smart.finder 3.x die Server Komponente migriert werden muss, da Apache Solr nicht mehr als Teil von smart.finder ausgeliefert wird. Die Einrichtung von Apache Solr ist im folgenden Abschnitt beschrieben.

Client-Anwendung

Um die Bundles und Apps des smart.finder nutzen zu können, ist eine map.apps-Instanz erforderlich.

Die Installation der smart.finder Bundles und Apps ist hier beschrieben.

Apache Solr Konfiguration

Zum Betrieb von smart.finder ist die Bereitstellung einer Apache Solr Instanz Voraussetzung. Informationen zur Installation und Konfiguration von Apache Solr finden Sie unter https://solr.apache.org/.

Verwenden Sie als Apache Solr Distribution die full Variante. Die slim Variante enthält nicht die erforderlichen Module und ist daher nicht geeignet.

Da Apache Solr nun als externer Dienst betrieben wird, ergeben sich dadurch folgende Änderungen für smart.finder:

solr.home Konfiguration

Im SOLR_HOME Verzeichnis werden die Indexe verwaltet und persistiert. Das SOLR_HOME Verzeichnis befindet sich standardmäßig unter [SOLR_INSTALL_DIR]/server/solr.

Sie können Apache Solr auch mit einem anderen Verzeichnis starten. In diesem Fall müssen Sie dies entsprechend anpassen. Hier bestehen folgende Möglichkeiten:

  • in der Datei [SOLR_INSTALL_DIR]/bin/solr.in.sh (Linux) oder [SOLR_INSTALL_DIR]/bin/solr.in.cmd (Windows)

  • als Systemumgebungsvariable

  • beim Start von Apache Solr mit dem Parameter --solr-home <dir>

Kopieren Sie den Inhalt des Verzeichnisses [RELEASE-ORDNER]/solr/cores in das SOLR_HOME Verzeichnis. Danach sehen Sie folgende Verzeichnisstruktur:

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

Kopieren Sie nun die Datei SOLR_HOME/lib/jts-core-[VERSION].jar in das Verzeichnis [SOLR_INSTALL_DIR]/server/solr-webapp/webapp/WEB-INF/lib. Die Präsenz dieser Bibliothek an exakt dieser Stelle ist seitens Apache Solr vorgegeben.

Übernahme existierender Indexe

Für die Übernahme existierender Indexe muss sichergestellt sein, dass die Datei conf/solrconfig.xml der jeweiligen Cores mit den ausgelieferten Dateien in der Version 3 übereinstimmen.

Wenn Sie Anpassungen an den Dateien conf/solrconfig.xml und conf/schema.xml durchgeführt haben oder komplett eigene Cores nutzen wird empfohlen, diese Dateien mit den ausgelieferten Dateien der Version 3 zu vergleichen und ggf. Anpassungen vorzunehmen.

Nach Veränderung der Datei conf/schema.xml müssen die jeweiligen Indexe neu gebaut werden.

2.8

Keine.

2.7

Änderung von CSS-Klassen in der Detailansicht

Ab Version 2.7.0 wurden einige CSS-Klassen für das Layout der Detailansicht geändert, um die inhaltliche Aufteilung der Seite zu verbessern. Das folgende Schaubild zeigt die aktuellen Bereiche der Detailansicht und deren CSS-Klassen.

css smartfinder

Update des Schemas für core0

Die Platzhalter- und Volltextsuche wurde optimiert. Es wird nun ein expliziter FieldType für die Tokenerzeugung bei der Platzhaltersuche verwendet. Dadurch werden z.B. Interpunktionen nicht mehr berücksichtigt, was zu klareren Ergebnissen führt.

2.6

Neue erforderliche Solr Properties

Ab Version 2.6.1 müssen aufgrund von Änderungen in Apache Solr zwei neue Systemvariablen wie folgt gesetzt werden.

System Properties
solr.enableRemoteStreaming=true
solr.enableStreamBody=true

Hier z.B. für Linux:

Setzen von System Properties in Java/Tomcat
export JAVA_OPTS="$JAVA_OPTS -Dsolr.enableRemoteStreaming=true -Dsolr.enableStreamBody=true"

Änderung des Index-Schema im core0

Im core0 Core hat sich das Index-Schema geändert. Falls Sie die indexierten Dokumente aus ihrer aktuellen smart.finder Installation migrieren möchten, befolgend Sie die Migrationsanleitung für das Versionsupdate.

Neues Bundle sf_bootstrap

Es ist ein neues Bundle sf_bootstrap hinzugekommen, das die Basiskomponenten von smart.finder beim Start der App lädt. Dieses Bundles ist für den Start von smart.finder notwendig.

  • Wenn Sie eine selbst angepasste App verwenden, die bereits eines der Sammelbundles (beginnend mit sf_bundle-set_…​) enthält, müssen Sie nichts weiter tun. Das Bundle sf_bootstrap wird in diesem Fall automatisch geladen.

  • Wenn die App keines der Sammelbundles sf_bundle-set…​ enthält, fügen Sie bitte das Bundle sf_bootstrap wie im folgenden Beispiel zu ihrer App hinzu:

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

2.5

Keine.

2.4

Passwort im Sicherheitsmodus INTEGRATED

Aus Sicherheitsgründen ist das Administrator-Passwort im Sicherheitsmodus INTEGRATED in der Auslieferung nicht mehr vorbelegt. Setzen Sie dieses mithilfe der Property security.user.admin.pw, um eine Anmeldung am smart.finder zu ermöglichen.

Änderung des Index-Schema im indexingmanagement

Im indexingmanagement Core hat sich das Index-Schema geändert. Befolgend Sie die Angaben in Migrationsanleitung für das Versionsupdate.

Änderung des Index-Schema im core0

Im core0 Core hat sich das Index-Schema geändert. Falls Sie die indexierten Dokumente aus ihrer aktuellen smart.finder Installation migrieren möchten, befolgend Sie die Migrationsanleitung für das Versionsupdate.

sf_search-ui-connector Bundle

Die Komponente SearchAnythingSearchTermResetAction wurde entfernt. Das Verhalten der Suche bei einem leeren Suchbegriff kann jetzt über die Eigenschaft searchAllOnEmptySearchTerm der ResultListPageForwarder-Komponente gesteuert werden. Weitere Information finden Sie in der Dokumentation des sf_search-ui-connector Bundles .

sf_resultlist.SortConfig-Komponente

Aufgrund der Neuimplementierung der Sortierkomponente auf der Ergebnisseite hat sich das Konfigurationsschema der SortConfig-Komponente im Bundle sf_resultlist geändert. Falls Sie in Ihren app.json-Dateien Anpassungen an dieser Komponente vorgenommen haben, müssen diese Anpassungen auf der Grundlage des neuen Konfigurationsschemas neu vorgenommen werden. Das neue Konfigurationsschema ist in der Dokumentation des sf_resultlist Bundles beschrieben.

In früheren Versionen von smart.finder SDI musste der Cookie-Domäne in der Konfigurationseinstellung security.sso.cookie.domain ein Punkt vorangestellt werden. Dieser Punkt ist jetzt nicht mehr gültig. Die Domäne muss also ohne führenden Punkt angegeben werden und den Regeln in RFC 6265 entsprechen.

Beispiel:

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

2.3

sf_search-ui-connector Bundle

Die Komponente SearchAnythingSearchTermResetAction wurde entfernt. Das Verhalten der Suche bei einem leeren Suchbegriff kann jetzt über die Eigenschaft searchAllOnEmptySearchTerm der ResultListPageForwarder-Komponente gesteuert werden. Weitere Information finden Sie in der Dokumentation des sf_search-ui-connector Bundles .

sf_resultlist.SortConfig-Komponente

Aufgrund der Neuimplementierung der Sortierkomponente auf der Ergebnisseite hat sich das Konfigurationsschema der SortConfig-Komponente im Bundle sf_resultlist geändert. Falls Sie in Ihren app.json-Dateien Anpassungen an dieser Komponente vorgenommen haben, müssen diese Anpassungen auf der Grundlage des neuen Konfigurationsschemas neu vorgenommen werden. Das neue Konfigurationsschema ist in der Dokumentation des sf_resultlist Bundles beschrieben.

2.1

Wenn Sie ihren bestehenden Index weiter verwenden möchten, müssen Sie lediglich die Property solr.solr.home auf den Speicherort des Index zeigen lassen. Starten Sie danach den Tomcat neu. Nun sollten alle Suchergebnisse sowie die Indexierungs-Jobs wieder verfügbar sein.

Falls für einen Core die Suchverschläge nicht angezeigt werden, geben Sie folgendes Kommando im Browser ein:

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

Danach werden die Vorschläge wieder angezeigt.

2.0

2.0.3

Durch das Update auf Apache Solr 8.6.2 hat sich die interne Initialisierung des Backend-Dienstes geändert. Dadurch sind folgende Schritte notwendig:

  1. der JNDI-Eintrag solr/home in /META-INF/context.xml, welcher auf das Verzeichnis der Indexes verweist, wird nicht mehr verwendet. Hierzu wird ein neues Property solr.solr.home bereitgestellt.

    Falls Sie den Ort des solr.home geändert haben, müssen Sie diese Änderungen mithilfe der Property solr.solr.home bekannt machen.

  2. In den Konfigurationsdateien der verwendeten Cores [SOLR_HOME]/[CORE_NAME]/conf/solrconfig.xml müssen Sie sicherstellen, dass das XML-Element luceneMatchVersion den Wert 8.6.2 aufweist:

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

    Falls Sie eine angepasste Datei verwenden, stellen Sie sicher, dass der Wert übereinstimmt.