Diese Aktivität bindet Webservices vom Typ REST oder SOAP in einen Workflow ein.
Mit Webservices lassen sich Daten zwischen Systemen automatisch austauschen oder per Workflow Informationen in anderen Anwendungen erstellen, aktualisieren oder löschen.
Umgekehrt können Sie Daten aus anderen Programmen wie Ihr CRM oder Ihrer FiBu in einem DocuWare Workflow verwenden.
Um Webservices mit Workflow Manager nutzen zu können, registrieren Sie diese zunächst in der DocuWare Konfiguration unter Webservices.
Die Aktivität Webservices bietet Ihnen eine assistierte Struktur mit einer Schrittfolge zum Einrichten des Webservice-Aufrufs. Die wichtigsten Schritte werden im folgenden am Beispiel eines REST-Webservice dargestellt.
1. Allgemein
Im ersten Schritt wählen Sie den REST-Webservice aus und legen das Format für den Datenaustausch fest (JSON oder XML). Es stehen Ihnen die Dienste zur Auswahl, die zuvor in der DocuWare Konfiguration unter Webservices eingerichtet wurden. Abhängig vom ausgewählten Webservice-Typ unterscheiden sich die weiteren benötigten Angaben.
Wenn Ihr Webdienst eine OpenAPI-Spezifikationsdatei (*.json, *.txt, *.yml oder *.yaml) anbietet, haben Sie die Möglichkeit, diese zu importieren. Nach dem Import werden alle verfügbaren Endpunkte in der Dropdown-Liste aufgeführt:
Oder Sie verwenden die Standard Webservice DocuWare Platform API, bei der die Endpunkte bereits vorkonfiguriert sind.
2. Anforderung
Wählen Sie die Methode und erstellen die HTTP-Abfrage. Oben wird dann eine Vorschau angezeigt. Den URL-Pfad, die Abfrageparameter und die Body-Inhalte können Sie mit Variablen dynamisch gestalten.
Am Ende testen Sie die Abfrage und sehen im Tab "HTTP Response Status Codes", ob die Abfrage erfolgreich war.
Sie müssen für jede Variable einen Testwert angeben, um den Test durchzuführen.
HTTP Body
Auf der Registerkarte HTTP body haben Sie die Möglichkeit, das aktuelle Dokument an die HTTP-Anfrage an einen externen RESTful Web Service anzuhängen. Damit können Sie zum Beispiel ein gespeichertes Dokument wie eine Rechnung an einen externen KI-Erfassungsdienst senden, um das Dokument zu erfassen und die erfassten Informationen Indexfeldern oder globalen Variablen zuzuordnen.
Das Dokument kann als pdf mit (ab DocuWare Version 7.14) oder ohne Anmerkungen oder als Originaldokument oder exportiert werden. Wenn das DocuWare Dokument mehrere Dateien enthält (geheftet), werden alle Dateien separat exportiert und angehängt. Die HTTP-Anfrage enthält dann mehrere Datei-Objekte.
Mit DocuWare Version 7.12 können Sie hier auch ein Testdokument angeben, das in die Test-Webservice-Anfrage aufgenommen wird.
Validierung des HTTP-Bodys
Die Validierung des HTTP-Bodys wird entweder mit Senden oder automatisch beim Speichern der Konfiguration durchgeführt. Wird ein Teil des Inhalts für ungültig befunden, wird der entsprechende Fehler hervorgehoben und eine entsprechende Meldung angezeigt. Auch bei Validierungsproblemen kann die Konfiguration gespeichert werden.
Verschlüsselung von HTTP-Abfragen
Für die Verschlüsselung von HTTP-Anfragen drei Optionen zur Auswahl:
Sonderzeichen kodieren (Empfohlen): Alle Sonderzeichen werden kodiert, z.B. wird "AT&T" zu "AT%26T" und "Rapid Transport" zu "Rapid%20Transport"
Sonderzeichen außer reservierten URL-Zeichen kodieren: ?#[]@!$&/*+,;='() Außer den reservierten URL-Zeichen werden alle Sonderzeichen kodiert, z.B. bleibt "AT&T", aber "Rapid Transport" wird zu "Rapid%20Transport".
Sonderzeichen nicht kodieren: Weder Sonder- noch Leerzeichen werden kodiert.
Die Kodierung wird auf alle Werte angewendet, deren Übergabe auf den Reitern Route und Abfragen festgelegt wird, nicht aber auf die Werte der Reiter HTTP Header und HTTP Body.
Konfiguration von Endpunkten
Falls Sie eine OpenAPI-Spezifikationsdatei oder den Standard-REST-Webdienst "DocuWare Platform API" verwenden, konfigurieren Sie den im vorherigen Schritt ausgewählten Endpunkt. Um die Konfiguration zu vereinfachen, werden alle erforderlichen Parameter automatisch auf Basis des gewählten Endpunkts voreingestellt.
Speziell für die DocuWare Platform API definieren Sie in den Abschnitten Route und Queries fehlende Werte, zum Beispiel das Archiv oder Dokument, auf das zugegriffen werden soll.
Im Bereich HTTP Body geben Sie die erforderlichen Informationen und Eigenschaften an, die zur Ausführung der ausgewählten Operation benötigt werden, z. B. die GUID des zu platzierenden Stempels.
3. Datenzuweisung
Hier weisen Sie die Werte aus der Antwort-Variablen oder Indexdaten zu. Dabei wählen Sie die benötigten Werte aus dem empfangenen JSON oder XML aus einer Baumstruktur (siehe unten) aus.
Auf diese Weise können Sie bestimmte Informationen aus der Antwort extrahieren und für die weitere Verwendung in Ihrem Workflow speichern.
Wenn Sie alle zurückgegebenen Einträge verarbeiten wollen, ersetzen Sie den Index im Array-Indexer manuell durch ein Sternchen (*). Dies ermöglicht eine umfassende Verarbeitung aller Einträge innerhalb des Arrays.
Standard Webservice DocuWare Platform API
Mehr Informationen zu den Endpunkten im Artikel Standard Webservice DocuWare Platform API
Anwendungsbeispiel für den Endpunkt "documentAnnotations"
Nachdem eine Rechnung in der Buchhaltungssoftware bearbeitet wurde, soll sie in DocuWare automatisch mit dem Stempel "Bezahlt" versehen werden. Um dies zu konfigurieren, richten Sie zunächst einen Autoindex-Job ein, der den Indexeintrag der Rechnung auf "Bezahlt" ändert.
Auf die Änderung des Indexeintrags startet ein Workflow, dessen Webservice-Aktivität den Stempel „Bezahlt“ automatisch auf das Rechnungsdokument setzt.
Beachten Sie, dass der "Paid"-Stempel konfiguriert und dem Benutzer zugewiesen sein muss, der für den Workflow angegeben ist, um automatische Aktivitäten auszuführen.
Die Konfiguration des Endpunkts "documentAnnotations" sieht wie folgt aus:
