Vorgangsraum Schnittstelle zu Dokumentenmanagmentsystemen

Der Vorgangsraum kann über eine (auch automatisierbare) Tätigkeit in der Rolle eines CMIS/DokuFIS-Clients mit Dokumentenmanagementsystemen (DMS) Dateien austauschen.

CMIS / DokuFIS Adapter

Der Vorgangsraum CMIS / DokuFIS Adapter unterstützt die folgenden CMIS-Methoden:

• createFolder
• createDocument
• getDocument

Darüber hinaus können beim Abholen von Dateien Quittungen an das DMS gesendet werden und so über den Status der Abholung informieren. Außerdem ist es möglich, die kompletten Metdaten eines Vorgangs als DokuFIS-XML auszutauschen.

Verbindungsparameter

Nachfolgende Parameter sind für die Einrichtung der Schnittstelle notwendig:

• Binding-Typ (Browser oder AtomPub)
• Endpunkt
• Login und Passwort des technischen Nutzers
• Repository ID

Verzeichnis anlegen (createFolder)

Für jeden Vorgang wird ein eigenes Vorgangsverzeichnis angelegt. Hierfür werden die folgenden Parameter benötigt:

• ID des übergeordneten Verzeichnisses
  ID (cmis:objectId) des Verzeichnisses in der die Vorgangsverzeichnisse angelegt werden sollen.
• Verzeichnis Typ-ID
  Typ-ID (cmis:objectTypeId) die für zu erstellende Verzeichnisse verwendet werden soll.

Weiterhin können verschiedene Metadaten aus dem Vorgang als CMIS-Eigenschaften (Properties) übertragen werden. Hierfür muss der Name der Eigenschaft sowie der jeweilige Datentyp bekannt sein. Folgende Werte können beispielsweise übermittelt werden:

• Vorgangskennung
• Vorgangskennung Extern
• Vorgangstyp Metadaten
• Vorgang Erstellt
• Vorgang Titel
• Antragstellender Name
• Antragstellender Email
• Initiator Name
• Initiator Email
• Einreichender Name
• Einreichender Email

Datei anlegen (createDocument)

Für das Anlegen von Dateien wird der nachfolgende Parameter benötigt:

• Dokument Typ-ID
  Typ-ID (cmis:objectTypeId) die für zu erstellende Dokumente verwendet werden soll.

Ähnlich wie bei Verzeichnis anlegen, lassen sich auch bei jeder Dateiübertragung Metadaten als CMIS-Eigenschaften übermitteln. Neben den schon genannten möglichen Metdaten, gibt es zusätzlichen bei Dateien darüber hinaus:

• Datei Name
• Datei Titel
• Datei Typ
• Datei Art
• Datei Quelle
• Datei Beschreibung
• Datei Groesse
• Datei Checksumme
• Datei Medienart
• Datei UUID

Datei abholen (getDocument)

Beim Abholen von Dateien ist es außerdem möglich, CMIS-Eigenschaften als eigene Metdadaten zu importieren. So können folgende Metdaten gesetzt werden:

• Vorgangskennung Extern
• Vorgang Titel
• Taetigkeit Inhalt
• Taetigkeit Titel
• Datei Name
• Datei Titel
• Datei Art
• Datei Quelle
• Datei Beschreibung
• Datei Import Id
• Datei Zustellung

Benachrichtigungswebservice

Das DMS kann den Vorgangsraum über neue Dateien im DMS benachrichtigen, damit der Vorgangsraum als CMIS/DokuFIS-Client die Dateien vom DMS liest und verarbeitet.

Darüber hinaus ist es möglich, über den Webservice auch die Weiterverarbeitung der abgeholten Datei zu beeinflussen. So kann eine Datei einfach nicht nur abgeholt, sondern dem Antragstellendem auch als Bescheid oder Nachricht zugestellt werden.

Aufgabe in Webservice erstellen (JSON)

Um eine Aufgabe mit Hilfe von JSON zu erstellen, müssen die nachfolgenden Header gesetzt sein:

• Content-Type ⇒ application/json
• Authorization ⇒ Bearer + Leerzeichen + Token

Als Body wird JSON übertragen. Dabei müssen für das Abholen von Dateien per CMIS mindestens folgende Schlüssel und Werte enthalten sein:

• action ⇒ vgv.cmis.datei.abholen
• vgk ⇒ Vorgangskennung
• docid ⇒ ID des abzuholenden Dokuments

Folgende Werte sind optional:

• mediatype ⇒ kann aktuell bescheid oder sonstiges (Standard) sein
• zustellung ⇒ kann frontend oder backend (Standard) sein

Die Anfrage geht an die URL https://domain.tld/ws/egov_vorgangsverwaltung/notify/create_job/.

Beispiel: Header

Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1Q.eyJpc3MiOiJodHRwc.RBeJswOdMaAlaydpqE

Beispiel: Body

{
"action":"vgv.cmis.datei.abholen",
"vgk":"V20201222130542-0000000397",
"docid":"T000001474",
"mediatype":"bescheid",
"zustellung":"frontend"
}

Aufgabe in Webservice erstellen (DokuFIS-XML)

Um eine Aufgabe mit Hilfe eines DokuFIS-XML zu erstellen, müssen die nachfolgenden Header gesetzt sein:

• Content-Type ⇒ application/xml
• Authorization ⇒ Bearer + Leerzeichen + Token

Als Body wird das DokuFIS-XML übertragen. Dabei müssen für das Abholen von Dateien per CMIS mindestens folgende Schlüssel und Werte enthalten sein:

• document > id ⇒ ID des abzuholenden Dokuments
• document > properties > property > vorgangskennung ⇒ Vorgangskennung

Die Anfrage geht an die URL https://domain.tld/ws/egov_vorgangsverwaltung/notify/create_job/.

Beispiel: Header

Content-Type: application/xml
Authorization: Bearer eyJ0eXAiOiJKV1Q.eyJpc3MiOiJodHRwc.RBeJswOdMaAlaydpqE

Beispiel: Body