Konfiguration

Index-Servlets

Einleitung

Um Index-Servlets aufrufen zu können, muss zuerst ein Index gestartet werden, bei diesem Index muss auch das Kontrollkästchen „Disable Unrestricted Privileged Servlets“ deaktiviert werden. Dazu gehen Sie in Ihrer Mindbreeze InSpire Konfiguration im Reiter Indices auf Ihren gewünschten Index. Dabei müssen allerdings „Advanced Settings“ aktiviert werden.

Nun können Sie die Index-Servlets unter:

https://<Appliance>:8443/index/<IndexPortNr>

erreichen.

Index-Servlets

Aggregate

Mit diesem Index-Servlet können Sie aggregierte Werte von Dokumenten erhalten, wie zum Beispiel die Anzahl verschiedener Dokumenttitel. Folgende Optionen können dabei konfiguriert werden:

• Column Name: Hier können Spaltennamen des Indexes angegeben werden. Sie werden für die Aggregation verwendet.
• Query Constraint: Hier können Verschiedene Einschränkungen der Anfrage angegeben werden. Zum Beispiel eine Filterung nach Dokumentdatum. Die Suche ist auf Systemmetadaten (category, categoryinstance, fqcategory, mes:key, datasource/mes:key, url, extension, mes:uniformdocid, mes:date, mes:size, mes:lang, store:modificationdate, store:creationdate) beschränkt.
• Aggregation operator: Hier kann aus vier Operatoren ausgewählt werden.
• Concatenation max value count: Hier kann die maximale Anzahl der zu konkatenierenden Werte angegeben werden.
• Concatenation value order: Gibt an, wie die Werte für die „CONCAT“ Funktion sortiert werden.
• Output Format: Das Format in dem die Ausgabe erfolgt hier kann zwischen „csv“ und „protobuf_textual“ ausgewählt werden.

Documents

Mit diesem Index-Servlet können Sie einzelne Dokumente nach ihrer docID, ihrem Key oder ihrer UniformItemID durchsuchen.

• By docID: Hier können Sie die docID des gewünschten Dokuments eingeben
• By Key: Hier können Sie den Key des gewünschten Dokuments eingeben
• By UnifomItemID: Hier können Sie die UniformItemID des Dokuments eingeben.
• Output Format: Hier können Sie auswählen in welchem Format das Dokument angezeigt werden soll und welcher Inhalt dargestellt werden soll.
• Deleted documents: Hier können Sie auswählen ob auch gelöschte Dokumente in die Suche miteinbezogen werden sollen.

Find

Mit diesem Index-Servlet können Sie Suchanfragen absenden um nach Dokumenten zu suchen.

• Query: Hier können Sie ähnlich wie im Standard Mindbreeze Suchfenster eine Suchquery angeben. Die Suche ist auf Systemmetadaten (category, categoryinstance, fqcategory, mes:key, datasource/mes:key, url, extension, mes:uniformdocid, mes:date, mes:size, mes:lang, store:modificationdate, store:creationdate) beschränkt.
• Order by: Hier können Sie angeben nach welchem Kriterium die Dokumente sortiert werden sollen.
• Order Direction: Hier können sie auswählen, ob die Dokumente auf- oder absteigend sortiert werden sollen.
• Group by: Hier können Sie angeben ob und nach welchem Kriterium die Dokumente gruppiert werden sollen.
• Group by Parent Reference: Hier können Sie nach Referenzen gruppieren
• Group by Parent Reference Mode: Hier können Sie angeben, wie weit Referenziert werden soll.
• Summarize by property: Hier können Sie Dokumente mit gleichen Eigenschaften zusammenfassen, wie zum Beispiel Name oder Dateierweiterung.
• Order summarized by: Hier können Sie noch die Sortierung der Zusammenfassung ändern.
• Output Format: Hier können Sie wieder das Ausgabeformat angeben in dem die Ergebnisse angezeigt werden.
• Diacritic Similar Terms: Hier können Sie angeben, ob bei einer Suche auch Diakritische Einträge miteinbezogen werden. Zum Beispiel wird bei einer suche nach „moglich“ auch „möglich“ miteinbezogen.
• Requested Properties (CSV): Hier können Sie Explizit nach Dokumenteigenschaften suchen. Mehrere Eigenschaften werden wie bei CSV durch Semikolons getrennt.

Statistics

Hier können Sie Statistiken zum aktuellen Index abrufen.

• Detail Level: Hier können Sie den Detailgrad angeben in dem die Statistiken ausgegeben werden sollen.
• Output Format: Hier können Sie das Format angeben in dem die Statistiken ausgegeben werden sollen.

ProcessItems

Eine genaue Anleitung zum Index-Servlet „processitems“ finden Sie hier:

https://help.mindbreeze.com/de/index.php?topic=doc/Konfiguration---Metadaten-Anreicherung/index.htm#privileged-servlets

Wait

Das Servlet dient als Statusabfrage am Index, insbesondere für Scipts, da die Verbindung zum Servlet aufrechterhalten bleibt bis der Index fertig ist. Die Index-Konfigurationsoption „Wait for Event Servlet Update Status Interval (Seconds)“ bestimmt, in welchen Abständen ein Update gesendet wird. Der Content-Type der Antwort ist „text/event-stream" und wird im Header gesetzt. Der data Teil ist ein JSON formatierter Plain Text, dessen Content „finished“ erst in der letzten Nachricht „true“ wird.

Die Option „totalBucketCount“ gibt die Anzahl der Buckets am Index an. Diese kann steigen, wenn gerade neue Dokumente indiziert werden. Die Optionen „invertingCompleteFraction“, „mergingCompleteFraction“ und „totalCompleteFraction“ geben die Vollständigkeit in Bruchteilen an und werden durch die Multiplikation mit 100 zur Prozentangabe.

Beispiele:

data: {"event":"all_finished","finished":false,"invertingCompleteFraction":0.5,"mergingCompleteFraction":0.5,"totalBucketCount":2,"totalCompleteFraction":0.5}

data: {"event":"all_finished","finished":false,"invertingCompleteFraction":1.0,"mergingCompleteFraction":0.5,"totalBucketCount":2,"totalCompleteFraction":0.5}

data: {"event":"all_finished","finished":true,"invertingCompleteFraction":1.0,"mergingCompleteFraction":1.0,"totalBucketCount":2,"totalCompleteFraction":1.0}

Folgende URL-Parameter können verwendet werden:

• event: Schränkt ein worauf der Index warten soll. Die Werte all_finished und inverting_finished sind gültig:
  • inverting_finished: wartet nur auf die Invertierung.
  • all_finished: wartet auf Invertierung und Merging.
• update_interval: Setzt eine Zeitüberschreitung nach dem spätestens ein Update geschrieben wird. Wenn dieser Parameter nicht gesetzt ist, wird auf das „Wait for Event Servlet Update Status Interval (Seconds)“ aus der Index Konfiguration zurückgegriffen. Das minimale Interval ist 5 Sekunden.
• Hinweis: Die Abfrage ist nicht Laufzeitintensiv, allerdings müssen Threads synchronisiert werden (Lock mutex), daher wird empfohlen diese Option so hoch wie möglich einzustellen.

Siehe auch „Bereich: Inverter Settings“ bei Konfiguration - Mindbreeze InSpire - Registerkarte "Indices".