Übersicht über die Eigenheiten des "d.velop documents, d.velop cloud"-Moduls

In diesem Artikel lernen Sie die Besonderheiten und Eigenheiten des Moduls d.velop documents, d.velop cloud (REST-API) (ID=d3one) in edoc content services kennen. Sie verwenden das Modul immer dann, wenn Sie Funktionen in Verbindung mit d.velop documents (Cloud und On-Premises (AKA d.3one)) verwenden möchten.

Verwendete Authentifizierungsmethode im “d.velop documents, d.velop cloud (REST-API)”-Modul

d.velop documents bietet eine REST-API, die mit dem Open Authorization 2-Protokoll (OAuth2) arbeitet. Sie müssen einen API-Key in d.ecs identity provider erstellen. Weitere Informationen zu den Authentifizierungsmethoden finden Sie in der entsprechenden d.velop-Dokumentation zu den d.velop-Infrastrukturkomponenten von d.velop documents.

Was passiert bei der Aktion “ConnectionTest”?

Wenn Sie den Endpunkt GET /ConnectionTest ansprechen, wird eine Anmeldung beim Modul durchgeführt und eine Suche nach einem fiktivem Dokument gestartet. Auf diese Weise wird sichergestellt, dass sowohl die Parameter user und password als auch der Parameter repositoryid korrekt sind.

Automatische Freigabe beim Ändern von Dokumenteigenschaften

Wenn sich ein Dokument im Status Bearbeitung befindet, können die Eigenschaften nicht geändert werden. Um dieses Problem zu umgehen, werden Dokumente im Status Bearbeitung zunächst automatisch freigegeben und anschließend deren Eigenschaften geändert.

Besonderheiten bei den Eigenschafts-IDs in d.velop documents On-Premises

Die REST-API von d.velop documents On-Premises verhält sich technisch teilweise anders als die REST-API von d.velop documents in der Cloud. In einigen Fällen kann es vorkommen, dass die Zuordnung (Mapping) bei einem On-Premises-System nicht korrekt funktioniert.

Ein wichtiger Unterschied zwischen der REST-API von d.velop documents On-Premises und der REST-API von Cloudsystemen sind die IDs der Dokumenteigenschaften. Eine d.velop documents-Cloudinstanz liefert Dokumenteigenschafts-IDs in Form von UUIDs, z.B. 4ce20af2-4926-4a72-b219-77eba975b247, zurück. On-Premises-Systeme hingegen liefern Dokumenteigenschafts-IDs zurück, die der Feldnummer in d.velop documents entsprechen, z.B. 6.

In manchen Fällen liefert ein On-Premises-System von d.velop documents beim Abrufen der Kategorien die IDs entsprechend der Feldnummer und beim Abrufen von Dokumenten die IDs in Form von UUIDs zurück. Die IDs müssen konsistent sein, damit die Zuordnung (Mapping) funktioniert.

Damit die IDs konsistent sind und die Zuordnung korrekt funktioniert, müssen Sie in der Konfiguration der DMS-App einen Parameter festlegen.

So geht’s

1. Öffnen Sie die Konfiguration der DMS-App von d.velop documents unter https://<d3one-host>>/dms/config.

2. Fügen Sie im Feld Parameter name den Parameter Feature.UseUUIDsForMapping hinzu.

3. Legen Sie den Wert des Parameters auf false fest.

4. Klicken Sie auf Cache leeren (Besensymbol).

Mit dem Parameter Feature.UseUUIDsForMapping mit dem Wert false werden sowohl bei den Kategorien als auch bei den Dokumenteigenschaften konsistent die IDs gesendet, die der Feldnummer in d.velop documents entsprechen. Durch die konsistenten IDs funktioniert die Zuordnung korrekt.