Installation - Quickstart

Da die Inbetriebnahme eine Vielzahl von Einzelmaßnahmen umfasst, werden in diesem Abschnitt die notwendigen Schritte beschrieben.

Für dieses Quickstart-Tutorial wird eine vorhandene Installation des security.managers vorausgesetzt.
Dieser Quickstart-Tutorial erläutert die Verwendung des Standalone-Clients. Die Installation der Bundles in map.apps ist hier beschrieben: Installation in vorhandener map.apps Instanz.

Umgebung einrichten

Stellen Sie sicher, dass ihre Umgebung der entspricht, die durch das Produkt unterstützt wird:

  • JDK Version

  • Apache Tomcat Version

  • Datenbanksystem

siehe: Systemanforderungen

ZIP Archiv entpacken

Das Produkt wird als ZIP Archiv ausgeliefert. Entpacken Sie dieses z.B. in ein temporäres Verzeichnis.

Ergebnis: im Wurzelverzeichnis befinden sich folgende Artefakte, die für den weiteren Installationsprozess wesentlich sind:

smartfinder-sdi.war

Standalone Web Client

ct-smartfinder-sdi-extension-js-[VERSION].jar

map.apps Bundles für smart.finder SDI

smartfinder-csw.war

CSW Proxy

smartfinder-search.war

smart.finder Backend für ISO Dokumente

smartfinder-editor.war

Metadatenerfassungskomponente (smartEditor)

Deployment der Web-Applikation

Deployen Sie die folgenden Archive in die Apache Tomcat Instanz:

  • smartfinder-sdi.war

  • smartfinder-csw.war

  • smartfinder-search.war

  • smartfinder-editor.war

Details zum Deployment finden Sie hier: Basiskomponenten

Ergebnis: die Web-Anwendungen sind unter folgenden URLs zugreifbar:

  • http://[HOST]:[PORT]/smartfinder-sdi

  • http://[HOST]:[PORT]/smartfinder-csw

  • http://[HOST]:[PORT]/smartfinder-search

  • http://[HOST]:[PORT]/smartfinder-editor

Stoppen Sie den Apache Tomcat, damit die Properties für ihre Umgebung in den nächsten Schritten angepasst werden können.

Konfiguration der Web-Anwendung

Jede Web-Applikation besitzt drei .properties-Dateien, in denen die einzelnen Web-Applikationen konfiguriert werden können:

  • application.properties

  • custom-application.properties

  • default-application.properties

Die Dateien befinden sich in den /WEB-INF/classes-Verzeichnissen der Web-Applikationen. Der grundsätzliche Aufbau der .properties-Dateien wird im Abschnitt Konfigurationsdateien erläutert.

Von diesen drei Dateien sollten nur die Dateien application.properties und custom-application.properties angepasst werden. Die default-application.properties-Datei sollte unverändert bleiben.

In der Datei custom-application.properties wird das Verzeichnis festgelegt, in dem Daten und eine weitere, externe application.properties-Datei abgelegt werden können. Eine externe application.properties-Datei hat den Vorteil, dass sie von mehreren Web-Applikationen gleichzeitig verwendet werden kann und deshalb bestimmte allgemein verwendete Einstellungen nicht in jeder einzelnen application.properties-Datei innerhalb der Web-Applikationen wiederholt werden müssen. Außerdem wird eine externe application.properties-Datei bei einem Update der Web-Applikation nicht von der neuen application.properties-Datei überschrieben, sodass die persönlichen Einstellungen nicht verloren gehen.

Um eine externe application.properties-Datei zu erstellen, stellen Sie in der Datei custom-application.properties den Pfad zu einem Verzeichnis ein, in dem Sie die externe application.properties-Datei abgelegen möchten:

# Pfad zum Verzeichnis, in dem die externe application.properties-Datei abgelegt ist
# $\{user.home\} ist eine Variable und verweist auf das Home-Verzeichnis des Benutzerkontos,
# unter dem der Tomcat-Dienst ausgeführt wird. Sie können stattdessen auch einen absoluten
# Pfad angeben.
data.directory.location=$\{user.home\}/.smartfinder

Legen Sie dann in dem hier angegebenen Verzeichnis eine Datei mit dem Namen application.properties an. In dieser Datei werden sämtliche Konfigurationseinstellungen für ihre Umgebung gespeichert und von allen Web-Applikationen verwendet.

Die folgenden Einstellungen sind mindestens erforderlich:

Properties Weitere Informationen

finder.service.url

Anpassen der URL-Konfiguration

smarteditor.context.name

URL zu smartEditor, wie z.B. http://myhost:8080/smartfinder-editor

db.use
db.type
(db.jndi.name)
db.jdbc.driver
db.jdbc.url
db.jdbc.username
db.jdbc.password
db.hibernate.dialect

Datenbank-Verbindung

security.administration.url
security.sso.cookie.name
security.sso.cookie.domain
security.keystore.location
security.keystore.passwd
security.keystore.key.alias
security.keystore.key.passwd

Sicherheitsaspekte

Um diese Properties in Ihre externe application.properties-Datei zu übernehmen, können Sie den folgenden Abschnitt in die Zwischenablage kopieren und anschließend einfügen:

# Die URL zur 'ct-finder-iso-webapp' Web-Applikation, wie z.B. https://myhost/smartfinder-search
finder.service.url=

# Die URL zur 'smarteditor' Web-Applikation, wie z.B. http://myhost:8080/smartfinder-editor
smarteditor.context.name=

# jndi|jdbc
db.use=jdbc

# The type of the DB system e.g: hsqldb | postgresql | sqlserver | oracle
db.type=

# The JNDI name, if db.use=jndi
db.jndi.name=

# JDBC driver
#
# Postgres: org.postgresql.Driver
# MS SQL Server: com.microsoft.sqlserver.jdbc.SQLServerDriver
# Oracle: oracle.jdbc.driver.OracleDriver
db.jdbc.driver=

# JDBC connection URL
#
# Oracle: jdbc:oracle:thin:@<HOST>:<PORT>:<DATABASE>
# MS SQL Server: jdbc:sqlserver://<HOST>:<PORT>;DATABASENAME=<DATABASE>
# PostreSQL: jdbc:postgresql://<HOST>:<PORT>/<DATABASE>
db.jdbc.url=

# JDBC user name
db.jdbc.username=

# JDBC user password
db.jdbc.password=

# Hibernate dialect to be used
#
# PostgreSQL: de.conterra.sdi.common.db.dialect.PostgreSQL9MapDialect
# Oracle: org.hibernate.dialect.Oracle10gDialect
# MS SQL Server: org.hibernate.dialect.SQLServerDialect
db.hibernate.dialect=

Vorbereitung der Datenbank

Einige Datenbank-Parameter wurden im Abschnitt der Konfiguration bereits aufgelistet. Zwar wird die Datenbank über die Komponente smartEditor automatisch eingerichtet, es müssen jedoch einige Datenbank-spezifische Vorbereitungen getroffen werden. Diese sind im Detail im Kapitel Datenbank-Verbindung erläutert.

Ergebnis: Die Datenbank ist so vorbereitet, dass eine JDBC Verbindung durch die Applikationen aufgebaut werden kann. Die Datenbank-Parameter sind in der Datei data.directory.location=$\{user.home\}/.smartfinder/application.properties eingetragen.

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.

Starten Sie den Apache Tomcat.

Wenn alle Web-Applikationen bereit sind, wurde auch die Datenbank unter der angegebenen Datenbankverbindung erzeugt.

Folgende Tabellen sind vorhanden:

  • Metadata

  • Locking

Einrichtung Nutzer

Öffnen Sie den security.manager und melden Sie sich als Administrator an. Legen Sie folgende Rollen an:

  • tc_Informationssuchender

  • tc_Datenpfleger

  • tc_Redakteur

  • tc_Administrator

  • maAdmin

Details finden Sie unter Rollenbasiertes Rechtekonzept.

Legen Sie einen Test-Nutzer mit dem Namen sfsdiadmin an und weisen Sie diesem die Rollen tc_Administrator und maAdmin zu.

Einrichtung der Indexierung

Rufen Sie die Anwendung auf http://[HOST]:[PORT]/smartfinder-sdi und melden Sie sich mit dem gerade erzeugten Nutzer sfsdiadmin an. Öffnen Sie den Manager.

Richten Sie nun den Data Import Handler ein, um die Datenbank kontinuierlich zu indexieren.

Eine detaillierte Anleitung finden Sie im Kapitel Indexierung der Datenbank.

Ein erster Test

Testen Sie die gesamte Anwendung wie folgt:

  1. Öffnen Sie http://[HOST]:[PORT]/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 Menu "Smart Editor" auf.

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

  6. Warten Sie solange, 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.

  10. Das Dokument wird nun in der Ergebnisliste angezeigt.

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

Optionale Schritte

Migration der Altdatenbestände

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

Einrichtung CSW Proxy

Sie können den CSW Proxy bezüglich der Capabilities, Sprachunterstützung und SSL/TLS Verbindung konfigurieren. Dies wird hier detailliert erläutert: CSW Proxy.

Einrichtung verteilte Kataloge

Um die Broker-Funktionalität zu nutzen, können Sie weitere Kataloge indexieren. Dies wird detailliert hier erläutert: Indexierungs-Jobs.