Ceyoniq:Archive Writer
Die Prozess-Komponente Ceyoniq:Archive Writer dient zur Anbindung des Dokumentenarchivs nscale der Firma Ceyoniq.
Über diese Komponente können Dokumente aus dem Prozesskontext von intracon:bk zusammen mit zugehörigen Metadaten an das nscale-Archiv übertragen und dort archiviert werden.
Die Kommunikation mit dem Zielsystem erfolgt über die REST-basierte Archivschnittstelle von nscale.
Nach erfolgreicher Archivierung liefert die Schnittstelle eine Archiv-ID zurück, die im Prozesskontext gespeichert und für nachgelagerte Prozessschritte (z. B. Referenzierung, Kontakthistorie oder Archivlinkbildung) verwendet werden kann.
Konfigurationsparameter
| Feld | Beschreibung |
|---|---|
| ApiKey | API-Schlüssel zur Authentifizierung an der nscale-Archivschnittstelle. Der Schlüssel wird vom Betreiber des nscale-Systems bereitgestellt. |
| Base Uri | Basis-URL der nscale-REST-Schnittstelle. Die URI verweist auf den Endpunkt des Archivsystems, über den Dokumente und Metadaten übertragen werden. |
| Datei | Auswahl des Dateiobjekts aus dem Prozesskontext, das das zu archivierende Dokument enthält. Das Objekt wird als Dokumentinhalt an das Archiv übermittelt. |
| Ausgabename DokumentId | Definiert den Key bzw. Namen der Prozessvariablen, unter dem die vom Archiv zurückgegebene Archiv-ID im Prozesskontext gespeichert wird. |
| Metadaten | Definiert die Datenquelle im Prozesskontext, aus der die Metadaten für die Archivierung gelesen werden. In dieser Datenquelle wird auch der Wert des Feldes Ausgabename DokumentId gespeichert. |
| Instanz | Bezeichnet die Zielinstanz des verwendeten nscale-Archivs. Diese Angabe dient der Identifikation der Archivumgebung im Zielsystem. |
| DocArea | Definiert die Dokumentenablage (DocArea) innerhalb des nscale-Archivs, in der das Dokument archiviert werden soll. |
Authentifizierung
| Feld | Beschreibung |
|---|---|
| Service User | Technischer Benutzer zur Authentifizierung an der nscale-Schnittstelle, sofern die Authentifizierung über Benutzerkennung und Passwort erfolgt. Der Benutzer muss zuvor unter Communication → Ressourcen → Benutzerkonten konfiguriert werden. |
Meta-Eigenschaften
Über den Bereich Meta-Eigenschaften können zusätzliche Metadaten konfiguriert werden, die beim Archivierungsrequest an das nscale-System übertragen werden.
Diese Metadaten dienen der strukturierten Ablage und späteren Recherche der archivierten Dokumente.
| Feld | Beschreibung |
|---|---|
| Null/Leer erlauben | Steuert, ob der Wert der Eigenschaft NULL oder leer sein darf. |
| Leere Eigenschaft erstellen | Definiert, ob eine Eigenschaft mit leerem Wert dennoch an die Schnittstelle übergeben wird oder vollständig ausgelassen wird. |
| Datenquelle | Definiert die Datenquelle im Prozesskontext, aus der der Wert der Eigenschaft ermittelt wird. |
| Default Wert | Optionaler Standardwert, der verwendet wird, wenn der konfigurierte Wert aus der Datenquelle nicht vorhanden ist. |
| Default benutzen | Steuert, ob der konfigurierte Default Wert unabhängig von der Datenquelle immer verwendet werden soll. |
| Kopf-Information | Steuert, ob die Eigenschaft als Header-Information im Request an die Archivschnittstelle übertragen wird. |
| Quelle | Definiert den Schlüssel (Key) innerhalb der gewählten Datenquelle, aus dem der Wert gelesen wird. |
| Ziel | Definiert den Zielschlüssel bzw. den Namen der Eigenschaft, unter dem der Wert an die nscale-Schnittstelle übergeben wird. |