Verwenden des Clients von d.velop documents repo export

d.velop documents repo exporter ist eine Clientlösung, die direkt mit der Export-API (Cloud und On-Premises) kommunizieren kann. Mit d.velop documents repo exporter können Sie den Datenexport für Ihre Kunden vereinfachen.

Es handelt sich um eine Clientanwendung, die Sie aus der Windows-Eingabeaufforderung starten können. Sie können den Client über das Paket d.3 server tools beziehen. Der Client abstrahiert die HTTP-Kommunikation zur Export-API und lädt die konfigurierten Dokumente in ein definierbares Zielverzeichnis.

Die Clientanwendung bietet Ihnen folgende Funktionen:

Sie können den Client per Konfigurationsdatei einstellen und mit entsprechenden Parametern starten.
Zur Protokollierung können Sie d.velop logfile viewer (d.3 logview) verwenden. Zusätzlich können Sie festlegen, dass Meldungen in einer separaten Textdatei protokolliert werden.

Voraussetzungen:

Die Export-API ist erreichbar, installiert und aktiviert.
Ein Exportverzeichnis ist vorhanden, auf dem die Metadaten und die Originaldateien gespeichert werden können. Die Dokumente werden beim Export basierend auf der Verzeichnisstruktur (Dokumentenbaum) gespeichert.

Aufbau der Datei "Config.json"

Die Konfigurationsdatei umfasst Folgendes:

Benutzerinformationen des Quellsystems (On-Premises: Benutzername und Kennwort, Cloud: Repository-ID und API-Schlüssel)
URL, unter der d.velop documents repo exporter erreichbar ist.
Filter zum Festlegen der Dokumente, die exportiert werden sollen.

Anmerkung

Die Basisadresse der Export-API wird beim Start in der Ausgabe protokolliert.

Die Konfigurationsdatei ist wie folgt aufgebaut:

{
  "baseUrl" : "<http://127.0.0.1:8333>",
  "user" : "<exportUser>",
  "password" : "<passsword>",
  "repoId" : "<uuid>",
  "apikey" : "<apikey>",
  "timeout" : "<seconds>",
  "proxyPort" : "<port>",
  "proxyHost" : "<ProxyIp>",
  "filter" : {
      "modifiedAfter": "<2017-11-07T13:27:37.643Z>",
      "modifiedBefore": "<2023-01-01T01:01:01.001Z>",
      "numberOfProcesses": <2>,
      "documentTypesByD3Id": [],
      "documentTypesById": [],
      "docIds": [],
      "batchSize": <200>
  }
}

Soweit nicht anderweitig definiert können Sie alle Parameter aus der Eingabeaufforderung auch in der Konfigurationsdatei eintragen.

Im Folgenden finden Sie Beschreibungen zu den Parametern in der Konfigurationsdatei:

Parameter	Beschreibung
user	Benutzername des Benutzers mit Berechtigungen zum Exportieren Weitere Informationen zum Verteilen von Berechtigungen: Konfigurieren von Benutzerrechten für die Cloud
password	Optional: Kennwort des Benutzers, der Dateien exportiert
apikey	Relevant für die Cloud: API-Schlüssel des Benutzer mit Berechtigungen zum Exportieren
timeout	Optional: Request Timeout Standard: 300 Sekunden
filter	Einschränkungsfilter für den Datenexport Weitere Informationen: Festlegen des Exportfilters

Starten des Clients per Windows-Eingabeaufforderung

Sie können d.velop documents repo exporter mit der Windows-Eingabeaufforderung (cmd) starten. Fügen Sie die folgende Eingabeaufforderung ein und passen Sie die Werte entsprechend Ihrer Bedürfnisse an:

export_client.exe --configFile <pathToConfig.json> <optionale Parameter>

Der Export erfolgt nach Start der Anwendung automatisch.

Im Folgenden finden Sie Beschreibungen zu den Parametern der Eingabeaufforderung:

Parameter	Optional	Beschreibung
--configFile	n	Pfad zur Konfigurationsdatei für den Client. Verpflichtend beim Start der Anwendung zu übergeben.
--baseUrl	n	Basisadresse der d.velop documents repo exporter-API.
--exportPath	n	Pfad zum Zielverzeichnis für den Export (Speichern der Originaldatei und der zugehörigen Metadaten). Verpflichtend in der Eingabeaufforderung oder in der Konfigurationsdatei zu übergeben.
--repoId	-	Repository ID des zu exportierenden d.velop documents-Systems. Verpflichtend bei der Verwendung der in d.velop documents eingebetteten export-API. Dies betrifft aktuelle d.velop documents-Systeme sowie Exporte aus der Cloud. Wenn Sie die eigenständige d.velop documents repo export-API verwenden, müssen Sie diesen Konfigurationswert auslassen. Das d.velop documents-System, das exportiert werden soll, wird über die Startparameter der d.velop documents repo exporter-API festgelegt.
--exportWithFiletype	n	Diese Konfiguration ermöglicht das Exportieren unter Beibehaltung bekannter Dateierweiterungen. Dieser Modus eignet sich nicht für anschließende Migrationen oder Importe in d.velop documents.
--exportMetadataOnly	n	Es werden nur die Metadaten aus d.velop documents exportiert. Dieser Modus kann zum Beispiel zur Analyse der Metadaten verwendet werden.
--exportRepositoryConfigOnly	n	Der Client erfragt nur die Konfiguration des zu exportierenden d.velop documents-Systems und beendet sich nach dem Speichern der Konfiguration.
--logFile (optional)	n	Pfad und Name einer Protokolldatei (Logdatei). Die Datei beinhaltet das gesamte Protokoll des Exports und wird laufend ergänzt. Die Datei ist nicht rollierend und kann daher viel Speicherplatz einnehmen. Wir empfehlen, eine Sicherheitskopie der Datei anzufertigen, bevor Sie d.velop documents repo exporter erneut ausführen.
--logLevel (optional)	n	Protokolliergrad (Loglevel, Standard: 6) Die Werte liegen zwischen 0 bis 9 (0: keine Protokollierung, 9: maximale Debug-Protokollierung).
--proxyHost	n	Hostname oder IP eines HTTP/HTTPS Proxys. Authentifizierung am Proxy wird nicht unterstützt.
--proxyPort	n	Port eines HTTP/HTTPS Proxys
--ignoreCertificates	n	Erlaubt das Verwenden von ungültigen und selbstsignierten Zertifikaten.
--startLink	n	Verwenden Sie diesen Parameter, wenn ein vorheriger Export gescheitert ist und URL des letzten erfolgreichen Blocks bekannt ist. Dieser Startparameter umgeht alle ggf. festgelegten Filter.
--help	n	Zeigt eine Hilfe zu den Startparametern an und beendet die Anwendung.

So exportieren Sie aus der Cloud: Geben Sie in der Konfigurationsdatei für die Parameter repoId und apikey die entsprechenden Werte an.

Anschließend werden die Dokumente im angegebenen Ordner (exportPath) basierend auf der Verzeichnisstruktur (Dokumentenbaum) gespeichert, mitsamt der JSON-Darstellung der Metadaten. Wenn Sie die entsprechende Option ausgewählt haben, werden zusätzlich die Stammdaten im angegebenen Ordner gespeichert.

Verhalten bei Fehlern

Informationen über exportierte Dokumente werden in den Dateien error_log_<Nummer>.json gespeichert. Die Dateien werden fortlaufend nummeriert. Die Dateien werden nach 1.000.000 Dokumenten oder nach 100 Fehlern erzeugt. Nach 100.000 Dokumenten wird ein Protokoll geschrieben.

Beispiel eines Fehlers in "error_log_0.json":

 {
  "errorBatches": [
    {
      "filter": {
        "docIds": [
          "P000000005",
          "P000000079",
          "P000009725",
          "P000009729",
          "P000009731",
          "P000009733",
          "P000009735",
          "P000009737",
          "P000009739",
          "P000009742"
        ]
      },
      "link": "/repo/export?startDocId=P000000005&batchNumber=0&docIds=P000000005,P000000079,P000009725,
P000009729,P000009731,P000009733,P000009735,P000009737,P000009739,P000009742&bS=100"
    }
  ]
}

Beschreibung: