Konfiguration

Konfigurationsdateien

Folgende Konfigurationsdateien werden von smart.finder verarbeitet:

  • WEB-INF/classes/default-application.properties (NICHT EDITIEREN)
    In dieser Datei befinden sich alle Konfigurationsoptionen von smart.finder mit ihren Standardwerten.

  • WEB-INF/classes/custom-application.properties
    Wenn Sie das Arbeitsverzeichnis data.directory.location ändern, müssen Sie diese Datei anpassen. Alle weiteren Anpassungen erfolgen in der nachfolgenden Datei.

  • [data.directory.location]/application.properties
    Das Bearbeiten dieser Datei ist der empfohlene Weg Konfigurationsänderungen vorzunehmen.
    Standardmäßig ist ${user.home}/.smartfinder das Arbeitsverzeichnis data.directory.location von smart.finder. Die application.properties wird nicht automatisch erstellt. Als Vorlage können Sie die Datei WEB-INF/classes/application.properties nutzen. Es wird empfohlen, nur die Einstellungen in der Datei zu belassen, die geändert wurden.

Das Format der Konfigurationsdateien muss dem Java Properties Dateiformat entsprechen.

Beispiel Properties Datei
# Die Dateien müssen UTF-8 kodiert sein, sonst können Umlaute zu Fehlern führen!
# Am sichersten ist die Kodierung von Umlauten in Unicode-Syntax z.B: ä = \u00E4 (vgl. http://0xcc.net/jsescape/)

# Kommentare erfolgen mit vorangestellter Raute

# Allgemeine Syntax:
key = value

# Ein Value kann einen anderen Key referenzieren
key1 = http://${key.with.server}/test
Starten Sie nach Änderungen an einer der Konfigurationsdateien die Web-Applikation oder alternativ den kompletten Tomcat Server neu.

Konfigurationsparameter

In diesem Abschnitt werden die Parameter beschrieben, die am häufigsten in einer Standardinstallation verändert werden müssen. Weitere Parameter sind in der Datei WEB-INF/classes/default-application.properties in Kommentaren beschrieben.

Sowohl im Client als auch im Server liegen diese Konfigurationsdateien vor. In der folgenden Auflistung wird nicht danach unterschieden. Halten Sie sich an die jeweilige default-application.properties, um die Parameter für die jeweilige Web-Applikation zu verändern.
data.directory.location

Arbeitsverzeichnis, in dem map.apps-Daten (z.B. eine HSQL-Datenbank) lokal gespeichert werden.

Für den Fall, dass der Tomcat-Server als Windows-Dienst betrieben wird, liegt der .smartfinder Ordner im Nutzerverzeichnis des Tomcat-Nutzers, der den Dienst gestartet hat. Pfad-Trenner müssen entweder als / oder \\ angegeben werden.

Standardwert: $\{user.home\}/.smartfinder

proxy.allowedServerUrls

Liste von URLs, auf die das Proxy Servlet zugreifen darf.

smart.finder stellt ein integriertes Proxy Servlet bereit. Ein direkter Zugang zu bestimmten Ressourcen, die nur unter einer anderen Domänen erreichbar sind, ist aufgrund von Sicherheitsbeschränkungen innerhalb von JavaScript untersagt. Dieser Parameter definiert entsprechende Ausnahmen. Nach jeder URL muss ein ; gesetzt werden. Jede Zeile, mit Ausnahme der Letzten, endet mit einem \.

finder.service.url

Context-Name des smart.finder Servers.

Wurde der Name bei der Installation des smart.finder Servers geändert, so muss hier der aktuelle Name eingetragen werden.

Standardwert: /ct-finder-server-webapp-2.1.0

solr.solr.home

Verzeichnispfad zum solr.home.

Der Pfad kann absolut oder relativ angegeben werden. Es können auch Platzhalter verwendet werden, die durch den Web Container aufgelöst werden.

Beispiel:

solr.solr.home = ${catalina.base}/webapps/ct-finder-server-webapp-[VERSION]/WEB-INF/solr.home

Security

security.mode

Absicherungsmodus des administrativen Bereichs des smart.finders.

Der Zugriff auf die administrativen Bereiche des smart.finder kann bei Bedarf geschützt werden. Hierzu muss der Wert dieses Parameters auf INTEGRATED gesetzt werden (ansonsten: NONE).
Der Modus ONLY_AUTHN kann nur in Verbindung mit security.manager Enterprise Edition verwendet werden.

Erlaubte Werte: INTEGRATED, NONE, ONLY_AUTHN
Standardwert: INTEGRATED

Wurde INTEGRATED ausgewählt, kann der Modus über den folgenden Parametersatz näher spezifiziert werden:

security.user.admin.name

Nutzername im Plaintext.

security.user.admin.pw

Passwort des Nutzers.

Diese muss entsprechend der gewählten Kodierung beschrieben sein.

security.user.pwenc

Kodierung des Passworts.

Dieses kann plain (keine Kodierung) oder mittels MD5 (Message-Digest Algorithm 5) bzw. SHA-1 (secure hash algorithm) erfolgen. Es existieren Webdienste, die bei der Erzeugung mittels MD5 oder SHA-1 verschlüsselter Passwörter unterstützen.

Erlaubte Werte: plain, MD5, SHA-1

security.user.use_mapped_pass

Gibt an, ob eine andere Passwortkodierung als plain gewählt wurde.

Erlaubte Werte: true, false

security.ssl.trustAny

Gibt an, ob selbst signierte Zertifikate bei HTTPS-Verbindungen unterstützt werden.

Erlaubte Werte: true, false
Standardwert: false

Mailing

mailing.host

Rechnername, auf dem ein SMTP Server für das Versenden von E-Mails zur Verfügung steht.

mailing.port

SMTP Port auf dem SMTP Host-Rechner.

mailing.username

Nutzername für den SMTP Server.

mailing.password

Passwort für den SMTP Server.

mailing.senderaddress

Antwortadresse für den E-Mail Versand.

mailing.locale

Spracheinstellung für das Versenden von E-Mails.

Erlaubte Werte: de, en

Logging

Es stehen folgende Konfigurationsparameter zur Anpassung des Loggings zur Verfügung:

logging.logger.level

Detailgrad des Logs.

Mögliche Werte: TRACE, DEBUG, INFO, WARN, ERROR
Standardwert: INFO

logging.output.location
Ersetzt seit 2.0.8
Verwenden Sie stattdessen logging.file.location
logging.file.location

Ort, an dem die Log-Datei gespeichert wird.

Der Standardwert entspricht dem logs Verzeichnis des Tomcat. Mit dem Wert ${data.directory.location}/logs wird die Log-Datei im Arbeitsverzeichnis von smart.finder erzeugt.

Standardwert: ${catalina.base}/logs

logging.file.prefix

Dieser Parameter definiert den Namen der Log-Dateien.

Um den Log-Dateien den URL-Kontextpfad der ct-smartfinder-Installation voranzustellen (zum Beispiel smartfinder), verwenden Sie den Wert ${webcontext.name}.

Standardwert: ct-smartfinder

Weitere Logging-Parameter sind in der Datei default-application.properties beschrieben, z.B. zum Aktivieren oder Deaktivieren des Loggings in die Konsole, in Log-Dateien oder mittels GELF.

Änderung des Speicherorts des Index

In der Standardauslieferung werden die Indexe von smart.finder unter folgendem Pfad abgelegt:

%TOMCAT%\webapps\ct-finder-server-webapp-[VERSION]\WEB-INF\solr.home

In der hier lokalisierten Unterverzeichnissen werden die Indexe der einzelnen Cores gespeichert. Um den Speicherort der Indexe zu ändern, müssen Sie den Wert der Variable solr.solr.home in der Datei application.properties anpassen.

solr.solr.home=[absoluter Pfad]

Nach einem Neustart werden die Indexe in diesem Verzeichnis abgelegt.

Suchergebnisse sortieren

In der Standardkonfiguration wird das Ergebnis einer Suchanfrage an den Index anhand der Trefferwahrscheinlichkeit Score sortiert. Sollen Ergebnisse im Gegensatz dazu nach einem Feld (z.B. Titel) alphabetisch sortiert werden, so muss die Schema-Konfiguration dieses Feldes eindeutig sein. Das heißt, Felder, die von Analyzern benutzt werden (unter anderem alle Felder vom Typ text), können nur für die Sortierung von Suchergebnissen benutzt werden, wenn der Analyzer genau einen einzigen Ausdruck generiert. Weitere Einschränkungen für das Sortieren finden Sie in der Solr Dokumentation . Um dennoch auf solchen Feldern sortieren zu können, müssen diese Felder im Schema mittels copyField in ein neues Feld mit einem anderen Typ kopiert werden.

Nachfolgend ein Beispiel für das Feld name:

  1. Ändern Sie die schema.xml

    Angepasste schema.xml
    <fields>
    [...]
    <field name="name" type="text" indexed="true" stored="true" required="false" multiValued="false"/>
    <copyField source="name" dest="name_string"/>
    <field name="name_string" type="string" indexed="true" stored="true" required="false" multiValued="false"/>
    [...]
</fields>

  2. Speichern Sie die Datei.

  3. Starten Sie den smart.finder Server oder Apache Tomcat neu, damit die Änderungen wirksam werden.

Konfiguration von Synonymen der Facettenwerte

Manchmal sind die in der Datenbank verwendeten Begriffe für eine Sache nicht einheitlich. Sie sollten Synonyme entsprechend der unten stehenden Anleitung zusammen fassen.

Beispielsweise beziehen sich die Werte shape und Shapefile beide auf dasselbe Format. Sie können die Werte der Facette Format immer als SHP in der Nutzeroberfläche anzeigen lassen.

Um dies zu konfigurieren sind zwei Schritte nötig.

Schritt 1: Abbildung von Werten auf Synonyme

Pflegen Sie die Synonyme in der Konfigurationsdatei /ct-finder-server-webapp-2.1.0/WEB-INF/solr.home/core0/conf/lang/synonyms.txt ein.

Für das obige Beispiel müssen Sie die folgende Zeile ergänzen: shape, Shapefile => SHP

Die Werte vor dem Pfeil werden zusätzlich im Index abgelegt. Sie können nach shape, Shapefile sowie SHP suchen. Im Attributfilter wird immer SHP angezeigt. Ein Filter auf dem Wert SHP schließt dann alle seine Synonyme mit ein.

Schritt 2: Synonym-Index-Verknüpfung

Verknüpfen Sie nun die Synonyme mit dem Feld im Index.
Öffnen Sie dazu die Datei /ct-finder-server-webapp-2.1.0/WEB-INF/solr.home/core0/conf/schema.xml und suchen das Feld, für dessen Werte Sie die Synonyme definieren.

In unserem Beispiel handelt es sich um das Feld format:

<field name="format" type="string" indexed="true" stored="true" required="false" multiValued="true"/>

Legen Sie darunter nun ein neues Feld mit dem Typ text_synonym, beispielsweise dem Namen format_facet und den folgenden Attributen an:

<field name="format_facet" type="text_synonym" indexed="true" stored="true" required="false" multiValued="true"/>

Weisen Dokumente beim Indexieren einen Wert für das Feld format auf, wird dieser auch in das Feld format_facet kopiert. Dieses Feld kann als Facette genutzt werden und muss dann auch in der Client-Konfiguration facetFields konfiguriert werden, siehe Auswahl und Reihenfolge von Filterattributen.