Open Documentation Menu

How do I export documents and dossiers from an on-premises system using the export API?

Overview

This section will show you how to export documents and dossiers from an on-premises system using the d.velop documents repo export API (export API).

The API documentation is available here: d.velop documents repo export API 

Prerequisites

  • The prerequisites for the export API are met.

  • You have access to a user who has export permissions (d.3 server version 8.39.x or later) or d.3 administrator permissions (for older d.3 server versions).

    Warning

    You cannot use a system user for the export, e.g. d3_admin.

Necessary components

Component

Version

d.velop documents repo export API

Latest

d.velop documents repo exporter

Latest

d.3 server

8.x or higher

This is how it works
Preparing for the export

Before you can start the actual export, you first need to prepare your system environment.

  1. Download d.3 server tools (with API and client). You can find the files on the corresponding page in the d.velop service portal.

  2. Execute the setup for d.3 server tools.

Before starting the export, execute the following tools and carry out the recommended repairs.

  • d.3 update checker

  • d.3 database checker

  • d.3 document checker

Starting the export API

In order to export documents and dossiers, you first have to start the export API.

For d.3 server version 8.39.0 (from 09/07/2023) and later, the API is already available in the on-premises system in the file dms-docs.exe. Manual starting is therefore not necessary in this case.

For all previous versions, launch the file d.velop_documents_repo_export_API.exe that was delivered with d.3 server tools (guide). You will find the file at the file path for the d.3 configuration (by default ../d3/d3server.prg/D3X).

Note

Please make sure that the user has the necessary permissions. Information on permissions can be found in the API documentation. The user must also be a d.3 user. An LDAP user is not sufficient.

We recommend entering the export API in d.velop process manager and starting the API from here. The call might look as follows: C:\d3\d3server_tools\d.velop_documents_repo_export_API.exe -u dvelopExpo -c C:\d3\d3server.prg\D3T

Alternatively you can start the API using the Windows command prompt (cmd.exe). The call might look as follows: d.velop_documents_repo_export_API.exe -c C:\d3\d3server.prg\D3T -u dvelopExpo 

Configuring the export

You can configure the export using a JSON file that was included as a template (d.velop_documents_repo_exporter.config.json). You can define the parameters for the export. To keep the JSON file valid, make sure to enter at least the following:

  • Base address at which the export API can be reached. You can find further information in the API documentation.

  • Path to the export directory. You can find further information in the API documentation.

  • User (and password) that will be used to perform the export and that started the export API. You can find further information in the API documentation.

Under filter you can also define which documents and dossiers will be exported. There are various filter options for categories, change date or document IDs. You can find further information in the API documentation.

Starting the export

You can carry out the export using the d.velop documents repo exporter client.

You can start the client using the Windows command prompt (cmd.exe) in the same way as the API. You can find the possible call parameters in the API documentation.

An example call might look as follows: d.velop_documents_repo_exporter.exe --configFile d.velop_documents_repo_exporter.config.json 

Remedying possible errors

If errors occur despite your preparations, first check the logs and error messages. The export API logs errors in the d.3 log file. You can open the log file using d.velop logfile viewer (d.3 logview). In the Source column, enter the filter DOCEXPO to filter out the entries from the export API.

The d.velop documents repo exporter application records individual logs for jobs that are stored in the export directory. You can find further information on the logs in the API documentation.