Installation

Der Betrieb des smart.finder SDI kann auf zwei Arten erfolgen:

  • Installation als Standalone-Client

  • Installation in vorhandener map.apps Instanz

Im Folgenden werden beide Varianten beschrieben. Installationsschritte, die für beide Varianten gelten, beginnen mit Allgemein in der Überschrift.

Es wird eine vorhandene Installation von security.manager Enterprise Edition vorausgesetzt.

Benötigte Software

Für die Installation von smart.finder SDI muss folgende Software auf Ihrem System installiert sein. Die mit smart.finder SDI kompatiblen Versionen dieser Software finden Sie in den Systemanforderungen.

  • Java, zum Beispiel von der OpenJDK Download-Seite .

  • Apache Tomcat, von der Apache Tomcat Download-Seite . Laden Sie für eine Windows-Installation zum Beispiel 32-bit/64-bit Windows Service Installer herunter. Weitere Informationen zum Installationsprozess finden Sie in der Tomcat Setup-Dokumentation .

    Wenn Ihre Systemumgebung besondere Proxyserver-Einstellungen benötigt, müssen diese ggf. im Tomcat angepasst werden.

  • Datenbank: Standardmäßig wird für Testzwecke eine lokale HSQL-Datenbank im Dateisystem erstellt.

    Installieren Sie für Produktions-Umgebungen eine eigene Datenbank. Für weitere Informationen lesen Sie den Abschnitt Datenbank-Konfiguration.

  • security.manager - Enterprise Edition: Für den Betrieb ist security.manager - Enterprise Edition (ab Version 4.x) zwingend erforderlich. Falls Sie noch keine entsprechende Installation betreiben, können Sie diese gebündelt mit smart.finder SDI über das con terra Portal beziehen.

    Sie erhalten eine Lizenz für den Betrieb des security.managers im Rahmen von smart.finder SDI unter: cs@conterra.de

Wenn Sie Java 17 als Runtime verwenden, muss vor dem Start des Tomcat-Prozesses die Java-Option --add-opens=java.base/java.math=ALL-UNNAMED zusätzlich festgelegt werden. Je nachdem, ob Tomcat als Systemprozess oder über die Kommandozeile/Shell gestartet wird, kann dies auf unterschiedliche Art und Weise geschehen.

Beispiel für Linux-Umgebung via Shell: export JAVA_OPTS="$JAVA_OPTS --add-opens=java.base/java.math=ALL-UNNAMED"

Allgemein: Basiskomponenten

Die folgenden Komponenten müssen in jedem Fall installiert werden, unabhängig davon, ob Sie smart.finder SDI Standalone oder in einer map.apps Instanz betreiben.

  1. Entpacken Sie das ZIP-Archiv.

    Die WAR-Dateien für die Installation befinden sich im Wurzelverzeichnis. Die folgenden Dateien sind für die weiteren Installationsschritte wichtig:

    • smartfinder-csw.war CSW Proxy

    • smartfinder-search.war smart.finder Backend für ISO Dokumente

    • smartfinder-editor.war Metadatenerfassungskomponente (Editor)

    • smartfinder-sdi.war Standalone Web Client

    • ct-smartfinder-sdi-extension-js-[VERSION].jar map.apps Bundles für smart.finder SDI

  2. Installieren Sie nun die zentralen Basiskomponenten von smart.finder SDI.

    • smartfinder-search.war für die smart.finder SDI Server Komponente

    • smartfinder-editor.war für den Editor

    • smartfinder-csw.war für den CSW Proxy

      Kopieren Sie dazu die Dateien in den Ordner [TOMCAT_HOME]\webapps. Falls der Tomcat-Dienst bereits gestartet ist, werden die Dateien automatisch entpackt. Andernfalls kann der Tomcat-Dienst jetzt gestartet werden. Alternativ können Sie auch den Tomcat-Manager verwenden, um die Dateien zu installieren.

Die Komponenten sind nun initial bereitgestellt und später über die folgenden Adressen erreichbar. Falls Sie die WAR-Dateien umbenannt haben, ändern sich entsprechend auch die Adressen.

https://<yourserver>/smartfinder-search
https://<yourserver>/smartfinder-editor
https://<yourserver>/smartfinder-csw
Die Web-Applikation smart.editor benötigt Schreibzugriff auf das Verzeichnis /WEB-INF/classes/validation. Stellen Sie sicher, dass der Tomcat-Nutzer diese Schreibrechte besitzt.

Fahren Sie nun mit der Installation des smart.finder SDI Clients fort. Die folgenden Abschnitte führen Sie durch die beiden möglichen Installationsvarianten:

Variante 1: smart.finder SDI - Standalone

Installation des Client

Unter Allgemein: Basiskomponenten wurden bereits alle Komponenten bis auf den Standalone-Client installiert. Installieren Sie nun den smart.finder SDI Standalone Client im Tomcat:

  1. Kopieren Sie smartfinder-sdi.war in den Ordner [TOMCAT_HOME]\webapps.

    Falls der Tomcat-Dienst bereits gestartet ist, wird die Datei automatisch entpackt. Andernfalls können Sie den Tomcat-Dienst jetzt starten. Alternativ können Sie auch den Tomcat-Manager verwenden, um die Dateien zu installieren.

  2. Nach Anpassung der Konfigurationsparameter im nächsten Abschnitt wird die Anwendung unter https://<yourserver>/smartfinder-sdi erreichbar sein. Falls Sie die WAR-Datei umbenannt haben, ändert sich die Adresse entsprechend.

    Der Standalone-Client wird mit folgenden Apps ausgeliefert:

  3. Stoppen Sie nun den Apache Tomcat, um die Konfigurationsparameter in den nächsten Schritten anzupassen.

Anpassung der Konfigurationsparameter

Um die Konfigurationsparameter für smart.finder SDI anzupassen, editieren Sie die mitgelieferten Properties-Dateien. Der grundsätzliche Aufbau der Dateien wird im Kapitel Konfigurationsdateien erläutert.

Passen Sie alle Konfigurationsparameter für Ihre Umgebung an.

Fahren Sie fort mit dem Abschnitt Allgemein: Datenbank vorbereiten.

Variante 2: smart.finder SDI - map.apps

Voraussetzung für diese Installation ist eine vorhandene map.apps Instanz. Die verwendete map.apps Instanz muss im Security Mode "ONLY_AUTHN" (Einstellung security.mode=ONLY_AUTHN in der application.properties-Datei) und in Verbindung mit dem security.manager betrieben werden.

Installation der Bundles

  1. Melden Sie sich als Benutzer mit Administrationsrechten im map.apps Manager an.

  2. Öffnen Sie den Reiter Bundles.

  3. Klicken Sie auf die +-Schaltfläche oberhalb der Liste der installierten Bundles.

  4. Laden Sie die Datei [RELEASE-ORDNER]/ct-smartfinder-sdi-extension-js-[VERSION].jar hoch. Diese enthält alle Bundles für smart.finder SDI.

Sobald das Hochladen beendet ist, werden die smart.finder SDI Bundles in der Liste der installierten Bundles angezeigt.

Installation des Job-Manager

Um den smart.finder SDI Job-Manager innerhalb des map.apps Manager nutzen zu können, gehen Sie folgendermaßen vor:

  1. Öffnen Sie die map.apps Konfigurationsdatei application.properties. Diese liegt üblicherweise im Ordner [USER_HOME]/.mapapps.

  2. Suchen Sie den Eintrag manager.config.viewbundles.

Falls der Eintrag bereits existiert, ergänzen Sie am Ende den Wert sf_jobadmin. Falls dieser noch nicht existiert, legen Sie ihn wie folgt an:

manager.config.viewbundles=appmanagement,reportmanagement,bundlemanagement,mapapps-github-manager,bundleupdatechecker,sf_jobadmin

Nach einem Neustart des map.apps-Kontexts erscheint im map.apps Manager der neue Reiter Indexierungs-Jobs.

Anpassung der Konfigurationsparameter

Die Konfigurationsparameter werden ebenfalls in der zentralen Konfigurationsdatei von map.apps angepasst oder ergänzt. Diese finden Sie unter [USER_HOME]/.mapapps/application.properties.

Der grundsätzliche Aufbau der Dateien wird im Kapitel Konfigurationsdateien erläutert.

Die verfügbaren Konfigurationsparameter finden Sie im Kapitel Konfigurationsparameter. Passen Sie die Werte der Konfigurationsparameter für Ihre Umgebung an.

Wenn Sie neben smart.finder SDI weitere Produkte von con terra Technologies einsetzen, die einen Index aufbauen (z.B. smart.finder oder map.apps Smart Search Extension) achten Sie darauf, dass die Indexe getrennt voneinander betrieben werden müssen.

Sie können z.B. nicht den iso Core verwenden, um zusätzlich zu den Metadatendokumenten Features für map.apps Smart Search Extension zu indexieren. Beides muss in separaten Indexen erfolgen.

Achten Sie zudem darauf, dass für jeden verwendeten Core die Permission Filter im Verzeichnis /WEB-INF/templates/filter vorhanden sind. Für die map.apps Smart Search Extension bedeutet dies z.B., dass Sie die Datei smartsearch.ftl nach /smartfinder-search/WEB-INF/templates/filter kopieren müssen.

Die Permissions Filter befinden sich immer in der jeweiligen smartfinder-search.war Datei, die Teil des Produktrollouts ist.

map.apps App-Konfiguration

Zur Ausführung der mitgelieferten Apps ist nun alles konfiguriert. Diese Apps bieten Ihnen einen Ausgangszustand für eigene Anpassungen. Die full-page-sdi App erfordert noch zusätzliche Anpassungen, damit einige Funktionen wie Kacheln und Themenbaum korrekt funktionieren.

Weitere Informationen zur Konfiguration finden Sie im Abschnitt Konfiguration von Funktionen.

Fahren Sie fort mit dem Abschnitt Allgemein: Datenbank vorbereiten.

Allgemein: Datenbank vorbereiten

Die Datenbank für smart.finder SDI wird automatische durch die Komponenten smartfinder-editor erstellt. Sie müssen lediglich einige Vorbereitungen durchführten, wie im Kapitel Datenbank-Verbindung beschrieben.

Die benötigten JDBC-Datenbanktreiber werden nicht mit ausgeliefert. Kopieren Sie daher die zu Ihrem Datenbanksystem passenden Treiber entweder nach [TOMCAT_HOME]/lib oder [TOMCAT_HOME]/webapps/smartfinder-editor/WEB-INF/lib.

Allgemein: Nutzer und Rollen einrichten

  1. Öffnen Sie den security.manager und melden Sie sich als Administrator an.

  2. Legen Sie folgende Rollen an, falls noch nicht vorhanden. Details finden Sie unter Rollenbasiertes Rechtekonzept.

  • tc_Informationssuchender

  • tc_Datenpfleger

  • tc_Redakteur

  • tc_Administrator

  • maAdmin

    1. Legen Sie eine Testperson mit dem Namen sfsdiadmin an.

    2. Weisen Sie dieser die Rollen tc_Administrator und maAdmin zu.

Allgemein: Indexierung der Datenbank einrichten

  1. Rufen Sie die Anwendung https://<yourserver>/smartfinder-sdi auf.

  2. Melden Sie sich mit sfsdiadmin an und öffnen den Manager.

  3. Richten Sie einen Data Import Handler ein, um die Datenbank kontinuierlich zu indexieren.

Eine detaillierte Anleitung hierzu finden Sie im Kapitel Indexierungs-Jobs im Abschnitt Datenimport.

Abschluss: Testen der Installation

Überprüfung der Datenbank

  1. Starten Sie den Tomcat neu.

  2. Prüfen Sie, ob unter dem eingerichteten Datenbanknutzer folgende Tabellen angelegt worden sind:

    • Metadata

    • Locking

Test der gesamten Anwendung

  1. Öffnen Sie https://<yourserver>/smartfinder-sdi.

  2. Wählen Sie die App full-page-sdi.

  3. Falls Sie nicht schon angemeldet sind, melden Sie sich als sfsdiadmin an.

  4. Rufen Sie im Menü Editor auf.

  5. Erfassen Sie einen Metadatensatz und speichern Sie diesen als Öffentlich.

  6. Warten Sie so lange, bis der Data Import Handler die Datenbank neu indexiert hat. Alternativ können Sie diese Indexierung auch direkt im Job-Manager anstossen.

  7. Gehen Sie zur Startseite der App full-page-sdi.

  8. Tippen Sie einen Begriff ein, den Sie im gerade erstellen Metadatensatz verwendet haben.

  9. Wählen Sie einen der Vorschläge aus.
    Das Dokument wird nun in der Ergebnisliste angezeigt.

  10. Klicken Sie auf den Eintrag in der Ergebnisliste, um zur Detailansicht zu gelangen.

Optionale Schritte

Migration von 1.x

Zur Übernahme von Metadatenbeständen aus smart.finder SDI 1.x können Sie das mitgelieferte Migrationstool verwenden. Dieses wird detailliert unter Migration beschrieben.

CSW Proxy

Sie können den CSW Proxy bezüglich der Capabilities, Sprachunterstützung und SSL/TLS Verbindung konfigurieren. Dies wird detailliert unter CSW Proxy beschrieben.

Verteilte Kataloge

Um die Broker-Funktionalität zu nutzen, können Sie weitere Kataloge indexieren. Dies wird detailliert unter Indexierungs-Jobs beschrieben.