FACT-Finder einrichten
Wie schon erwähnt, besteht das FACT-Finder Framework aus drei Webanwendungen, die untereinander verknüpft sind. Der Einfachheit halber gehen wir davon aus, dass alle drei Anwendungen auf einem Server installiert werden sollen. Die Anleitung ist jedoch auch generell für die anderen Betriebsszenarien gültig, in diesem müssen dann lediglich die Pfade und andere Dinge angepasst werden, die an anderer Stelle noch erläutert werden.
Suchclient
Nehmen Sie die Suchanwendung, die Sie von Omikron erhalten haben, benennen Sie diese in fact-finder.war
um und platzieren Sie diese im tomcat/webapps
-Verzeichnis (Beispiel: /var/lib/tomcat8/webapps
). Behalten Sie am Besten hierbei das catalina.out
-Logfile von Tomcat im Auge um mögliche Fehler zu erkennen. Die Anwendung erzeugt beim Hochfahren einen fact-finder
-Ordner in dem Verzeichnis, dass als FACTFINDER_RESOURCES
definiert wurde (Beispiel: /opt/factfinder
). In diesem werden die initialen Konfigurationsdateien abgelegt, auf die wir gleich noch näher eingehen. Prüfen Sie an dieser Stelle, ob ein entsprechendes Verzeichnis mit Inhalt angelegt worden ist.
Eine der wichtigsten Konfigurationsdateien in FACT-Finder ist die fff.properties
, diese finden Sie in unserem Beispiel unter /opt/factfinder/fact-finder/conf/
. In dieser müssen folgende zwei Einstellungen angepasst werden:
Key | Beschreibung | Beispielwert |
---|---|---|
server.public.url | Gibt an, unter welcher externen URL die Suchanwendung erreichbar ist. Diese Angabe wird von der UI-Anwendung an einigen Stellen verwendet und ist daher für eine reibungslose Verknüpfung der beiden Anwendungen notwendig. | http://dev.fact-finder.de/fact-finder |
analytics.url | Gibt die URL an, an der die Analytics-Anwendung erreichbar ist, damit die Systeme miteinander kommunizieren können. | http://localhost:8080/analytics |
Sobald die Werte angepasst sind, rufen Sie bitte als nächstes die Suchanwendung über den Browser unter folgender URL auf:
http://<Adresse Ihres Servers>:8080/fact-finder/Management.ff
Wenn Sie einen FACT-Finder Anmeldebildschirm sehen ist die Installation bis hier hin korrekt und wir können uns der nächsten Anwendung widmen.
Ergänzung
Änderung des SMTP-Servers
Die FACT-Finder Anwendung ist in der Lage in gewissen Fällen Benachrichtigungmails zu versenden, diese werden per Standard über einen simplen SMTP-Server versendet. Sollte die Anwendung nicht mit dem Internet verbunden sein oder es Probleme beim Senden/Empfangen der Mails geben, sollte über die mailServer.properties
Konfigurationsdatei ein anderer Mailserver angegeben werden. Die Konfigurationsdatei befindet sich im gleichen Verzeichnis, wie die vorherige fff.properties
(Im Beispiel /opt/factfinder/fact-finder/conf/
). In dieser Datei lassen sich folgende Konfigurationen einstellen:
Konfiguration-Key | Beschreibung | Beispielwert | Standardwert | |
---|---|---|---|---|
mail.transport.protocol | benötigt | Protokoll welches für den Mailversand genutzt werden soll. | smtp | smtp |
mail.smtp.localhost | benötigt | Localhost Adresse | ihreDomain.de | fact-finder.de |
mail.smtp.connectiontimeout | benötigt | Connection Timeout für die Kommunikation mit dem Mailserver in Millisekunden | 120000 | 120000 |
mail.smtp.timeout | benötigt | Session Timeout für die Kommunikation mit dem Mailserver in Millisekunden | 600000 | 600000 |
mail.smtp.host | optional | Adresse des Mailservers. Per Standard bzw. wenn dies nicht explizit angegeben ist, wird diese durch ein MX-Lookup ermittelt. | mail.ihreDomain.de | - |
mail.smtp.port | optional | Port des Mailservers | 587 | 25 |
mail.smtp.auth | optional | Boolesche Angabe ob Benutzerdaten für den Mailserver notwendig sind oder nicht. Falls dies true ist, so sind Angaben bei username und password notwendig. | true | false |
username | optional | Name des Benutzers für den Mailserver | user | - |
password | optional | Passwort des Benutzers für den Mailserver | passwort | - |
mail.smtp.from | optional | Mailadresse von der aus die Benachrichtigungsmails versendet werden. | ff-report@ihreDomain.de | noreply@fact-finder.de |
Standarderweiterungen (Common Classes)
Die FACT-Finder Common Classes bieten optionale Erweiterungen für Import, Suche, Suggest und geplante Tasks. Wenn Sie diese nutzen möchten, dann legen Sie bitte die fff-commonClasses.jar Datei in dem Verzeichnis customClasses
der Suchanwendung ab, welches vom Tomcat automatisch erstellt wird.
Siehe auch Standarderweiterungen (Common Classes) und Individuelle Erweiterungen (Custom Classes).
Analytics
Benennen Sie die Analytics-Anwendung in analytics.war
um und platzieren Sie diese ebenfalls im tomcat/webapps
-Verzeichnis. Im Anschluss sollten Sie einige Fehlermeldungen in der catalina.out
feststellen können, da die Anwendung noch nicht korrekt konfiguriert ist. Durch das Deployment sollte, wie auch beim Suchclient, im FACTFINDER_RESOURCES
-Verzeichnis ein Ordner mit anwendungsspezifischen Namen und Konfigurationsdateien erstellt worden sein.
In diesem finden Sie eine Datei mit dem Namen application.properties
in der Sie folgende Konfigurationen vornehmen:
Konfiguration-Key | Beschreibung | Beispielwert | Standardwert | |
---|---|---|---|---|
ffa.persistence.searchLogDirectory | benötigt | Pfad in dem die FACT-Finder Suchlogfiles liegen, die analysiert werden sollen. Es können mehrere Pfade mit Komma getrennt angegeben werden. Lesezugriff ist hier ausreichend.
|
Bei Angabe von mehreren Werten:
| - |
ffa.persistence.scicLogDirectory | benötigt | Pfad in dem die FACT-Finder Shoppingcart (SCIC) Logfiles liegen, die analysiert werden sollen. Es können mehrere Pfade mit Komma getrennt angegeben werden. Lesezugriff ist hier ausreichend.
|
Bei Angabe von mehreren Werten:
| - |
ffa.persistence.jobDirectory | benötigt | Verzeichnis in dem die Berechnungen von FACT-Finder Analytics zu Cachingzwecken abgelegt werden. Lese- und Schreibzugriff ist daher notwendig. |
| - |
ffa.job.maximumIdleTime | optional | Gibt an, ab wann ein Analysejob als abgelaufen gilt, bei dem x Millisekunden lang keine Interaktion stattfand. Mindestwert: 1800000 (=30min). | 172800000 | 172800000 (=48h) |
ffa.job.cleanupEvery | optional | Definiert das Analytics alle x Millisekunden alle Jobs, deren maximumIdleTime überschritten ist, löschen soll. Mindestwert: 60000 (=60s). | 3600000 | 3600000 (=1h) |
In unserem Beispiel würde die Datei folgend aussehen:
ffa.persistence.searchLogDirectory=/opt/factfinder/fact-finder/logs
ffa.persistence.scicLogDirectory=/opt/factfinder/fact-finder/logs/shoppingcart
ffa.persistence.jobDirectory=/opt/factfinder/analytics/jobs
Sobald die Konfiguration entsprechend angepasst ist, führen Sie ein Redeploy der Anwendung durch. Das können Sie beispielsweise über den Befehlt touch analytics.war
im tomcat/webapps
-Verzeichnis anstoßen. Im Anschluss sollte das Deployment ohne Fehler durchlaufen und Sie können über den Browser folgende URL aufrufen:
http://<Adresse Ihres Servers>:8080/analytics/manage/health
Sehen Sie eine Seite, auf der die Meldung {"status":"UP"}
steht, so ist auch FACT-Finder Analytics betriebsbereit und wir können uns der letzten Anwendung widmen.
Komprimierung von Logfiles
FACT-Finder Analytics kann ab der Version 7.1 gzip-komprimierte Logdateien verarbeiten. Um Festplattenplatz zu sparen können Sie daher die Logfiles in den Verzeichnissen von ffa.persistence.searchLogDirectory
und ffa.persistence.scicLogDirectory
zyklisch komprimieren. Bitte beachten Sie jedoch, dass das aktuellste Logfile nicht getroffen ist, da die FACT-Finder Suchanwendungen dort während des Betriebs Informationen reinschreiben.
UI
Benennen Sie die UI-Anwendung in fact-finder-ui.war
um und platzieren Sie diese ebenfalls im tomcat/webapps
-Verzeichnis. Auch bei dieser Anwendung sollten Sie nach dem Deployment einen anwendungsspezifschen Ordner unterhalb des FACTFINDER_RESOURCES
-Verzeichnisses sehen. In diesem finden Sie die Konfigurationsdatei fff-ui.properties
, in der folgende Einstellungen vorgenommen werden müssen.
Konfiguration | Key | Beschreibung |
---|---|---|
URL zur Suchanwendung |
| Die URL an dem sich der Kommunikationsendpunkt zur Suchanwendung befindet. |
Authentifizierung |
| Diese Werte spiegeln die Authentifizierungswerte der Suchanwendung wieder, dienen also dazu, dass sich die UI-Anwendung beim Suchserver anmelden kann. Die Werte müssen identisch mit denen aus der |
In unserem Beispiel sieht die Datei wie folgt aus:
server.url=http://localhost:8080/fact-finder/ui/ws/soap/
authentication.algorithm=MD5
authentication.mode=ADVANCED
authentication.prefix=FACT-FINDER
authentication.postfix=FACT-FINDER
Im Anschluss sollten Sie nach einem Neustart der Anwendung die untere URL aufrufen und überprüfen, ob Sie einen FACT-Finder Anmeldebildschirm sehen und dort ein Banner angezeigt wird, der über Neuigkeiten informiert.
http://<Adresse Ihres Servers>:8080/fact-finder-ui/
Wenn beides der Fall ist, sollten Sie sich mit den initialen Zugangsdaten (Benutzername: admin
, Passwort: adminpw
) anmelden können. Bitte denken Sie daran, die Daten für den späteren Betrieb über die Benutzerverwaltung zu ändern.
Navigieren Sie in der Oberfläche auf System -> Systeminformation, um die Verknüpfung der drei Anwendungen zu überprüfen. Bei richtiger Konfiguration sollten Sie im allgemeinen Bereich die entsprechenden URLs und Versionsnummern sehen. Sollten die angezeigten Werte von Ihren Einstellungen in den Konfigurationsdateien abweichen, so können Sie durch Klick auf den Link "Konfiguration neuladen" ein erneutes Einlesen der Konfigurationsdateien erzwingen.
Sollten die Informationen korrekt sein, haben Sie das FACT-Finder Framework korrekt aufgesetzt und es kann nun mit Produktdaten befüllt werden.