In this article you will learn about the special features and characteristics of the module d.velop documents, d.velop cloud (REST-API)(ID=d3one) in edoc content services. You use the module whenever you want to use functions in connection with d.velop documents (cloud and on-premises (AKA d.3one)).
Authentication method used in the "d.velop documents, d.velop cloud (REST-API)" module
d.velop documents offers a REST API that works with the Open Authorization 2 protocol (OAuth2). You need to create an API key in d.ecs identity provider. For more information about the authentication methods, please refer to the corresponding d.velop documentation for the d.velop infrastructure components of d.velop documents.
What happens during the "ConnectionTest" action?
If you address the GET /ConnectionTest endpoint, a login to the module is performed and a search for a fictitious document is started. This ensures that both the user and password parameters as well as the repositoryid parameter are correct.
Automatic release when changing document properties
If a document has the status Processing, the properties cannot be changed. To avoid this problem, documents in the Processing status are first released automatically and then their properties are changed.
Special features of the property IDs in d.velop documents on-premises
The REST-API of d.velop documents on-premises behaves technically partly differently than the REST-API of d.velop documents in the cloud. In some cases it can happen that the mapping does not work correctly with an on-premises system.
An important difference between the REST-API of d.velop documents on-premises and the REST-API of cloud systems are the IDs of the document properties. A d.velop documents cloud instance returns document property IDs in the form of UUIDs, e.g. 4ce20af2-4926-4a72-b219-77eba975b247. On-premises systems, on the other hand, return document property IDs that correspond to the field number in d.velop documents, e.g. 6.
In some cases, an on-premises system of d.velop documents returns the IDs according to the field number when retrieving the categories and the IDs in the form of UUIDs when retrieving documents. The IDs must be consistent for the mapping to work.
To ensure that the IDs are consistent and the mapping works correctly, you must define a parameter in the configuration of the DMS app.
Here's how
-
Open the configuration of the DMS app from d.velop documents at https://<d3one-host>>/dms/config.
-
In the Parameter name field, add the parameter Feature.UseUUIDsForMapping.
-
Set the value of the parameter to false.
-
Click on Empty cache (broom symbol).
With the parameter Feature.UseUUIDsForMapping with the value false, the IDs that correspond to the field number in d.velop documents are consistently sent for both the categories and the document properties. Due to the consistent IDs, the mapping works correctly.
Search for documents
If you use the module d.velop documents, d.velop cloud (REST-API), you can filter by the category of documents when searching for documents.
To filter by category, add a search criterion in the request with the key category and the ID of the category as the value.
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 ag"
}
With the module d.velop documents, d.velop cloud (REST-API) you can also search for documents without specifying a category. If you search for documents without a category, the filter properties must be available in all categories.