Konfiguration und Verwaltung - ELO Flows
←
→
Transkription von Seiteninhalten
Wenn Ihr Browser die Seite nicht korrekt rendert, bitte, lesen Sie den Inhalt der Seite unten
Konfiguration und Verwaltung ELO Flows
2 Konfiguration und Verwaltung Inhaltsverzeichnis ELO Flows - Getting started 3 Was ist ELO Flows? 3 Schnellstart 4 Installation & Betrieb 9 Überblick 9 Architektur 9 Installation 10 Troubleshooting 12 Verwendung 15 ELO Flows Administration 15 Automatische Templates 21 Manuelle Templates 34 Abfrage-Templates 45 Synchrone Flows 46 JSONata-Editor 49 Webhooks und Token-Authentifizierung 51 Komponenten 54 ELO Objekte & Metadaten 54 ELO Feed 56 ELO Time 57 ELO Workflow 58 SMTP Mail 60
3 Konfiguration und Verwaltung
ELO Flows - Getting started
Was ist ELO Flows?
Abb.: ELO Flows Icon
ELO Flows ist ein ELO Modul für die einfache Umsetzung von Automatisierungs- und
Integrationsaufgaben.
Wann sollte ich ELO Flows verwenden?
• Sie möchten Benutzereingabeformulare in den ELO Clients zur Verfügung stellen. Diese
Formulare können als Kachel oder als Schaltfläche im Menüband hinterlegt werden.
• Sie möchten dienstübergreifend Automatisierungen erstellen.
• Sie möchten Eigenentwicklungen mit ELO verbinden. Es ist möglich eigene Komponenten
zu entwickeln.
• Sie möchten ELO in ein bestehendes Ökosystem einbinden oder andere Anwendungen in
Ihr bestehendes Umfeld integrieren. Zum Beispiel: ERP-Systeme, Mail-Server, File-
Shares...
Warum sollte ich ELO Flows verwenden?
• ELO Flows ermöglicht einfaches Zusammenstellen von Funktionen aus zahlreichen
Komponenten.
• Die Datendefinition erfolgt über eine einfache, deklarative Transformationssprache
(JSONata) mit Vervollständigungshilfe.
• Durch ein Worker-Modell ist eine Skalierbarkeit der Jobabarbeitung möglich.
• Für eigene Services können Komponenten erweitert und erstellt werden.
• ELO Flows verwendete eine moderne, web-basierte Benutzeroberfläche.
• Benutzerformularen und Automatisierung lassen sich über eine Administrationsoberfläche
konfigurieren.
• ELO Flows ist in der ELO Lizenz bereits enthalten.
Abgrenzung
Es soll beleuchtet werden wie ELO Flows zu weiteren ELO Komponenten steht:
ELOas
ELO Flows ist langfristig und sukzessive als Nachfolger des ELOas zu verstehen. Der ELOas wird
weiterhin unterstützt und gewartet, aber nicht mehr weiterentwickelt.
ELO Flows wird das Erstellen von Automatisierungsaufgaben vereinfachen. Im Idealfall kann
komplett auf eigenes Skripting verzichtet werden.
4 Konfiguration und Verwaltung ELO Workflows ELO Flows wird im Zusammenspiel mit ELO Workflows die Umsetzung von Business-Prozessen gemeinsam vereinfachen. Technische Logik kann mit Flows umgesetzt werden, wohingegen Business Logik über ELO Workflows abgehandelt werden kann. Die Verknüpfung beider Module schafft ein umfassendes Prozess-Werkzeug. ELO Business Logic Provider (BLP) ELO Flows wird neben dem ELO BLP existieren. Für komplexe Integrationsszenarien wird der ELO BLP weiterhin Mittel der Wahl sein. ELO Business Solutions Die ELO Business Solutions sind Fachlösungen auf Basis der ELO Suite. ELO Flows wird zukünftigen Business Solution-Lösungen als technische Plattform dienen und das Common-Framework in Teilen ersetzen. Schnellstart Willkommen bei ELO Flows. Um Ihnen den Anfang zu erleichtern, haben wir einen Schnelleinstieg vorbereitet, damit Sie gleich loslegen können! Bereitstellung Vermutlich haben Sie ELO Flows direkt mit dem Server-Setup installiert. Falls noch keine Installation durchgeführt wurde, können Sie diese einfach über das Server-Setup starten. ELO Flows Administration Die ELO Flows Administration ist die zentrale Oberfläche zur Konfiguration von ELO Flows Templates, Zugangsdaten und weiteren Funktionen. Hier definieren und bearbeiten Sie die ELO Flows-Logik. Den Flow-Manager können Sie so erreichen: Öffnen Sie hierzu die ELO Administration Console. Scrollen Sie bis zur entsprechenden Überschrift und wählen Sie "ELO Flows Konfiguration". Sie gelangen auf die folgende Startseite:
5 Konfiguration und Verwaltung Abb.: Flows Administration Startseite 1: Mit Klick auf Neuer Flow können Sie ein neues Template anlegen. 2: Mit Klick auf Template importieren können Sie bereits exportierte Templates als JSON-Datei importieren. 3: Beim Start ist der Tab Automatische Templates gewählt. Über den Tab Automatische Templates legen Sie Flow-Templates mit automatischen Triggern an. Weitere Informationen finden Sie unter Automatische Templates 4: Nach Klick auf Manuelle Templates werden Ihnen die aktuellen Templates mit manuellen Triggern angezeigt. Weitere Informationen finden Sie unter Manuelle Templates. 5: Der Tab Abfrage Templates ist bisher nicht funktional. Weitere Informationen folgen. 6: Unter Zugangsdaten können Sie zu jeder Komponente Zugangsdaten hinterlegen. Weitere Informationen finden Sie unter Zugangsdaten. 7: Wechseln Sie zu Icons um Icons für ELO Client-Schaltflächen zu hinterlegen. Weitere Informationen finden Sie unter Icons. 8: Über den Tab Token erstellen Sie Token. Die Absicherung von Trigger-Events, die durch Drittsystemaufrufe ausgelöst werden, kann durch die Erstellung eines Tokens mit zugewiesenem Benutzerkontext erfolgen. Weitere Informationen finden Sie unter Webhooks und Token-Authentifizierung. 9: Hier sehen Sie die aktuell vorhandenen Templates. Template-Editor Wenn Sie ein Template angelegt haben, können Sie dieses nun öffnen.
6 Konfiguration und Verwaltung Abb.: Template Editor Der Template-Editor beinhaltet folgende Elemente: 1: Die Schaltfläche Pausieren bzw. Fortsetzen setzt einen Flow auf "Aktiv" oder "Inaktiv". Hiermit können Sie Templates deaktivieren. D. h. die Trigger werden nicht aufgerufen bzw. die Schaltflächen eines manuellen Flows werden (vorübergehend) nicht mehr angezeigt. 2: Mit Klick auf Knoten löschen kann der aktuell gewählte Knoten gelöscht werden. 3: Die Schaltfläche Floweigenschaften zeigt Ihnen Einstellungen zum Template an. Hier kann das Template gelöscht und exportiert werden. 4: Mit Klick auf Speichern speichern Sie das Template. Führen Sie dies regelmäßig aus, damit keine Änderungen verloren gehen. 5: Die Übersicht des hinterlegten Triggers. 6: Die Übersicht des ersten Schrittes an. Je nach Komplexität können hier schon ein paar Schritte zusammen kommen. Das heißt, die Kette wird nach unten hin länger.
7 Konfiguration und Verwaltung
Aufbau eines Flows
Abb.: Beispiel mit einem Schritt
Ein Flow besteht aus folgenden Elementen:
1: Einem Trigger.
2: Einer Reihe von Schritten (mindestens einem).
3: Mit dem grünen Plussymbol können Sie einen weiteren Schritt hinzufügen.
Trigger
Es existieren verschiedene Arten von Trigger. Trigger können angesprochen werden, um einen
Flow zu starten.
• Automatische Trigger: Diese hören unter anderem auf ELOix Events (bereitgestellt vom
ELOix Event-Konnektor).
• Manuelle Trigger: Diese erstellen in den Clients (aktuell im ELO Java Client und im ELO
Web Client) eine Schaltfläche, um den Flow manuell zu starten. Hinter dieser Schaltfläche
liegt eine Definition für die Activity-UI. Diese wird geöffnet, wenn Sie eine Schaltfläche
anklicken, welche durch ein manuelles Template definiert wurde. Diese Aktivitäten bilden
eine Benutzereingabe für ELO Flows ab.
• Webhook: Ein Webhook-Trigger erstellt einen REST-Endpunkt, der von externen Systemen
aufgerufen werden kann.
Es gibt zwei unterschiedliche Arten von Templates:
• Automatische Templates
• Manuelle Templates
Diese unterscheiden sich im initialen Trigger.
Automatisches Templates starten unter anderem mit ELO Events. Wenn Sie eine Komponente
installieren, welche Trigger anbietet, sind diese hier zu verwenden. Neben den IX-Events wäre
hier beispielsweise bei einer E-Mail Komponente die Aktion, der ankommenden E-Mail
vorstellbar. Sie könnten darauf reagieren und einen Flow ausführen.
8 Konfiguration und Verwaltung Manuelle Templates starten mit einem manuellen Trigger. Diese ermöglichen die Benutzereingabe aus einem ELO Client heraus. Diese Daten werden in den Flow übertragen und können dort verarbeitet werden. Komponenten Komponenten sind Verbindungsmodule bzw. Konnektoren zu Systemen. Die ELO Basiskomponente beispielsweise bietet Funktionen an, um mit einem ELO Repository zu interagieren. Sie können hier einen neuen Eintrag anlegen oder einen Feed-Eintrag schreiben. Die Grenzen der Funktionalitäten sind nur durch Schnittstellen der Systeme gegeben. Das heißt, Sie können auch eigene Komponenten schreiben, welche mit ihren Wunschsystemen interagieren. Hierzu finden Sie hier mehr Informationen. Neben den ELO Komponenten sind noch weitere Komponenten geplant. Zum Beispiel für die Interaktion mit E-Mail-Servern, dem Filesystem, ERP-Systeme oder weiteren sinnvollen Business-Diensten. Dienste Dienste werden Funktionen genannt, die in den Flow-Schritten aufgerufen werden. Die ELO Basiskomponente beispielsweise, stellt einige Funktionen (teilweise übernommen aus der ELO Business Solutions Common) für die Arbeit mit einem ELO Repository zur Verfügung. Aktivitäten Aktivitäten sind User-Interface Schritte, welche dem Benutzer bei Klick auf eine Schaltfläche im ELO Java Client oder ELO Web Client angezeigt werden. Die Schaltflächen-Definition wird im Zuge eines manuellen Templates definiert. Hier können Sie schnell gängige Use Cases abbilden. Beispiele wären: eine Formular-Aktivität, eine File-Upload-Aktivität, einer Kalender-Aktivität, usw. Mehr Informationen finden Sie im Kapitel ELO Flows Administration.
9 Konfiguration und Verwaltung Installation & Betrieb Überblick In diesem Kapitel bekommen sie einen detaillierten Überblick über die Architektur, Installation und den Betrieb von ELO Flows. Zusätzlich geben wir Ihnen Tipps an die Hand, wie Sie Fehler analysieren können und/oder Fehlerdaten sammeln können, um in der Community oder Support die Analyse zu beschleunigen. Architektur ELO Flows wurde auf Basis einer modernen Architektur geschaffen. Diese liefert einerseits ein web-basiertes Front-End, ein skalierbares Worker-Modell und mit Apache Karaf eine Komponentenverwaltung mit Hot-Deployment-Unterstützung. Abb.: Flows Architektur Module ELO Flows setzt sich aus diversen Modulen zusammen. Der ELO Flow-Manager und die Registry laufen als Webapp in einem Tomcat (wie die anderen ELO Module auch). Die Worker laufen auf einem Apache Karaf. Flow-Manager Der Flow-Manager ist die zentrale Instanz für die Ablaufsteuerung der Flows. Er ist verantwortlich für das Starten neuer Flows sowie die Ablaufsteuerung. Der Flow-Manager stellt die Schnittstelle für die ELO Flows Administration zur Verfügung. Über diese Schnittstelle kann die ELO Flows Administration Flow-Templates anlegen und verwalten.
10 Konfiguration und Verwaltung
Die Oberfläche kann über die Schnittstelle zudem auf die Informationen der Registry
(verfügbare Komponenten und deren Services) zugreifen.
Registry
Die Registry ist die zentrale Instanz bei der sich die Worker anmelden und ihre Komponenten
registrieren. Sie überprüft ebenfalls, ob die Worker erreichbar sind und wird informiert, wenn
sich die Komponenten eines Workers ändern.
Worker
Die Worker sind eigenständige Container. In den Workern werden die Komponenten deployed.
Zur Lastverteilung können mehr als ein Container parallel benutzt werden.
Komponenten
Die Komponenten werden als OSGi-Plug-in entwickelt. Sie stellen Trigger und Services zu
Verfügung.
ELO Flows Administration
Die ELO Flows Administration ist die Oberfläche über die Benutzer Flow-Templates verwalten
können. Die App (sowie die benötigte Schnittstelle) wird vom Flow-Manager bereitgestellt.
ELOix Event-Konnektor (OSGi-Plug-in)
Das ELOix-Plug-in ist dafür verantwortlich ELOix-Events an den Flow Manager weiterzureichen.
Hierbei wird aktuell zwischen Create- und Update-Events unterschieden.
• Create-Events: Neuanlage eines SORD
• Update-Events: Aktualisierung eines bestehenden SORD
Installation
1. Starten Sie das ELO Server Setup.
Abb.: ELO Server Setup, Schaltfläche 'Custom install'
2. Wählen Sie die Option Custom install11 Konfiguration und Verwaltung
Abb.: Seite 'Application Servers'
3. Fügen Sie auf der Seite Application Servers einen Eintrag für den ELO Flows Worker hinzu.
Klicken Sie hierzu auf Add.
Abb.: Seite 'Applications'
4. Auf der Seite Applications fügen Sie die beiden Flows Serveranwendungen ELO Flows
Engine und ELO Flows Registry hinzu.
5. Schließen Sie daraufhin das ELO Server Setup ab.
Authentifizierung am Manager
Der Flows Manager kann nach der Installation über die ELO Administration Console aufgerufen
werden.
Alternativ kann ein Aufruf direkt über einen Link mit folgendem Schema erfolgen:
http://:/ix-/plugin/de.elo.ix.plugin.proxy/flows/12 Konfiguration und Verwaltung
Troubleshooting
Problemanalyse
Die Problemanalyse kann in mehreren Schritten ausgeführt werden:
1. Prüfen Sie, ob alle Module ordnungsgemäß laufen. Hier stehen Ihnen mehrere
Statusseiten zur Verfügung:
Wie Sie diese erreichen können finden Sie im Kapitel Monitoring.
2. Prüfen Sie die Log-Dateien. Sie finden mehrere Log-Dateien im ELO Flows
Arbeitsverzeichnis:
Dort finden Sie die Files worker.log und manager.log. Fehler beginnen mit dem Präfix
ERROR.
Prüfen Sie den kompletten Error Stack Trace, bzw. stellen Sie dem Support, der
Entwicklung oder der Community die vollständige Fehlerursache zur Verfügung.
Monitoring
ELO Flows stellt ein Monitoring-Tool zur Verfügung. In diesem Tool können Sie die Abarbeitung
von Flows prüfen und Fehler analysieren.
Abb.: Schaltfläche 'Monitoring'
1. Klicken Sie auf die Schaltfläche Monitoring in der rechten oberen Ecke der ELO Flows
Administration.13 Konfiguration und Verwaltung
Abb.: Seite 'Status Report'
Die Seite Status Report erscheint. Die Seite besteht aus folgenden Tabs:
• Version: Zeigt die aktuell verwendete Version
• Messages: Zeigt aktuelle Statusnachrichten.
• Flows: Zeigt die vorhandenen Flows mit dazugehörigen statistischen Werten.
• Flows-Chronik: Zeigt den Verlauf der ausgeführten Flows. Die Liste kann gefiltert werden.
Alternativ nutzen Sie eine manuelle Problemanalyse, welche auch durch folgende Statusseiten
unterstützt wird.
Statusseiten
Wir stellen Ihnen mehrere Statusseiten zur Überprüfung zur Verfügung. Diese zeigen neben der
aktuell installierten Versionsnummern auch den Online-Status der Module an:
Einfache Statusseite des Flow Managers
Abb.: Einfache Statusseite des ELO Flow Managers
Der Manager bietet eine sehr simple Statusseite, welche ausschließlich den Status anzeigt und
ohne Authentifizierung benutzt werden kann:14 Konfiguration und Verwaltung
http://:/flows/status
Statusseite der ELO Flows Administration
Abb.: Statusseite der ELO Flows Administration Die Statusseite der ELO Flows Administration
können Sie unter folgendem Link erreichen:
http://:/ix-/plugin/de.elo.ix.plugin.proxy/flows/#/status
Statusseite der ELO Flows Registry
Abb.: Statusseite der ELO Flows Registry
Die Statusseite der ELO Flows Registry können Sie unter folgendem Link erreichen:
http://:/registry
Information
Passen Sie Hostname und Port entsprechend der jeweiligen Installation an.15 Konfiguration und Verwaltung Verwendung ELO Flows Administration Die ELO Flows Administration ist die zentrale Applikation zur Verwaltung von ELO Flows. Als Einstiegspunkt dient die Startseite. Startseite Abb.: Flows Administration Startseite 1: Mit Klick auf Neuer Flow können Sie ein neues Template anlegen. 2: Mit Klick auf Template importieren können Sie bereits exportierte Templates als JSON-Datei importieren. 3: Beim Start ist der Tab Automatische Templates gewählt. Über den Tab Automatische Templates legen Sie Flow-Templates mit automatischen Triggern an. Weitere Informationen finden Sie unter Automatische Templates 4: Nach Klick auf Manuelle Templates werden Ihnen die aktuellen Templates mit manuellen Triggern angezeigt. Weitere Informationen finden Sie unter Manuelle Templates. 5: Abfrage-Templates sind spezielle Flows-Vorlagen um Daten bereitzustellen. Diese laufen synchron ab und stellen eine Möglichkeit dar, mit den entsprechenden Komponenten, Datenabfragen bereitzustellen. Weitere Informationen finden Sie unter Abfrage-Templates. 6: Unter Zugangsdaten können Sie zu jeder Komponente Zugangsdaten hinterlegen.
16 Konfiguration und Verwaltung
Weitere Informationen finden Sie unter Zugangsdaten.
7: Wechseln Sie zu Icons um Icons für ELO Client-Schaltflächen zu hinterlegen.
Weitere Informationen finden Sie unter Icons.
8: Über den Tab Token erstellen Sie Token. Die Absicherung von Trigger-Events, die durch
Drittsystemaufrufe ausgelöst werden, kann durch die Erstellung eines Tokens mit
zugewiesenem Benutzerkontext erfolgen.
Weitere Informationen finden Sie unter Webhooks und Token-Authentifizierung.
9: Hier sehen Sie die aktuell vorhandenen Templates.
Zugangsdaten
Unter Zugangsdaten hinterlegen Sie zu jeder Komponente Verbindungs- und Zugangsdaten.
Abb.: Komponentenübersicht
1. Klicken Sie auf eine Komponente um diese zu bearbeiten.17 Konfiguration und Verwaltung
Abb.: Schaltfläche 'Auswählen'
2. Klicken Sie auf Auswählen.
Abb.: Seite 'Zugangsdaten'
Die Seite Zugangsdaten erscheint.
Das Default-Objekt ist standardmäßig sichtbar und übernimmt die Zugangsdaten aus der
Config-File.
Die Seite Zugangsdaten hat folgende Elemente:18 Konfiguration und Verwaltung
1: Mit Klick auf Neu können Sie neue Zugangsdaten hinterlegen.
2: Unter Bearbeiten können Sie diese bearbeiten.
3: Unter Löschen können Sie ein Zugangsdaten-Objekt löschen.
4: Ein bestehendes Zugangsdaten-Objekt.
Zugangsdaten anlegen
Mit Klick auf Neu können Sie neue Zugangsdaten hinterlegen.
Information
Hier wird als Beispiel das Zugangsdaten-Objekt der Komponente ELO Objekte &
Metadaten beschrieben. Der Aufbau dieses Objektes unterscheidet sich je nach
Komponente. Sie finden weitere Informationen im Bereich Komponenten.
Abb.: Neue Zugangsdaten
1: Mit Klick auf Erstellen speichern Sie die Zugangsdaten ab.
2: Über Testen testen Sie die aktuellen Eingaben.
3: Geben Sie einen Titel für das Zugangsdaten-Objekt an. Dieser wird daraufhin in der Übersicht
angezeigt.
4: Tragen Sie unter Archive-Url die Adresse zum ELO Indexserver ein.
5: Tragen Sie unter Password das Passwort des jeweiligen Benutzers ein.
6: Tragen Sie unter User name den Benutzer ein, den Sie verwenden wollen.
Zugangsdaten bearbeiten
1.19 Konfiguration und Verwaltung
Klicken Sie auf ein bestehendes Zugangsdaten-Objekt.
2. Klicken Sie auf Bearbeiten.
Nun können Sie die gewünschten Änderungen vornehmen.
Zugangsdaten löschen
Mit einem Klick auf Löschen löschen Sie das ausgewählte Zugangsdaten-Objekt.
Information
Das Default-Objekt ist nicht löschbar.
Icons
Mit Klick auf Icons werden Ihnen alle Icons angezeigt, welche für ELO Flows zu Verfügung
stehen. Diese Icons können für Schaltflächen (manuelle Templates) der ELO Clients verwendet
werden.
Abb.: Seite 'Icons'
1: Mit Klick auf Neu fügen Sie ein neues Icon hinzu.
2: Nach Auswahl eines Icons und Klick auf Bearbeiten können Sie das ausgewählte Icon ändern.
Information
Den Namen können Sie nicht ändern. Legen Sie einen neuen Eintrag an, falls Sie ein Icon
mit einem anderen Namen benötigen.
3: Über die Schaltfläche Löschen löschen Sie das ausgewählte Icon.
4: Unter der Übersicht finden Sie alle hinterlegten Icons.20 Konfiguration und Verwaltung
Icon erstellen
1. Klicken Sie auf Neu.
Abb.: Seite 'Icon erstellen'
Die Seite Icon erstellen erscheint.
2. Bearbeiten Sie die Seite über die nachfolgend beschriebenen Elemente:
1: Mit Klick auf Erstellen speichern Sie den Eintrag.
2 Im Feld Bezeichner geben Sie dem neuen Icon-Eintrag einen eindeutigen Namen.21 Konfiguration und Verwaltung
Beachten Sie
Der Name kann nicht nachträglich geändert werden.
Information
Verwenden Sie keine Sonderzeichen.
Folgende Zeichen sind erlaubt:
• a-z
• A-Z
• 0-9
• äöü
• ÄÖÜ
• ß
• _
3: Unter Icon können Sie eine Bilddatei als Icon hochladen.
• Maximalgröße : 1MB
• Format: SVG
4: Unter Vorschau wird Ihnen das aktuell hochgeladene Icon angezeigt.
Automatische Templates
Templates bestehen aus einem (automatischen) Trigger und aus mindestens einem oder
mehreren Diensten.
Neues Template anlegen
Abb.: Flows Administration Startseite
1. Klicken Sie auf Neuer Flow.
Die Seite Floweigenschaften erscheint.
2.22 Konfiguration und Verwaltung
Geben Sie für das neue Template grundlegende Metadaten ein. Nutzen Sie die
nachfolgend beschriebenen Elemente:
Abb.: Floweigenschaften
1: Mit Erstellen speichern Sie die Eingaben und ein neues Template wird erstellt.
2: Über Verwerfen brechen Sie die Template-Erstellung ab.
3: Unter Bezeichner geben Sie dem Flow einen eindeutigen Namen.
Information
Geben Sie dem Template einen Namen, welcher kurz beschreibt, was das Template
ausführt.
Information
Verwenden Sie keine Sonderzeichen.
Folgende Zeichen sind erlaubt:
◦ a-z
◦ A-Z
◦ 0-9
◦ äöü
◦ ÄÖÜ
◦ß
◦_
4: Über das Feld Gruppe können Sie Templates gruppieren. Sie können somit mehrere
Flows zu einer logischen Einheit zusammenführen. Die Gruppierung können Sie in der
Template-Übersicht anzeigen lassen.23 Konfiguration und Verwaltung
5 Unter Beschreibung können Sie detaillierter beschreiben, welche Funktion dieses
Template hat. Verwenden Sie dieses Feld, wenn Ihr Template komplex wird.
Abb.: Neuer Flow
Nachdem Sie Erstellen gewählt haben, sehen Sie das neue Template in der Übersicht. Diese
zeigt Unvollständig an, da noch keine Dienste definiert wurden.
In den nachfolgenden Abschnitten erfahren Sie, wie Sie den Flow vervollständigen.
Trigger wählen
Als Erstes müssen Sie einen Trigger definieren.
Abb.: Komponenten
1. Klicken Sie auf eine Komponente (1).
2. Bestätigen Sie die Komponente mit einem Klick auf Auswählen.
3. Die Seite Trigger erscheint. Wählen Sie hier den Trigger, welcher diesen Flow starten soll:24 Konfiguration und Verwaltung
Abb.: Seite 'Trigger'
4. Klicken Sie auf Auswählen, um diesen Trigger zu wählen.
Die Seite Einstellungen erscheint. Hier werden Ihnen Trigger-spezifische Einstellungen
angezeigt:25 Konfiguration und Verwaltung
Abb.: Trigger-Einstellungen
In diesem Beispiel können Sie den Trigger Eintrag angelegt auf bestimmte Masken
einschränken, in dem Sie hier den Maskennamen eintragen. Andere Trigger besitzen hier
natürlich andere Einstellungen.
5. Klicken Sie auf Weiter.26 Konfiguration und Verwaltung
Abb.: Seite 'Zusammenfassung'
Die Seite Zusammenfassung erscheint.
Diese Seite zeigt Ihnen eine Zusammenfassung aller Einstellungen an:
1: Unter Knotenschlüssel können Sie diesem Knoten einen Namen geben. Dieser wird
darauf Links im Template-Editor unter dem Trigger angezeigt.
2: Unter Knotenbeschreibung können Sie diesen Knoten noch weiter detaillieren.
3: Der Bereich Komponente zeigt Ihnen die gewählte Komponente an.
4: Der Bereich Dienst zeigt Ihnen den direkten Pfad zum Auslösen des Triggers an. Das
heißt, Sie könnten diesen auch direkt über diese URL ausführen. (Für erweiterte
Anwendungsfälle gedacht)
5: Der Bereich Einstellungen zeigt Ihnen die restlichen Einstellungen an.
6: Klicken Sie auf Abschließen, um die Trigger-Einstellungen zu übernehmen.27 Konfiguration und Verwaltung
Abb.: Trigger speichern
6. Klicken Sie im Template-Editor auf Speichern, um das Template abzuspeichern.
Dienst hinzufügen
1. Um dem Flow einen Dienst hinzufügen, klicken Sie auf das grüne Plussymbol (1).
Ein neuer Knoten (2) wird hinzugefügt.
2. Klicken Sie auf eine Komponente (3).
3. Bestätigen Sie mit Auswählen.
Abb.: Dienst anlegen
Die Seite Dienst erscheint.
4. Wählen Sie hier den gewünschten Dienst.
Es könnte sein, dass diese gruppiert sind.
Optional: Wählen Sie (falls vorhanden) eine Gruppe aus und klicken Sie auf einen Dienst.28 Konfiguration und Verwaltung
Abb.: Dienst auswählen
Die Dienste werden mit einem Blitzsymbol gekennzeichnet.
5. Bestätigen Sie mit Auswählen.
Die Seite Benutzer erscheint.29 Konfiguration und Verwaltung
Abb.: Seite 'Benutzer'
Information
Falls Sie schon auf der ELO Flows Startseite einen Benutzer hinterlegt haben,
können Sie diesen hier auswählen. Ansonsten können Sie die Default-Verbindung
wählen, oder eine neue hinzufügen.
Die Seite Einstellungen erscheint. Hier wird es Ihnen ermöglicht Daten zu hinterlegen,
welche der Dienst verwendet.30 Konfiguration und Verwaltung
Abb.: Diensteinstellungen
In den markierten Feldern können statische sowie dynamische Werte eingetragen
werden. Eine dynamische Auswertung geschieht auf der Basis von JSONata. Mit dieser
Transformationssprache können Sie auf Ergebnisobjekte der vorangehenden Knoten und
Trigger zugreifen, sowie Transformationen oder einfache Funktionen verwenden.
Information
Mehr zur JSONata Verwendung in ELO Flows finden Sie hier.
6. Klicken Sie auf Weiter.
Information
Manche Dienste bieten Ihnen die Funktion des Ausgabe-Schemas an. Das
bedeutet, dass dieser Dienst ein dynamisches Ausgabe-Objekt anbietet. Dies kann
z. B. bei Metadaten-Objekten vorkommen.
Beispiel: Sie legen ein Dokument mit der Maske E-Mail ab und möchte in einem
folgenden Knoten auf ein Feld dieses Dokumentes zugreifen. Da ELO Flows
zunächst nicht weiß, welche Felder für dieses Dokument infrage kommen, bietet31 Konfiguration und Verwaltung
Ihnen der Dienst im Folgeobjekt nur das übergeordnete Objekt (z. B. objKeys) an
ohne Zugriff auf einzelne Metadaten-Felder.
Damit ELO Flows weiß, welche Metadaten-Felder das Ausgabe-Objekt besitzt,
können Sie beispielsweise eine Maske laden. Geben Sie in das Feld Maske E-Mail
ein und klicken Sie auf Schema laden. Das Schema wird mit den passenden
Maskeneigenschaften geladen.
Abb.: Ausgabe-Schema laden
Alternativ können Sie auch Standard benutzen wählen. Dann wird das Objekt mit
Standard-Eigenschaften ausgegeben und der Zugriff auf die Eigenschaften des
Objektes muss manuell über JSONata erfolgen.32 Konfiguration und Verwaltung
Abb.: Standard Ausgabe-Schema geladen
Falls vorhanden, bestätigen Sie die Einstellungen auf der Seite Ausgabe Schema
mit Weiter.33 Konfiguration und Verwaltung
Abb.: Seite 'Zusammenfassung'
Die Seite Zusammenfassung erscheint. Hier werden Ihnen nochmals alle Einstellungen
angezeigt.
1: Im Feld Knotenschlüssel können Sie diesem Knoten einen Namen geben. Dieser wird
im Template-Editor unter dem Symbol angezeigt.
2: Im Feld Knotenbeschreibung können Sie eine noch detailliertere Beschreibung
hinterlegen.
Information
Verwenden Sie diese Felder, um auch bei größeren Templates den Überblick zu
behalten.
3: Mit der Checkbox Keinen Fehler auslösen, wenn der Dienst fehlschlägt. wird der
komplette Flow durchgelaufen, auch wenn dieser Dienst fehlschlägt. Beachten Sie, dass
Ergebnisdaten dieses Dienstes fehlerhaft oder nicht vorhanden sein können.
7. Klicken Sie auf Abschließen, um den Dienst zu übernehmen.34 Konfiguration und Verwaltung
Abb.: Angelegter Dienst
1: Die Statusanzeige zeigt Ihnen den Aktivierungsstatus des aktuellen Templates an.
2: Mit Klick auf Speichern speichern Sie das gesamte Template.
3: Im Template-Editor wird nun der angelegte Dienst vollständig angezeigt.
4: Mit dem grünen Plussymbol können Sie bei Bedarf weitere Dienste anhängen.
8. Speichern Sie das Template.
Die Statusanzeige sollte nun auf Aktiv wechseln.
Manuelle Templates
Manuelle Templates bestehen aus einem manuellen Trigger und aus mindestens einem oder
mehreren Diensten.35 Konfiguration und Verwaltung
Neues Template anlegen
Abb.: Übersicht für manuelle Templates
1. Klicken Sie in der linken Menüleiste auf Manuelle Templates (1).
2. Klicken Sie auf Neuer Flow (2).
Alternativ: Mit Template importieren (3) können bereits exportierte Templates als JSON-
Datei importiert werden.
3. Geben Sie dem anzulegenden Flow die entsprechenden Metadaten mit:
Abb.: Floweigenschaften
1: Mit Erstellen speichern Sie die Eingaben und ein neues Template wird erstellt.36 Konfiguration und Verwaltung
2: Über Verwerfen brechen Sie die Template-Erstellung ab.
3: Unter Bezeichner geben Sie dem Flow einen eindeutigen Namen.
Information
Geben Sie dem Template einen Namen, welcher kurz beschreibt, was das Template
ausführt.
Information
Verwenden Sie keine Sonderzeichen.
Folgende Zeichen sind erlaubt:
◦ a-z
◦ A-Z
◦ 0-9
◦ äöü
◦ ÄÖÜ
◦ ß
◦ _
4: Über das Feld Gruppe können Sie Templates gruppieren. Sie können somit mehrere
Flows zu einer logischen Einheit zusammenführen. Die Gruppierung können Sie in der
Template-Übersicht anzeigen lassen.
5 Unter Beschreibung können Sie detaillierter beschreiben, welche Funktion dieses
Template hat. Verwenden Sie dieses Feld, wenn Ihr Template komplex wird.
4. Klicken Sie auf Erstellen.
Sie sehen das neue Template in der Übersicht. Diese zeigt Unvollständig an, da noch
keine Trigger und Dienste definiert wurden.
Trigger wählen
1. Klicken Sie auf den Flow, um ihn zu ergänzen.
Als Erstes müssen Sie einen Trigger definieren. Da Sie ein manuelles Template anlegen,
können Sie hier keinen Trigger einer Komponente wählen, sondern definieren hier eine
Schaltfläche für die ELO Clients.37 Konfiguration und Verwaltung
Abb.: Manueller Trigger
1: Im Feld Label definieren Sie die Beschriftung. Dieser Text wird als Titel der Schaltfläche
in den ELO Clients angezeigt.
2: Das Feld Hinweis setzt einen Tooltip-Text für die angelegte Schaltfläche.
3: Mit der Einstellung Maske, können Sie die gültige Maske für diese Schaltfläche wählen.
Das heißt, dass die Schaltfläche wird nur aktiviert, wenn das gewählte Element die
definierte Maske trägt.
4: Die Einstellung Kontext aktivieren für... definiert die gültigen Elementtypen. Sie können
zwischen Ordner* und *Dokument wählen. Die Schaltfläche wird nur aktiviert, wenn das
gewählte Element ein Ordner und/oder ein Dokument ist. Des Weiteren wird ihnen nach
Aktivierung die Objekt-ID des gewählten Objektes in Flows zur Verfügung gestellt.
5: Mit der Auswahl Als Kachel wird die Schaltfläche als Kachel im Funktionsbereich Mein
ELO angezeigt. Sie können ein Symbol hinterlegen, welches im ELO Client angezeigt
werden soll.
6: Mit der Auswahl In Menüband können Sie können die Position der Schaltfläche im
Menüband der ELO Client definieren. Wählen Sie hier den Tab, die Gruppe und das
Symbol aus.
Mit dem Kontrollkästchen Nur in bestimmten ELO Clients anzeigen können Sie steuern, in
welchen Clients die Schaltfläche angezeigt wird. Wenn hier nichts gewählt ist, wird dieser
in allen Clients angezeigt.38 Konfiguration und Verwaltung
7: Ist die Option Benutzer/Gruppen aktiviert, können Sie ELO Gruppen und Benutzer
definieren, welche die Schaltfläche angezeigt bekommen. Ist Option nicht aktiviert, wird
die Schaltfläche allen Benutzern angezeigt.
2. Bestätigen Sie Ihre Eingaben mit Weiter.
Es wird Ihnen eine Zusammenfassung Ihrer Eingaben angezeigt.
Optional: Setzen Sie für eine bessere Lesbarkeit einen Knotenschlüssel und eine
Knotenbeschreibung. Diese wird Ihnen im Template-Editor angezeigt.
3. Die Triggerbearbeitung können Sie nun Abschließen.
Aktivitäten hinzufügen
Da Sie einen manuellen Trigger anlegen, können Sie definieren,was angezeigt wird, wenn die
Schaltfläche im Client geklickt wird. Diese Anzeige nennen wir Aktivitäten.
Abb.: Aktivitäten
1. Um eine Aktivität hinzuzufügen, klicken Sie auf das obere grüne Plussymbol.
Auf der Seiten Aktivität werden Ihnen nun alle verfügbaren Aktivitäten angezeigt.
◦ Information: Zeigt einen reinen Informationstext an. Diese Aktivität liefert somit
keine Daten.
◦ Vereinbarung: Hier können Sie Kontrollkästchen definieren, um mit den Benutzern
eine Vereinbarung zu treffen. Zum Beispiel eine Datenschutzvereinbarung,
Lizenzvereinbarung... etc.
◦ Dokumenten-Upload: Mit dieser Aktivität können Sie den Benutzer auffordern ein
Dokument hochzuladen. Sie können dieses zum Beispiel mit der ELO Objekte &
Metadaten in ELO speichern.
◦39 Konfiguration und Verwaltung
Date-Picker: Zeigt einen Kalender an. Benutzer können hier ein bestimmtes Datum
oder ein Datumsintervall auswählen.
◦ Formular: Zeigt ein Formular an. Zum Beispiel können Sie hiermit ein
Kontaktformular umsetzen.
◦ Zusammenfassung: Die Zusammenfassung zeigt alle Daten vorausgegangener
Aktivitäten an. Sie können dieses an das Ende setzen, um nochmals einen
Überblick zu geben.
◦ Repositoryauswahl: Mit der Aktivität Repositoryauswahl, können Sie die Benutzer
auffordern, ein Element aus dem ELO Repository auszuwählen. Setzen Sie in den
Einstellungen das Root-Element, um zu definieren, von welcher Ebene aus die
Benutzer eine Auswahl angeboten bekommen.
◦ Benutzerauswahl: Mit dieser Aktivität können Sie die Benutzer auffordern einen ELO
Benutzer und/oder ELO Gruppe aus dem ELO System auszuwählen.
2.
Wählen Sie eine Aktivität aus.
Optional 1: Um eine Abfolge dieser Aktivitäten abzubilden, sind diese verkettbar. Klicken
Sie erneut auf das grüne Plussymbol, um eine weitere Aktivität hinzuzufügen.
Optional 2: Um eine Aktivität zu löschen, klicken Sie auf diese im Template-Editor und
wählen das Mülleimer-Symbol.
Folgendermaßen werden die Schaltfläche und die Aktivitäten im Client angezeigt:
Beachten Sie
Die Schaltfläche wird erst angezeigt, wenn der Status des Flows auf Aktiv steht. Hierzu
müssen Sie mindestens einen Dienst definieren.
Nachdem Sie Aktivitäten definiert haben, können Sie den ersten Dienst anlegen.40 Konfiguration und Verwaltung
Dienst hinzufügen
Abb.: Dienst anlegen
1. Klicken Sie auf das grüne Plussymbol unterhalb des Triggers.
ELO Flows fügt ein neuen Knoten hinzu.
Die Seite Komponenten erscheint.
2. Wählen Sie eine Komponente aus.
3. Bestätigen Sie mit Auswählen.
Die Seite Dienst erscheint.
4. Wählen Sie hier den gewünschten Dienst.41 Konfiguration und Verwaltung
Abb.: Dienst wählen
Optional: Es kann sein, dass diese gruppiert sind. Wählen Sie (falls vorhanden) eine
Gruppe aus und klicken Sie auf einen Dienst. Diese werden mit einem Blitzsymbol
gekennzeichnet. Bestätigen Sie mit Auswählen.
Die Seite Benutzer erscheint.42 Konfiguration und Verwaltung
Abb.: Seite 'Benutzer'
Falls Sie schon auf der ELO Flows Startseite einen Benutzer hinterlegt haben, können Sie
diesen hier auswählen. Ansonsten können Sie die Default-Verbindung wählen, oder eine
neue hinzufügen. Des Weiteren ist es möglich den Benutzerkontext auszuwählen. Hiermit
wird die Aktion vom angemeldeten Benutzer und somit mit dessen Rechte ausgeführt.
5. Klicken Sie auf Weiter.
Die Seite Einstellungen erscheint.
6. Geben Sie Daten ein, welche der Dienst verwenden soll.43 Konfiguration und Verwaltung
Abb.: Diensteinstellungen
In den markierten Feldern können statische sowie dynamische Werte eingetragen
werden. Eine dynamische Auswertung geschieht auf der Basis von JSONata. Mit dieser
Transformationssprache können Sie auf Ergebnisobjekte der vorangehenden Knoten und
Trigger zugreifen, sowie Transformationen oder einfache Funktionen verwenden.
Hinweis
Mehr zur JSONata Verwendung in ELO Flows finden Sie hier.
7. Klicken Sie auf Weiter.
Die Seite Zusammenfassung erscheint.
Hier werden Ihnen nochmals alle Einstellungen angezeigt.44 Konfiguration und Verwaltung
Abb.: Seite 'Zusammenfassung'
1: Im Feld Knotenschlüssel können Sie diesem Knoten einen Namen geben. Dieser wird
im Template-Editor unter dem Symbol angezeigt.
2: Im Feld Knotenbeschreibung können Sie eine noch detailliertere Beschreibung
hinterlegen.
Information
Verwenden Sie diese Felder, um auch bei größeren Templates den Überblick zu
behalten.
3: Ist die Option Keinen Fehler auslösen, wenn der Dienst fehlschlägt. aktiviert, wird der
komplette Flow durchgelaufen, auch wenn dieser Dienst fehlschlägt. Beachten Sie, dass
Ergebnisdaten dieses Dienstes fehlerhaft oder nicht vorhanden sein können.
8. Klicken Sie auf Abschließen, um den Dienst zu übernehmen.45 Konfiguration und Verwaltung
Abb.: Dienst im Editor
1: Im Template-Editor wird nun der angelegte Dienst vollständig angezeigt.
2: Mit dem grünen Plussymbol können Sie an diesen Dienst bei Bedarf weitere Dienste
anhängen.
3: Die Statusanzeige zeigt Ihnen den Aktivierungsstatus des aktuellen Templates an.
4: Mit einem Klick auf Speichern speichern Sie das gesamte Template.
9. Klicken Sie auf Speichern.
Die Statusanzeige sollte nun auf Aktiv wechseln.
Abfrage-Templates
Abfrage-Templates sind spezielle Flows-Vorlagen um Daten bereitzustellen. Diese laufen
synchron ab und stellen eine Möglichkeit dar, mit den entsprechenden Komponenten,
Datenabfragen bereitzustellen. Eine Anwendung sind beispielsweise dynamische
Stichwortlisten. In der aktuellen Version 21.1 ist diese Möglichkeit schon implementiert. ELO
liefert jedoch (noch) keine Komponenten hierfür aus. Sie können schon Komponenten für dieses
Feature selbst umsetzen und somit Datenabfragen bereitstellen. Prüfen Sie hierzu die
Dokumentation für Komponentenentwickler.46 Konfiguration und Verwaltung
Synchrone Flows
In den Standardeinstellungen sind alle Flows-Templates asynchron, welche ohne eine
Rückmeldung (außer Fehlermeldungen) ausgeführt werden. Dies ergibt in den meisten Fällen
Sinn, wenn beispielsweise das User-Interface nicht blockiert werden soll. In anderen Fällen ist
jedoch eine synchrone Abarbeitung erwünscht. Hierzu wurde das Feature der synchronen Flows
eingeführt.
Synchrone Flows der manuellen Templates
1. Öffnen Sie einen manuellen Flow
Abb.: Flaggensymbol
2. Um das synchrone Feature für den manuellen Flow zu aktivieren, klicken Sie am Ende der
Dienstkette auf das Flaggensymbol.
Abb.: Seite 'Eigenschaften'
Die Seite Eigenschaften erscheint.
3. Aktivieren Sie den Schalter Synchrone Rückmeldung aktivieren.47 Konfiguration und Verwaltung
Abb.: Drop-down-Menü
Ein Drop-down-Menü mit unterschiedlichen Aktionen erscheint:
◦ Aktualisieren: Aktualisiert den Client nach Abarbeitung des Flows.
◦ Gehe zu: Der Client springt zum hinterlegten Objekt.
◦ Rückmeldung: Der Client zeigt einen Toast mit der hinterlegten Meldung an.
◦ Info: Der Client zeigt eine Info-Box mit der hinterlegten Nachricht an.
◦ Fehler: Der Client zeigt eine Error-Box mit der hinterlegten Nachricht an.
4.
Wählen Sie eine Aktion aus.
5. Klicken Sie auf die Schaltfläche Client-Aktion hinzufügen.
Abb.: Objekt-Eigenschaften48 Konfiguration und Verwaltung
Information
Sie können mehrere Client-Aktionen verketten.
Allerdings sind nicht alle Kombinationen sinnvoll.
Beispiel: Eine Gehe-zu-Aktion impliziert eine Aktualisieren-Aktion. Diese müssten
Sie also nicht verketten.
6. Hinterlegen Sie die gewünschten Objekt-Eigenschaften.
7. Klicken Sie auf Abschließen.
Abb.: Geändertes Flaggensymbol
Die ausgewählte(n) Aktionen(en) werden mit dem Flow verknüpft. Das Flaggensymbol
ändert sich.
8. Klicken Sie auf Speichern.
Der Flow wird gespeichert.
Synchrone Flows der automatischen Templates
Falls ein Trigger mit einer synchronen Rückmeldung verwendet wird, erscheint auch in den
automatischen Templates das Flaggensymbol am Ende der Dienstkette.49 Konfiguration und Verwaltung Abb.: Flaggensymbol in einem automatischen Template Ob das Flaggensymbol erscheint, ist jeweils von der verwendeten Komponente abhängig. Falls der gewählte Trigger keine synchrone Rückmeldung unterstützt wird das Flaggensymbol nicht angezeigt. Abb.: Seite 'Eigenschaften' bei einem automatischem Trigger Im Gegensatz zum manuellen Template können in automatischen Templates keine Eigenschaften für die synchrone Rückmeldung hinterlegt werden. Der Trigger definiert hier das Ergebnis. Das Flaggensymbol ist hier ausschließlich als Indikator gedacht, dass eine synchrone Rückmeldung stattfindet. JSONata-Editor Der JSONata-Editor in ELO Flows ist für die Definition von Dienst-Eigenschaften zuständig. Das heißt, wenn Sie einen Dienst anlegen wird dieser wahrscheinlich Daten benötigen, mit denen er die jeweilige Aktion ausführen wird. Ein einfaches Beispiel wäre die Objekt-ID eines ELO Objektes. Diese wird verwendet im Dienst Beitrag schreiben der ELO Feed Komponente:
50 Konfiguration und Verwaltung Der Dienst möchte wissen, zu welchem Objekt ein Feed-Eintrag geschrieben werden soll. Sie könnten hier natürlich einen festen Wert eintragen, jedoch ist dies in den meisten Fällen nicht sinnvoll. Um die Objekt-ID dynamisch zu ermitteln, verwendet ELO Flows für den Daten-Zugriff und Daten-Transformation die Transformationssprache JSONata. 1: Im Eingabefeld können Sie entweder feste Werte, oder einen JSONata-Ausdruck eingeben. 2: Für einen Ausdruck wechseln Sie unter dem Dropdown auf den Expertenmodus. 3: Das Feld Typ zeigt Ihnen den Typ an, welcher für diese Eigenschaft erwartet wird. Das heißt, dass das Ergebnis der Eingabe diesen Typ erzeugen muss. 4: Unter Daten können Sie auf Daten vorangehender Knoten zugreifen. Wählen Sie einfach aus dem Baum die Eigenschaft aus, welche Sie übergeben möchten. In diesem Beispiel können Sie, falls Sie den Kontext eines manuellen Triggers aktiviert haben, unter trigger.objid die Objekt-ID des im ELO Client gewählten Objektes übergeben. 5: Der Tab Vorschläge bietet Ihnen in JSONata unterstützte Funktionen an. Diese können Sie verwenden, um Daten zu transformieren.
51 Konfiguration und Verwaltung
Information
Weitere Informationen zum Aufbau und Möglichkeiten mit JSONata finden Sie unter
jsonata.org
Webhooks und Token-Authentifizierung
Die Absicherung von Trigger-Events, die durch Drittsystemaufrufe ausgelöst werden, kann
durch die Erstellung eines Tokens mit zugewiesenem Benutzerkontext erfolgen. Die
Überprüfung orientiert sich dabei am WebSub-Standard. Drittsystemen, die den Standard nicht
umsetzen, kann das Token als Query-Parameter in der Webhook-URL mitgegeben werden.
Token-Verwaltung
Die Token-Verwaltung stellt eine Übersicht aller Endpunkte und ihrer jeweiligen Token bereit.
Abb.: Token-Verwaltung
1. Mit einem Klick auf den Eintrag Token in der Sidebar öffnen Sie die Token-Verwaltung.
In der Token-Verwaltung werden alle verwendeten Endpunkte und ihre Token aufgelistet.
Außerdem lassen sich hier Token erstellen, anpassen und zurückziehen.
Für die übersichtliche Darstellung der Endpunkt und ihrer jeweiligen Token sind die
Endpunkteinträge zunächst zugeklappt. Erst durch einen Klick auf einen Endpunkt wird
eine Liste mit den Token zu genau diesem Endpunkt angezeigt.
• 1 Mit einem Klick auf Erstellen kann ein neues Token angelegt werden. Mehr dazu unter
Token-Erstellung.
◦ Durch einen Doppelklick auf einen Token-Eintrag lässt sich der Bearbeitungsdialog
starten. Dort kann der Benutzerkontext und das Ablaufdatum des Tokens angepasst
werden.
• 2 Über Sie Schaltfläche Zurückziehen kann ein Token wieder zurückgezogen werden.
Drittsysteme, die dieses Token verwenden, sind damit nicht mehr autorisiert Trigger-
Events auszulösen.52 Konfiguration und Verwaltung
Token-Erstellung
Ein Token benötigt einen Benutzerkontext und ein Ablaufdatum. Diese können über den
Erstellungsidalog gesetzt werden.
1. Klicken Sie in der Tokenverwaltung auf einen Endpunkt.
Der Endpunkt wird aufgeklappt.
1. Klicken Sie im Endpunkt auf Erstellen.
Der Dialog Token erscheint.
Abb.: Dialog 'Token'
1. Tragen Sie in das Feld Ablaufdatum ein, wie lange das Token gültig sein soll.
2. Klicken Sie auf Benutzerauswahl.
Ein Suchfeld erscheint.
3. Suchen Sie den gewünschten Benutzer, über welchen das Token laufen soll.
Information
Der Benutzer muss im Menüpunkt Zugangsdaten angelegt sein.
4. Wählen Sie den gewünschten Benutzer aus.
5. Klicken Sie auf Erstellen.
ELO Flows erstellt ein neues Token.53 Konfiguration und Verwaltung
Abb.: Token-Erstellung abgeschlossen
Nach der Erstellung wird im Dialog das Secret angezeigt, das bei der Webhook-Registrierung
verwendet wird.
Achtung
Das Secret kann nicht erneut eingesehen werden. Erstellen Sie daher eine Kopie.
Query-Parameter
Nicht jedes Drittsystem unterstützt den Websub-Standard. Um dennoch ein solches System
verwenden zu können, besteht die Möglichkeit die Webhook-URL mit einem Query-Parameter zu
versehen, der das Token-Secret enthält. Diese URL wird dann für die Registrierung des
Webhooks im Drittsystem verwendet. Dadurch wird das Secret beim Auslösen des Trigger-
Events aus dem Drittsystem mitgeliefert und es kann eine Authentifizierung erfolgen.
Ein möglicher Endpunkt kann zum Beispiel so aussehen:
http://:/ix-/plugin/de.elo.ix.plugin.proxy/flows/api/v1/trigger/com.elo.flows/EL
Beachten Sie
Query-Parameter sollten nur bei einer möglichen HTTPS-Verbindung verwendet werden.54 Konfiguration und Verwaltung
Komponenten
ELO Objekte & Metadaten
Abb.: Symbol der Komponente 'ELO Objekte & Metadaten'
Installation
Um die Komponente ELO Objekte & Metadaten zu installieren, kopieren Sie die entsprechende
JAR-Datei in das Karaf-Verzeichnis deploy. Die Komponente ELO Objekte & Metadaten sollte
daraufhin in der ELO Flows Administration angezeigt werden.
Ziel und Verwendung
Die ELO Objekte & Metadaten bietet Ihnen grundlegende Funktionen, um mit einem ELO
Repository zu kommunizieren.
Zugangs- und Verbindungsdaten
Für die Komponente ELO Objekte & Metadaten ist es verpflichtend Verbindungsdaten zu
hinterlegen. Einerseits steht eine Default-Verbindung zur Verfügung. Diese wird in den Config-
Files eingepflegt. Der Benutzerkontext übernimmt die Session des angemeldeten Benutzers im
ELO Client. Darüber hinaus können Sie weitere Verbindungen erstellen, um Dienste mit
definierten Rechten auszuführen.
Trigger
Trigger sind Startpunkte eines Flows. Die Komponente ELO Objekte & Metadaten bietet
folgende Trigger an:
Name Event
Objekt
Wird gestartet, wenn ein Objekt in ELO abgelegt wurde.
angelegt
Objekt Wird gestartet, wenn ein Objekt in ELO geändert wurde (Metadaten,
geändert Versionen, ...).
Dienste
Dienste sind Aktionen, welche innerhalb eines Flows ausgeführt werden können. Die
Komponente ELO Objekte & Metadaten bietet folgende Dienste an:55 Konfiguration und Verwaltung
Gruppe 'Berechtigung'
Name Funktion
Berechtigungen hinzufügen Fügt einem Objekt Berechtigungen hinzu.
Berechtigungen entfernen Entfernt Berechtigungen von einem Objekt.
Gruppe 'Neu'
Name Funktion
Neues Dokument Legt ein neues Dokument im Repository ab.
Neuer Ordner Legt einen neuen Ordner im Repository an.
Gruppe 'Metadaten'
Name Funktion
Metadaten laden Liest Metadaten eines Objektes aus und stellt Sie im Flow zur Verfügung.
Farbe ändern Setzt die Farbe eines Objektes.
Maske ändern Setzt die Maske eines Objektes.
Metadaten setzen Setzt definierte Metadaten auf ein Objekt.
Gruppe 'Verwalten'
Name Funktion
Kopieren Kopiert ein ELO Objekt und legt die Kopie ab.
Löschen Löscht ein ELO Objekt.
Verschieben Verschiebt einen Eintrag im Repository.
Referenzieren Erzeugt eine Referenz eines ELO Objekts im Repository.
Gruppe 'zusätzliche Metadaten'
Name Funktion
Lädt Map-Felder eines Objektes und stellt diese in ELO Flows zur
Map-Felder laden
Verfügung.
Map-Felder
Schreibt Werte in Map-Felder eines Objektes
schreiben
Gruppe 'Dokumente'
Name Funktion
Arbeitsversion Lädt eine Version eines Objektes herunter und stellt es in ELO Flows
herunterladen zur Verfügung.
Dokumentversion
Lädt eine ELO Flows Datei als Dokumentversion in ein Objekt.
hochladen56 Konfiguration und Verwaltung
ELO Feed
Abb.: Symbol der Komponente 'ELO Feed'
Installation
Um die Komponente ELO Feed zu installieren, kopieren Sie die entsprechende JAR-Datei in das
Karaf-Verzeichnis deploy. Die Komponente ELO Feed sollte daraufhin in der ELO Flows
Administration angezeigt werden.
Ziel und Verwendung
Die Komponente ELO Feed bietet Ihnen grundlegende Funktionen, um Feed-Einträge zu
erstellen und zu bearbeiten.
Zugangs- und Verbindungsdaten
Für die Komponente ELO Feed ist es verpflichtend Verbindungsdaten zu hinterlegen. Einerseits
steht eine Default-Verbindung zur Verfügung. Diese wird in den Config-Files eingepflegt. Der
Benutzerkontext übernimmt die Session des angemeldeten Benutzers im ELO Client. Darüber
hinaus können Sie weitere Verbindungen erstellen, um Dienste mit definierten Rechten
auszuführen.
Trigger
Trigger sind Startpunkte eines Flows. Die Komponente ELO Feed bietet keine Trigger an.
Dienste
Dienste sind Aktionen, welche innerhalb eines Flows ausgeführt werden können. Die
Komponente ELO Feed bietet folgende Dienste an:
Name Funktion
Beitrag schreiben Schreibt einen Feed-Eintrag auf ein Objekt.
Verwendung
Der Dienst Beitrag schreiben akzeptiert einen String als Parameter. Zur Verwendung eines
Hashtags oder einer Erwähnung verwenden Sie folgendes Format:
• #[HASHTAG]
• @[User]57 Konfiguration und Verwaltung
ELO Time
Abb.: Symbol der Komponente 'ELO Time'
Installation
Um die Komponente ELO Time zu installieren, kopieren Sie die entsprechende JAR-Datei in das
Karaf-Verzeichnis deploy. Die Komponente ELO Time sollte daraufhin in der ELO Flows
Administration angezeigt werden.
Ziel und Verwendung
Die Komponente ELO Time bietet Ihnen die Möglichkeit zeitgesteuert ELO Flows zu starten.
Zugangs- und Verbindungsdaten
Diese Komponente benötigt keine Zugangsdaten.
Trigger
Trigger sind Startpunkte eines Flows. Die Komponente ELO Time bietet folgende Trigger an:
Name Event
Zeitlicher Trigger Wird per Cron-Ausdruck gestartet.
Verwendung:
Sie können die Auslösung des Triggers Zeitlicher Trigger über einen Cron-Ausdruck definieren.
Dieser sieht sechs Felder vor.
Beachten Sie
Eine Unix-Cron-Definition ist nur mit fünf Feldern definiert. Hier werden keine Sekunden
verwendet.
ELO Flows verwendet das Cron-Format von Spring mit einem Sekunden-Feld. Der Aufbau sieht
folgendermaßen aus:
Sekunde, Minute, Stunde, Tag des Monats, Monat, Tag der Woche
Beispiel 1: Jede Stunde:
0 0 * ? * *58 Konfiguration und Verwaltung Beispiel 2: Jede Minute: 0 * * ? * * Des Weiteren können Felder nicht doppelt belegt werden. Wie in Beispiel 2 zu entnehmen wurde das Feld Tag des Monats durch ein '?' nicht belegt. Andere Systeme erlauben oft eine Doppelbelegung. Zum Beispiel: 0 * * * * *. Dies funktioniert hier nicht. Dienste Dienste sind Aktionen, welche innerhalb eines Flows ausgeführt werden können. Die Komponente ELO Time bietet keine Dienste an. ELO Workflow Abb.: Symbol der Komponente 'ELO Workflow' Installation Um die Komponente ELO Workflow zu installieren, kopieren Sie die entsprechende JAR-Datei in das Karaf-Verzeichnis deploy. Die Komponente ELO Workflow sollte daraufhin in der ELO Flows Administration angezeigt werden. Ziel und Verwendung Die Komponente ELO Workflow bietet Funktionalitäten an, um einen ELO Workflow aus einem Flow heraus zu starten. Des Weiteren können Flows durch Workflows ausgelöst werden. Zugangs- und Verbindungsdaten Für die Komponente ELO Workflow ist es verpflichtend Verbindungsdaten zu hinterlegen. Einerseits steht eine Default-Verbindung zur Verfügung. Diese wird in den Config-Files eingepflegt. Darüber hinaus können Sie weitere Verbindungen erstellen, um Dienste mit definierten Rechten auszuführen. Trigger Trigger sind Startpunkte eines Flows. Die Komponente ELO Workflow bietet folgende Trigger an: Name Event Workflow-Knoten Wird gestartet, wenn ein Flow aus einem Workflow heraus gestartet Event wurde.
59 Konfiguration und Verwaltung Verwendung Abb.: ELO Workflow-Komponente Wählen Sie in ELO Flows den Trigger Workflow-Knoten Event aus. Geben Sie unter Einstellungen/Eventname einen Wunschnamen ein. Zum Beispiel exampleEvent. Wählen Sie im ELO Workflowdesigner einen Knoten aus, mit dem Sie einen Flow triggern möchten. Fügen Sie unter Ende-Skript folgenden Eintrag ein: flows-plugin/wf-event/exampleEvent Nach Durchlauf des ELO Workflows und Ausführen des Ende-Skriptes wird der Flow gestartet. Alternative (für Experten) Geben Sie im Ende-Skript statt dem Event-Namen Folgendes ein: flows-plugin/wf-hook Im Feld Skripteigenschaften geben Sie beispielsweise Folgendes ein: com.elo.flows.components/EloWorkflowComponent/1.0/StartFromWorkflowTrigger Sie setzen dadurch den zu startenden Trigger ELO Workflow. Hier können Sie nun jeden beliebigen Trigger starten. Sie benötigen hierzu nur den Pfad zum Trigger innerhalb der Komponente. Dienste Dienste sind Aktionen, welche innerhalb eines Flows ausgeführt werden können. Die Komponente ELO Workflow bietet folgende Dienste an:
Sie können auch lesen
