Generelle Informationen für eine Cloudmigration
Voraussetzungen für eine Cloudmigration
Einschränkungen und Hindernisse einer Cloudmigration
Menü der Dokumentation
Wie exportiere ich Dokumente und Akten aus einem On-Premises-System per Export-API?
Überblick
Im Folgenden erfahren Sie, wie Sie Dokumente und Akten aus einem On-Premises-System mithilfe der d.velop documents repo export-API (Export-API) exportieren.
Hier finden Sie die API-Dokumentation: d.velop documents repo export-API
Voraussetzungen
Die Voraussetzungen der Export-API sind erfüllt.
Ihnen steht ein Benutzer zur Verfügung, der Exportberechtigungen (ab d.3 server Version 8.39.x) oder d.3-Administratorberechtigungen hat (für ältere d.3 server-Versionen).
Warnung
Sie können für den Export keinen Systembenutzer wie z.B. d3_admin verwenden.
Notwendige Komponenten
Komponente | Version |
|---|---|
d.velop documents repo export-API | aktuell |
d.velop documents repo exporter | aktuell |
d.3 server | 8.x oder höher |
So geht's
Vorbereiten des Exports
Bevor Sie mit dem eigentlichen Export starten können, bereiten Sie zunächst Ihre Systemumgebung vor.
Laden Sie d.3 server tools (mit API und Client) herunter. Sie finden die Dateien auf der entsprechenden Seite im d.velop service portal.
Führen Sie das Setup für d.3 server tools aus.
Führen Sie vor dem Export die folgenden Tools aus und nehmen die empfohlenen Reparaturen vor:
d.3 update checker
d.3 database checker
d.3 document checker
Starten der Export-API
Damit Sie Dokumente und Akten exportieren können, starten Sie zunächst die Export-API.
Ab d.3 server-Version 8.39.0 (vom 07.09.2023) ist die API bereits im On-Premises-System in der Datei dms-docs.exe vorhanden. Entsprechend entfällt das manuelle Starten in diesem Fall.
Für alle vorherigen Versionen starten Sie die Datei d.velop_documents_repo_export_API.exe, die mit d.3 server tools mitgeliefert wird (Anleitung). Sie finden die Datei unter dem Dateipfad für die d.3-Konfiguration (standardmäßig ../d3/d3server.prg/D3X).
Anmerkung
Stellen Sie sicher, dass der entsprechende Benutzer die notwendigen Berechtigungen hat. Die Informationen zu den Berechtigungen finden Sie in der API-Dokumentation. Außerdem muss es sich um einen d.3-Benutzer handeln. Ein LDAP-Benutzer reicht nicht aus.
Wir empfehlen, die Export-API in d.velop process manager zu hinterlegen und die API darüber zu starten. Ein Aufruf könnte z.B. so aussehen: C:\d3\d3server_tools\d.velop_documents_repo_export_API.exe -u dvelopExpo -c C:\d3\d3server.prg\D3T
Alternativ können Sie die API auch mithilfe der Windows-Eingabeaufforderung (cmd.exe) starten. Ein Aufruf könnte z.B. so aussehen: d.velop_documents_repo_export_API.exe -c C:\d3\d3server.prg\D3T -u dvelopExpo
Konfigurieren des Exports
Sie konfigurieren den Export mit einer JSON-Datei, die bereits als Vorlage mitgeliefert wird (d.velop_documents_repo_exporter.config.json). Sie können die angegebenen Parameter für den Export festlegen. Damit die JSON-Datei valide bleibt, stellen Sie sicher, dass u.a. die folgenden Angaben vorhanden sind:
Basisadresse, unter der die Export-API erreichbar ist. Weitere Informationen finden Sie in der API-Dokumentation.
Pfad zum Exportverzeichnis. Weitere Informationen finden Sie in der API-Dokumentation.
Benutzer (und Passwort), mit dem der Export durchgeführt werden soll und mit dem auch die Export-API gestartet wurde. Weitere Informationen finden Sie in der API-Dokumentation.
Unter filter können Sie zusätzlich festlegen, welche Dokumente und Akten exportiert werden sollen. Es gibt verschiedene Filtermöglichkeiten für Kategorien, Änderungsdatum oder Dokument-IDs. Weitere Informationen finden Sie in der API-Dokumentation.
Starten des Exports
Sie führen den Export mit dem Client d.velop documents repo exporter durch.
Sie können den Client analog zur API per Windows-Eingabeaufforderung (cmd.exe) starten. Die möglichen Aufrufparameter finden Sie in der API-Dokumentation.
Ein beispielhafter Aufruf könnte so aussehen: d.velop_documents_repo_exporter.exe --configFile d.velop_documents_repo_exporter.config.json
Beheben von möglichen Fehlern
Wenn trotz der Vorbereitung Fehler auftreten, prüfen Sie zunächst die Protokolle und Fehlermeldungen. Die Export-API protokolliert Fehler in der d.3-Protokolldatei (Logdatei). Sie können die Protokolldatei mithilfe von d.velop logfile viewer (d.3 logview) öffnen. Tragen Sie in der Spalte Source den Filter DOCEXPO ein, um die Einträge der Export-API herauszufiltern.
Die Anwendung d.velop documents repo exporter protokolliert einzelne Protokolle für Jobs, die im Exportverzeichnis abgelegt werden. Weitere Informationen zu den Protokollen finden Sie in der API-Dokumentation.