Handbuch

Installation und Konfiguration von Mindbreeze InSpire

Einleitung

Dieses Dokument beschreibt die Installation und Konfiguration von Mindbreeze InSpire in einer Microsoft Windows-Systemumgebung.

Mindbreeze InSpire besteht aus:

• Der Mindbreeze InSpire Node dient dazu, an zentraler Stelle Indizes anzulegen, die von Benutzern für ihre Abfragen genutzt werden können.
• Über den Mindbreeze InSpire Management Node können die im Netzwerk verteilten Mindbreeze InSpire Nodes über eine grafische Benutzeroberfläche administriert und konfiguriert werden.

Diese Komponenten können je nach Infrastruktur auf verschiedenen Rechnern installiert werden.

In Kapitel 9 wird die Abfragesprache von Mindbreeze InSpire erklärt.

Softwarevoraussetzungen

Die Informationen in diesem Dokument beziehen sich auf eine Mindbreeze InSpire Systemumgebung und Mindbreeze InSpire 2017 Winter Release.

Voraussetzungen:

Bitte entnehmen Sie die aktuellen Softwarevoraussetzungen der Software Produkt Information

Die benötigten Installationsprogramme für die genannten Produkte werden auf der Mindbreeze InSpire ZIP/ISO Datei im Ordner Prerequisites mitgeliefert.

Konfiguration von Mindbreeze InSpire

Nach der Konfiguration und die Änderungen in einem späteren Zeitpunkt wird es empfohlen die „Apply changes and restart on save“ Option auszuwählen bevor diese Änderungen gespeichert werden. Da die Prozesse dabei neugestartet werden, sollten diese nur während der Wartungszeiten durchzuführen.  

Registerkarte Overview

Auf der Registerkarte „Overview“ wird ein Überblick über die aktuell konfigurierten Services, Nodes und Kategorieerweiterungen (Category Plugins) angezeigt.

Registerkarte „Indices“

Die Registerkarte „Indices“ dient zur Verwaltung von Index Services. Auf dieser Registerkarte werden alle bestehenden Index Services angezeigt. Diese können bearbeitet und gelöscht werden. Zusätzlich können neue Index Services erzeugt werden.

Einstellungen für ein Index Service können direkt aus einem bereits existierenden Index importiert bzw. exportiert werden.

Weitere Details stehen im Kapitel Import/Export von Einstellungen zur Verfügung

Um im Feld „Indices“ ein neues Index Service zu erzeugen, gehen Sie folgendermaßen vor:

1. Klicken Sie auf den „+ Add Index“-Button rechts außen im Kopfbereich der Liste.
2. 
3. Bearbeiten Sie die Eigenschaften des Index Service.
   Im Bereich „Setup“ stehen standardmäßig die Optionen „Display Name“, „Index Node“, „Index Path“ und „Filter Service“ zur Verfügung. Folgende Eigenschaften können über diese Felder konfiguriert werden:
4. „Display Name“: In diesem Feld kann ein Name für das Index Service konfiguriert werden.
5. „Index Node“: In diesem Feld wird der Rechner angegeben, auf dem das Index Service ausgeführt wird.
6. „Index Path“: In diesem Feld wird der Pfad zum Indexverzeichnis definiert, in dem die Dateien des Index gespeichert werden. Dieser Pfad befindet sich auf dem Rechner der mit „Index Node“ definiert wurde.
7. „Filter Service“: In diesem Kombinationslistenfeld kann ein Filter Service ausgewählt werden, das die zu indizierenden Dateien spezifiziert.
   Hinweis: Bei Bedarf können über das Kontrollkästchen Advanced settings weitere Optionen eingeblendet werden.
8. Im Bereich „Query Services“ können aus allen bestehenden Query Services jene ausgewählt werden, über die das Index Service zur Verfügung gestellt werden soll.
9. Im Bereich „Data Sources“ kann eine Datenquelle angegeben werden, die indiziert werden soll. Mehr zu diesem Thema im folgenden Unterabschnitt.
10. Klicken Sie auf die Schaltfläche „Configure“, um das zugehörige Filter Service zu konfigurieren.
    

• Sie wechseln automatisch auf die Registerkarte „Filters“. Das zu konfigurierende Filter Service wird dort im Bearbeitungsmodus geöffnet. Mehr zum Thema Filter finden Sie im Abschnitt Registerkarte „Filters“.
  Hinweis: Sie können alle Filter Services auch von der Registerkarte „Filters“ aus bearbeiten.

Um zusätzliche Einstellungsmöglichkeiten für einen Index zu erhalten, klicken Sie nun wieder auf die Registerkarte „Indices“ und klicken Sie rechts oben auf das Feld „Advanced Settings“.

Sie erhalten folgende zusätzliche Einstellungsmöglichkeiten:

• Das Feld „Disabled“ erlaubt es, diesen Index temporär zu deaktivieren.
• Das Feld „Supported TLS Protocols“ erlaubt die vom Query Service unterstützten TLS Protokolle zu konfigurieren. Hier kann eine, mit Beistrich getrennte Liste von JSSE Protokollnamen angegeben werden.
• „External URL“: sollte das Query Service hinter einem Load Balancer, der unter einem anderen Hostnamen erreichbar ist, betrieben werden, so ist hier die externe URL des Loadbalancers inklusive des Pfades (siehe „Query Service URL BASE PATH“) einzutragen.
• Der „Query Service URL Base Path“ erlaubt der Query Service URL eine andere URL als den Default Root („/“) Basispfad zu benutzen. Das wird vor allem benötigt, wenn ein Query Service hinter einem zentralen Reverse Proxy, der URL-Pfade nicht umschreiben kann, verwendet wird.
• „Data Port (TCP/IP)“: TCP-Port, der zur Kommunikation mit Subsystemen verwendet wird
• Das Feld „Stop Character Class“ dient zur Definition von Trennzeichen für die Worttrennung für diesen Index. Standardmäßig definiert sind alle in Unicode als Trennzeichen definierten Symbole. Sollten Sie diese Option nicht ausfüllen, wird ein werkseitiger Standardsatz von Stoppzeichen verwendet, welcher aus den folgenden Zeichen besteht:
  [:punct:] ¿ ¡ „ “ ‘ ” ’ « » ‹ › ‚ \pC
  „[:punct:]“ steht für ein beliebiges Satzzeichen, also: ! ' # S % & ' ( ) * + , - . / : ; < = > ? @ [ / ] ^ _ { | } ~
  Falls dieses Feld nicht leer gelassen wird, werden die hier definierten Stoppzeichen zusätzlich zu den Unicode-Trennzeichen zur Trennung von Wörtern verwendet.
  Bitte beachten Sie, dass in der Mindbreeze InSpire nach Stoppzeichen nicht gesucht werden kann.

Das Feld „Tokenizer Profile“ erlaubt die Konfiguration des Worttrennungsverfahrens durch ein Profil. Derzeit stehen zwei Profile zur Auswahl:

Profil „numeric“ (Standardeinstellung bei leerem Feld) ermöglicht die Erkennung von Zahlen.

Bei „nonnumeric“  werden Zahlen wie Zeichenketten behandelt.

• Das Feld  „Dump Requests /Responses“  erlaubt eine erweiterte Fehlersuche und loggt Anfragen und Antworten in das „mesindex-debug-dumps“ Verzeichnis unterhalb des Indexverzeichnis. Bei der Option „On Error“ werden bei jedem auftretenden Fehler automatisch Log-Dateien angelegt. Bei der vorkonfigurierten Option „Never“ werden keine Dumps erzeugt und bei „Always“ für jede Anfrage. Anmerkung: Aktivieren Sie „Always“ nicht dauerhaft im Produktionsbetrieb.
• Die „Maximum Sample Length“ gibt die maximale Länge eines indizierten Wortes in Zeichen definiert. Das bedeutet, längere Wörter werden nur bis zu dieser Anzahl von Zeichen indiziert.
• Der „Maximum Hit Count“ gibt die maximale Anzahl der intern verarbeiteten Treffer im Index für eine Suchanfrage an.
• "Approved Hits Reauthorize" gibt an ob eine Reautorisierung durch die externe Datenquelle oder den internen Token Cache zu erfolgen hat:
  • Token Cache: "Interne Autorisierung" gegen den von Mindbreeze InSpire verwendeten Token Cache um die Berechtigung des suchenden Benutzers zu verifizieren.
  • External Authorizer: Reautorisierung von potentiellen Treffern gegen die jeweilige Datenquelle um die Berechtigung des suchenden Benutzers zu verifizieren.
• "Aggregated Metadata Keys" konfiguriert jene Metadaten die für den Benutzer zur Aggregation aufbereitet werden sollen.
• Bei Aktivierung von „Unrestricted Public Access“ sind Abfragen auf diesen Index ohne Authentifizierung möglich.
• Die Option „Use SAML Authentication“ aktiviert die SAML Authentifizierung für den aktuellen Index.
• "Suppress Internal Identity Conversion" deaktiviert die Normalisierung von Benutzernamen. Hier wird unter Windows eine Konvertierung von UPN Konvention in NETBIOS Benutzernamen durchgeführt. Sollte dies nicht notwendig sein, kann diese Option deaktiviert werden.
• "Suppress Identity Conversion" keine Benutzernameänderung wird durchgeführt auch keine interne Normalisierung.
• Mit der Option „ACL Evaluation Cache“ der ACL-Evaluierungscache konfiguriert werden.
  • „Disabled“: Caching ist ausgeschaltet
  • „Enabled (Per Query)“: Caching innerhalb einer einzelnen Suche
  • „Enabled (Long Term)“: Caching über mehrere Suchen hinweg
  • „Enabled (Long Term and Collect Filter)“: Caching über mehrere Suchen hinweg, zudem werden intern verarbeitete Treffer bereits frühzeitig weggefiltert, die als unauthorisiert oder gelöscht im Cache vermerkt sind.
• Die “Use Authentication Cache” Option ist standardmäßig deaktiviert und erlaubt das Cachen von zwischenspeicherbaren Autorisierungsergebnissen innerhalb eines “Authentication Cache Flushing Intervals”.
• Die Option „Enable Security Token Authentication Cache (deprecated)” aktiviert das Zwischenspeichern von Security Token. Diese Option ist veraltet und standardmäßig deaktiviert.
• Die Zeit bei der Option „Authentication Cache Flushing Interval“ gibt die maximale Lebensdauer eines Eintrages für zwischengespeicherte Ergebnisse eines Access-Checks an.
• Mit dem Feld „SyncDelta Wait For Index Production Finished Attempts“ kann für den SyncDelta Vorgang konfiguriert werden, wie oft (im Abstand von 5s) maximal geprüft wird, ob der Index bereits fertig invertiert ist. Bei Überschreiten dieser Maximalanzahl wird der SyncDelta Versuch abgebrochen.
• Über die Felder „Term Boost Factor“ und „NGram Boost Factor“ kann die Relevanzbewertung von Terms und NGrams gesteuert werden.
• Bei Deaktivierung von „Use Term Lexicon“ wird das Term Lexicon nicht länger beim Indexaufbau und der Suche berücksichtigt. Hinweis: Sobald das Term Lexicon bei einem bestehenden Index deaktiviert wurde, muss zur vollständigen Reaktivierung der Index neu invertiert werden.
• Mit der Option „Disable Query Expansion for Diacritic Term Variants“ kann die Ausweitung der Suche auf diakritische Varianten des Suchwortes für das Query Service unterbunden werden.
• “Embedded Java VM Args” erlaubt der Java VM spezifische Werkzeuge wie zum Beispiel "Garbage Collection Control Information" in die JVM einzubinden.
• Die Zeit bei der Option “RPC Request Timeout” gibt die maximale Dauer einer internen RPC Anfrage an, bevor diese abgebrochen wird.
• Mit der Option „Document Insertion“ werden die Ersetzungsregeln für indizierte Dokumente festgelegt:
  • „Include Modification Date in Document Replacement“: Bei abweichender Änderungszeit wird das Dokument ersetzt
  • „Include Metadata CRC64 in Document Replacement“: Bei abweichender Checksumme über die Metadaten wird das Dokument ersetzt
  • „Include Content CRC64 in Document Replacement“: Bei abweichender Checksumme über den Content wird das Dokument ersetzt
• Mit der Option „Reinversion Settings“ werden die Parameter für die Neuinvertierung der bereits indizierten Dokumenten festgelegt:
  • „Reinversion Startup Delay Seconds“: verzögert die Invertierung damit alle Services z.B. Item Transformation Service Zeit haben sich am Index zu registrieren.
• Mit der Option „Index Objects Status Includes“ wird festgelegt, welche Objekte der Index dem Crawler als Gesamtmenge der indizierten Dokumente mitteilt:
  • „All Documents“: Sämtliche Dokumente
  • „Complete Documents“: Nur Dokumente mit vollständiger Referenzierung
  • „No Documents“: Keine Dokumente
• Mit der Option „Alternative Query Spelling Settings“ wird festgelegt, wann alternative Suchbegriffe vorgeschlagen werden:
  • Bei weniger Treffern als „Alternative Query Spelling Max Estimated Count“ werden alternative Suchbegriffe vorgeschlagen.
  • „Force Alternative Query Spelling Max Estimated Count“ verhindert es, dass das „Alternative Query Spelling Max Estimated Count“ mit den erweiterten Optionen in der Suchanfrage vom Client Service überschrieben wird.
• Mit der Option „Query Transformation Service Plugin Processing Timeout (ms)” kann für Query Transformation Services ein zeitliches Limit für Transformationen gesetzt werden. Standardmäßig ist das Limit auf 200ms gesetzt, d.h. bei einer Suche wird auf jede Transformation maximal diese Zeit gewartet. Benötigt eine Transformation länger als das Timeout, dann wird diese Transformation übersprungen. Das Timeout gilt für alle Query Transformation Plugins pro Transformation. Ein Wert kleiner oder gleich 0ms bedeutet, dass kein Limit konfiguriert ist.

Query Performance Einstellungen

Die Einstellungen in diesem Abschnitt dienen zur Verbesserung der Query Performance:

• Enable Filter Deleted DocIds: Ist diese Option aktiv, so werden gelöschte Dokumente früher ausgeschlossen.
• Enable Precomputed ACLs: Mit dieser Option werden Dokumente früher ausgeschlossen für die der abfragende Benutzer keine Berechtigungen hat. Dies ist nur dann möglich wenn keine ACL-Referenzen verwendet werden. Mögliche Werte:
  • Disabled: Die Optimierung wird nicht durchgeführt.
  • Enabled (SearchRequest): Die Optimierung wird nur durchgeführt, wenn dies in der Query angefordert wurde.
  • Force: Die Optimierung wird immer durchgeführt.
• Number of ACL Precomputation Threads: Diese Einstellung legt fest, wieviele Threads für diese Optimierung verwendet werden. Ist das Feld leer, so wird der Wert der Einstellung “Query Threads per Index” verwendet.
• Use ACL Document Filter if Authorized Ratio is Less Than: Die Precompute ACL Optimierung wird nur angewendet, wenn in einem Index weniger als dieser Prozentwert (0.0-1.0) für den abfragenden Benutzer via ACL autorisiert sind.
• Reject Empty ACLs: Dokumente mit leeren ACLs werden als abgelehnt bei der ACL Vorberechnung.
• Content Position Sampling Optimization: Mit dieser Option wird ein optimierter Algorithmus für das Sampletexting verwendet.

Einstellungen zu Aggregationen

• Aggregated Metadata Keys Without Timeout (; separated): Für diese Metadata Keys wird die Aggregation nicht abgebrochen.
• Aggregation Count Limit: Die Aggregierung wird abgebrochen sobald die hier konfigurierte Anzahl an eindeutigen Werden erreicht wurde.
• Collected Aggregation Results Limit: Die Aggregierung wird hier nach erreichen der hier konfigurierten Anzahl nicht abgebrochen, jedoch nur maximal soviele Resultate zurückgegeben.

Kompaktifizierung des Index

Werden häufig Dokumente zu einem Index hinzugefügt bzw. entfernt, so kann die Performance auf Dauer darunter leider. Deshalb können Index Buckets mit bereits gelöschten Dokumenten entfernt werden. Die noch vorhandenen Dokumente werden in ein neues Bucket verschoben.

Automatische Kompaktifizierung

Folgende Optionen sind hier verfügbar:

„Enable Periodic Delete Buckets“: Aktiviert das automatische Kompatifizieren.

„Periodic Delete Buckets Cron Expr“: Legt den Zeitplan (als Cron-Ausdruck) für die automatische Kompaktifizierung fest. Der Wert „0 0 0 * * *“ bedeutet zum Beispiel einen Durchlauf jeden Tag um Mitternacht.

„Periodic Delete Buckets Max Duration“: Der Kompaktifizierungslauf wird nach der angegebenen Anzahl von Minuten abgebrochen. Beim nächsten Durchlauf wird an dieser Stelle fortgesetzt.

„Periodic Delete Bucket if Deleted $xo“: Es werden nur jene Buckets für das Kompaktifizieren herangezogen deren Anzahl an gelöschten Dokumenten diesen Prozentsatz übersteigt.

„Permanent Delete Buckets“: Wird diese Einstellung deaktiviert, so werden Buckets nicht komplett gelöscht, sondern nur in Sicherungsordner verschoben.

Manuelle Kompaktifizierung

Es ist ebenfalls möglich die Kompaktifizierungs-Tasks auf der Kommandozeile zu starten. Dazu ist das „mescontrol“-Interface verfügbar.

„bucketsinfo”: Gibt den aktuellen Füllstand der Buckets aus.

„listtasks“: Gibt alle aktuell laufenden Tasks aus.

„taskcancel <taskid>“: Bricht den angegebenen Task ab

„taskwait <taskid>“:  Der Befehl wartet bis der angegebene Task abgschlossen wurde

„taskstatus <taskid>“: Gibt den aktuellen Status den angegebenen Tasks aus.

„deletebuckets  [--sync] [--min-percent-deleted-docs=<0..1>] [<bucketid_1>… <bucketed_n>] [--log-unreferenced-unfiltered-documents] [--cleanup-unreferenced-unfiltered-documents]: Löscht die angegebenen Buckets und verschiebt die verbliebenen Dokumente in neue Buckets.

„--sync”: Der Befehl wird erst abgeschlossen wen auch der Task abgeschlossen ist.

„—min-percent-deleted-docs“: mit diesem Parameter wird angegeben ab welchen Prozentsatz an gelöschten Dokumenten die Buckets gelöscht werden sollen.

„bucketid.“: Gibt die IDs jener Buckets an die gelöscht werden sollen.

„--log-unreferenced-unfiltered-documents“: Wenn es Dokumente gibt, für die Metafiles generiert werden, wie z.B. Thumbnails für PDFs, aber das Dokument ohne diese Metafiles gelöscht wurde, werden für diese Dateien Logs geschrieben.

„--cleanup-unreferenced-unfiltered-documents“: Wenn es Dokumente gibt, für die Metafiles generiert werden, wie z.B. Thumbnails für PDFs, aber das Dokument ohne diese Metafiles gelöscht wurde, werden diese Dateien gelöscht. In Kombination mit „--log-unreferenced-unfiltered-documents“ werden die Logs geschrieben und gleichzeitig gelöscht.

Netzwerk Eigenschaften

Man kann unter Netzwerk-Eigenschaften auswählen ob man das HTTP keep-alive für Item-Transformationen verwendet. Dadurch wird die Anzahl von offenen Verbindungen zu den statischen Resourcen vermindert, bzw. die Verbindungen werden wiederverwendet. Dieses Feature ist per Default deaktiviert.

Item Transformation Service Plugin Timeout: Item Transformation Requests werden nach diesem Timeout abgebrochen und das Dokument ohne diese Transformation invertiert.

Entity Recognition Parameter

• Diese Parameter erlauben das extrahieren von bestimmten Metadaten aus dem Inhalt von den Dokumenten.
• “Pattern Rules” definiert eine Menge von Regeln - getrennt durch Zeilenumbruch, die beim Extrahieren von Metadaten angewendet werden.
• “Metadata Definition” definiert die Eigenschaften einzelne Metadaten.
• “Add if Rule Matches”  ist die Regel, die der Bereich definiert, wo das Metadatum sich befindet.
• “Metadata Name” ist der Name des Metadatums.
• “Metadata Value”  ist die Regel, die der Wert des Metadatums feststellt.
• “Scope”  ist die Regel, die die Stelle innerhalb des gemachten Bereichs definiert.
• “Format” erlaubt es von extrahierten Zeichenketten typisierten Metadaten wie z.B. Datum zu generieren.
• “Format Options” weitere Format Optionen.
• “Locale” Gebietsschema.
• “In Existing Metadata” definiert es auf welche Metadaten die Regeln angewendet werden sollen.

Beispiel:

“Pattern Rules” :

Day   = /(?:0?[1-9]|[12]\d|[3][0-1])/

Month = /(?:0?[1-9]|1[0-2])/

Year  = /(?:19|20)\d\d/

Date = Year "-" Month "-" Day

ChangedDateInText = "last changed:" /\s+/ Date /\(?:$|[^\d])/

“Add if Rule Matches” :

ChangedDateInText

“Metadata Name” :

ModificationYear

“Metadata Value” :

{{Year}}

“Scope” :

Date

Falls Query Transformation Plugins installiert sind  wird im „Advanced Settings“ Mode folgender Abschnitt der Index Service Konfigurationsoberfläche hinzugefügt:

Benützen Sie die Drop-Down Box um verfügbare Query Transformation Plugins auszuwählen. Verwenden Sie die Add Schaltfläche, um das Plugin für das aktuelle Index Service zu aktivieren. Die bereits aktivierten Plugins werden darüber dargestellt. Durch Bestätigen der „Expandieren“ Schaltfläche eines aktiven Plugins wird ein Abschnitt mit den Plugin Properties angezeigt. Hier haben Sie die Möglichkeit Properties in Form von Schlüssel – Wert Paaren für das aktuelle Plugin zu definieren. Mit der entsprechenden „delete“ Schaltfläche können Sie diese benutzerspezifischen Plugin Properties wieder löschen.

Ein Klick auf eine weitere „delete“ Schaltfläche rechts neben dem Pluginnamen entfernt das ganze Plugin mitsamt aller benutzerspezifischen Properties, sodass dieses nicht mehr vom aktuellen Index Service verwendet wird.

Globale Konfiguration von Query und Item Transformation Plugins

Im „Global Index Settings“ Bereich kann man die bereits installierten Query und Item Transformation Plugins für alle Indices global konfigurieren. Diese Plugins werden auch für einen neuen hinzugefügten Index automatisch übernommen Die globale Konfiguration gilt nur für die Indices für die keine Plugins konfiguriert sind bzw. kein Plugin das per Default aktiv ist entfernt worden ist.

Reperatur von Referenzen

Mittels “repairreferences“ ist es möglich Referenzen zu korrigieren, die auf inkorrekte uniformitemids verweisen. Werden dabei Korrekturen vorgenommen wird automatisch ein Reinvertierung der DocumentInfo durchgeführt.

Die Reperatur erfolgt in folgenden Schritten:

1. Scannen aller Dokumente im index um sicherzustellen, dass die DocIDs eindeutig sind
2. Reperatur der Dokumenteinträge im Reference Index.
3. Reperatur der Referenzen in allen Dokumenten

Anwendung:

Die Reperatur wird mit dem mescontrol Kommandozeilen-Tool “repairreferences” gestartet. Dabei ist es notwendig, dass die Option “Disable Unrestricted Privileged Servlets” deaktiviert ist.

mescontrol http://<INDEXHOST>:<INDEXPORT> repairreferences [--bulk-update-size=0] [--skip-uniformitemid-check] [--dry-run] [<docid> ... <docid>]

Optionale Parameter:

--bulk-update-size: Die Anzahl an Updates die innerhalb einer Transaktion durchgeführt werden. Überschreibt die Indexoption “References Repair Bulk Update Size”. Standardwert: 100

--skip-uniformitemid-check: Schritt 1 wird übersprungen.

--dry-run: Am Ende von Schritt 3 werden die Dokumente nicht aktualisiert

docid ... docid: Liste von Dokumenten die repariert werden sollen

Index Backups freischalten

Das Freischalten von Index Backups erfolgt im “Global Index Settings” Bereich unterhalb des Service Konfiguration Bereichs im “Indices” mittels der Option „Enable Index Backups“.

Im Feld „Allowed Backup Path Pattern (Regex)“ wird ein Regulärer Ausdruck angegeben, mit dem beschränkt wird, welche Verzeichnisse als Zielpfade eines Backup-Vorganges erlaubt sind.
Backslashes zur Pfadtrennung müssen dabei escaped werden: \\

Ein Backup kann mit dem Kommandozeilen-Tool mescontrol gestartet werden:
    mescontrol http://<INDEXHOST>:<INDEXPORT> backup <BACKUPZIELPFAD>

Ebenso kann ein laufendes Backup auf Bedarf abgebrochen werden:
    mescontrol http://<INDEXHOST>:<INDEXPORT> stopbackup

Support Mode Aktivieren

Das Aktivieren der “Advanced Settings” Checkbox zeigt auch den “Support Mode” Bereich unterhalb des Service Konfiguration Bereichs im “Indices”, “Filter”, wie auch im “Client Services” Tab. Support Mode zeichnet detaillierte Informationen über die verschiedenen Services in Logdateien auf, die im Standardfall im temporären Verzeichnis des Mindbreeze Service Benutzers unter Windows und im /var/opt/mindbreeze/log Verzeichnis unter Linux Plattformen gespeichert werden. Vom Standard abweichende Logverzeichnisse können in dem Abschnitt „Log Location“ eingestellt werden.

Hinweis: Deaktivieren sie den Support Mode im “normalen” Gebrauch, um die Performanz nicht unnötig zu verschlechtern.

Um die Änderungen zu speichern drücken sie “Save”.

Sub Query Expression

Sub Query Expression ermöglicht es Referenzen von Daten für die Suche auszuwerten. So kann z.B. aus einem Ordner alle Dateien gesucht werden, oder auch umgekehrt, der Ordner in dem sich eine Datei befindet. Dies kann auf alle Metadata Keys angewandt werden, die auf ein anderes Dokument zeigen. Die Invertierte Richtung kann auch genutzt werden, wenn die Metadata Keys in Inverted Reference Metadata Keys eingetragen sind.

Enable Sub Query Expression Evaluation aktiviert das Feature.

Sub Query Expressions maximum recursion depth/level bestimmt die Rekursion Tiefe einer Sub Query suche. Da Sub Queries in einander verschachtelt werden können, aber die Laufzeit sehr viel kostet, ermöglicht dies die Komplexität einzuschränken.

Sub Query Expressions maximum total evaluations bestimmt die maximale Anzahl von Sub Queries, die in einer Suche enthalten sind. Dies unterscheidet sich zu Tiefe, da eine suche von parallelen Sub Queries durch die Tiefe nicht eingegrenzt werden kann.

Tokenizer Configuration

Die Optionen in „Tokenizer Configuration“ dienen der Anpassung der Suchtreffer für Wortteile.

Die Option “NGrams for Non-Whitespace Separated Tokens Zone Pattern“ definiert den Regulären Ausdruck (RegEx) für die Metadaten für die Non-Whitespace Separated N-Gramme erzeugt werden. Wenn dieses Feld leer gelassen wird, ist das Feature deaktiviert.

Anmerkung: Änderung werden erst nach einer Reindexierung des Index aktiv!
Anmerkung: Metadatum “title” wird als Infix verarbeitet. Jedes andere Metadatum wir nur als Prefix verarbeitet. Sollte nicht für content aktiviert warden.

Beispiele: (Liste der Suchbegriff ist unvollständig)

Dokument title: Hans-Peter, RegEx: title
Suchbegriffe mit dem das Dokument gefunden wird (erfolgreiche Suche): Hans-Peter, Hans-Pet, Hans, Hans-Pe, ans-Peter, ns-Pete, Peter

Datenquellen

Zur Erstellung von Datenquellen für einen Index klicken Sie im Abschnitt „Data Sources“ ganz unten auf eines der Symbole rechts in der Kopfzeile.

Zu jedem Index können Sie beliebig viele Datenquellen zuordnen.

Drittanbieter-Datenquellen

Eine Drittanbieter-Datenquelle ermöglicht Ihnen von einem Dritthersteller integrierte Daten auch vom Mindbreeze InSpire Client durchsuchbar zu machen.

Solche Konnektoren können im Mindbreeze Management Center installiert werden (siehe auch Konfiguration – Plugin Installation).

Zur Erstellung einer Drittanbieter-Datenquelle gehen Sie wie folgt vor:

1. Klicken Sie auf das Symbol , es erscheint die Konfigurationsmaske für eine Drittanbieter-Datenquelle
2. Geben Sie im Feld „Source name“ einen beliebigen Namen für diese Datenquelle ein
3. Wählen Sie im Feld „Category“ die registrierte Datenkategorie, die der einzustellenden Datenquelle entspricht.

Um die durchgeführten Änderungen dauerhaft zu speichern, drücken Sie den „Save“ Knopf rechts oben.

Wie Sie eine neue Datenkategorie in Mindbreeze InSpire registrieren können und wie Ihre Indizierung zu konfigurieren ist, erfahren Sie aus der Dokumentation der jeweiligen Dritthersteller-Mindbreeze-Connector.

Crawler-Zeitplanung

Für jede Datenquelle ist es möglich, einen Zeitraum zu definieren, in dem diese aktiv ihre Daten für die Suche aufbereitet. Dafür müssen Sie „Advanced Settings“ aktiviert haben. Danach sehen Sie unterhalb der Standard Konfigurationsfelder unter anderem ein neues Feld „Crawler Schedule“.

Dieses Feld zeigt, welche Zeiträume bereits definiert sind. Um einen neuen Zeitraum hinzuzufügen, benutzen sie die Schaltfläche „Add“. Um einen bestehenden Zeitraum zu modifzieren, seleketieren Sie ihn bitte in der Liste und benutzen dann bitte die Schaltfläche "Edit". Einen bestehend Zeitraum löschen können Sie mit der Schaltfläche "Remove" entfernen.

Nun öffnet sich darunter eine neue Eingabefläche.

Hier können sie nun die Startzeit und die Endzeit des Vorgangs festlegen. Diese müssen im Format hh:mm eingegeben werden. Weiters können Sie bestimmen, an welchen Tagen diese Aufgabe gestartet werden soll. Wenn Sie Every Day auswählen, wird der Vorgang an jedem Tag ausgeführt, ansonsten nur an den von Ihnen bestimmten Wochentagen. Mit der Schaltfläche „Cancel“ verwerfen Sie ihre Einstellungen. Drücken Sie „Apply“, um den Zeitraum zu übernehmen. Danach sollte dieser Zeitraum im Feld „Crawler Schedule“ angezeigt werden.

Um alle Änderungen endgültig abzuspeichern, müssen Sie noch die Schaltfläche „Save“ am Kopf der Seite betätigen.

Extension Point Properties und Environment Variables

Für jede Datenquelle können “Extension Point Properties“ und „Extension Point Environment Variables“ definiert werden. Diese Einstellungen sind für Sie nicht relevant und dienen nur zur internen Verwendung.

Anpassen des Category Descriptors

Die Category Descriptor beschreibt die Anzeigeoptionen und die Filterinformation einer Datenquelle und ist ein XML Dokument, das im Plugin abgelegt ist (typischerweise categoryDescriptor.xml, der Name ist via plugins.xml referenziert). Die Wurzel bildet das „category“ Element.

<?xml version="1.0" encoding="UTF-8"?>

<category id="Category" supportsPublic="false" keep-docinfo-metadata="false">

  <name>Category</name>

</category>

Attribute auf dem „category“ Element sind:

supportsPublic definiert, ob die Datenquelle in einem öffentlichen Index konfiguriert werden darf. Der Standardwert ist false.

keep-docinfo-metadata definiert, ob Metadaten die aggregatable oder regexmatchable Attribute aufweisen durch einen aktualisierten Descriptor bestehen bleiben oder überschrieben werden. Der Standardwert ist false

Hinzufügen von eigenen Metadaten Spalten

Eine Metadaten-Definition könnte folgendermaßen aussehen:

  <metadata>

    <metadatum aggregatable="true" id="current_state" visible="true">
      <name xml:lang="en">Ticket State</name>
      <name xml:lang="de">Ticket Status</name>
    </metadatum>

  </metadata>

Folgende Attribute können auf dem metadatum Element definiert werden und dienen der Steuerung des Metadatums im Index:

aggregatable: wenn diese Option auf true gesetzt ist, wird die Spalte als Filter verfügbar sein (soll nur für Properties definiert werden, bei denen die Werte eine Gruppierung der Ergebnisse zulassen – bei einzigartigen Werten, die also im Suchergebnis jeweils nur einmal vorkommen können, macht aggregatable keinen Sinn).

regexmatchable definiert, ob die Suche nach diesen Metadaten mit einer Regular Expression durchgeführt werden kann.

visible definiert, ob die Spalte in der standardmäßigen Ergebnispräsentation angezeigt wird.

Ersetzen der Treffersymbole

Das kleine Icon in der Datenquelle-Liste beim Suchclient wird von der Datei „categoryIcon.png” im ZIP-Archiv vom Datenquelle Plugin bestimmt. Sie können das Icon mit einem 16x16 Icon Ihrer Wahl ersetzen.

Sie können ein Icon auch direkt im categoryDescriptor.xml mit dem Icon-Tag definieren. Es benötigt eine eindeutige id, Größenattribute (height und width) und das Bild selbst (value), codiert als Base64-Wert.

<context>

<Icon alt="Ticket" height="16" width="16"

    id="tag:mindbreeze.com,2007/contextitems/contexticon;ticket"

            mimetype="image/png"

            type="tag:mindbreeze.com,2007/contextitems/contexticon"

            value="

iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH3wIXECgw/xAFagAAAS1JREFUOMvFkz1uwkAUhL/nNV4Zesw9wgUILYq4gymCgCiRIG3gCkAOEnMFTgMNFT8W65cCpOAIAqmY8knzaTQ7C/eWvA8Gpd1uN3HOPQFyo0+NMYm1tkcrjmuzJNH/apYk2orjmu+c88tRxHq91tVqJSJ/hBBhu9kQRZGWo0icc74PoFmGqspkPMZae9G/3W55brdJ01Q0ywA4AIAgCPgYDi+agyAAYL/fIyLo8e4fKlEKhQKf0+nZBM45ur1eDoTqCeCo17e36/WrctpTDtDtdAjD8KzROUej0eCxXs/dc4DhaJSjh2FIsVi8nkA8D0Dn87kU/B9mpVLhoVr99ZICoOJ5AuAbY/bLxQJAms3mzQteLhYYY5wM+v1SmqbT45S5ecqe9xVY+3L3z8g3o1Sele9r3SQAAAAASUVORK5CYII= " />

</context>

Hinzufügen von benutzerdefinierten Trefferaktionen

Es ist möglich, benutzerdefinierte Aktionen, die auf spezifischen Metadaten basieren, hinzuzufügen. Z. B. um ein Ticket-Suchresultat in einer benutzerdefinierten Ticket Webanwendung zu öffnen.

<context>

<Menu>

<Action name="Open" pattern="http://intranet.mycompany.com/ticketing/show.html?ticketid={{mes:key}}">

  <name xml:lang="en">Open Ticket</name>

  <name xml:lang="de">Ticket Öffnen</name>

</Action>

</Menu>

</context>

Damit die Änderungen wirksam werden, können Sie das Plugin ZIP-Archiv mit dem modifizierte categoryDescriptor.xml über die Mindbreeze Konfigurationsoberfläche hochladen.

Anmerkung: es wird empfohlen, modifizierte Plugins mit einem eigenen Namen umzubenennen, um Änderungen in Produktupdates besser erkennen zu können.

app.telmetry Konfiguration für Crawl Runs

Die Crawl Run Informationen können in einen separaten LogPool abgelegt werden.

Dazu müssen die Fabasoft app.telemetry Log Definitionen für die Mindbreeze Services von der Mindbreeze Konfigurationsoberfläche heruntergeladen werden. Wählen Sie dazu den „Overview“ Karteireiter aus und klicken Sie auf dem Link „Fabasoft app.telemetry log definitions and Dashboards“.

Legen sie danach einen neuen Logpool mit folgenden Einstellungen an:

Application: Mindbreeze

Application ID: *

Application Tier: Crawler Service Run

Tier ID: *

Im Tab “Log Definition Columns” muss noch die xml Datei: apptelemetrylogdefinitions_crawlerservicerun.xml aus den Logdefinitionsarchiv hochgeladen werden.

Registerkarte „Filters“

Auf der Registerkarte „Filters“ können alle Filter Services verwaltet werden. Im Feld Filter Services werden die vorhandenen Filter Services angezeigt. Das Plus-Symbol rechts außen im Kopfbereich der Liste dient zum Hinzufügen weiterer Filter Services.

Um im Feld Filters ein neues Filter Service zu erzeugen, gehen Sie folgendermaßen vor:

1. Klicken Sie auf das Plus-Symbol rechts außen im Kopfbereich der Liste ().
2. Bearbeiten Sie die Eigenschaften des Filter Service.
3. Im Feld „Setup“ steht standardmäßig das Feld „Display Name“ zur Verfügung. In diesem Feld kann ein Name für das Filter Service definiert werden.
4. Im Feld „Node“ können jene Server ausgewählt werden, auf denen das Filter Service ausgeführt werden soll.

Um ein Filter Service anzupassen, gehen Sie folgendermaßen vor:

1. Markieren Sie das Kontrollkästchen „Advanced settings“, um alle Dateierweiterungen anzuzeigen, die vom Filter Service nach Informationen durchsucht werden soll. Verfügbare Microsoft IFilter werden ebenso angezeigt wie die Filter, die von Mindbreeze InSpire bereitgestellt werden.
2. 
   
3. Falls der Java Filter mehr Speicher bei der Ausführung benötigt, erhöhen Sie den Wert der Option „Embedded Java VM Maximum Heap Size“.
4. Zur Analyse von Fehlern und Problemen mit den Filtern aktivieren Sie „Dump Requests/Responses“ und wählen ein Verzeichnis zur Ablage der „Dumps“ aus.
5. Standardmäßig können nur Dokumente die kleiner als 50 MB sind gefiltert werden. Um größere Dokumente zu filtern, erhöhen Sie den Wert „Maximal Input Size (MB)“.
6. Um das Filtern von Zips oder PST-Files zu beschleunigen erhöhen Sie den Wert „Maximum Threads per Filter Request“ um mehr Parallelität zu erlangen.
7. Bestimmen Sie die „Maximum Filter Recursion Depth“ um die Anzahl extrahierter Objekte aus ineinander verschachtelten Containerobjekten wie ZIPs zu steuern.
8. Definieren Sie eine Regular Expression für die Option „Filter Pass Through Regular Expression“ um ausgewählte Extensions ohne Filter direkt an den Index zu schicken.
9. Geben Sie im Feld „Probe Filters Matching Extension Regex“ die Datei-Endungen – in der Form von Regular Expression -  ein, für die alle Filter-Plugins ausprobiert werden sollen, wenn ein Fehler passiert.
10. Um die Metadaten von der Datenquelle beim Filtern nicht zu überschreiben, Wählen sie „Keep Datasource Metadata“ von „Metadata Merge Strategy“ Dropdown Box.
11. Bearbeiten Sie die „Filter Plugins“ analog der gewünschten Konfiguration. Abhängig von der Dateiendung werden Dokumente unterschiedlich vom Filter Service behandelt, hier kann angepasst werden, ob und von welchem Filter Plugin ein bestimmter Dateityp behandelt werden soll.
12. Im Feld „Generate CRC64 of Metadata“  kann eingestellt werden, ob eine CRC64 der gefilterten Metadaten generiert werden soll. Ist CRC unterschiedlich, wird ein Dokument im Index gegebenenfalls ersetzt. Weiters gibt es zusätzlich noch die Möglichkeit über Regular Expression Rules einzelne Metadaten der Crawler zur Berechnung des CRC hinzuzufügen oder auszunehmen. Die Standardkonfiguration sieht vor das alle Metadaten der Crawler zur Berechnung des Metadata CRC herangezogen werden.
13. Aktivieren Sie “Ignore Heartbeat Error” falls das Filter Service nicht neugestartet werden soll wenn es keine Heartbeats an Node schickt. Das kann bei stark ausgelastetem System der Fall sein.

Metadata CRC:

• Wenn die Option „Generate CRC64 of Metadata“ aktiviert ist, wird der metadatacrc zusätzlich verwendet um zu prüfen, ob ein Item im Index ersetzt werden soll.
• In den weiteren Optionen kann eine „Regular Expression“ angegeben werden um Metadaten im CRC zu inkludieren oder zu exkludieren.

Indizieren zusätzlicher PDF Metadaten

Aus PDF Dokumenten werden falls verfügbar die folgenden Metadaten extrahiert:

• document:title
• document:Author
• document:Subject
• document:Keywords
• document:Creator
• document:Producer
• document:CreationDate
• document:LastModified
• document:Trapped

Um zusätzliche PDF Metadaten zu extrahieren gehen, fügen Sie beim Filter unter „Global Filter Plugin Properties“ das Plugin „FilterPlugin.PDFPreviewFPDFFilter“ hinzu und konfigurieren Sie die Eigenschaft „PDF Meta Keys“, getrennt mit Strichpunkt, siehe unten:

HTML Meta Tags als Metadaten speichern

Die HTML Filter Plugins Jericho und JerichoWithThumbnails extrahieren die HTML Meta Tags als Metadatumswerte. Wenn diese HTML Meta Tags mehrfach vorkommen (mit demselben Namen und Wert), ist es möglich diese nur einmal als Metadatumwert speichern.

Fügen Sie dafür beim Filter unter „Global Filter Plugin Properties“ das Plugin „FilterPlugin.JerichoWithThumbnails“ oder „FilterPlugin.Jericho“ (wenn keine HTML Thumbnail Generierung verwendet ist) hinzu und aktivieren Sie die Eigenschaft „Store only distinct HTML meta tag values as metadata“.

Wenn hier ein Regulärer Ausdruck als „Parsable HTML meta tag pattern“ definiert ist, werden nur Meta Tags mit passenden „name“ oder „http-equiv“ Attributen als Metadaten gespeichert.

Falls Post Filter Transformation Plugins installiert sind (z.B.: SignatureToKeyRewriter) wird folgender zusätzlicher Abschnitt angezeigt:

Verwenden Sie die Drop-Down Box, um ein verfügbares Post Filter Transformation Plugin auszuwählen. Aktivieren Sie ein ausgewähltes Plugin indem Sie auf die „Add“ Schaltfläche daneben klicken.

Aktivierte Plugins werden im Bereich über der „Add“ Schaltfläche aufgelistet. Durch Bestätigen der „Expandieren“ Schaltfläche eines aktiven Plugins wird ein Abschnitt mit den Plugin Properties angezeigt. Hier haben Sie die Möglichkeit Properties in Form von Schlüssel – Wert Paaren für das aktuelle Plugin zu definieren. Mit der entsprechenden „delete“ Schaltfläche können Sie diese benutzerspezifischen Plugin Properties wieder löschen.

Ein Klick auf eine weitere „delete“ Schaltfläche rechts neben dem Pluginnamen entfernt das ganze Plugin mitsamt aller benutzerspezifischen Properties, sodass dieses nicht mehr vom aktuellen Filtern Service verwendet wird.

1. Um Ihre Angaben zu übernehmen, klicken Sie auf die Schaltfläche „Save“. Änderungen der Konfiguration werden den betroffenen Nodes mitgeteilt und übernommen.
2. Wechseln Sie auf die Registerkarte „Overview“, um eine Übersicht über die Zuordnung von Services zu Servernodes angezeigt zu bekommen.

Gleich wie bei der Registerkarte „Indices“ gibt es auch auf der Registerkarte „Filters“ die Möglichkeit den Support-Modus einzuschalten.

Destination rewrite

“Destination Pattern” ist eine regulärer Ausdruck (regex) der auf Destinations in Index-Requests angewendet wird z.B.:

https?://domain\.example\.com:(\d*)(/.*)?

Die Destination wird mit “Destination Replacement” ersetzt. Es können Optional Backreferences auf Capture-Groups in “Destination Pattern” verwendet werden z.B.:

http://localhost:\2/\1

Registerkarte „Client Sevices“

Auf der Registerkarte „Client Services“ werden alle Client Services verwaltet. Ein Client Service stellt die serverseitige Unterstützung für den Mindbreeze InSpire Web Client zur Verfügung. Im Feld „Web Client Services“ werden die vorhandenen Web-Client-Services angezeigt.

Über einen Klick auf das Plus-Symbol () rechts außen im Kopfbereich der Liste können weitere hinzugefügt werden.

Um ein neues Web Client Service zu erstellen, gehen Sie folgendermaßen vor:

Klicken Sie auf das Plus-Symbol rechts außen im Kopfbereich der Liste ().

Folgende Optionen stehen zur Verfügung:

• „Disabled“: Erlaubt es das Client Service temporär zu deaktivieren.
• „Display Name“: In diesem Feld wird der Name für das Client Service definiert.
• „Node“: In diesem Feld wird der Rechner angegeben, auf dem das Client Service ausgeführt wird.
• „Port (HTTPS)“: In diesem Feld wird konfiguriert, unter welchem TCP-Port das Service erreichbar gemacht wird. Dieser Port steht dann in der Adresse vom Web Client, z.B. http://myserver.mycompany.com:23350/
• „Bind Address (HTTPS)“: Hier wird konfiguriert, auf welcher IP-Adresse das Service erreichbar ist. Standardmäßig (Wert nicht gesetzt) wird die IP-Adresse 0.0.0.0 (alle IP-Adressen) verwendet. Wenn beispielsweise der Service nur auf localhost erreichbar sein soll, muss die Option „Bind Address (HTTPS)“ auf den Wert 127.0.0.1 gesetzt werden.
• „Data Port (TCP/IP)“: TCP-Port, der zur Kommunikation mit Subsystemen verwendet wird
• „Query Metrics Port(TCP/IP)“: Mit diesem Port kann das Aufzeichnen von Query Statistiken eingeschaltet werden. Wird dieser Port nicht konfiguriert gibt es keine Aufzeichnungen.
• „Requires Authentication“: Dieses Feld definiert, ob das Client Service seine Ressourcen öffentlich anbietet, oder nur für die lokalen Benutzer. Sollen die Daten öffentlich verfügbar gemacht werden, so müssen die Indizes auch entsprechend markiert sein („Advanced Settings“, „Unrestricted Public Access“).
• „Suppress Termination Cause“: Bei Aktivierung der Option wird dem Benutzer keine Information angezeigt, falls bei einer Suche ein Timeout auftritt.
• „Display Tabs for Data Sources“: Ist diese Option aktiviert, werden für alle aktivierten Datenquellen Karteireiter angezeigt.
• „Enable Tab Editing“: Ist diese Option aktiviert, können die Karteireiter editiert werden.
• „Load More Results Using“: Ist Infinite Scrolling aktiv, werden in der Standardsuchanwendung weitere Resultate automatisch geladen, wenn man ans Ende der Seite kommt. Mit Pages aktiviert man das seitenweise Blättern. Die Anzahl der maximal sichtbaren Seiten wird mit Maximum Number of Displayed Pages eingestellt.

• „URL of Help-Website“: Hier kann eine URL zu einer Hilfeseite hinterlegt werden, die im Client Service als Link zur Verfügung steht.
• „Fabasoft app.telemetry Web API URL“: Tragen Sie hier die URL zur app.telemetry Web API ein, um End-To-End Software-Instrumentierung einzuschalten.
• Zur Analyse von Fehlern und Problemen aktivieren Sie „Dump Requests“ und wählen ein Verzeichnis zur Ablage der „Dumps“ unter „Dump Directory“ aus.
• „One Phase Search and Enrich“: Ist diese Option aktiviert, werden Suche und Kontextualisierung der Resultate in einer Anfrage, statt der üblichen zwei, durchgeführt. Aktivieren Sie diese Option, falls vom Client Service nur wenige Query Engines verwendet werden.
• „Logout Redirect URL“: Meldet sich ein Benutzer vom Client Service ab, erfolgt eine Weiterleitung zur konfigurierten URL. Wird kein Wert angegeben, erfolgt eine Weiterleitung zur Startseite des Client Service.
• „User ID is E-Mail Address”: Falls der angezeigte Benutzername eine gültige E-Mail Adresse ist, kann damit festgelegt werden, dass die E-Mail Adresse im Feedback Dialog automatisch befüllt wird.
• „Disable Autocompletion of Query“: Deaktiviert die Autovervollständigung des Suchbegriffs.
• „Mandatory Data Source Search In Constraints Resolution”: Führt dazu, dass für alle Datenquellen die Search In Constraints berechnet werden. Kann im Category Descriptor je Datenquelle gesetzt werden.
• „Query Expansion for Diacritic Term Variants“: Ist diese Option aktiviert, wird die Suche auf diakritischen Varianten des Suchwortes ausgeweitet.
• „Use SSL (HTTPS)“: Diese Option legt fest, ob das Client Service SSL verwendet. Ist „Use SSL“ aktiviert, ist das Client Service im Browser unter https:// verfügbar, sonst unter http://. Die Einstellung „Port“ wird weiterhin berücksichtigt. Anmerkung: Diese Option ist sicherheitskritisch. Ist diese Option deaktiviert, ist die Übertragung der Daten zwischen Browser und Client Service nicht verschlüsselt.
• „Supported TLS Protocols“: Diese Option erlaubt die vom Client Service unterstützten TLS Protokolle zu konfigurieren. Hier kann eine, mit Beistrich getrennte Liste von JSSE Protokollnamen angegeben werden. Die Dokumentation von JSSE finden Sie unter: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html
• „SSL Certificate“: Dieses Feld erlaubt die Auswahl des vom Client Service verwendeten SSL-Zertifikats. Als Standardeinstellung wird das in der Lizenz enthaltene Zertifikat verwendet („Use SSL Certificate supplied with your license“). Wurden in der Registerkarte „Certificates“ SSL-Zertifikate installiert, werden diese zur Auswahl angeboten.
• „Use SAML Authentication“: Legt fest, ob SAML-Authentifizierung für das Client Service verwendet wird.
• „External URL“: ist das Client Service hinter einem Proxy erreichbar, muss hier die URL eingetragen werden, über die das Client Service erreichbar ist.
• „URL Base Path“: Hier kann eine andere URL als der Default Root („/“) Basispfad eingetragen werden. Das wird vor allem benötigt, wenn ein Client Service hinter einem zentralen Reverse Proxy, der URL-Pfade nicht umschreiben kann, verwendet wird.
• „Language“: Dieses Feld definiert die Lokalisierung des Client Service. Ist "System default" aktiviert, so wird die im Browser eingestellte Sprache verwendet.
• „Servlet Affinity“: Geben Sie hier eine eindeutige Bezeichnung für jedes Client Service ein, wenn Sie SAML Authentifizierung mit einem Load Balancer verwenden. Der Wert dieses Feldes wird als „AFFINITY“-Cookie hinterlegt.
• „Maximum Number of User Query Terms”: Limitiert die Anzahl der bei der Suche berücksichtigten Wörter.
• „Maximum Number of Displayed Values“ (Filter Settings): Hier kann die maximale Anzahl der pro Filter angezeigten Werte angegebene werden.
• „Number of Displayed Values“ (Filter Settings): Hier kann die Anzahl der pro Filter angezeigten Werte angegebene werden.
• „Collapsible“ (Filter Settings): Wenn diese Option ausgewählt ist, können die Filter Werte zusammengeklappt werden.
• „Open by Default“ (Filter Settings): Wenn diese Option ausgewählt ist, werden Filter Werte standardmäßig aufgeklappt angezeigt.
• „Maximum Custom Metadata Count“: Wenn die Datenquelle gruppierte Metadaten unterstützt, wird mithilfe dieses Werts die Maximalanzahl der in der Detailansicht anzuzeigenden gruppierten Metadaten bestimmt. Zusätzlich bestimmt dieser Wert die maximale angezeigte Länge von Listen-Metadaten.
• „Content Fetch Timeout“: Legt fest, nach welcher Zeit das Herunterladen von Dokumenten abgebrochen wird.
• „Query Timeout“: Hier wird konfiguriert, nach welcher Zeit Suchen gegen einzelne Indizes abgebrochen werden. Die Suchen gegen einzelne Indizes werden parallel ausgeführt. Liefert ein Index innerhalb des Timeouts keine Resultate, dann werden nur Resultate der anderen Indizes angezeigt. Innerhalb dieses Timeouts werden alle notwendigen Vorgänge durchgeführt, wie z.B. Query Transformation, Suche im Index, Autorisation von Treffern usw…
• „Refinement Resolution Timeout“: Dieses Feld legt die Zeit fest, nach der das Laden von Einschränkungen abgebrochen wird.
• „Search In Resolution Timeout“: Gibt an, nach welcher Zeit das Laden von der „Quellen“ Liste abgebrochen wird.
• „HTTP Connect Timeout“: Legt fest, nach welcher Zeit Anfragen an Query Services abgebrochen werden, wenn keine Verbindung aufgebaut werden kann.
• „AJAX Request Timeout“: Legt fest, nach welcher Zeit AJAX-Anfragen abgebrochen werden.
• „Preview Length“: Legt die Länge der Vorschau fest.
• „Maximum Request Size“: Maximale Anfragegröße in kB.
• „Maximum Search Request Size“: Maximale Anfragegröße für Suchanfragen in kB.
• „User Profile Storage Path“: Legt ein konkretes Verzeichnis fest, in dem die Benutzerprofile abgelegt werden. Benutzerprofile werden während der Verwendung des Clients automatisch gespeichert. Wenn mehrere Client Services die gleichen Benutzerprofile verwenden sollen, geben Sie hier jeweils den gleichen Pfad an. Ist kein Pfad eingetragen, werden die Benutzerprofile für jedes Client Service getrennt abgelegt.
• „Embedded Java VM Args (-Xmx...)“: Dieses Feld bestimmt Optionen die beim Start des Client Service übergeben werden. Bitte verwenden Sie diese Option nur in Rücksprache mit Mindbreeze Support. Mit der Option “-XX:+ExitOnOutOfMemoryError” wird das Client Service automatich neu gestartet wenn es aufgrund von Speicherauslastung nicht mehr reagiert.
• „Flush in Memory Metrics after (queries)“: Query Aufzeichnung werden nach dem angegebenen Wert Queries persistiert.
• „Flush in Memory Metrics after (seconds)“: Query Aufzeichnungen werden nach dem angegebenen Wert Sekunden persistiert.
• „Maximum Metrics Filesize“: Begrenzung der Dateigröße der Query Aufzeichnungen.
• „Metrics Base Directory“: Verzeichnis zum Ablegen der Query Aufzeichnungen.
• „Enable Healthcheck“: Aktiviert das Healthcheck-Service, das für Tests der Funktionalität des Client Services verwendet werden kann.
• „Additional Client Service Nodes“: Mindbreeze Knoten, auf welchen das Client Service zusätzlich gestartet wird.
• Im Abschnitt „Data Sources“ wird die Sortierung der Datenquellen festgelegt. Durch „Group by Category“ werden die Datenquellen nach Datenquellentyp (Category) gruppiert und danach alphabetisch sortiert. Möchten sie die Reihenfolge der Datenquellentypen ändern, geben Sie die gewünschte Reihenfolge Beistrich getrennt in das Feld „Order of Categories“ ein. Um eine angepasste Sortierung nach Name der Datenquelle zu machen, verwenden Sie das Feld „Manual Order of Data Sources“. Ist „Group by Category“ aktiviert, werden die Datenquellen in der Gruppe nach vorne sortiert. Wenn Sie nicht alle verwendeten Datenquellentypen oder Namen angeben, werden die restlichen Datenquellen laut der Standardsortierung angezeigt. Enthält ein Wert einen Beistrich, können Sie statt der Beistrich getrennten Liste ein JSON-Array verwenden.
• Im Abschnitt „Filters“ können die Filter ausgewählt werden, die im Client Service angezeigt werden. Die auswählbaren Filter hängen von den ausgewählten Query Services und den konfigurierten Datenquellen ab.
• Im Feld „Query Engines“ können jene Query Services ausgewählt werden, die über das Client Service zur Verfügung gestellt werden.
• „Federated Query Engines“: Hier können die URLs von Query-Services eingetragen werden, die nicht von diesem Manager verwaltet werden. Zur Authorisierung ist hier eine spezielle Multi-Master Konfiguration erforderlich, genauere Details hierzu finden sich im Whitepaper "Konfiguration SAML (deu)".
• „Federated Client Services“: URLs von Client Services, die für alle Benutzer eingebunden werden.
• „Display federated results immediately, ignoring global relevancy ranking “: Ist die Option aktiviert, werden immer alle Resultate, die von den einzelnen Services angefordert wurden angezeigt. Dadurch kann es sein, dass weniger relevante Resultate bereits auf der ersten Seite angezeigt werden.
• „Federated Client Services Use Legacy Messageframe Channel”: Ist die Option aktiviert, läuft die Kommunikation zu den eingebunden Client Services über den Legacy Messageframe Channel. Diese Option kann verwendet werden, wenn Client Services eingebunden werden sollen, die auf einer InSpire Appliance der Version 20.2 oder älter laufen.
• „Use Legacy Messageframe Channel“: Um auch den Legacy Messageframe Channel für Client Services zu verwenden, die über die Einstellungen direkt am Search Client eingebunden wurden, setzen Sie die Option „Use Legacy Messageframe Channel“ auf „Enable“. Folgende Werte können ausgewählt werden:
  • „Auto“: Mindbreeze InSpire entscheidet selbst, ob der Legacy Messageframe Channel verwendet wird (empfohlen)
  • „Enable“: aktiviert explizit den Legacy Messageframe Channel
  • „Disable“: deaktiviert explizit den Legacy Messageframe Channel
• „Metrics Query Engines“: Sollen für die Autovervollständigung Benutzeranfragen verwendet werden, müssen hier die URLs von Query Engines mit aufgezeichneten Metrics eingetragen werden.
• „Federated Sources“: Haken Sie die Option „Enable Fabasoft Mindbreeze Cloud Services” an, um mehrere Fabasoft Mindbreeze Cloud Services einzubinden. Referenzieren Sie eigene Servicelisten, um zusätzliche Services zu verwenden.
• „API V2 Concurrent Request Limits”: Hier können die maximal gleichzeitig verarbeiteten Anfragen pro API-Service konfiguriert werden. Ist das Limit erreicht, liefern die API-Aufrufe die Statusmeldung „Maximum number of concurrent requests exceeded, please try again later!“, bis das Limit wieder unterschritten wird. 0 bedeutet keine Limitierung. Standardwert: 0
• „API V2 Named Concurrent Request Limits“: Hier können die maximal gleichzeitig verarbeiteten Anfragen pro Anfrage Name konfiguriert werden. Der Anfrage Name kann mit dem Request Header „x-mes-api-request-name“ gesetzt werden. Wenn die „Request Name Pattern“ Regex auf die Anfrage Name passt wird der Anzahl gleichzeitig verarbeiteten Anfragen auf das Wert in „Maximum Concurrent Request Count“ Feld gesetzt. 0 bedeutet auch hier keine Limitierung.
• Im Abschnitt “Query Persistence Settings“ kann das Speichern von Suchen für den Benutzer freigeschaltet werden. Schalten sie mittels „Enable“ die Funktionalität frei und konfigurieren Sie eine Datenbankverbindung zum Speichern der Suchen mittels der Felder „JDBC URL“, „User“, „Password“ und „Database Table Prefix“. Der „Database Table Prefix“ kann dazu verwendet werden, um verschiedene Clientservices in die gleiche Datenbank abspeichern zu können. Die „User“ und „Password“ Parameter können auch als Username/Password Credential konfigurieren werden. Dazu muss ein Endpoint Eintrag für die JDBC URL angelegt werden.
• Wird im Abschnitt „Query Settings“ die Option „Count Filtered Values“ aktiviert so werden die Filterzahlen auch für nicht ausgewählte Filterwerte angezeigt.
• Wird im Abschnitt „Query Settings“ die Option „Enable Character NGRAMs“ aktiviert so können Character NGRAMs ein- und ausgeschaltet werden. Default: true.
• Mit der Auswahl der Option „Ignore Global Uniform Properties“ kann man die Übersetzung eines Metadatums, das im Uniform Property Descriptor existiert mit der Übersetzung im Category Descriptor der Datenquelle überschreiben.

Zulässige Weiterleitungs-URL für Benutzeranmeldung konfigurieren

Wenn sich ein Benutzer am Client-Service anmeldet, oder der Search App Editor verwendet wird, werden je nach konfigurierter Anmeldeart vom Browser HTTP Weiterleitungen (über die Adresse /mashup-login) durchgeführt. Aus Sicherheitsgründen sind keine Weiterleitungen auf beliebige URLs erlaubt. Mit diesen Einstellungen kann konfiguriert werden, welche URLs zugelassen sind.

Standardmäßig ist die Einstellung „Allow login redirect URLs to“ auf „Client Service External URL“ gesetzt. Das bedeutet es werden nur URLs erlaubt, die der „External URL“ des Client Services entsprechen. Wenn z.B. die Client Service External URL https://search.mycompany.com ist, dann ist die URL https://search.mycompany.com/login erlaubt, die URL https://crm.mycompany.com/login allerdings nicht.
Hinweis: Ist im Client Service die External URL nicht gesetzt, dann wir nur das URL-Schema überprüft, HTTP oder HTTPS, je nach „Use SSL“ Einstellung im Client Service.
Relative URLs sind immer zulässig. Der Browser bekommt bei einer nicht zulässigen URL einen „HTTP 403 Forbidden“ Fehler.

Die Standardeinstellungen sind für einfache Anwendungsfälle meist ausreichend. In speziellen Fällen, wie bei z.B. Load-Balancer mit abweichenden Client Service „External URLs“ oder Reverse-Proxies, die SSL terminieren, sind die Standardeinstellungen nicht geeignet und verursachen HTTP 403 Fehler. Für diese speziellen Anwendungsfälle muss die Einstellung „Allow login redirect URLs to“ auf „Custom Pattern“ gestellt werden, sowie ein regulärer Ausdruck (Java) bei „Custom Pattern“ angegeben werden. Der reguläre Ausdruck wird direkt gegen die Weiterleitungs-URL gematcht. Bei einem Match ist die URL zulässing, ansonsten wird ein HTTP 403 Fehler ausgegeben. Ein Beispiel für einen regulären Ausdruck ist z.B. https://search.mycompany.com.* welcher die URL https://search.mycompany.com/login erlaubt, jedoch nicht https://crm.mycompany.com/login.
Hinweis: fehlt oder ist der reguläre Ausdruck fehlerhaft, so ist jede Weiterleitungs-URL nicht zulässig.

Einstellungen zur Validierung von Anfragen konfigurieren

Der Client Service unterstützt die Validierung des HTTP-Host Headers von Anfragen. Dadurch kann die Sicherheit erhöht werden. Mit der Einstellung „Validate HTTP Request Host Header Pattern“ kann ein regulärer Ausdruck angegeben werden, welcher auf den Host matched. Nur bei einer Übereinstimmung wird die Anfrage verarbeitet. Ansonsten wird ein Fehler im Log vermerkt und die Anfrage mit dem Status HTTP 403 zurückgewiesen.

Einstellungen zur Auslieferung von Bildern konfigurieren

Standardmäßig werden nicht-statische Bilder, wie z.B. Vorschaubilder oder Icons, als Data-URLs ausgeliefert. Falls z.B. ein Custom-Client mit Data-URLs Probleme macht, kann mit dem Aktivieren der Einstellung „Enable Get Image Resources In Separate Requests“ die Auslieferung auf HTTP(S)-URLs umgestellt werden. Diese Einstellung wird möglicherweise in der nächsten Version von Mindbreeze entfernt. Daher muss der Custom-Client angepasst werden und Data-URLs verwenden, um auch nach dem nächsten Update zu funktionieren. Sicherheitshinweis: Ist diese Einstellung aktiv, wird der Hostname in der URL nicht validiert.

Einstellungen für Query Service konfigurieren

In einem Producer-Consumer Szenario werden Suchanfragen auf dem Consumer Node standardmäßig an den Index im Consumer Node geleitet. Wenn z.B. wegen einer Wartung der Consumer Index nicht erreichbar ist, kann der Consumer nicht für eine Suche herangezogen werden. Die Client Service Einstellung „Enable Fallback to Query Services on other Nodes“ kann aktiviert werden, um in solchen Situationen die Suchanfrage direkt zu dem Producer Index zu senden. Dadurch wird die Verfügbarkeit der Suche in Producer-Consumer Szenarien verbessert.

Die Einstellung "Use Credentials from Endpoint Mapping Fallback" ist für den internen Gebrauch bestimmt und muss nicht verändert werden.

Gespeicherte Suchen aktivieren

Diese Einstellung erlaubt es, die gespeicherten Suchen am Server abzuspeichern. Dazu kann im Abschnitt “Query Persistence Settings“ das Speichern von Suchen für den Benutzer freigeschaltet werden. Schalten sie mittels „Enable“ die Funktionalität frei und konfigurieren Sie eine Datenbankverbindung zum Speichern der Suchen mittels der Felder „JDBC URL“, „User“, „Password“ und „Database Table Prefix“. Das „Database Table Prefix“ kann dazu verwendet werden, um verschiedene Clientservices in die gleiche Datenbank abspeichern zu können.

Einstellungen:

• Enable: Aktivieren der serverseitigen Speicherung.
• JDBC URL: URL zur Datenbank
• Max Number Of Database Connections: Maximale Anzahl der Datenbankverbindungen. Standardwert: 10, Minimalwert: 2.
• User: Der Benutzer der Datenbank
• Passwort: Das Passwort für den Benutzer der Datenbank
• Database Table Prefix: Angabe eines Table-Prefixes.
• Die „User“ und „Password“ Parameter können auch als Username/Password Credential konfigurieren werden. Dazu muss ein Endpoint Eintrag für die JDBC URL angelegt werden.

Optionale Authentisierung

Die „Optionale Authentisierung“ Einstellung erlaubt eine anonyme Suche in den öffentlich verfügbaren Dokumenten. Die Benutzer können sich jederzeit im Mindbreeze Client Service anmelden, um die Inhalte mit eingeschränktem Zugriff durchsuchen zu können oder sich abmelden um wieder auf die anonyme Suche zurückzuschalten.

Um die Einstellung zu aktivieren müssen Sie in der Registrierkarte „Client Services“ die Option „Requires Authentication“ auf „Optional“ einstellen.

Für eine optionale Authentisierung ist es erforderlich, dass die Option „Authentication Generates Trusted Peer Credentials“ aktiv ist und ein “Trusted Peer Credential Certificate” selektiert ist.

Wenn kein “Trusted Peer Credential Certificate” verfügbar ist, ist kein anonymer Zugriff auf das Mindbreeze Client Service erlaubt.

Wenn die optionale Authentisierung konfiguriert ist kann der User zwischen authentisiertem - und anonymen Modus umschalten. Um sich zu authentisieren betätigt der User den „Anmeldung“ Button, um eine anonyme Suche abzusetzen loggt sich der User mittels „Abmelden“ einfach wieder aus.

Benutzername ein-/ausblenden

Ist ein Benutzer angemeldet und ein Benutzername ist verfügbar, kann dieser mit dem Setting „Display Username“ ein- und ausgeblendet werden.

Wenn dieses Setting aktiviert ist, wird der volle Benutzername ausgegeben. Ist das Setting nicht aktiviert, erscheint je nach Anmeldestatus „Login“ oder „Logout“.

CORS Header

Wenn Sie die föderierte Suche verwenden, oder eine Search-App verwenden, welche auf einem anderen Server betrieben wird, dann sind diese Einstellungen möglicherweise für Sie relevant. In solchen Szenarien verbieten Webbrowser meistens die Kommunikation mit anderen Servern, ausgenommen sind nicht authentisierte, öffentliche Server, da hier keine kritischen Daten übertragen werden.

Die Option “Allowed Origins” steuert, welche „Origins“ erlaubt sind. Origins sind absolute URLs, von denen aus Requests erlaubt sind.

Falls Sie einen ClientService mit Authentisierung von anderen Origins mit anderen privaten Domänen aus verwenden wollen, müssen Sie die URLs dieser Origins explizit in der Option „Allowed Origins” auflisten. Z.B. http://www.example.com,https://www.mycompany.com

Alternativ können Sie auch mit der Option „Allowed Origins Pattern“ mit regulären Ausdrücken steuern, welche Origins erlaubt sind. Sie können hier mehrere Zeilen angeben. Z.B. der Wert

https://.*\.mycompany\.com

https://.*\.mycorporation\.com

erlaubt den Zugriff von z.B.

https://search.mycompany.com

https://myapp.mycompany.com

https://find.mycorporation.com

aber jedoch nicht von

https://search.example.com

Hinweis: sobald Sie die Option „Allowed Origins Pattern“ verwenden, ist die Option „Allowed Origins“ wirkungslos.

Standardwerte

Bei nicht authentisierten ClientServices („Requires Authentication“: „No“) wird für „Allowed Origins Pattern” standardmäßig der Wert “.*” angenommen, wenn „Allowed Origins (Pattern)“ nicht explizit konfiguriert ist.

Bei (optional) authentisierten ClientServices („Requires Authentication“: „Optional“ oder „Yes“) sind standardmäßig alle Hosts mit beliebigem Port erlaubt, die innerhalb Ihrer obersten privaten Domäne liegen, wenn „Allowed Origins (Pattern)“ nicht explizit konfiguriert ist. Mit „oberster privaten Domäne“ ist die Domäne gemeint, die eine Ebene unterhalb des öffentlichen Suffixes (gemäß der Definition in der Public Suffix List (PSL) der Mozilla Foundation) liegt. Beispielsweise wäre solch eine Domäne „mindbreeze.com“, aus der das Pattern „(.*\.)?\Qmindbreeze.com\E(:[0-9]+)?“ generiert wird. Der Domänenname wird dabei aus der „External URL“ extrahiert. Wenn diese nicht konfiguriert ist, wird er aus dem konfigurierten „Hostname“ aus der Nodes-Konfiguration extrahiert. Ist dies auch nicht möglich, wird der Domänenname aus dem System-FQDN extrahiert.

CORS bei SAML

Wenn Ihr SAML IDP nicht innerhalb der Domäne Ihrer Mindbreeze InSpire Appliance liegt, müssen unter bestimmten Bedingungen Konfigurationen vorgenommen werden. Meistens ist das für SAML IDPs in der Cloud interessant. Es muss sichergestellt werden, dass Mindbreeze InSpire Ihrem IDP vertraut. Aktivieren Sie dazu zunächst die Advanced Settings.

Healthcheck

Im Abschnitt „Healthcheck Settings“ wird der Healthcheck des Client Services konfiguriert.

Die Adresse <Adresse des Client Services>/ping liefert, ob das Client Service betriebstüchtig ist. Damit kann das Service überwacht werden, um z.B. den Betrieb zu informieren oder es an einem Load Balancer zu aktivieren/deaktivieren.

Standardmäßig wird mit dem „Workload Check“ die Auslastung des Web-Servers und die Anzahl der parallelen Anfragen geprüft (siehe auch API V2 Concurrent Request Limits). Die Einstellung „Disabled“ deaktiviert diese Prüfung.

Zusätzlich können in „JSON Healthcheck Files Directory“ eigene Prüfungen hinzugefügt werden. Damit können Suchanfragen ausgeführt und deren Resultate geprüft und mit Javascript verarbeitet werden.

Antworten

Voting

Um die Möglichkeit anzubieten, Feedback zu einem Treffer zu geben (positive oder negative Bewertung), kann im Client-Service die Option „Enable Voting“ gesetzt werden.

Ist die Option aktiv, werden die Treffer im Client mit zwei weiteren Buttons ausgestattet.

Das jeweilige Feedback wird in app.telemetry angezeigt.

Cookie Einstellungen

Der Client Service Setzt standardmäßig automatisch ein Session Cookie (JSESSIONID). Falls gewünscht, kann dies mittels aktivieren der Einstellung „Disable Session Cookie“ unterbunden werden. (Wenn z.B. der Client Service öffentlich betrieben wird, und aus rechtlichen Gründen Cookies nicht zulässig sind) Hinweise: Diese Einstellung kann die Performance verschlechtern. Diese Einstellung darf nicht in Zusammenhang mit der Autorisierungsform SAML verwendet werden.

Die Einstellung „Same Site Cookie Behavior“ bestimmt, ob Cookies domänenübergreifend verwendet werden. Falls Sie die Suche föderiert verwenden und die Server auf unterschiedlichen Domänen liegen, (z.B. search.mycompany.de föderiert auf search.mycorporation.com) und Sie zur Anmeldung im Browser Cookies verwenden (für z.B. die Autorisierungsform SAML), dann muss „Same Site Cookie Behavior“ auf den Wert „Auto“ gestellt sein (Standardwert). Damit ist sichergestellt, dass die zur Autorisierung notwendigen Cookies übertragen werden können. Hinweis: der Wert „Auto“ führt dazu, dass wenn „Use SSL“ aktiv ist, effektiv Cookies mit Same Site Cookie Behavior „None“ gesetzt werden. Falls „Use SSL“ nicht aktiv ist (z.B. bei Verwendung eines Load Balancers), wird kein Same Site Cookie Behavior gesetzt.

Falls Sie keine föderierte Suche mit Cookie-basierter Autorisierung verwenden, können Sie zur Erhöhung der Sicherheit die Einstellung „Same Site Cookie Behavior“ auf den Wert „Strict“ setzen. Damit können dann keine Cookies weitergegeben werden. Die anderen möglichen Werte dieser Einstellung sind für internen Gebrauch vorgesehen und sollten nicht verwendet werden.

Betreiben von Suchanwendungen über das Client Service und Ändern der Standardsuchanwendung

Um eigene Suchanwendungen direkt über das Client Service zu betreiben und dort auch als Standard zu hinterlegen, kann der Menüpunkt „Web Application Contexts Settings“ verwendet werden. Details zur Konfiguration finden sich in der Dokumentation „Entwicklung von Suchanwendungen“.

Verwendung von Port 80 als Client Service Port auf G7 Appliances

Um ein Client Service auf Port 80 zu betreiben, sind auf G7 Appliances folgende Schritte notwendig.
Deaktivieren sie die Option: „Use SSL (HTTPS)“ und setzen sie den „Port (HTTP)“ auf 23350. Port 80 wird automatisch auf diesen Port weitergeleitet.

Aus Sicherheitsgründen ist der Zugriff auf Port 80 eingeschränkt. Um den Zugriff für bestimmte IP-Adressen oder Subnetze zu erlauben, bearbeiten Sie die Datei: „/var/data/iptables.sh“.

Tragen sie in der Zeile „iptables -t nat -A PREROUTING -m addrtype --dst-type LOCAL -s 127.0.0.1 -p tcp -m tcp --dport 80 -j DOCKER“ anstatt 127.0.0.1 die erlaubten Adressen ein oder entfernen sie „-s 127.0.0.1“ um den Zugriff von überall aus freizugeben. Starten Sie anschließend die Appliance neu um die Firewall Regeln anzuwenden.

Bei einem Update wird die Datei „/var/data/iptables.sh“ überschrieben und automatisch ein Backup im Format „/var/data/iptables.sh.bak.YYYY-MM-DD“ erstellt. Stellen Sie bei Bedarf ihre angepassten Regeln nach dem Update wieder her.

Registerkarte „Administrators“

Die Registerkarte „Administrators" dient zur Konfiguration der Authentisierung und Autorisierung für den Zugriff auf die Mindbreeze InSpire Konfiguration.

Im Feld „Authorized Users“ werden alle Benutzer angezeigt, die aktuell Zugriff auf die Konfigurationsoberfläche haben.

Hinweis: Ist kein Benutzer konfiguriert, so erfolgt keine Authentisierung und daher keine Einschränkung des Zugriffs.

Um einen neuen Administrator hinzuzufügen, gehen Sie folgendermaßen vor:

1. Klicken Sie auf das Plus-Symbol rechts außen im Kopfbereich der Liste ().
2. Geben Sie im Feld „Username“ den Namen jenes Benutzers an, der Zugriff auf die Konfiguration haben soll. Der Name muss dem Schema MACHINE\username bzw. DOMAIN\username entsprechen.
3. Klicken Sie auf die Schaltfläche „Save“.

Sobald Sie einen neuen Administrator für die Konfigurationsoberfläche hinzugefügt haben, können nur mehr diese die Konfiguration ändern. Stellen Sie daher unbedingt sicher, dass Sie Ihre eigenen Anmeldeinformationen auch eingeben.

Sie können nachträglich einem der Benutzer in der Liste die Rechte zur Administration verweigern, in dem Sie entweder den Haken in der „Authorized“ Checkbox entfernen oder mittels Klick auf das Icon mit einem roten X am rechten Fensterrand ()  den Benutzer löschen.

Die Authentisierung basiert auf Kerberos bzw. NTLM. Um eine Authentisierung via Kerberos zu ermöglichen, muss die Kerberos Infrastruktur durch Hinzufügen eines sogenannten Service Principal Name (SPN) konfiguriert werden.

Registerkarte „License“

Die Registerkarte „License“ dient zur Verwaltung der Mindbreeze InSpire-Lizenz.  

Im Feld „License Management“ können Lizenzen für Mindbreeze InSpire verwaltet werden.

Um eine Lizenz neu zu installieren oder aktualisieren, führen Sie folgende Schritte durch:

1. Geben Sie im Feld neben „License“: die Lizenzdatei an. Sie können dazu die Schaltfläche „Durchsuchen…“ verwenden.
2. Klicken Sie auf die Schaltfläche „Save“.

Im Feld „Current License Information“ wird nach dem Laden einer Lizenz angezeigt, wer berechtigt ist, die aktuelle Installation von Mindbreeze InSpire zu benutzen und bis wann die Lizenz gültig ist. Unter „License Restrictions“ werden zusätzliche Einschränkungen, wie zum Beispiel auf wie viele Benutzer die aktuelle Lizenz ausgestellt ist, angezeigt.

Registerkarte „Certificates“

Mindbreeze InSpire bietet die Möglichkeit, dass Applikationen von Drittherstellern beim Query Service Abfragen durchführen, ohne Benutzername und Passwort zu übergeben. Es handelt sich um so genannte „trusted peers“, die sich mit einem SSL-Zertifikat ausweisen. Um die Vertraulichkeit von den im Index erfassten Daten zu gewährleisten, wird vorausgesetzt, dass ein derartiges Zertifikat von einer in Mindbreeze InSpire registrierten Certificate Authority (CA) signiert ist.

Um die vertraute CA zu definieren, laden Sie in der Registerkarte „Certificates“ im Feld Trusted Certificate Authority die .CER-Datei, die das Zertifikat des CAs im PEM Format enthält. Wenn sie kein CA-Zertifikat laden, ist die Funktionalität von „Trusted Peers“ nicht verfügbar. Für jedes übermittelte Zertifikat legt die Option „Trusted Peer“ fest, ob das Zertifikat für diesen Zweck verwendet wird. Im Feld „Current Trusted CA Information“ werden die aktuell registrierten Zertifikate angezeigt.

Alle verfügbaren CA-Zertifikate („Available CAs“) können für die Authentifizierung mit Client-Zertifikaten verwendet werden. Diese Authentifizierungsart kann beim Windows Client eingesetzt werden, um Benutzer anhand von Zertifikaten zu authentifizieren. Auch hierzu muss ein CA-Zertifikat vorliegen, mit dem alle Benutzerzertifikate signiert sind, damit eine vertrauenswürdige Verbindung eingegangen werden kann. Dazu muss beim Index unter „Advanced Settings“ ein Zertifikat für die Einstellung „Authentication Certificate“ ausgewählt werden.

Damit ein Web Client Service mit einem anderen SSL-Zertifikat betrieben werden kann, beispielsweise um Loadbalancing zu ermöglichen, muss in der „Certificates“ Registerkarte ein Zertifikat im pkcs12-Format übertragen werden. Unter „Available SSL Certificates“ sind diese Zertifikate aufgelistet. Bei einem Web Client Service kann ein solches Zertifikat unter „Advanced Settings“ bei der Einstellung „SSL Certificate“ ausgewählt werden. Die Standardeinstellung „Use SSL Certificate supplied with your license“ verwendet das mit der Lizenz ausgelieferte Zertifikat.

Tutorial Video „Installieren eines SSL-Zertifikats“

In diesem Video erklären wir, wie Sie ein SSL-Zertifikat für Mindbreeze InSpire installieren können: https://www.youtube.com/watch?v=oThC_VNcc5s

Registerkarte „Network“

Auf der Registerkarte „Network“ werden allgemeine Netzwerkeinstellungen für alle Mindbreeze Enterprise Search Services ermöglicht.

Proxy Settings

Um Zugang zu den Web Ressourcen durch einen Proxy Server zu erhalten sind die Host Adresse und Port Information vom Proxy Server und bei Bedarf einen gültigen Usernamen und Passwort einzugeben.

LDAP Settings

Zur Konfiguration der LDAP Abfragen, die für Autorisierung notwendig sind, sind folgende Information wichtig:

• Domain Name: Vollqualifizierter Domänen Name.
• LDAP Server: Diese Server werden für LDAP Abfragen bevorzugt. Falls die konfigurierte LDAP Server nicht erreichbar sind oder keine Ergebnisse liefern werden zusätzlich die LDAP Server in DNS Server Records (_ldap._tcp.gc._msdcs and  _ldap._tcp) von Active Directory aufgelöst und abgefragt.
• Disable LDAP Server Discovery: Nur die konfigurierten Server werden für LDAP Abfragen benutzt.
• Excluded Domain: Domänen die nicht abgefragt werden.
• Enable Persisted Cache: Die Resultate von LDAP Abfragen werden lokal gespeichert und diese werden bei nächsten Abfragen wiederverwendet. Z.B. Gruppenmitgliedschaft eines Benutzers , die bei jeder Suche benötigt wird, wird im Cache gespeichert.
• Enable SSL/TLS: Verbingungen zum LDAP Server verwenden SSL/TLS Verschlüsselung.
• Enable Connection Pool Manager: Durch die Wiederverwendung von Verbindungen wird die Performanz erhöht.
• Maximum Connections: Maximale Anzahl von Verbindungen zum LDAP Server die für die LDAP Abfragen beim Starten eines Services aufgebaut werden. Diese Verbindungen können gleichzeitig verwendet werden. Eine Abfrage wird nur dann blockiert wenn alle Verbindungen zur dieser Zeit besetzt sind.  
• Maximum Shared Connections: Dadurch wird eine physische Verbindung gemeinsam von mehreren Threads verwendet.

Die LDAP Abfragen werden im „Network Requests“ Log Pool von AppTelemetry geloggt. Scheme „ldap“ und Port „389“ können als filter verwendet werden. Alle Abfragen die im Cache vorhanden sind haben den Status „Persisted Cache“.  

Registerkarte „About“

Auf der Registerkarte „About“ werden allgemeine Informationen, wie die Versionsnummer und das Copyright der aktuell installierten Version von Mindbreeze InSpire angezeigt.

Konfiguration aus Sicherungskopie wiederherstellen

Wenn eine Konfigurationsänderung mit „Save“ gespeichert wird, werden Sicherungskopien von den Konfigurationsdateien (mesmaster.xml und pluginsite.xml) gemacht. Die Kopien liegen im selben Verzeichnis wie die Konfigurationsdateien:

%userprofile% ist der Profilverzeichnis des Servicebenutzers des Mindbreeze Manager Services. Wenn das Mindbreeze Manager Service mit System Konto gestartet wird, befindet sich das Profilverzeichnis unter:

C:\Windows\System32\config\systemprofile\ AppData\Roaming\Mindbreeze\Enterprise Search\Server\

Die Sicherungskopien folgen dem Namensschema: mesconfig.xml.backup_<Zeitstempel> und pluginsite.xml.backup_<Zeitstempel>.

Um den letzten Mindbreeze Konfigurationsstand wiederherzustellen sind folgende Schritte nötig:

• Mindbreeze Manager Service und Mindbreeze Node Service stoppen
• mesconfig.xml und pluginsite.xml mit den gewünschten mesconfig.xml.backup_<Zeitstempel> und pluginsite.xml.backup_<Zeitstempel> Dateien ersetzen
• Mindbreeze Manager Service und Mindbreeze Node Service starten

Import/Export von Einstellungen

Einstellungen für verschiedenen Services können mithilfe dieser Komponente importiert und exportiert werden.

Format

Folgendes Format wird für den Export und Import von Einstellungen verwendet:

<settings>

    <attributes>

        <attribute name="name" value="value"></attribute>

    </attributes>

    <properties>

        <property name="name" value="value"></property>

    </properties>

</settings>

Export

Das Export Fenster (links) liest automatisch alle verfügbaren Optionen aus dem jeweiligen Service aus, welche im Anschluss 1:1 für den Import verwendet werden können.

Import

Im Import Fenster (Mitte) wird die angepasste Konfiguration eingespielt. Achtung: Diese Konfigurationen müssen vom selben Typ sein (Index, Filter, Client Service, Crawler, Launched Service).

Changes

Das Fenster Changes zeigt die Änderungen im Überblick als Diff.

Remove existing settings

Ist diese Option aktiviert (Default), wird die Konfiguration für das jeweilige Service überschrieben. Folgende Optionen werden in keinem Fall überschrieben:

Service Name

Index Path

Index Port (HTTP)

Data Port (TCP/IP)

Query Port (HTTPS)

Filter Service

Caching Principal Resolution Service

Authorization Service

Wenn Sie die bestehende Konfiguration nur erweitern und updaten möchten, deaktivieren Sie diese Option.

Parametrisierung

Einleitung

Durch die Einführung von Konfigurationsparametern und sogenannten Development-Snapshots können Anpassungen an

der Mindbreeze Service Konfiguration (Hinzufügen/Entfernen und Anpassen von Connectoren, Indizes, Filter, Client Services, …)

der Semantik Pipeline

der Query Transformation Pipeline

InSpire Search Apps

Beliebiger Resource-Files wie Boostings, Relevanzparameter

Als Snapshot exportiert werden und dann automatisch in die Produktion übernommen werden. Dabei können beliebige Einstellungen (wie zB die zu indizierenden Quellsysteme) als Parameter auf der jeweiligen Umgebung lokal überschrieben werden. Damit z.B.: kann sichergestellt werden, dass produktiv die Produktionsquellen indiziert werden und im Entwicklungssystem die Entwicklerquellen. Credentials, Zertifikate werden nicht abgelegt und bleiben erhalten.

Parametrisierung Aktivieren/Deaktivieren

Diese Funktion ist nur für G7 Appliances verfügbar.

In den erweiterten Einstellungen (advanced settings) unter ‘Indices’ kann die Parametrisierung aktiviert oder deaktiviert warden.

Hinweis: Um die Parametrisierung zu deaktivieren, klicken Sie auf den Button 'Disable Parameterized Configuration'. Wenn es aktive parametrisierte Konfigurationsoptionen gibt, ist der Button deaktiviert. Um die Parametrisierung in diesem Fall zu deaktivieren, müssen Sie zuerst alle Parameter entfernen.

Parameter hinzufügen

Sobald die Parametrisierung aktiviert ist, kann man über den Button ‘Add/Update Parameter’ (…) gewünschte Parameter hinzufügen.

Sie können einen der vorhandenen Parameter auswählen oder einen neuen Parameter aus der folgenden Tabelle hinzufügen.

Hinweis: Der Name des Parameters darf keine Leer- oder Sonderzeichen enthalten.

Um Änderungen anzuwenden, müssen Sie einen Parameter aus der Tabellenliste auswählen.

Hinweis: Die Auswahl eines Parameters erfolgt durch Klicken auf die Tabellenzeile. Falls ausgewählt, wird sie gelb markiert.

Nach dem Klicken auf ‘Apply’ ist der Wert der Konfigurationsoption 'z.B. Crawling Root [1]' der Wert des aus der vorherigen Tabelle ausgewählten Parameters. Zusätzlich ist der Wert der Konfigurationsoption jetzt schreibgeschützt.

Parameter updaten

Um die Parameter zu bearbeiten (z.B. den Parameterwert zu ändern oder einen anderen Parameter zu wählen), klicken Sie auf den Button ‘Add/Update Parameter'.

Das Dialogfeld wird geöffnet, und der referenzierte Parameter für diese Konfigurationsoption wird automatisch aus der verfügbaren Liste ausgewählt (hervorgehoben).

Ändern Sie den Wert des Parameters (z.B. 'https://another_site.com/events') und klicken Sie auf ’Apply’:

Der Wert der Konfigurationsoption ändert sich ebenfalls entsprechend.

Hinweis: Eine weitere mögliche Änderung ist die Wahl eines anderen Parameters (z.B. 'param2'). In diesem Fall bezieht sich die Konfiguration 'Crawling Root [1]' nun auf den neu gewählten Parameter.

Und der Wert von 'Crawling Root [1]' wird sich dementsprechend auf den Wert von 'param2' beziehen.

Remove a Parameter

Um einen Parameter aus der Konfigurationsoption z.B. 'Crawling Root [1]' zu entfernen,klicken Sie auf den Button ‘Remove Parameter’.

Hinweis: Der Wert der Konfigurationsoption 'Crawling Root [1]' ist jetzt read/write und nimmt den Wert des zuletzt referenzierten Parameters an.

Wenn Sie nun auf den Button ‘Add/Update Parameter’ klicken, wird der Dialog zur Parametrisierung dieser Konfigurationsoption von Anfang an wieder geöffnet.

Abfragesprache von Mindbreeze InSpire

Die Mindbreeze InSpire Abfragesprache wird zur Formulierung von Abfragen in den Clients verwendet.

Abfragen von einzelnen Wortanfängen (Single Terms)

Allgemein werden bei der Suche nach Wortanfängen und Wörtern keine Platzhalterzeichen (wie %, * usw.) verwendet.

Eine Eingabe von „bau“ startet eine Suche nach Objekten, die Wörter mit den Zeichen „bau“ am Wortanfang und das Wort (den Term) bau enthalten. Bei einer Suche wird Groß- und Kleinschreibung grundsätzlich nicht berücksichtigt, d.h. eine Suche nach bau ergibt dieselben Treffer wie eine Suche nach Bau oder BAU.

Analog zum Abfragen von einzelnen Wörtern bzw. Wortanfängen können mehrere Wörter bzw. Wortanfänge in einem Dokument gesucht werden. Die einzelnen Wortanfänge einer Suchabfrage werden mit einem logischen UND verknüpft. Es werden nur jene Dokumente ausgegeben, die alle eingegebenen Wörter bzw. Wortanfänge enthalten.

Suche nach mehreren Wortanfängen im selben Dokument

Alle drei Varianten in diesem Beispiel liefern dasselbe Resultat. Es werden jene Ergebnisse geliefert, in denen die Wörter "auto" und "test" als Wortanfang oder als eigenständige Wörter (Terme) vorkommen. Die Groß- und Kleinschreibung wird nicht berücksichtigt.

Phrasensuche / exakte Suche

Eine Phrasensuche sucht nach exakten Wörtern oder exakten Phrasen. Diese wird durch Angabe von beginnenden und schließenden Anführungszeichen (") unmittelbar vor und am Ende der gesuchten Phrase initiiert.

Es wird nur nach exakt dieser Phrase gesucht. Die Phrasensuche ist daher nicht sinnvoll, wenn die genaue Schreibweise der Wörter bzw. der Phrase nicht bekannt ist.

Einschränkung nach Datenerweiterung

Mindbreeze InSpire bietet die Möglichkeit, die Suche auf bekannte Dateierweiterungen einzuschränken.

Diese Abfrage sucht in allen Dateien mit den Dateierweiterungen ".doc" (Microsoft Word), ".xls" (Microsoft Excel) und ".msg" (Microsoft Outlook) nach Wörtern mit dem Wortanfang "mind" und nach dem Wort "mind", wobei die Groß- und Kleinschreibung nicht berücksichtigt wird.

Logische Verknüpfungen

AND

Wortanfänge, Wörter und Phrasen einer Suchabfrage werden implizit und-verknüpft. Das heißt, es werden nur jene Treffer zurückgeliefert, in denen alle gelisteten Wortanfänge, Wörter und Phrasen vorkommen. Das Schlüsselwort AND kann ebenfalls explizit in einer (zum Beispiel geschachtelten) Abfrage vorkommen.

OR

Die Oder-Verknüpfung liefert jene Ergebnisse, in denen zumindest eine der Suchbedingungen erfüllt ist, also in denen einer der Wortanfänge, eines der Wörter oder eine der Phrasen vorkommet. Das heißt, es werden auch jene Treffer zurückgeliefert, in denen nur ein einziger gelisteter Wortanfang, ein Wort oder eine gelistete Phrase vorkommen. Das Schlüsselwort OR muss explizit in einer Abfrage formuliert werden und kann auch geschachtelt vorkommen.

Diese beiden Abfragen liefern jene Ergebnisse, in denen das Wort "Mindbreeze" und/oder das Wort "Search" gemeinsam mit dem Wort "Software" vorkommt. Sie liefern also Ergebnisse mit den Kombinationen "Mindbreeze" und "Software", "Search" und "Software", sowie "Mindbreeze", "Search" und "Software".

Andere Schlüsselwörter

NEAR

Eine Suche mit NEAR liefert ausschließlich Ergebnisse zurück, in denen ein Wort nahe einem anderen steht.

NOT

Eine Suche mit NOT liefert Ergebnisse aus einer Grundmenge zurück, in denen ein Wort nicht vorkommt. NOT kann nicht alleine verwendet werden.

Metadatensuche

Die Metadatensuche wird vor allem verwendet, um eine Ergebnismenge weiter einzuschränken, man spricht in diesem Zusammenhang auch von "Refinement" (Verfeinerung). Es gibt von Mindbreeze InSpire fix vorgegebene Metadaten sowie herstellerabhängige Metadaten (die von Mindbreeze-Partnern selbst definiert werden).

Syntax einer Metadatensuche: <metadatum>:<wert>

Die Suche nach einer Dateierweiterung kann durch das Metadatum "extension" definiert werden.

In diesem Beispiel liefern beide Varianten dasselbe Ergebnis: Microsoft Word Dateien, die das Wort „mind“ oder Wörter enthalten, die mit „mind“ beginnen.

Folgende Metadaten sind für die standardmäßig unterstützten Datenquellen definiert:

Der Exchange Connector definiert unter anderem die Metadaten from und to.

Diese Suche liefert jene Objekte, die in der Absendeadresse den Begriff "bauernf" enthält.

Intervallsuche

Eine Suche mit TO liefert grundsätzlich Begriffe zwischen der linken und der rechten Seite des TO Operators. Besonders interessant ist das bei der Verwendung der Intervallsuche in Verbindung mit numerischen Strings. Mindbreeze erkennt numerische Werte verschiedener Art, zB

Syntax einer Intervallsuche: <von> TO <bis>

Erweiterte Metadaten-Intervallsuche

Syntax einer erweiterten Intervallsuche:

label:[<von> TO <bis>]

label:[<von>]

label:[TO <bis>]

Kombination der Sprachelemente der Abfragesprache

Eine Kombination der oben genannten Sprachelemente der Mindbreeze InSpire -Abfragesprache ist möglich.

Dieses Beispiel liefert Microsoft Word-Dokumente, die von einer Adresse mit dem Begriff "bauernf" geschickt wurden. Der Titel der resultierenden Objekte enthält das Wort "Integration" (bzw. ein Wort das mit "Integration" beginnt) enthält.

Betrieb und Wartung

Ändern des Index Service-Modus

Ein Mindbreeze InSpire Index Service unterstützt die folgenden Modi:

• Mode: running ()
  Dies ist der Standardmodus von Mindbreeze InSpire Index Services. In diesem Modus wird das Index Service betrieben.
• Mode: readonly ()
  Dieser Modus wird benützt um die Indexdateien von Mindbreeze InSpire zu sichern (Backup) und die Konsistenz der Daten während dieses Zeitraumes zu gewährleisten.
  
  Hinweis: Um den Indizierungsvorgang fortzusetzen bzw. hinzukommende Dokumente indizieren zu können (Deltaindizierung) muss vom „Mode: readonly“ wieder auf den „Mode:running“ gewechselt werden.
• Mode: offline ()
  Dieser Modus kann vom Benutzer nicht explizit gesetzt werden. In diesem Modus befindet sich ein gestoppter Index Service.

Manuelles Ändern des Index Service-Modus

Neben dem automatisierten Setzen des Index Service-Modus, kann der Modus auch über die Mindbreeze InSpire -Konfiguration geändert werden. Klicken Sie dazu im Feld „Services“ in der Zeile des entsprechenden Index Service auf das Symbol im Feld „Associated Index“. Erneutes Klicken ändert den Modus wieder in den Ausgangszustand

Hinweis: Ein nicht laufendes Index Service wird ebenfalls angezeigt. Der Modus des Index Service kann in diesem Fall nicht geändert werden. Um den Modus zu ändern, muss das Index Service gestartet werden.

Ändern des Index Service-Modus mit Hilfe eines Skripts

• Um den Modus des Index Service auf „Mode: readonly“ () zu ändern, führen Sie folgenden Befehl aus:
  mescontrol http://indexserver.yourcompany.com:23100 readonly
• Um den Modus des Index Service auf „Mode: running“ () zu ändern, führen Sie folgenden Befehl aus
  mescontrol http://indexserver.yourcompany.com:23100 readwrite

Sichern der Indexdaten

Mindbreeze InSpire erzeugt einen dateibasierten Index. Diese Indexdateien können in einem konsistenten Zustand vollständig gesichert werden.

Um die Indexdaten zu sichern, gehen Sie folgendermaßen vor:

1. Ändern Sie den Modus des Index Service auf „Mode: readonly” ().
2. Prüfen Sie Konsistenz des Index mit folgendem Kommando:
   mescontrol http://indexserver.yourcompany.com:23100 checkconsistency'
3. Navigieren Sie zum Indexverzeichnis und sichern Sie die enthaltenen Dateien
4. Ändern Sie den Modus des Index Service aufs “Mode: running” ()

Wiederherstellen der Indexdaten

Um den gesicherten Index wieder einzusetzen, führen Sie die folgenden Schritte aus:

1. Stoppen Sie das Index Service.
2. Löschen Sie die vorhandenen Dateien aus dem Indexverzeichnis (falls nicht mehr benötigt) oder wählen Sie in der Mindbreeze InSpire-Konfiguration für diesen Index ein anderes Verzeichnis.

Hinweis: Wenn Sie ein anderes Verzeichnis definieren, vergewissern Sie sich, dass der Servicebenutzer für den definierten Pfad Schreibrechte besitzt.

1. Kopieren Sie die gesicherten Indexdateien in das Indexverzeichnis.
2. Starten Sie das Index Service wieder.

Index Status Information

Index Statistiken

Jedes Indexservice bietet unter der URL “/statistics” detailierte Statusinformationen über den Status des Indexprozesses und die Anzahl der Dokumente:

Ein Indexservice auf dem Host “indexserver.mycompany.com” unter 23100 ist unter folgender Statistik URL erreichbar: http://indexserver.mycompany.com:23100/statistics

Indizierte Dokumente

Zusätzlich zu den Indexstatistiken können unter dem Pfad “/documents” die indizierten Dokumente mittels des Dokumentenschlüssels (anhängig vom benutzten Connector) oder der ID des Dokuments (docid) abgerufen werden. Bitte beachten Sie, dass die docid eine interne Sequenznummer ist und zwischen den Indizierungsläufen variiert.

Ein Indexservice auf dem Host “indexserver.mycompany.com” unter 23100 ist unter folgender URL erreichbar: http://indexserver.mycompany.com:23100/documents

Index Status Information abfragen

Um die Verfügbarkeit des Index Services zu überprüfen gibt es eine Statushandler, der einerseits via mescontrol abgefragt und auch direkt via HTTP aufgerufen werden kann. Für die direkte Abfrage steht ein Handler via /index_mode am jeweiligen Index Service Port zur Verfügung.

Läuft der Index Service auf dem Host indexserver.mycompany.com und horcht dieser auf 23100, kann die Status Information unter folgender Adresse abgerufen werden: http://indexserver.mycompany.com:23100/index_mode

Erhält der Index Service eine HTTP GET Anfrage, antwortet dieser mit einem XML Dokument, das folgenden Aufbau hat::

<status mode=”<status-information>” />

<status-information> beschreibt dabei den Modus des Index Services und kann folgende Werte annehmen:

• normal (read write)
• readonly
• offline (closed)

Erhält man einen HTTP Statuscode der nicht 200 (HTTP SUCCESS) lautet, deutet dies ebenso auf einen nicht betriebsbereiten Index Service hin.

Backup von Log-Dateien

Die Log Dateien werden regelmäßig archiviert. Dies wird mittels einen Cron-Jobs durchgeführt, der standardmäßig jeden Sonntag um 2:30 läuft.

Dabei werden Logdateien aus den Pfaden /data/logs und /var/opt/mindbreeze/log archiviert und in /data/backups/log-backups abgelegt.

Binäre Dateien werden nicht gesichert sondern beim Backup entfernt.

Von sehr großen Dateien werden nur die ersten 50GB gesichert.

Anhang A

Service Neustartverhalten bei Konfigurationsänderungen

• **   Nur jene Services, die von den Änderungen betroffen sind (z.B. welche Authentisierung benutzen) werden neugestartet.

Anhang B

Manuelle Konfiguration der Authentifizierung mittels Kerberos

Für die manuelle Konfiguration ist folgendes nötig:

• Setzen des Service Principal Names HTTP/<host_fqdn> für den Servicebenutzer mittels setspn.exe oder händisch mitttels adsiedit.msc. Der <host_fqdn> ist der voll qualifizierte Hostname des Mindbreeze InSpire Node.
  
  setspn -a HTTP/myserver.mydomain.com DOMAIN\serviceuser
  
  Wichtig ist hierbei, dass der SPN für kein anderes Active Directory Objekt gesetzt ist. Dies kann unter Windows Server 2008 Systemen mittels "setspn -X" oder mit Hilfe von externen Tools wie zum Beispiel "dumpspn" überprüft werden.

Setzen von "Trusted for delegation" für den Servicebenutzer mittels des "Benutzer und Computer" Management Console Plugins (dsa.msc).

Anhang C

In diesem Anhang finden Sie Beschreibungen zur Administration einzelner Komponenten von Mindbreeze InSpire.

Web Client Browsereinstellungen

Es gibt Sicherheitseinstellungen des Browsers, die den Komfort für Nutzer einschränken. So werden im Standardfall Links von Webseiten zu Dateiressourcen (z.B. file://myserver.mycompany.com/freigabe/brief.doc) nicht geöffnet. Zusätzlich werden Kerberos-Tickets nicht an das  Mindbreeze InSpire Web Client Service weitergegeben: Mindbreeze InSpire setzt Netzwerk Single-Sign-On via Kerberos voraus, um einen sicheren und effizienten Zugriff auf Suchtreffer im Netzwerk zu erlauben. Im folgenden wird beschrieben, wie die Einstellungen des Browsers so gesetzt werden können, dass sowohl Verknüpfungen zu lokalen Dateien geöffnet, als auch die Konfiguration der Kerberos Single-Sign-On Umgebung ordnungsgemäß funktioniert.

Mozilla Firefox - Manuelles setzen der Einstellungen

Die Einstellungen, die bei der Installation der Erweiterung gemacht werden, können selbstverständlich auch manuell gesetzt werden. Um unter Mozilla Firefox eine Liste der Konfigurationsmöglichkeiten sichtbar zu machen, muss in der Adressleiste „about:config“ eingegeben werden.

Um Kerberos Authentifizierung gegen das Mindbreeze InSpire Client Service zu erlauben, sollten folgende Einstellungen ähnlich zu den Beispielen gesetzt sein:

Nach einem Neustart von Mozilla Firefox sollte die Anmeldung an das Mindbreeze InSpire Client Service über Kerberos funktionieren.

Zusätzlich soll es möglich sein, dass die Mindbreeze InSpire Web Client Dateien öffnen kann, die auf einem Netzlaufwerk liegen. Für Firefox 1.0.x, der Mozilla Browser Suite 1.7.x und früheren Versionen  gibt es lediglich eine globale Einstellungsmöglichkeit. Durch Setzen der Einstellung „security.checkloaduri“ auf „false“ können alle Internet Seiten auf lokale Dateien verlinken und diese auch öffnen. Anschliessend muss der Browser neu gestartet werden.

Warnung: Diese Einstellung könnte von potentiell böswilligen Seiten genutzt werden, um lokale Dateien auszuführen.

In neueren Versionen (Mozilla Firefox 1.5, Mozilla Seamonkey 1.0 und neuer) kann diese globale Einstellung durch Sicherheitsrichtlinien, die auf bestimmte Seiten eingegrenzt werden können, ersetzt werden.

Neue Richtlinien können über die Datei user.js hinzugefügt werden. Diese liegt – sofern vorhanden - im Profilordner des jeweiligen Benutzers
(z.B.: C:\Dokumente und Einstellungen\Mindbreeze User\Anwendungsdaten\Mozilla\Firefox\Profiles\jisttzus.default\user.js).
Existiert die Datei noch nicht, muss die Datei angelegt werden.

Folgende Einstellungen müssen in die Datei eingefügt werden:

Bemerkung: Sind in der Infrastruktur mehrere Web Clients vorhanden, die von einem Rechner aus abgerufen werden sollen, so können auch zusätzliche Adressen – durch Leerzeichen getrennt – hinzugefügt werden.

Bemerkung: Die Datei „%USERPROFILE%\Anwendungsdaten\Mozilla\Firefox\profiles.ini“ gibt Aufschluss darüber in welchem Unterverzeichnis das gewünschte Profil zu finden ist, falls mehrere Profile verwendet werden.

Microsoft Internet Explorer

Manuelles setzen der Einstellungen

Im Microsoft Internet Explorer setzen Sicherheitszonen das Sicherheitskonzept um. Ohne die Einstellungen zu ändern, befindet sich jede Seite in der Zone „Internet“. Um dem Web Client die nötigen Rechte einzuräumen, fügen Sie die URL des Mindbreeze InSpire Web Client Service zur Sicherheitszone „Lokales Intranet“ hinzu.

Klicken Sie in der Statuszeile im rechten Bereich auf das Globus Symbol doppelt und markieren  Sie im Reiter „Sicherheit“ die Sicherheitszone „Lokales Intranet“. Über die Schaltfläche „Sites“, gelangen Sie zu einem Dialogfenster, über welches die Adresse des Mindbreeze InSpire Web Client Service hinzugefügt werden kann.

Sie müssen sowohl die http- als auch die https-URL hinzufügen.

Beispiel: Ihr Mindbreeze InSpire Web Client Service wird vom Rechner myserver.mycompany.com verfügbar gemacht. Daher fügen Sie die Adressen

http://myserver.mycompany.com und

https://myserver.mycompany.com

zur Liste hinzu.

Stellen Sie außerdem sicher, dass die Option „Gemischte Inhalte anzeigen“ für das lokale Intranet aktiviert ist. Sie können diese Einstellung durch einen Klick auf „Stufe anpassen“ überprüfen.

Zusätzlich sollten Sie die Option “Verschlüsselte Seiten nicht auf der Festplatte speichern“ im „Erweitert“ Tab deaktiveren.

Um die Änderungen zu übernehmen, laden Sie die Web Client Seite neu, nachdem die Adresse des Web Clients zur Intranetzone hinzugefügt wurde.

Automatisches setzen der Einstellungen

Um den Microsoft Internet Explorer automatisch für alle Mitglieder Ihrer Domäne zu konfigurieren, kann die Adresse der Client Service Webseite auch über die Gruppenrichtlinien zu den vertrauenswürdigen Webseiten hinzugefügt werden.

Als ersten Schritt müssen Sie sich dafür als ein Mitglied der Domänenadministratoren an Ihrem Domänen-Controller anmelden.

Danach starten Sie das Verwaltungswerkzeug „Active Directory, Benutzer und Computer“. Öffnen sie mit einem Rechtsklick das Kontextmenü der Organisationseinheit, auf die die Änderung der Einstellung durchgeführt werden soll, und wählen Sie dort den Menüpunkt Eigenschaften aus.

Wählen Sie als nächsten Schritt den Reiter Gruppenrichtlinie aus. Dort fügen Sie über die Schaltfläche „Neu“ eine neue Gruppenrichtlinie hinzu und benennen sie diese entsprechend (z.B.: MES IE Config). Klicken Sie dann auf die Schaltfläche „Bearbeiten“.

Im folgenden Abschnitt wird erklärt wie man die Konfiguration des Internet Explorers über Gruppenrichtlinien vornimmt.

Nach dem Öffnen der Gruppenrichtlinie, clicken Sie mit der rechten Maustaste auf Administrative Vorlagen und clicken sie auf „Filterung…“.

Deaktivieren Sie im folgenden Dialog “Nur vollständig verwaltbare Richtlinieneinstellungen anzeigen”.

Als nächstes werden wir die administrative Vorlage für die Internet Explorer Einstellungen hinzufügen.

Clicken Sie zuerst mit der rechten Maustaste auf „Administrative Vorlagen“ und clicken auf „Vorlagen hinzufügen/entfernen“.

Fügen Sie im folgenden Dialog die Datei “MindbreezeEnterprise SearchWebclient.adm” zu ihren Vorlagen hinzu. Diese Datei finden sie im Mindbreeze InSpire Installations ZIP / ISO.

Nachdem Sie die administrative Vorlage hinzugefügt haben, aktivieren Sie bitte alle Optionen.

Um den Mindbreeze Webclient zu ihren „Vertrauenswürdigen Sites“ hinzuzufügen, navigieren Sie danach durch „Benutzereinstellungen“ > „Windows-Einstellungen“ > „Internet Explorer-Wartung“ > „Sicherheit“ bis Sie in der rechten Hälfte den Punkt „Sicherheitszonen und Inhaltsfilter“ sehen. Öffnen Sie dort mit einem Rechtsklick das Kontextmenü und wählen Sie den Menüpunkt „Eigenschaften“ aus.

Im nächsten Schritt wählen Sie den Punkt „Aktuelle Einstellungen für Sicherheitszonen und Datenschutz importieren“ aus. Bestätigen Sie das Popupfenster mit „Weiter“. Sie können nun die Schaltfläche „Einstellungen ändern“ klicken.

Standardmäßig ist nun die Zone „Internet“ markiert, wechseln Sie zur Zone „Lokales Intranet“. Danach klicken Sie die Schaltfläche „Sites“. In manchen Fällen öffnet sich nun ein Dialog in dem Sie definieren können, welche Seiten der Lokalen Intranet Zone angehören. Betätigen Sie hier bitte die Schaltfläche „Erweitert“. Nun können Sie die Adresse des Web Clients hinzufügen. Führen Sie hier bitte eine Adresse für das http und eine für das https Protokoll an (z.B.: http://myserver.mycompany.com und https://myserver.mycompany.com).

Zusätzlich können Sie auch das Zertifikat von Mindbreeze InSpire in die Liste der vertrauenswürdigen Zertifikate einfügen. Dies wird benötigt damit bei einer Verbindung über https der Web Client eindeutig identifiziert werden kann. Dazu navigieren Sie bitte durch Computerkonfiguration > Windows-Einstellungen > Sicherheitseinstellungen > Richtlinien öffentlicher Schlüssel zum Knoten „Vertrauenswürdige Stammzertifizierungsstellen“. Öffnen Sie mit einem Rechtsklick auf diesen das Kontextmenü und wählen Sie dort den Punkt „Importieren“.

Den ersten, nun erscheinenden, Dialog bestätigen Sie bitte mit „Weiter“. Im nun erscheinenden Dialog wählen Sie das Zertifikat von Mindbreeze InSpire aus. Dieses befindet sich im Installationsordner (z.B. C:\Programme\Mindbreeze\Enterprise Search\Server) und trägt den Namen ca-mindbreeze.pem. Bestätigen Sie den nächsten Dialog mit „Weiter“ und den darauf folgenden mit „Beenden“

Nun sollte sich unter „Vertrauenswürdige Stammzertifizierungsstellen“ ein Eintrag mit dem Namen Mindbreeze MES Server Authority befinden. Schließen Sie jetzt alle offenen Fenster und Dialoge die im Zusammenhang mit dem Verwaltungswerkzeug „Active Directory, Benutzer und Computer“ geöffnet wurden. Die Änderungen sollten nun nach einem Neustart aktiviert werden. Sie können nun den Mindbreeze Enterprise Web Client auf Microsoft Internet Explorer in Ihrer Domäne uneingeschränkt benutzen.

Anhang

Fabasoft app.telemetry Log Pools installieren für die Mindbreeze Services

Log Definitionen herunterladen

Sie können die Fabasof app.telemetry Log Definitionen für die Mindbreeze Services von der Mindbreeze Konfigurationsoberfläche herunterladen. Wählen Sie dazu den „Overview“ Karteireiter aus und klicken Sie auf dem Link „Fabasoft app.telemetry log definitions and Dashboards“.

Nachdem Sie den apptelemetryconfig.zip Archiv erfolgreich heruntergeladen und extrahiert haben, finden Sie die Log Definition Files im Verzeichnis „Logdefinitions“. Die folgenden Files sind hier enthalten:

• apptelemetrylogdefinitions_clientservice.xml: Log Definition File für die  Mindbreeze Client Services;
• apptelemetrylogdefinitions_client.xml: log definition file for the Mindbreeze JavaScript Clients;
• apptelemetrylogdefinitions_contentfilterservice.xml: Log Definition File für  Mindbreeze Content Filter Services;
• apptelemetrylogdefinitions_crawlerservice.xml: Log Definition File für die Mindbreeze Crawler Services;
• apptelemetrylogdefinitions_filterservice.xml: Log Definition File für die Mindbreeze Filter Services;
• apptelemetrylogdefinitions_indexservice.xml: Log Definition File für die Mindbreeze Index Services;
• apptelemetrylogdefinitions_jobsyncservice.xml: Log Definition File für die JobSync Services (wird bei die Mindbreeze InSite Installationen verwendet);
• apptelemetrylogdefinitions_networkrequests.xml: Log Definition für ein Netzwerkabfragen Log Pool für Mindbreeze Web Crawlers;
• apptelemetrylogdefinitions_queryservice.xml Log Definition File für Mindbreeze Query Services;
• apptelemetrylogdefinitions_sdkcsandbox.xml: Log Definition File für Mindbreeze SDKCsandbox services;
• apptelemetrylogdefinitions_tenantqueryservice.xml: zusätzliches Log Definition File für multitenant Query Services.
• apptelemetrylogdefinitions_crawlerservicerun.xml: zusätzliches Log Definition File für die Crawl Runs aller Datenquellen.

Log Pools anlegen für die Mindbreeze Services in Fabasoft app.telemetry

Die nötige Schritte für Log Pools zu definieren finden Sie unter folgenden Link:

http://help.apptelemetry.com/doc/Installation-Guide-for-Fabasoft-apptelemetry/using-software-telemetry-log-pools-and-top-x-reports.htm.

Auf dem „Log Pool Properties“ Karteireiter in der Log Pool Konfiguration die folgende „Application Filter“ Parameter sollen für die Mindbreeze Log Pools gesetzt werden:

• Application: Mindbreeze
• Application Tier:
  • “Client” für Mindbreze Client Log Pools
  • “Client Service” für Mindbreeze Client Service Log Pools
  • “Client Service Query Log” für Mindbreeze Client Service Query Log - Log Pools
  • “Content Filter Service” für Content Fitler Service Log Pools
  • “Index Service” für Index Service Log Pools
  • “Query Service” für Query Service Log Pools
  • “Sandbox” für SDKCsandbox für Service Log Pools.
  • “Sandbox” für SDKCsandbox für Service Log Pools.
  • “Crawler Service Run” für Crawler Run Log Pools.