¶ Installation
Das Plugin-Bundle wird in den Mandanten-Einstellungen durch Upload des fd-plugin-bundle-docuvita.jar Archives in FORMCYCLE mandantenspezifisch installiert.
Nach der Installation stehen zwei neue Aktions-Knoten zur Verwendung in den Workflows bereit:
Die zusätzlichen Aktions-Knoten können in der gewohnten Weise in FORMCYCLE Workflows eingebunden werden.
Zusätzlich wird durch das Plugin-Bundle ein Attachment-Servlet-Plugin bereitgestellt:
¶ Mandanteneinstellungen
In den Mandanteneinstellungen von FORMCYCLE können für das Plugin-Bundle zentral allgemeingültige globale Einstellungen vorgenommen werden:
¶ Konfigurationseigenschaften
| Name | Bedeutung | |
|---|---|---|
| docuvita Service-URL | Service-URL für docuvita API Aufrufe | Pflichtfeld für XML Import Plugin |
| Session GUID / API Token | API-Token des Benutzers für docuvita API Aufrufe | Pflichtfeld nur für das Download Plugin |
| Importbenutzer | docuvita Benutzer für den XML Import | Pflichtfeld für XML Import |
| Importbenutzer Passwort | Passwort des docuvita Benutzers für den XML Import | Pflichtfeld für XML Import |
| Importname | Identifizierender Name für den Import | Pflichtfeld für XML Import |
| System/Mandant | Systemnummer/Mandant, in den der XML Import erfolgen soll | Pflichtfeld für XML Import |
Die in den Mandanteneinstellungen vorgenommenen Einstellungen gelten für alle Aktions-Knoten-Instanzen in den Workflows. Sie können allerdings im jeweiligen Knoten einzeln mit individuellen Werten überschrieben werden.
¶ docuvita Dokument Download Plugin
Das Plugin stellt einen FORMCYCLE Aktionsknoten bereit, mit dem Dokumente aus docuvita heruntergeladen und dem FORMCYCLE Workflow zur Verfügung gestellt werden können.
Die Aktion führt die docuvita API-Anfrage GetDokument zum Download eines Dokumentes aus und hängt dieses Dokument an den Vorgang in FORMCYCLE an.
Die Knoten-Eigenschaften entsprechen den definierten JSON-Parametern für GetDocument, die in den docuvita Metadaten dokumentiert sind.
Werden hier die Konfigurationseigenschaften für docuvita Service-URL und Session GUID/API Token gemacht, so überschreiben diese individuell für den betreffenden Knoten getroffenen Einstellungen die globalen Einstellungen im FORMCYCLE Mandanten.
Das Plugin stellt folgende Ergebnisse bereit, die als Platzhalter verwendet werden können:
¶ docuvita XML Import Plugin
Das Plugin stellt einen FORMCYCLE Aktionsknoten bereit, mit dem Daten für den docuvita XML Import erzeugt und an docuvita übergeben werden können.
Die Aktion erzeugt ein zip-Archiv docuvitaUpload.zip mit einer dvImport-Steuerdatei und den im Knoten für den Upload nach docuvita ausgewählten Vorgangsdateien.
Diese werden mit der docuvita API-Anfrage FileUpload an docuvita zur weiteren Verarbeitung durch den XML Import übertragen.
Werden hier die Konfigurationseigenschaften für docuvita Service-URL, Importbenutzer, Importbenutzer Passwort, Importname und System/Mandant gemacht, so überschreiben diese individuell für den betreffenden Knoten getroffenen Einstellungen, die globalen Einstellungen im FORMCYCLE Mandanten.
¶ dvImport Steuerdatei
Für die Verarbeitung durch den Autoprofiler in docuvita wird eine dvImport Steuerdatei benötigt. Diese Steuerdatei kann mit Hilfe des Knoten Textdatei erzeugen als XML-Datei generiert werden.
Für das dargestellte Beispiel wird ein Formular verwendet, in dem folgende Variablen definiert sind:
Zur Aktualisierung eines in docuvita vorhandenen Dokuments und Füllen der docuvita Pflichtfelder mit den Werten aus FORMCYCLE Formularfeldern bzw. Variablen mittels Platzhalter kann folgender XML-Code verwendet werden:
<?xml version="1.0" encoding="UTF-8"?>
<import>
<data>
<object
obj.ID="[%objID%]"
doc.filename="[%fileName%]"
ver.Comment="[%verComment%]"
type="[%type%]" />
</data>
</import>
Im Inhalt der Datei können alle syntaktischen und funktionalen Möglichkeiten der dvImport-Dateien aus docuvita verwendet werden.
Durch die Verwendung der FORMCYCLE Platzhalter können dynamisch die Inhalte und Werte aus einem auszuwählenden Formular eingefügt und für den XML-Import verwendet werden.
Eine andere Möglichkeit bietet die Anlage einer Textdatei unter Dateien & Templates.
Dieses Datei-Template kann dann seinerseits mittels eines Platzhalters in den Dateiinhalt im Knoten Textdatei erzeugen eingefügt werden.
Im Name der Ausgabedatei ist die Dateiendung .dvImport zwingend!
Die erzeugte XML-Datei wird im Knoten docuvita XML Import in den Dateien für die Übermittlung nach docuvita eingetragen.
Für die Verarbeitung muss zwingend mindestens die dvImport Datei (Dateiendung .dvImport) eingetragen sein. Fehlt eine solche Steuerdatei wird die Verarbeitung mit einem Fehler abgebrochen.
¶ Attachment Servlet Plugin
Das Servlet-Plugin stellt eine URL bereit, über die Attachments eines Vorgangs abgerufen werden können.
Als URL-Parameter sind dabei die Client-Id und die Attachment-Id anzugeben.
Beispiel:
https://forms01.fakturbox.io/formcycle/plugin?name=DmsAttachmentServletPlugin&client-id=[%$CLIENT_ID%]&attachment-id=[%attachmentId%]