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.
Wissenswertes zum Filtern der d.velop documents-IDs On-Premises
Ab der Version Annual 2025 liefert d.velop documents On-Premises beim Abrufen der Daten zwei verschiedene Arten von IDs für Dokumenteigenschaften und Kategorien gleichzeitig zurück: Legacy-IDs und UUIDs.
Beispiel für die zurückgelieferten d.velop-IDs (ID im Legacy-Format und UUID)
// legacy
{
"key": "6",
"value": "sample record 1"
}
// uuid
{
"key": "4ce20af2-4926-4a72-b219-77eba975b247",
"value": "sample record 1"
}
Damit die Zuordnung in edoc content services korrekt funktioniert, müssen die IDs konsistent sein. Sie müssen festlegen, welche d.velop-ID-Art verwendet werden soll.
Es gibt zwei Stellschrauben, um die Filterung der d.velop documents-IDs zu steuern:
-
In der Konfiguration der DMS-App von d.velop documents mit dem Parameter Feature.UseUUIDsForMapping.
-
In edoc content services mit dem Parameter idmapping in der Verbindungszeichenfolge.
Beide Einstellungen müssen übereinstimmen, damit immer die gleiche ID-Art zurückgeliefert wird.
Festlegen des Parameters “idmapping” in der Verbindungszeichenfolge
Bei Verbindungen mit d.velop documents On-Premises können Sie in der Verbindungszeichenfolge (Connection String) den Parameter idmapping hinzufügen, um die Datensätze für Ihr System zu filtern.
Mit dem Parameter idmapping legen Sie fest, welche Art von d.velop-IDs verwendet wird: Legacy-IDs (z.B. 6) oder UUIDs, z.B. 4ce20af2-4926-4a72-b219-77eba975b247.
Standardmäßig ist der Parameter idmapping in der Verbindungszeichenfolge nicht festgelegt. Ab der Version Annual 2025 von d.velop documents müssen Sie den Parameter idmapping festlegen, damit die Zuordnung korrekt funktioniert.
Die Einstellung muss mit der Einstellung für den Parameter Feature.UseUUIDsForMapping in der Konfiguration der DMS-App von d.velop documents übereinstimmen: Verbindung mit dem Parameter “Feature.UseUUIDsForMapping” in d.velop documents
Für den Parameter idmapping in edoc content services stehen folgende Optionen zur Verfügung:
-
idmapping=legacy: Der Parameter liefert die IDs in der vom d.velop documents-System vorgegebenen Struktur zurück, z.B. 6.
-
idmapping=uuid: Der Parameter liefert die IDs im UUID-Format zurück.
-
idmapping=null (oder nicht festgelegt): Die Datensätze werden nicht nach ID-Art gefiltert. Die zurückgelieferten Daten können Legacy-IDs und UUIDs enthalten, je nach Einstellung in Ihrem d.velop documents-System.
Die Einstellungen sind abhängig von der Weiterverarbeitung in Ihrem System.
Verbindung zwischen dem Parameter “Feature.UseUUIDsForMapping” in d.velop documents und dem Parameter “idmapping”
Der Parameter idmapping in edoc content services muss mit der Einstellung für den Parameter Feature.UseUUIDsForMapping in der Konfiguration der DMS-App von d.velop documents zusammenpassen:
-
Feature.UseUUIDsForMapping=true: Verwenden Sie in der Verbindungszeichenfolge für idmapping den Wert uuid, also idmapping=uuid.
-
Feature.UseUUIDsForMapping=false: Verwenden Sie in der Verbindungszeichenfolge für idmapping den Wert legacy, also idmapping=legacy.
Wenn Sie z.B. ausschließlich Legacy-IDs verwenden möchten, müssen Sie den Parameter Feature.UseUUIDsForMapping in der d.velop documents-Konfiguration auf false festlegen.
So geht’s
-
Öffnen Sie die Konfiguration der DMS-App (d.3one DMSApp Configuration) von d.velop documents unter https://<d3one-host>/dms/config.
-
Fügen Sie im Feld Parameter name den Parameter Feature.UseUUIDsForMapping hinzu.
-
Legen Sie den Wert des Parameters auf false fest.
-
Klicken Sie auf Cache leeren (Besensymbol).
Suchen nach Dokumenten
Wenn Sie das Modul d.velop documents, d.velop cloud (REST-API) verwenden, können Sie bei der Suche nach Dokumenten nach der Kategorie von Dokumenten filtern.
Zum Filtern nach Kategorien fügen Sie im Request ein Suchkriterium mit dem Schlüssel category und der ID der Kategorie als Wert hinzu.
POST /Doucments/search
Accept: application/json
ModuleId: d3one
{
"category": "e09c63de-e217-44a8-957c-0c6e6c936d0c",
"5f28b031-399f-42e2-885b-093b3f7b66aa": "4485644",
"1623f20a-7f1d-40a9-b208-65db622c5b2c": "edoc solutions gmbh"
}
Sie können mit dem Modul d.velop documents, d.velop cloud (REST-API) auch nach Dokumenten suchen, ohne eine Kategorie anzugeben. Wenn Sie ohne Kategorie nach Dokumenten suchen, müssen die Filtereigenschaften in allen Kategorien vorhanden sein.