Menü der Dokumentation

Konfigurieren der Anwendungsfälle in der Weboberfläche

Aufrufen der Konfigurationsseite

Sie erreichen die Konfigurationsseite am einfachsten über die Verknüpften Seiten des d.ecs monitor for d.3 repositories-Prozesses in d.ecs monitor.

Alternativ können Sie über die folgende URL die Konfiguration von d.ecs monitor for d.3 repositories direkt aufrufen:

https://<base-address>/monwd3r<hostname>/config/repositories

Arbeiten mit der Konfigurationsliste

Die erste Ansicht zeigt die Konfigurationsliste. Auf dieser Seite bekommen Sie eine Übersicht über alle derzeit existierenden Überwachungen der Anwendung. In der Tabelle werden folgende Informationen aufgelistet:

  • Aktiv: Zeigt an, ob die Überwachung derzeit durchgeführt wird.

  • Titel: Der Name der Überwachung.

    Der Name wird zusammengesetzt aus den von Ihnen vergebenen Werten der Konfiguration. So beschreibt der Name bestmöglich den Inhalt der Konfiguration.

Im Bearbeitungsmodus ist zusätzlich die Schaltfläche Neue Konfiguration verfügbar. Über diese Schaltfläche können Sie neue Konfigurationen angelegen.

Arbeiten mit der Detailansicht

Mit einem Klick auf einen Eintrag der Konfigurationsliste öffnen Sie die Detailsansicht der entsprechenden Konfiguration.

In der Detailansicht einer Konfiguration sehen Sie die Übersicht und können Anpassungen von allen Überwachungswerten vornehmen. Es stehen Ihnen zwei Möglichkeiten zum Aufruf der Detailseiten zur Verfügung:

  • Öffnen Sie die Detailseite über die Konfigurationsliste.

  • Öffnen Sie die Detailseite in d.ecs monitor im Bereich Aktionen.

In der Menüleiste der Konfiguration, im Bearbeitungsmodus, können Sie über die Schaltfläche Test ausführen die aktuellen Konfigurationswerte testen.

Übersicht der Funktionswerte

Die Werte haben die folgenden Bedeutungen:

  • Aktiv: Ermöglicht Ihnen das Deaktivieren bzw. Aktivieren einer Konfiguration. Nur eine aktive Konfiguration wird überwacht.

  • Repository: Einstellungen zum d.3 Repository, welches überwacht werden soll.

Innerhalb dieses Formularbereiches gibt es einen Absprungpunkt, der Ihnen beim Bestimmen der benötigten Eingaben helfen kann. Springen Sie mithilfe des entsprechenden Icons zu verschiedenen Konfigurationen anderer Apps ab. Für diese Funktion muss jeweils eine gültige Basis-URI angegeben sein.

Anmerkung

Diese Navigationen funktionieren nur, wenn der derzeit angemeldete Nutzer auch auf die verlinkten Konfigurationen via d.ecs shell bzw. d.ecs identity provider zugreifen kann.

  • Basis-URI: Die Adresse von d.ecs http gateway, unter der das d.3 Repository verfügbar ist.

  • API Zugriffsschlüssel: Ein berechtigter Zugriffsschlüssel von d.ecs identity provider. Die Berechtigungen müssen den Zugriff auf die d.3 Repositories erlauben.

    Hier können Sie zur Konfiguration der Zugangsschlüssel in d.ecs identity provider springen.

  • d.3 Benutzername: Der Benutzername passend zum angegebenen API Zugriffsschlüssel.

  • Typ: Die Auswahlmöglichkeit auf welche Weise das d.3 Repository angesprochen werden soll.

    Der Typ gibt an, gegen welche der folgenden Schnittstellen der Test erfolgen soll:

    • d.3one

      Beim Typ d.3one wird der Test gegen die d.3one-Schnittstelle ausgeführt.

    • d.3 server

      Beim Typ d.3 server wird der Test gegen die d.3 server-Schnittstelle ausgeführt.

  • Repository: Der Anzeigename des d.3 Repository. Über eine entsprechende Abfrage werden innerhalb des Dropdown-Menüs alle möglichen Repositories zur Auswahl aufgelistet, sofern auf Basis der oben angegebenen Informationen welche vorhanden sind.

Übersicht der Anwendungsfälle

Sie bestimmen, welche Aktionen zum Test bzw. zur Überwachung im d.3 Repository ausgeführt werden sollen. Für ein Repository können die einzelnen Anwendungsfälle beliebig aktiviert und konfiguriert werden.

Folgende Anwendungsfälle stehen Ihnen zum Test der Anbindung eines d.3 Repositories zur Verfügung:

  • Volltextsuche nach Dokument-ID

  • Attributsuche nach Dokument-ID

  • Volltextsuche nach Begriff

  • Import, Suche und Löschen von Dokument

Bei sämtlichen Anwendungsfällen gibt es die folgende Konfiguration:

  • Intervall [min]: Sie geben hier die Laufzeit der Überwachung dieses Anwendungsfalles vor. Die Angabe erfolgt in Minuten.

    Folgende Minimalwerte sind vorgegeben:

    • 1 Minute bei Volltextsuche nach Dokument-ID, Attributsuche nach Dokument-ID und Volltextsuche nach Begriff.

      Anmerkung

      Bei jedem Durchlauf eines Suchanwendungsfalls wird die jeweils konfigurierte Suche fünf Mal abgesetzt und der Mittelwert der Laufzeiten ermittelt.

    • 5 Minuten bei Import, Suche und Löschen von Dokument.

Für die spezifischen Anwendungsfälle sind zusätzlich nachfolgende Konfigurationen möglich. Per Info-Icon neben dem Anwendungsfall-Titel wird der jeweilge Anwendungsfall näher erläutert.

  • Volltextsuche nach Dokument-ID: In diesem Anwendungsfall wird die Volltextsuche nach einer zufälligen Dokument-ID überwacht.

    Konfigurieren Sie einen Bereich von Bereichsstart bis inklusive Bereichsende, indem Sie je eine Dokument-ID angeben. Bei jedem Analysedurchlauf wird eine zufällige Dokument-ID innerhalb dieses Bereiches ermittelt. Nach dieser Dokument-ID wird eine Volltextsuche per API-Call ausgeführt.

  • Attributsuche nach Dokument-ID: In diesem Anwendungsfall wird die Attributsuche nach einer zufälligen Dokument-ID überwacht.

    Konfigurieren Sie einen Bereich von Bereichsstart bis inklusive Bereichsende, indem Sie je eine Dokument-ID angeben. Bei jedem Analysedurchlauf wird eine zufällige Dokument-ID innerhalb dieses Bereiches ermittelt. Nach dieser Dokument-ID wird eine Attributsuche per API-Call ausgeführt.

  • Volltextsuche nach Begriff: In diesem Anwendungsfall wird die Volltextsuche nach einem Suchbegriff überwacht. Geben Sie unter Suchbegriff den Text ein, nach dem bei einem Analysevorgang gesucht werden soll.

  • Import, Suche und Löschen von Dokument: In diesem Anwendungsfall werden mehrere Teilschritte überwacht.

    Geben Sie unter Dokumentartkürzel das Kürzel für die Dokumentart an.

    Geben Sie unter Dateigröße die gewünschte Dateigröße in Kilobytes an. Bei jedem Analysedurchlauf wird ein Testdokument mit generiertem Inhalt in der vorgegebenen Dateigröße zunächst importiert, dann gesucht und abschließend gelöscht.

    Im Feld Aktuell genutzte Dokument-ID können Sie die Dokument-ID abgelesen, die für diesen Analysedurchlauf genutzt wird. Diese Dokument-ID wird dabei beim ersten Ausführen ermittelt und anschließend wiederverwendet. Damit dies funktioniert, wird initial eine Freigabeversion für diese Dokument-ID angelegt. Aus Performancegründen und für die Nachvollziehbarkeit der Messwerte wird die Dokument-ID nach 1000 Vorgängen neu ermittelt.

    Anmerkung

    Bei Anpassungen an der Konfiguration muss die Dokument-ID gegebenenfalls neu ermittelt werden. Das generierte Testdokument, welches initial in die Freigabe importiert wird, kann dabei über den Bemerkungstext "Test document for d.ecs monitor for d.3 repositories" identifiziert werden.

    Warnung

    Es ist sinnvoll, die Dokumentart für den Anwendungsfall Import, Suche und Löschen von Dokument auf verschiedene Vorraussetzungen zu prüfen:

    • Erstellen Sie ggf. eine Dokumentart speziell für diesen Anwendungsfall erstellen. Dadurch wird keine andere Dokumentart mit "nicht relevanten" Dokumenten befüllt.

    • Die Dokumentart sollte nicht für die Auslagerung auf Sekundärsysteme konfiguriert sein.

    • Es sollte keine Anbindung an Rendition und keine Hook-Funktionen existieren.

    • Der eingestellter Benutzer muss das Recht haben, Dokumente zu importieren, zu suchen, freizugeben und Bearbeitungsversionen zu löschen.