Menü der Dokumentation

Wie konfiguriere ich eine externe Regelprüfung?

In kundenspezifischen Einzelfällen reichen die Standardregeln von d.ecs content crawler eventuell nicht aus, um ein Objekt zu prüfen und für das Weiterverarbeiten zu markieren. In diesem Fall können Sie die externe Regelprüfung verwenden. Sie können mithilfe einer einfachen HTTP-Schnittstelle individuelle Regeln erstellen, um ein Objekt beliebig detailliert zu prüfen.

Warnung

Sie können mit d.ecs content crawler bei der Regelauswertung ein externes Skript verwenden. Die d.velop AG übernimmt keinerlei Haftung und Gewährleistung für das aufgerufene Skript und/oder die Ergebnisse, die durch die Ausführung des Skripts entstehen können.

Die externe Regelprüfung muss eine Anwendung sein, die HTTP-Aufrufe entgegennehmen, auswerten und senden kann.

Der Ablauf einer externen Regelprüfung sieht wie folgt aus:

  1. d.ecs content crawler erstellt bereits Jobs und ermittelt Objekte. d.ecs content crawler überträgt die Jobs und Objekte an die externe Regelprüfung.

  2. Die externe Regelprüfung nimmt die HTTP-Aufrufe entgegen und sendet eine Bestätigung zurück.

  3. Bestätigte Jobs werden in einen Wartezustand versetzt. Fehler werden ebenfalls entsprechend markiert.

  4. Die externe Regelprüfung führt die Regeln für die Objekte aus und meldet das Ergebnis mithilfe der entsprechenden Rückrufe an d.ecs content crawler zurück.

  5. Wenn eine Rückmeldung erfolgt, wird der entsprechende Job markiert und mit dem nächsten Durchlauf weiterverarbeitet oder die Verarbeitung wird abgebrochen.

Die Kommunikation erfolgt ausschließlich mit HTTP-POST-Aufrufen. Daten werden als application/json übermittelt.

Im Folgenden finden Sie weitere wichtige Informationen zum Aufbau der HTTP-Aufrufe und der zu übermittelnden Daten für die externe Regelprüfung.

POST-Daten für die Übertragung von d.ecs content crawler an die externe Regelprüfung 

{
  "uri": "http://server.domain.com:2000/",
  "groupwareItemIdentifier": null,
  "jobId": null,
  "successCallback": null,
  "errorCallback": null,
  "isTest": true
}

  • uri: Die URI der externen Regelprüfung.

  • groupwareItemIdentifier: Die ID des Objekts, das an die externe Regelprüfung übermittelt wird. Die IDs für HCL Domino-Objekte und Microsoft Exchange-Objekte sind unterschiedlich.

  • jobId: Die ID des Jobs, der an die externe Regelprüfung übermittelt wird.

  • successCallback: Die URI des Rückrufs bei einem Erfolg. Der Rückruf muss aufgerufen werden, wenn die externe Regelprüfung erfolgreich abgeschlossen wurde.

  • errorCallback: Die URI des Rückrufs bei einem Fehler. Der Rückruf muss aufgerufen werden, wenn bei der externen Regelprüfung ein Fehler aufgetreten ist, der eine Weiterverarbeitung verhindert. Der Rückruf soll im Job protokolliert werden.

  • isTest: Beim Wert true dienen die übermittelten Daten lediglich dem Verbindungstest. Beim Wert false gehören die Daten zu einem Job und werden verarbeitet. Da der Wert false der Standardwert ist, können Sie den Wert auch auslassen.

GroupwareItemIdentifier (HCL Domino) 

{
    "type": "DOMINO",
    "server": "dominoserver/domain",
    "database": "mail/mailuser.nsf",
    "replicaId": "C1257CB700273AAF",
    "noteId": "39CA",
    "universalId": "84A717A82EDD701DC12580ED0051F49D",
    "attachmentIdentifier": null
}

  • type: Legt fest, ob ein Objekt einem HCL Domino-System oder einem Microsoft Exchange-System angehört.

  • server: Der Name des HCL Domino Servers, auf dem sich die Datenbank und das Objekt befinden. Verwenden Sie die übliche Kurzschreibweise <Server>/<Domäne>.

  • database: Der Pfadname und Dateiname der Datenbank, in der das Objekt enthalten ist. Die Angaben sind immer relativ zum Data-Verzeichnis des HCL Domino Servers.

  • replicaId: Die Replikat-ID der Datenbank.

  • noteId: Die Note-ID des Objekts innerhalb der Datenbank.

  • universalId: Die Universal-ID des Objekts innerhalb der Datenbank.

  • attachmentIdentifier: Wenn Sie diesen Eintrag füllen, wird mit diesem Eintrag ein Attachment innerhalb eines Objekts identifiziert. Da dieser Eintrag in d.ecs content crawler nicht angewendet wird, ist der Wert immer null.

GroupwareItemIdentifier (Microsoft Exchange) 

{
    "type": "EXCHANGE",
    "exchangeStoreType": 0,
    "mailbox": "ttes@so.training",
    "parentFolderId": null,
    "entryId": "AAMkADQyMzc0YTZmLWIyM2QtNDFkOC04MDJhLWRmZDUxMTAxMDMyZQBGAAAAAAAZMnZybIySRbt8MxDtMGQbBwCUhE5mmOtWRbVwYoiZpwRcAAAAZwNIAAAhPwfg1f9rTqKq29vpQTqcAAATGKY5AAA=",
    "attachmentId": -1,
    "entryIdFormat": 1,
    "isDeletedElement": false
}

  • type: Legt fest, ob ein Objekt einem HCL Domino-System oder einem Microsoft Exchange-System angehört.

  • exchangeStoreType: Der Typ des Postfachs. Beim Wert 0 handelt es sich um das primäre Postfach des Benutzers. Beim Wert 1 handelt es sich um das Archiv-Postfach des Benutzers. Beim Wert 2 handelt es sich um den öffentlichen Ordner.

  • mailbox: Das Postfach, in dem das Objekt enthalten ist. Das Format ist die SMTP-Adresse.

  • parentFolderId: Die ID des Ordners, in dem das Objekt enthalten ist.

  • entryId: Die ID des Objektes innerhalb des Postfachs.

  • attachmentId: Wenn Sie diesen Eintrag füllen, wird mit diesem Eintrag ein Attachment innerhalb eines Objekts identifiziert. Da dieser Eintrag in d.ecs content crawler nicht angewendet wird, ist der Wert immer -1.

  • entryIdFormat: Das Format der Eintrags-ID. Beim Wert 0 handelt es sich um das MAPI-Format. Beim Wert 1 handelt es sich um das EWS-Format. Mithilfe der Exchange-Webdienste können Eintrags-IDs im MAPI-Format in das EWS-Format umgewandelt werden.

  • isDeletedElement: Gibt an, ob das Objekt im Ordner Recoverable Items enthalten ist. Standardmäßig ist das irrelevant.

POST-Daten für die Übertragung der externen Regelprüfung an d.ecs content crawler 

{
  "uri": "http://server.domain.com:2000/",
  "groupwareItemIdentifier": "{\"type\":\"DOMINO\",\"server\":\"dominoserver/domain\",\"database\":\"mail/mailuser.nsf\",\"replicaId\":\"C1257CB700273AAF\",\"noteId\":\"39CA\",\"universalId\":\"84A717A82EDD701DC12580ED0051F49D\",\"attachmentIdentifier\":null}",
  "jobId": "dfd1a0ef-bbee-477a-936f-d43342abfe75",
  "status": 4,
  "statusMessage": "Task for externally checking job dfd1a0ef-bbee-477a-936f-d43342abfe75 successfully created"
}

  • uri: Die URI der externen Regelprüfung.

  • groupwareItemIdentifier: Die ID des Objekts, das an die externe Regelprüfung übermittelt wird. Die IDs für HCL Domino-Objekte und Microsoft Exchange-Objekte sind unterschiedlich.

  • jobId: Die ID des Jobs, der an die externe Regelprüfung übermittelt wird.

  • status: Der Status, den die externe Regelprüfung an d.ecs content crawler zurückmeldet. Folgende Werte sind möglich:

    • 0 Unknown: Diesen Wert dürfen Sie nicht verwenden. Der Wert dient der internen Prüfung.

    • 1 Continue: Dieser Wert gibt an, dass die Weiterverarbeitung des Jobs durch d.ecs content crawler erfolgen kann.

    • 2 Abort: Dieser Wert gibt an, dass die Weiterverarbeitung des Jobs durch d.ecs content crawler abgebrochen werden soll und dass das Objekt zurückgesetzt werden soll.

    • 3 Error: Dieser Wert gibt an, dass ein Fehler bei der externen Regelprüfung aufgetreten ist.

    • 4 Received: Dieser Wert gibt an, dass die externe Regelprüfung die Daten von d.ecs content crawler entgegengenommen hat und auf Rückmeldung der externen Regelprüfung wartet.

    • 999 TestSuccess: Dieser Wert wird für den Verbindungstest benötigt und gibt an, dass eine Verbindung zur externen Regelprüfung erfolgreich aufgebaut wurde.

  • statusMessage: Eine optionale Meldung, die in der Übersicht der Jobs von d.ecs content crawler angezeigt wird. Insbesondere im Fehlerfall sollten Sie einen Wert angeben.

Wenn ein Objekt durch eine externe Regel nicht verarbeitet wird, muss das Objekt ein entsprechendes Flag erhalten und in einen Ordner verschoben werden, der nicht überwacht wird. Bei der nächsten Verarbeitung durch d.ecs content crawler wird dieses Objekt nicht erneut verarbeitet.

In Microsoft Exchange müssen Sie die benannte Eigenschaft DXJOB (Typ: PT_UNICODE) mit dem Wert SCP füllen.

In HCL Domino müssen Sie das Feld D3IMPORT (Typ: Text) mit dem Wert SCP füllen.