1. Einleitung
Die Suchfunktion ist nur eine von vielen Funktionen, die Kunden an eine Online-Präsenz stellen. Sie muss intuitiv bedienbar sein und relevante Ergebnisse liefern.
SmartSearch bündelt diese Anforderungen mit einer hochperformanten Suchlösung, die auf umfangreichen Webseiten einsetzbar ist. Durch eine hohe Trefferqualität und einen optimalen Suchkomfort werden Kunden auf der Webseite gebunden.
Mittels SmartSearch Connect lassen sich die Funktionalitäten von SmartSearch und FirstSpirit optimal verbinden. Mit sehr wenig Aufwand ist es möglich die mittels FirstSpirit erstellte Webseite mit einer performanten Suche auszustatten. Aktualisierungen und neue Inhalte finden sich direkt in den Suchergebnissen wieder.
Das Ziel des Moduls ist eine einfache und schnelle Verknüpfung zwischen diesen Systemen. Dabei wurde darauf geachtet, so wenig Installations- und Konfigurationsaufwand wie möglich zu erzeugen. Aus diesem Grund wurde bewusst darauf verzichtet mit jedem FirstSpirit-Projekt kompatibel zu sein. So ist es aktuell noch nicht möglich Projekte zu verwenden, in denen Fragmente verwendet werden.
2. Installation und Konfiguration
Für die Verwendung der Funktionalitäten des SmartSearch Connect-Moduls ist die Installation und Konfiguration unterschiedlicher Komponenten notwendig. Die dafür erforderlichen Schritte werden in den nachfolgenden Unterkapiteln erläutert.
2.1. Installation des Moduls
Das Modul muss mit Hilfe der mitgelieferten smartsearch-connect-<Versionsnummer>.fsm Datei auf dem FirstSpirit-Server hinzugefügt werden. Öffnen Sie für die Installation des Moduls den ServerManager und wählen Sie den Bereich Server-Eigenschaften → Module.
Im Hauptpanel ist eine Liste der auf dem FirstSpirit-Server installierten Module zu sehen. Wählen Sie nach dem Klicken auf [Installieren] die mitgelieferte smartsearch-<Versionsnummer>.fsm aus und bestätigen Sie die Auswahl mit [Öffnen]. Nach der erfolgreichen Installation wurde der Liste ein Ordner SmartSearch hinzugefügt, der Alle Rechte erhalten muss (vgl. Abbildung Modulverwaltung in den Server-Eigenschaften).
|
Nach jeder Installation oder Aktualisierung eines Moduls ist ein Neustart des FirstSpirit-Servers notwendig. |
2.2. Konfiguration des Service
Die serverweite Konfiguration erfolgt mittels des SmartSearch ConnectConfigurationService.
- Endpoint
-
Hier kann die URL des SmartSearch Servers konfiguriert werden. Dabei muss ggf. auch der Port hinterlegt werden.
- Authentifizierung
-
Im Feld Authentication wird festgelegt, wie sich das Modul gegenüber dem SmartSearch Server authentifiziert. Je nach gewähltem Modus zeigt der Dialog nur die für diesen Modus relevanten Felder. Voreingestellt ist BASIC; bestehende Konfigurationen, die dieses Feld nicht anfassen, bleiben davon unberührt.
- BASIC
-
Der SmartSearch Server ist durch User und Passwort geschützt. Tragen Sie hier den entsprechenden User und das Passwort ein. Der hier hinterlegte Benutzer muss in SmartSearch alle Rechte haben welche für das Anlegen von Datengeneratoren und PreparedSearches relevant sind. Zum Testen ist der Standardbenutzer admin@localhost.de ausreichend, nachdem er wie üblich mit allen Rechten ausgestattet wurde.
| Das Passwort wird in der Modul-Konfiguration verschlüsselt, wenn die FirstSpirit Verschlüsselung aktiviert ist. Weitere Informationen zur FirstSpirit Verschlüsselung sind in der FirstSpirit Dokumentation zu finden. |
- OAUTH
-
Wählen Sie OAUTH, wenn der SmartSearch Server im OIDC-Modus betrieben wird. In diesem Modus verwendet das Modul keinen Benutzer und kein Passwort mehr, sondern authentifiziert sich als Service-Account eines dafür angelegten Clients beim Identity-Provider (OAuth-2.0-Client-Credentials-Grant).
Bereiten Sie den Identity-Provider vor dem Wechsel des Modus vor:
-
Legen Sie für das Modul einen Client an und aktivieren Sie dessen Service-Account sowie den Client-Credentials-Grant.
-
Vergeben Sie dem Service-Account eine E-Mail-Adresse.
-
Fügen Sie den Service-Account der Gruppe hinzu, deren Rolle die Rechte für das Anlegen von Datengeneratoren und PreparedSearches gewährt.
Tragen Sie anschließend Token endpoint, Client ID und Client secret ein. Der Token endpoint ist die vollständige Token-URL Ihres Identity-Providers, zum Beispiel https://sso.example.com/realms/smartsearch/protocol/openid-connect/token.
| Das Client secret wird in der Modul-Konfiguration verschlüsselt, wenn die FirstSpirit Verschlüsselung aktiviert ist - genauso wie das Passwort. |
- Ignorieren des SSL-Zertifikats
-
Auf Testsystemen ist an dem SmartSearch-Server häufig ein nicht gültiges SSL Zertifikat hinterlegt. Damit trotzdem getestet werden kann, ob SmartSearch Connect funktioniert kann über diese Checkbox eingestellt werden, dass das ungültige Zertifikat ignoriert wird.
Alle weiteren Konfigurationen sind projektspezifisch und somit identisch zur Konfiguration in der Cloud.
| Nach jeder Änderung an der Konfiguration wird der Service automatisch neu gestartet, damit die Änderung wirksam wird. |
2.3. Testen der Service-Konfiguration
Um die Konfiguration des Service zu testen, kann die Funktionialität der "Initialisierung" genutzt werden:
Hierzu zunächst in einem beliebigen FirstSpirit-Projekt wie im Dokument "SmartSearch Connect" beschrieben die Konfiguration der Projekt-Komponente aufrufen.
Über den sich dort befindlichen Knopf Initialize in SmartSearch! können ein Datengenerator und die PreparedSearch zu jedem Zeitpunkt erstellt werden ("Initialisierung").
Die Antwort auf diese Initialisiung kann Aufschluss über potenzielle Fehlkonfiguration des Service geben, im Fehlerfall können Informationen zum zugrundeliegenden Problem entweder im Antwortdialog der UI oder aber dem SmartSearch Log entnommen werden.
3. Rechtliche Hinweise
SmartSearch Connect ist ein Produkt der Crownpeak Technology GmbH, Dortmund, Germany.
Für die Verwendung des Modules gilt gegenüber dem Anwender nur die mit der Crownpeak Technology GmbH vereinbarte Lizenz.
Details zu möglicherweise fremden, nicht von der Crownpeak Technology GmbH hergestellten, eingesetzten Software-Produkten, deren eigenen Lizenzen und gegebenenfalls Aktualisierungsinformationen, finden Sie in der Datei THIRD-PARTY.txt, die mit dem Modul ausgeliefert wird.
4. Hilfe
Der Technical Support von Rezolve AI bietet qualifizierte technische Unterstützung zu allen Themen, die FirstSpirit™ als Produkt betreffen. Weitere Hilfe zu vielen relevanten Themen erhalten und finden Sie in auch in unserer Community.