# Integrationen
Integrationen können über eine Call Activity aufgerufen werden. Für die von der Plattform bereitgestellten Integrationen werden Element-Templates angeboten, die die Modellierung vereinfachen. Eine vollständige Liste der verfügbaren Integrationen finden Sie unter DigiWF Integrationen.
# Übergreifend
Alle Integrationen nutzen Basisinformationen aus dem Prozess und werden über ihren Namen im Connector identifiziert. Dazu werden von DigiWF autom. mit den jeweiligen Element-Templates folgende Properties gesetzt.
# Allgemeine Properties
| Properties | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
type | Header | Der Typ des Events. | Ja |
integration | Header | Der Name der Integration. | Ja |
# CoSys
Um ein Dokument über CoSys zu erstellen, muss eine Call Activity modelliert werden. Es stehen verschiedene CoSys-Templates zur Verfügung.
# CoSys: Dokument erstellen (alle Daten) (V02)
Es werden alle Daten der Prozessinstanz an CoSys übergeben.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Event Topic | Das Topic der CoSys-Integration | dwf-cosys-demo |
| Client | Der Name des CoSys-Clients | 9001 |
| Role | Der Name der CoSys-Role | TESTER, SB |
| Zuvor generierte signierte URLs des S3-Service für die Ablage des generierten Dokumtens | ${presignedUrls} | |
| File Context | File-Context des Prozesses. Wird als Prefix für die folgenden Pfade verwendet. | ${app_file_context} |
| Pfad im S3 | Dateipfad, an dem das generierte Dokument abgelegt werden soll. | test2/datei.pdf |
| GUID | Eindeutiger Bezeichner der CoSys-Vorlage | 519650b7-87c2-41a6-8527-7b095675b13f |
| Daten | Daten als JSON-Objekt, die in das Dokument eingemischt werden sollten | ${data} |
# CoSys: Dokument erstellen
Die Daten, die an CoSys übergeben werden, müssen zuvor definiert werden.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Event Topic | Das Topic der CoSys-Integration | dwf-cosys-demo |
| Client | Der Name des CoSys-Clients | 9001 |
| Role | Der Name der CoSys-Role | TESTER |
| Zuvor generierte signierte URLs des S3-Service für die Ablage des generierten Dokumtens | ${presignedUrls} | |
| File Context | File-Context des Prozesses. Wird als Prefix für die folgenden Pfade verwendet. | ${app_file_context} |
| Pfad im S3 | Dateipfad, an dem das generierte Dokument abgelegt werden soll. | test2/datei.pdf |
| GUID | Eindeutiger Bezeichner der CoSys-Vorlage | 519650b7-87c2-41a6-8527-7b095675b13f |
| Daten | Daten als JSON-Objekt, die in das Dokument eingemischt werden sollten | ${data} |
Um eine E-Mail zu versenden, muss eine CallActivity modelliert werden. Es stehen verschiedene E-Mail Templates zur Verfügung.
# E-Mail versenden
Um eine einfache E-Mail zu versenden, wird das Element Template Mail: E-Mail senden verwendet.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Receiver | E-Mail Adressen der Empfänger (Kommasepariert) | max.mustermann@example.com |
| Subject | Betreff | Test E-Mail |
| Body | E-Mail-Text | Das ist ein Test |
| Reply-To Address | E-Mail-Adresse, an die geantwortet werden soll | test@example.com |
| Receiver (CC) | Empfänger CC (Kommasepariert) | max.mustermann@example.com |
| Receiver (BCC) | Empfänger BCC (Kommasepariert) | max.mustermann@example.com |
| Von der S3-Integration generierte Presigned-URLs für das Herunterladen von Dateien | ||
| File Context | File-Context des Prozesses. Wird als Prefix für die folgenden Pfade verwendet. | ${app_file_context} |
| Pfad(e) im S3 | Semikolon separierte Liste an Datei- und Ordner-Pfaden. | test/;test2/datei.pdf |
# E-Mail mit Logo versenden
Um eine E-Mail mit Logo zu versenden, wird das Element Template Mail: E-Mail aus Vorlage mit Logo senden verwendet.
Bei der Verwendung ist zu beachten,
dass Zeilenumbrüche in den Werten der Felder 'E-Mail Text' und 'E-Mail Gruß' durch <br> ersetzt werden, damit sie in
der als HTML
zugestellten E-Mail korrekt angezeigt werden.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Receiver | E-Mail Adressen der Empfänger (Kommasepariert) | max.mustermann@example.com |
| Subject | Betreff | Test E-Mail |
| E-Mail Text | E-Mail Text | Das ist ein Test |
| E-Mail Gruß | E-Mail Gruß | Mit freundlichen Grüßen |
| Reply-To Address | E-Mail Adresse, an die geantwortet werden soll | test@example.com |
| Receiver (CC) | Empfänger CC (Kommasepariert) | max.mustermann@example.com |
| Receiver (BCC) | Empfänger BCC (Kommasepariert) | max.mustermann@example.com |
| Von der S3-Integration generierte Presigned-URLs für das Herunterladen von Dateien | ||
| File Context | File-Context des Prozesses. Wird als Prefix für die folgenden Pfade verwendet. | ${app_file_context} |
| Pfad(e) im S3 | Semikolon separierte Liste an Datei- und Ordner-Pfaden. | test/;test2/datei.pdf |
# E-Mail mit Logo und Link versenden
Um eine E-Mail mit Logo zu versenden, wird das Element Template Mail: E-Mail aus Vorlage mit Logo und Link senden
verwendet. Bei der Verwendung ist zu
beachten, dass Zeilenumbrüche in den Werten der Felder 'E-Mail Text' und 'E-Mail Gruß' durch <br> ersetzt werden,
damit sie in der als
HTML zugestellten E-Mail korrekt angezeigt werden.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Receiver | E-Mail Adressen der Empfänger (Kommasepariert) | max.mustermann@example.com |
| Subject | Betreff | Test E-Mail |
| E-Mail Text | E-Mail Text | Das ist ein Test |
| E-Mail Gruß | E-Mail Gruß | Mit freundlichen Grüßen |
| Link Bezeichnung | Bezeichung, die auf dem Button angezeigt wird | Beispielseite öffnen |
| Link URL | Link, auf den der Button verlinkt | example.com |
| Reply-To Address | E-Mail Adresse, an die geantwortet werden soll | test@example.com |
| Receiver (CC) | Empfänger CC (Kommasepariert) | max.mustermann@example.com |
| Receiver (BCC) | Empfänger BCC (Kommasepariert) | max.mustermann@example.com |
| Von der S3-Integration generierte Presigned-URLs für das Herunterladen von Dateien | ||
| File Context | File-Context des Prozesses. Wird als Prefix für die folgenden Pfade verwendet. | ${app_file_context} |
| Pfad(e) im S3 | Semikolon separierte Liste an Datei- und Ordner-Pfaden. | test/;test2/datei.pdf |
# S3
Für die Interaktion mit dem S3-Dienst stehen verschiedene Templates zur Verfügung.
# S3: Presigned URL erstellen (Deprecated)
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Dateipfad | Der Pfad, der ausgelesen werden soll | ${app_file_context}/docs |
| Dateiaktion | Die Aktion, die auf der Datei ausgeführt werden soll | GET |
| Out: PresignedUrls | Der Name des JSON-Arrays, in den das Ergebnis geschrieben wird | urls |
# S3: Dateien löschen
Ermöglicht das Löschen von Ordnern und Dateien aus dem S3.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| File Context | File-Context des Prozesses. Wird als Prefix für die folgenden Pfade verwendet. | ${app_file_context} |
| Pfade | Semikolon separierte Liste an Datei- und Ordner-Pfaden. | test/;test2/datei.pdf |
# DMS
Für die Interaktion mit dem DMS stehen verschiedene Templates zur Verfügung.
# Sachakte erstellen
Um eine Sachakte anzulegen, wird das Element Template DMS: Sachakte erstellen verwendet.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Dms System (Integration Name) | Dropdown-Auswahl zwischen MUCS und ALW DMS | mucs bzw. alw |
| Title | Name der Sachakte | Sachaktenname |
| User | Benutzername des Benutzers, über den die Sachakte erstellt werden soll | max.mustermann |
| Aktenplan (Coo) | Objekt-ID des Aktenplankennzeichnes, in dem die Sachakte erstellt werden soll | COO.1234.5678.9.1234567 |
| Out: File (Coo) | Objekt-ID der erstellten Sachakte | COO.9876.5432.1.9876543 |
# Vorgang anlegen
Um einen Vorgang anzulegen, wird das Element Template DMS: Vorgang anlegen verwendet.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Dms System (Integration Name) | Dropdown-Auswahl zwischen MUCS und ALW DMS | mucs bzw. alw |
| Title | Name des Vorgangs | Vorgangsname |
| Betreff | Betreff des Vorgangs | Vorgangsbetreff |
| User | Benutzername des Benutzers, über den der Vorgang angelegt werden soll | max.mustermann |
| Sachakte (Coo) | Objekt-ID der Sachakte, in der der Vorgang erstellt werden soll | COO.1234.5678.9.1234567 |
| Out: Procedure (Coo) | Objekt-ID des angelegten Vorgangs | COO.9876.5432.1.9876543 |
# Dokument anlegen
Um ein Dokument anzulegen, wird das Element Template DMS: Dokument anlegen verwendet.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Dms System (Integration Name) | Dropdown-Auswahl zwischen MUCS und ALW DMS | mucs bzw. alw |
| Vorgang (Coo) | Objekt-ID des Vorgangs, in dem das Dokument erstellt werden soll | COO.1234.5678.9.1234567 |
| Title | Name des Dokuments | Dokumentname |
| Datum | Eingang- bzw. Ausgangsdatum des Dokuments | 2024-01-31 |
| User | Benutzername des Benutzers, über den das Dokument angelegt werden soll | max.mustermann |
| Typ (Ein-/Ausgehend/Intern) | Dropdown-Auswahl zwischen Eingangs-, Ausgangs- und internem Dokument | Eingehend bzw. Ausgehend bzw. Intern |
| Pfad(e) im S3 | Pfad(e) zu Dateien oder Ordnern im S3 mit einem Komma getrennt | ordnername/,odner/filename.pdf |
| Out: Document (Coo) | Objekt-ID des Dokuments | COO.9876.5432.1.9876543 |
| Out: Content (Coos) | Objekt-IDs der untergeordneten Schriftstücke. | ["COO.9876.5432.1.9876544","COO.9876.5432.1.9876545"] |
# Dokument updaten
Um ein Dokument upzudaten, wird das Element Template DMS: Dokument updaten verwendet.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Dms System (Integration Name) | Dropdown-Auswahl zwischen MUCS und ALW DMS | mucs bzw. alw |
| Dokument-COO | Objekt-ID des Dokuments, das upgedatet werden soll | COO.1234.5678.9.1234567 |
| User | Benutzername des Benutzers, über den das Dokument upgedatet werden soll | max.mustermann |
| Typ (Ein-/Ausgehend/Intern) | Dropdown-Auswahl zwischen Eingangs-, Ausgangs- und internem Dokument | Eingehend bzw. Ausgehend bzw. Intern |
| Pfad(e) im S3 | Pfad(e) zu Dateien oder Ordnern im S3 mit einem Komma getrennt | ordnername/,odner/filename.pdf |
| Out: Content (Coos) | Objekt-IDs der untergeordneten Schriftstücke. | ["COO.9876.5432.1.9876544","COO.9876.5432.1.9876545"] |
# Objekt zu den Akten legen
Um eine Akte oder einen Vorgang zu den Akten zu legen, wird das Element Template DMS: Objekt zu den Akten legen
verwendet.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Dms System (Integration Name) | Dropdown-Auswahl zwischen MUCS und ALW DMS | mucs bzw. alw |
| Coo | Objekt-ID der Akte oder des Vorgangs, der zu den Akten gelegt werden soll | COO.1234.5678.9.1234567 |
| User | Benutzername des Benutzers, über den das Objekt zu den Akten gelegt werden soll | max.mustermann |
# Objekt stornieren
Um ein Objekt zu stornieren, wird das Element Template DMS: Objekt stornieren verwendet.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Dms System (Integration Name) | Dropdown-Auswahl zwischen MUCS und ALW DMS | mucs bzw. alw |
| Coo | Objekt-ID des Objekts, das storniert werden soll | COO.1234.5678.9.1234567 |
| User | Benutzername des Benutzers, über den das Objekt storniert werden soll | max.mustermann |
# Schriftstücke lesen
Um Schriftstücke zu lesen und in den S3-Speicher zu übertragen, wird das Element Template DMS: Schriftstuecke lesen
verwendet.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Dms System (Integration Name) | Dropdown-Auswahl zwischen MUCS und ALW DMS | mucs bzw. alw |
| Content-Coos | Array mit den Objekt-IDs der Schriftstücke, die gelesen werden soll | ["COO.1234.5678.9.1234567", COO.9876.5432.1.9876543"] |
| User | Benutzername des Benutzers, über den die Schriftstücke gelesen werden soll | max.mustermann |
| Pfad im S3 | Ordner im S3, in den die Schriftstücke übertragen werden sollen | ordnername |
# Sachakte suchen
Um eine Sachakte zu suchen, wird das Element Template DMS: Sachakte suchen verwendet.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Dms System (Integration Name) | Dropdown-Auswahl zwischen MUCS und ALW DMS | mucs bzw. alw |
| Suche | Suchstring mit Namen bzw. Teilen des Namens der gesuchten Sachakte | *Teil_des_Sachaktenames* |
| User | Benutzername des Benutzers, über den die Sachakte gesucht werden soll | max.mustermann |
| Fachdatum Referenz | Referenz des Fachdatums | stringReferenz bzw. numberReferenz |
| Fachdatum Wert | Wert des Fachdatums | beispielString bzw. 42 |
| Out: Sachakten (Coo) | Array mit den Objekt-IDs der gefundenen Sachakten | ["COO.1234.5678.9.1234567", "COO.9876.5432.1.9876543"] |
# Aktenplaneintrag suchen
Um einen Aktenplaneintrag zu suchen, wird das Element Template DMS: Aktenplaneintrag suchen verwendet.
Properties
| Property | Beschreibung | Beispiel |
|---|---|---|
| Dms System (Integration Name) | Dropdown-Auswahl zwischen MUCS und ALW DMS | mucs bzw. alw |
| Suche | Suchstring mit Namen des Aktenplaneintrags | Aktenplaneintragname |
| User | Benutzername des Benutzers, über den der Aktenplaneintrag gesucht werden soll | max.mustermann |
| Out: Aktenplaneintrag (Coo) | Objekt-ID des Aktenplaneintrags | COO.9876.5432.1.9876543 |
# Open AI
Die DigiWF OpenAI-Integration ermöglicht es Prozessentwicklern, Sprachmodelle in BPMN-Prozesse integrieren zu können.
# Chat
Um eine einfache Chat-Anfrage durchzuführen, müssen die folgenden Daten an die OpenAI-Integration übergeben werden:
# Properties
| Properties | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
prompt | String | Generische Anfrage an das Sprachmodell. | Ja |
# Übersetzung
Um einen Text übersetzen zu lassen, müssen Sie die folgenden Daten an die OpenAI-Integration übergeben werden:
# Properties
| Properties | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
text | String | Der zu übersetzende Text. | Ja |
language | String | Sprache, in die übersetzt werden soll. | Ja |
# Zusammenfassung
Um einen Text zusammenfassen zu lassen, müssen Sie die folgenden Daten an die OpenAI-Integration übergeben werden:
# Properties
| Properties | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
text | String | Der zu verkürzende Text. | Ja |
length | Int | Ungefähre Länge des neuen Textes. | Ja |
# Mail generieren
Um Mail-Texte in beliebigen Sprachen generieren zu lassen, müssen die folgenden Daten an die OpenAI-Integration übergeben werden:
# Properties
| Properties | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
json | json | Daten für das Template. | Ja |
language | String | Sprache des Mail-Textes. | Ja |
template | String | Vorlage für den Mail-Text. | Ja |
# Daten extrahieren
Um Daten aus einem Text oder JSON extrahieren zu lassen, müssen die folgenden Daten an die OpenAI-Integration übergeben werden:
# Properties
| Properties | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
json | String | Unstrukturierter Text oder unpassende JSON-Daten. | Ja |
fields | String | Zu extrahierende Informationen als JSON-Felder getrennt. | Ja |
# Klassifizierung
Um auf Basis von Daten einfache (Vor-)Entscheidungen zu treffen, müssen die folgenden Daten an die OpenAI-Integration übergeben werden:
# Properties
| Properties | Typ | Beschreibung | Erforderlich |
|---|---|---|---|
json | String | Unstrukturierter Text oder JSON-Daten als Basis. | Ja |
options | String | Mögliche Ergebnisse für die Klassifizierung. | Ja |