Konfiguration
External Query Service
Copyright ©
Mindbreeze GmbH, A-4020 Linz, 2023.
Alle Rechte vorbehalten. Alle verwendeten Hard- und Softwarenamen sind Handelsnamen und/oder Marken der jeweiligen Hersteller.
Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet. Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.
Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.
Einleitung
Durch das externe QueryService Plugin hat man die Möglichkeit, sowohl lokale als auch externe Indizes zu durchstöbern Darüber hinaus hat man damit auch die Möglichkeit, externe Query Expression-/ Search Response-Transformation Services zu verwenden. Mit „Extern“ versteht man in diesem Sinne einen anderen Docker-Container.
Man hat somit ebenfalls die Möglichkeit mehrere Indizes zu verwenden, jedoch sollten Sie in diesem Fall beachten, dass Sie dazu den SearchResponseTransformationService konfigurieren müssen, der die einzelnen Ergebnisse (SearchResponses) aller Indices zusammenfasst.
Installation
Zur Installation des Plugins, öffnen Sie das Mindbreeze Management Center. Wählen Sie aus dem linken Menü den Punkt „Configuration“ aus. Anschließend navigieren Sie auf den Reiter „Plugins“. Wählen Sie im Bereich "Plugin Management" die entsprechende Datei mindbreeze.plugins.external.queryservice-<version>.tar.gz aus und laden Sie diese über die Schaltfläche "Upload" hoch. Dadurch wird der externe Query Service automatisch installiert oder gegebenenfalls aktualisiert.
Konfiguration
Um den Service zu erstellen oder zu konfigurieren, navigieren Sie dazu auf den Reiter „Indices“ und klicken Sie im Bereich „Services“ auf den „Add Service“ Button.
Wählen Sie anschließend den gewünschten Service „QueryServicePlugin.ExternalService“ aus.
Base Configuration
Bind port | Port, auf dem der Service erreichbar ist. |
Bind address | IP-Adresse oder Hostname, an den der Service gebunden wird. |
Backend Threads | Anzahl der Threads des Backend Webservers. |
Query Service Configuration
URLs of the Indices to query | Liste der Indizes (als URL angegeben), die für die Suchanfragen verwendet werden. |
URL of the QueryExprTransformationService | Optionale URL des QueryExprTranformationService, der sich auch in einem Container befinden kann, der vor dem Aufruf der Indizes aufgerufen wird. |
URL of the SearchResponseTransformationService | Optionale URL des SearchResponseTransformationService, der sich auch in einem Container befinden kann, der nach dem Aufruf der Indices aufgerufen wird. Hinweis: Bei Verwendung von mehreren Indizes, ist dieser Service erforderlich. |
Fallback OAuth Configuration
Standardmäßig wird JWT als Authentifizierungsmethode verwendet. Wenn dies jedoch noch nicht unterstützt wird, wird stattdessen auf die OAuth2 Authentifizierungsmethode zurückgegriffen.
OAuth-Token URL | Die URL, von der OAuth2-Access-Token angefordert werden können. Normalerweise: https://<server-FQDN>:8443/auth/realms/master/protocol/openid-connect/token |
OAuth Username | Der OAuth User. Normalerweise: admin |
OAuth Password | Passwort des OAuth Users. |
OAuth Client-ID | Client-ID des OAuth Users. |
Konfiguration im Client Service
Damit der Service bei der Suche verwendet werden kann, muss er im Client Service unter "Federated Query Engines" (Advanced Settings) eingetragen werden.
