D-velop:d3one Writer
Die Komponente D-velop:d3one Writer dient zur Archivierung von Dokumenten in ein D-velop d.3-Archiv über die D3One-REST-Schnittstelle.
Hierbei werden ein Dokument sowie die zugehörigen Metadaten an den D3One-Service übertragen und gemäß der im Archivsystem definierten Ablagestruktur (Aktenplan) archiviert.
Die Übergabe erfolgt entsprechend der D3One-Schnittstellenspezifikation. Neben dem Dokumentinhalt werden strukturierte Metadaten übergeben, die für die korrekte Klassifikation und Ablage des Dokuments im Archiv erforderlich sind.
Voraussetzungen
Für eine erfolgreiche Archivierung müssen folgende fachliche und technische Voraussetzungen erfüllt sein:
- Die Person ist im Archiv bekannt (z. B. über einen vorherigen Stammdatenabzug oder Synchronisationsprozess).
- Die übergebene Dokumentenart entspricht einer im D3-Aktenplan konfigurierten Dokumentenart.
- Die übergebenen Metadaten erfüllen die vom Archivanbieter definierten Pflichtfelder und Strukturvorgaben.
Die vollständigen Anforderungen ergeben sich aus der D3One-Schnittstellenbeschreibung sowie aus der Archivkonfiguration des jeweiligen Archivanbieters.
Konfigurationsparameter
Schnittstellenverbindung
| Feld | Beschreibung |
|---|---|
| ApiKey | API-Key bzw. Bearer-Token zur Authentifizierung an der D3One-REST-Schnittstelle (Bearer-Authentifizierung). Der Token wird vom Archivanbieter bereitgestellt. |
| Base Uri | Basis-URI des D3One-Webservices. Diese Adresse wird vom Archivanbieter bereitgestellt und bildet den Einstiegspunkt für alle Archivoperationen. |
| Service User | Technischer Benutzer zur Authentifizierung an der D3One-Webschnittstelle. Der Benutzer wird vom Archivanbieter bereitgestellt und muss im Datacenter unter Communication → Ressourcen konfiguriert sein. |
Dokumentübertragung
| Feld | Beschreibung |
|---|---|
| Datei | Auswahl der zu archivierenden Datei aus dem Prozesskontext. Es können alle im Prozess erzeugten oder eingelesenen Dateiobjekte verwendet werden, die das zu archivierende Dokument beinhalten. |
| Ausgabename D3 DokumentId | Definiert den Namen des Prozessobjekts, in dem die vom Archiv zurückgegebene Dokument-ID gespeichert wird. Diese ID dient zur späteren Referenzierung des archivierten Dokuments. |
Metadatenquelle
| Feld | Beschreibung |
|---|---|
| Metadaten | Definiert das Prozessobjekt, das als Datenbasis für die Konfiguration der Meta-Eigenschaften verwendet wird. Die Felder dieses Objekts dienen als Quelle für die zu übergebenden Archivmetadaten. |
Meta-Eigenschaften
Die Meta-Eigenschaften definieren die Metadaten, die zusammen mit dem Dokument an die D3One-Schnittstelle übergeben werden.
Die Struktur und Bezeichnung dieser Metadaten richten sich nach:
- der D3One-Schnittstellenspezifikation
- dem im Archiv konfigurierten Aktenplan
- den fachlichen Vorgaben des Archivanbieters
Metadaten können dabei sowohl als Dokumentattribute als auch als Header-Informationen übergeben werden.
Konfigurationsfelder Meta-Eigenschaften
| Feld | Beschreibung |
|---|---|
| Null/Leer erlauben | Erlaubt die Übergabe leerer oder NULL-Werte für diese Meta-Eigenschaft. |
| Leere Eigenschaft erstellen | Erzwingt die Übergabe der Meta-Eigenschaft an die Schnittstelle, auch wenn kein Wert vorhanden ist. |
| Datenquelle | Definiert das Prozessobjekt, aus dem der Wert der Meta-Eigenschaft gelesen wird. |
| Default Wert | Fallback-Wert, der verwendet wird, wenn das konfigurierte Quellfeld nicht vorhanden oder leer ist. |
| Kopf-Information | Kennzeichnet die Meta-Eigenschaft als Header-Information im Request an die D3One-Schnittstelle. Die Notwendigkeit wird durch die Schnittstellenspezifikation vorgegeben. |
| Default benutzen | Erzwingt die Verwendung des Default Wert als konstanten Wert, unabhängig vom Inhalt der Datenquelle. |
| Quelle | Definiert den Feldnamen innerhalb der gewählten Datenquelle, dessen Wert als Metadatenfeld übertragen wird. |
| Ziel | Definiert den Namen der Meta-Eigenschaft, unter dem der Wert an die D3One-Schnittstelle übergeben wird. |
Verarbeitung
Die Komponente führt folgende Verarbeitungsschritte aus:
- Aufbau einer Verbindung zur D3One-REST-Schnittstelle
- Authentifizierung über ApiKey und optional Service User
- Übernahme des ausgewählten Dokuments aus dem Prozesskontext
- Generierung der Metadatenstruktur gemäß der konfigurierten Meta-Eigenschaften
- Übertragung von Dokument und Metadaten an das D3-Archiv
- Speicherung der vom Archiv zurückgegebenen Dokument-ID im konfigurierten Prozessobjekt