Konfigurationen managen

In den folgenden Kapiteln ist beschrieben, wie Sie Workflow-Konfigurationen erstellen und bearbeiten.

Workflow Designer starten

Der Workflow Designer nutzt die aktive Verbindung von DocuWare Desktop Apps zu Ihrem DocuWare System. Wenn Sie den Workflow Designer starten, gehen Sie daher unterschiedlich vor, je nachdem, ob bereits eine aktive Verbindung besteht.

1. Es besteht eine aktive Verbindung: Sie öffnen das Windows-Startmenü und klicken auf Alle Programme > DocuWare Workflow Designer oder Sie klicken doppelt auf das Icon des Workflow Designer auf Ihrem Desktop. Der Workflow Designer startet.

2. Es besteht keine aktive Verbindung: Sie öffnen zunächst das Tray-Menü von DocuWare Desktop Apps, klicken auf Verbindungen bearbeiten und dann in dem neuen Dialog auf Standardverbindung herstellen. Oder Sie öffnen in Ihrem DocuWare Client das Hauptmenü und klicken auf Desktop Apps verbinden. Dann starten Sie den Workflow Designer wie in 1. beschrieben.

Startseite: Übersicht

Die Startseite von Workflow Designer, Übersicht, bildet den Ausgangspunkt für das Erstellen und Bearbeiten von Workflow-Konfigurationen. Sie gliedert sich in drei Bereiche: Oben befinden sich die Navigationsleiste und das Menü. In der Mitte werden alle erstellten Workflows aufgelistet. Im unteren Bereich erhalten Sie Detailinformationen zu dem in der obigen Liste jeweils ausgewählten Workflow.

Navigationsleiste

Mit den Reitern der Navigationsleiste wechseln Sie zwischen der Übersicht über alle Workflows und den Flussdiagramm-Ansichten der einzelnen Workflows. Die Seite Übersicht wird immer mit einem eigenen Reiter dargestellt. Die Seite eines einzelnen Workflows wird nur dann mit einem Reiter aufgeführt, wenn er geöffnet wurde, entweder per Doppelklick auf seinen Listeneintrag oder über ein Markieren in der Liste und einen Klick auf Bearbeiten.

Mit der Funktion Veröffentlichen stellen Sie den Workflow den berechtigten Benutzern zur Verfügung.

Workflow-Liste und Details

Wenn Sie in der Workflow-Liste oben einen Workflow auswählen, werden Ihnen im unteren Bereich dessen Details angezeigt. Links sind in einer Liste die wichtigsten Details zu dem jeweiligen Workflow aufgeführt. In der Mitte des unteren Bereichs finden Sie eine Tabelle mit zwei Modi: Versionen und Aktive Instanzen. Standardmäßig wird der Modus Versionen angezeigt. Rechts wird eine Miniatur-Vorschau des ausgewählten Workflows angezeigt.

• Versionen: Auf der Registerkarte werden alle Versionen einer Workflow-Konfiguration aufgelistet, die jemals gespeichert wurden. Diese Liste stellt eine Art Entwicklungsgeschichte eines Workflows dar.
  Eine neue Workflows-Version ist sinnvoll, wenn Sie z.B. einen Workflow weiterentwickelt und publiziert haben, dieser aber nicht in der gewünschten Weise funktioniert.
  Der Lesemodus ist z.B. sinnvoll, wenn Sie prüfen möchten, wie der Prozess zu einem früheren Zeitpunkt aufgebaut war. Der Reiter in der Workflow-Übersicht enthält dann den Hinweis Lesemodus. Nur die jeweils aktuelle Workflow-Version wird im Bearbeiten-Modus geöffnet.

• Aktive Instanzen: Diese Registerkarte zeigt Ihnen alle aktiven Instanzen einer Workflow-Konfiguration an und Sie erfahren, welche Aktivität derzeit bearbeitet wird.

Berechtigungen

Es gibt zwei Berechtigungen für die Workflow-Konfiguration: Designer und Controller.

• Designer

  Der Designer ist berechtigt, bestehende Workflow-Konfigurationen zu bearbeiten, zu löschen, zu veröffentlichen, deren Veröffentlichung aufzuheben und den Workflow zu debuggen, also Fehler darin zu beseitigen.

  Für die Funktion Neuen Workflow erstellen und Kopieren benötigen Sie das Funktionsrecht Workflows designen, das in der DocuWare Konfiguration > Benutzerverwaltung unter Benutzer x > Funktionsprofile erteilt wird.

• Controller

  Im Workflow Designer kann der Controller die Workflow-Versionen im Lesemodus öffnen. Ältere Workflow-Versionen lassen sich in der Liste der Versionen über das Kontextmenü zu der jeweiligen Version öffnen.

  Im DocuWare Client verfügt der Controller über eine besondere Aufgabenliste der Workflows, für die er eine Controller-Berechtigung hat. Die Liste heißt genauso wie der Workflow und findet sich unter Aufgaben > Aufgaben überwachen.

  Der Controller sieht im DocuWare Client alle Aufgaben aller Benutzer, denen in einer Workflow-Instanz Aufgaben zugewiesen wurden. Das bedeutet, wenn eine Aufgabe mehreren Benutzern zugewiesen wurde, sieht er diese auch mehrfach, denn nur so kann er sie von einem Benutzer einem anderen zuweisen. Der Controller sieht außerdem, wenn eine Aufgabe in der Workflow-Aufgabenliste eines Benutzers in den Status Gelesen übergegangen ist, also in Bearbeitung ist. Wird ein Dokument in einem Workflow gelöscht, wird automatisch auch die Aufgabe selbst im Workflow gelöscht. Darüber hinaus kann der Controller eine Workflow-Instanz beenden, und zwar über Workflow stoppen im Kontextmenü zu der jeweiligen Workflow-Version. Dies wird in der Workflow-Historie vermerkt.

Der Benutzer, der den Workflow erstellt hat, besitzt standardmäßig Berechtigungen als Designer und Controller.

Außerdem benötigen Benutzer mit den Rollen Workflow Designer, Workflow Controller und Workflow System das funktionale Recht Alle Benutzer anzeigen – um sicherzustellen, dass die Workflows reibungslos funktionieren.  

Workflows exportieren und importieren

Wenn Sie zum Beispiel in einer Abteilung einen Workflow nutzen, der sich abgewandelt auch für einen anderen Bereich mit einem eigenen Archiv eignet, übertragen Sie den Workflow auf dieses und passen ihn an.

Das Zielarchiv kann zu Ihrer Organisation gehören oder sich auf einem anderen System befinden. Dabei ist der Import ist als neuer Workflow oder als neue Version möglich. Voraussetzung für einen Import ist, dass die Felder von Quell- und Zielarchiv übereinstimmen.

Für den Workflow-Export benötigen Sie Rechte als Organisationsadministrator. Beim Exportieren werden alle Workflows im aktuellen System in die Datei WorkflowExport_<Organisationsname>_<aktuelles Datum>.wfe exportiert.

1. In der Übersicht des Workflow Designers markieren Sie den Workflow, den Sie exportieren möchten, klicken Exportieren und speichern ihn im Dateisystem.

2. Um den Workflow in ein anderes System zu importieren, wechseln Sie zunächst die Verbindung in den Desktop Apps.

3. Starten Sie den Workflow Designer erneut. In der Übersicht klicken Sie auf Importieren und wählen den Workflow aus dem Dateisystem aus. Bestätigen Sie mit OK.

   Vor dem eigentlichen Import wird geprüft, ob die Archivfelder des Quellarchivs, die im Workflow verwendet werden, auch im Zielarchiv vorhanden sind. Dazu werden Datenbankname und Datentyp des Feldes verglichen. Wurden alle benötigten Felder im Zielarchiv gefunden, ist der Import abgeschlossen und der Workflow wird im gleichen Layout und mit allen Aktivitäten, Variablen und der Aufgabenlisten-Konfiguration geöffnet. Die Stellen, an denen die Workflow-Konfiguration überprüft, angepasst oder neu erstellt werden muss, werden hervorgehoben und aufgelistet.

   Damit die Konfiguration funktioniert, müssen alle Daten und Parameter, die aus externen Quellen kommen, manuell geprüft und ggf. bearbeitet werden. Dies gilt unabhängig davon, ob sie im Zielsystem identisch vorhanden sind oder nicht. Zu den Einstellungen und Parametern gehören andere Archive und deren Felder, Auswahllisten, externe Datenbanken sowie deren Tabellen und Spalten, Webservices, Benutzer, Rollen, Vertretungsregeln, Formularkonfigurationen, Vorlagen und Einfügebereiche.

4. Sie veröffentlichen den importierten und geprüften Workflow.

Workflow-Konfiguration erstellen

Um einen neuen Workflow zu erstellen, klicken Sie auf der Seite Übersicht in der Werkzeugleiste auf Neu. Es öffnet sich der Dialog Neuen Workflow erstellen mit zwei Seiten: Allgemein und Auslöser.

Allgemein

Name

Geben Sie dem Workflow hier einen eindeutigen, nur einmal verwendeten Namen. Der Name wird im Wofklow sowie in der Aufgabenliste des Web Client für die Registerkarte des Workflows angezeigt.

Beschreibung (optional)

Die Beschreibung ist nur im Workflow Designer sichtbar.

Archiv

Jeder Workflow muss einem DocuWare Archiv zugeordnet sein.

Workflow-Benutzer

Benutzername

Geben Sie hier einen DocuWare Benutzer an, mit dem die autmatischen Aktivitäten ausgeführt werden, z.B. den Organisations-Administrator. Achten Sie darauf, dass der Benutzer alle nötigen Zigriffsrechte auf das Archiv und die Dokumente hat.

Kennwort

Das Kennwort des hier hinterlegten Benutzers wird beim Verlassen des Dialogs nach der Bestätigung mit OK aus Sicherheitsgründen abgefragt. Das Kennwort wird nicht gespeichert.

Auslöser

Für den Start eines Workflows gibt es zwei Arten von Auslösern:

• dokumentbasierte Ereignisse, das heißt, die Ablage eines neuen Dokuments und/oder die Änderung von Indexdaten

• nach Zeitplan mit bestimmten Bedingungen für Indexdaten

Bei jedem Ausführen eines Workflows wird eine Workflow-Instanz erzeugt. Legen Sie z.B. zehn Dokumente mit den gleichen Auslösebedingungen ab, werden zehn Instanzen gestartet. Sobald der Workflow sein Ende erreicht hat, ist auch die Instanz beendet. Laufende Instanzen bleiben von Änderungen an der Workflow-Konfiguration unbeeinflusst.

Dokumentbasierte Ereignisse: Soll ein Workflow auf der Grundlage von dokumentbasierten Ereignissen ausgeführt werden, legen Sie die Bedingungen dafür hier fest.

Damit ein Workflow ausgeführt wird, muss erstens ein bestimmtes Ereignis eintreten. Dies kann z.B. das Ablegen eines neuen Dokuments im Dokumentenpool sein und/oder das Ändern von Indexdaten bei einem bestehenden Dokument. Zweitens muss ein Dokument bestimmte Indexwerte aufweisen, damit eine Auslöser-Bedingung erfüllt ist.

Neuen Workflow starten

Aktivieren Sie eine oder beide der Start-Aktivitäten, durch die der Workflow ausgelöst werden soll:

• für neue Dokumente
  Mit jedem neu abgelegten Dokument wird ein Workflow gestartet.

• wenn sich die Indexeinträge des Dokuments geändert haben
  Mit jeder Änderung eines Indexeintrags des Dokuments wird ein Workflow gestartet.

Zusätzlich können Sie das Auslösen des Workflows an die Bedingung knüpfen, dass das Dokument per Formularvorlage erzeugt wurde. Dies ist aber nur möglich, wenn mindestens eine der beiden vorigen Bedingungen ebenfalls erfüllt ist, also Ablage eines Dokuments oder die Änderung von Indexdaten.
Es wird ein Workflow gestartet, wenn ein z.B. Dokument abgelegt wird, das mit DocuWare Forms durch eine Formularvorlage mit Einfügebereichen und als ausfüllbares PDF erstellt worden ist. Es werden alle Konfigurationen von DocuWare Forms und alle Formularvorlagen zur Auswahl angezeigt, für die der angemeldete Benutzer das Recht Verwenden hat. Mit Aktivieren dieser Option schaffen Sie die Grundlage dafür, dass bei einer Datenzuweisung die Einfügebereiche angezeigt werden. Es können nur leere Einfügebereiche gefüllt werden.

Je nach Auswahl werden Ihnen entweder nur eine oder beide der weiteren Einstellungen von Bedingungen angezeigt.

Wenn alle/eine der folgenden Bedingungen vor der Indexänderung erfüllt sind:

Wenn alle/eine der folgenden Auslöser-Bedingungen nach der Indexänderung erfüllt sind:

1. Wählen Sie links ein Index- oder Systemfeld aus.

2. Wählen Sie in der Mitte einen Operator aus.

3. Wählen Sie rechts entweder einen Wert aus einer bereitgestellten Auswahlliste aus oder geben direkt einen Wert in das Feld ein.

Zeitplan: Wenn ein Workflow nach einem bestimmten Zeitplan in Verbindung mit bestimmten Indexdaten ausgeführt werden soll, legen Sie dies hier fest.

Ein Workflow kann ausgeführt werden:

• täglich bzw. an bestimmten Tagen

• wöchentlich bzw. in bestimmten Wochen

• monatlich bzw. in bestimmten Monaten

Jede Möglichkeit bietet jeweils unterschiedliche weitere Einstellungen.

Zusätzlich legen Sie fest, welche Bedingungen bei den Indexdaten erfüllt sein müssen, damit der Workflow nach dem oben festgelegten Zeitplan ausgeführt wird.

Um eine optimale Performance des DocuWare-Systems zu gewährleisten, werden pro zeitgesteuertem Start maximal für 100 Dokumente Workflow-Instanzen gestartet. Sie können diese Anzahl ändern, indem Sie in der Datei
C:\Program Files (x86)\DocuWare\Background Process Server\DocuWare.BackgroundProcessService.LongLiving.GenericProcess.x86.exe.config
in folgender Zeile den Wert ("100") anpassen:
<add key="ScheduledWorkflowMaxDocumentCount" value="100" />

Einstellungen speichern und Workflow-Konfiguration weiter bearbeiten

Um die Einstellungen zu speichern, klicken Sie auf OK. Es öffnet sich die Workflow-Seite mit der Flussdiagramm-Ansicht, in der Sie den Workflow bearbeiten können.

Workflow-Konfiguration bearbeiten

In den folgenden Kapiteln ist beschrieben, wie Sie eine Workflow-Konfiguration bearbeiten und damit die einzelnen Schritte eines Workflows definieren und zusammenstellen.

Workflow-Flussdiagramm-Ansicht

Die Flussdiagramm-Seite eines Workflows stellt Ihnen alle Funktionen für seine Bearbeitung zur Verfügung. Im oberen Bereich befindet sich die Navigationsleiste. In der Seitenleiste links sehen Sie die Reiter der Registerkarten Aktivitäten, Variablen und Validierungen. Im großen Bereich rechts wird das Flussdiagramm des Workflows angezeigt.

Die Gestaltung eines Workflows erfolgt über das Einfügen von Aktivitäten per Drag & Drop aus dem linken Bereich in die Flussdiagramm-Ansicht.

Ein Hinweis zum Testen: Im Dialog Ausgangswerte eingeben legen Sie die Indexwerte fest, die beim Start des Workflow-Testdurchlaufs vorhanden sein sollen, also Test-Indexdaten, mit denen Sie das Vorhandensein eines Dokuments simulieren. Außerdem finden Sie in dieser Liste alle ggf. vorhandenen Variablen.

Mit dem Speichern und Schließen des Dialogs per OK erscheint unter dem Flussdiagramm ein neuer Bereich für den Test. Links können Sie den Test über die verschiedenen Ausgänge eines Workflows steuern. Rechts sehen Sie ein tabellarisches Protokoll der Workflow-Aufgaben.

Automatische Validierung

Während Sie einen Workflow designen, werden die einzelnen Schritte automatisch validiert. Bei Fehlern wird Ihnen das Ergebnis in der linken Leiste unter Validierungen gemeldet.

Aufgabenliste im DocuWare Client strukturieren

Hier legen Sie die Struktur der Workflow-Aufgaben-Liste im DocuWare Client fest.

Grundsätzlich hängt es von den Einstellungen für die Ergebnisliste des Archivs ab, welche Funktionen Ihnen in der Workflow Aufgabenliste zur Verfügung stehen. Diese werden entsprechend an die Workflow-Aufgaben-Liste vererbt.

Um Funktionen für die Aufgabenliste steuern zu können, müssen Sie diese also zunächst für die Ergebnisliste des entsprechenden Archivs aktivieren, und zwar in der DocuWare Konfiguration unter Archive > Dialoge > Ergebnis > Ergebnisliste.

Im Workflow Designer können Sie pro Workflow in den Einstellungen für die Aufgabenliste dann die Ergebnisliste auswählen, von der die Funktionen geerbt werden. Per Maus-Over über den Link können Sie einsehen, welche Funktionen für die ausgewählte Ergebnisliste aktiviert wurden. Bei Bedarf aktivieren Sie dort zusätzlich spezifische Workflow-Funktionen für die Aufgabenliste.

Der Dialog Workflow-Aufgabe gliedert sich in zwei Bereiche: Oben stellen Sie in einer tabellarischen Auflistung alle Daten zusammen. Unten werden Ihnen die Spaltenköpfe der Aufgabenliste in einer Vorschau angezeigt.

Systemvariablen und globale Variablen

Im Workflow verwenden Sie globale Variablen und Systemvariablen. Globale Variablen definieren Sie selbst, Systemvariablen sind gesetzt.

Systemvariablen

Systemvariablen sind Parameter, die vom DocuWare System automatisch gesetzt und je nach Variable aktualisiert werden.

Beispiele: Der "Benutzer der letzten Entscheidung" ist automatisch der Benutzer, der die letzte Entscheidung getroffen hat. "Dokument URL" oder "Organisations GUID" sind Systemvariablen, die unverändert bleiben.

Globale Variablen

Globale Variablen sind Platzhalter für bestimmte Werte im gesamten Workflow.

Beispiel: Wurde für eine Rechnung die Kundennummer in das Formular der Workflow-Aufgabe eingegeben, wird der Name des Kunden aus einer externen Datenbank ausgelesen und in eine globale Workflow-Variable geschrieben. So lässt sich der Name in einem anderen Workflow-Schritt wieder verwenden.

Globale Variablen können auch im Web Client in der Liste der Aufgaben angezeigt werden.

Um globale Variablen zu erstellen, öffnen Sie eine Workflow-Konfiguration und klicken Sie in der linken Seitenleiste auf die Variablen.

Geben Sie der Variable einen eindeutigen Namen, mit dem sich die Variable später bei der Konfiguration de Workflows leicht identifizieren lässt z.B. "MyOrderNumber"

Wählen Sie aus der Drop-down-Liste den Variablentyp aus:

• Text: Die maximale Textlänge beträgt 255 Zeichen.

• Ganze Zahl oder Dezimalzahl: Legen Sie für eine Dezimalzahl auch die Zahl der Dezimalstellen fest.

• Datum oder Datum/Uhrzeit: Soll die Variable vom Typ Datum sein, wählen Sie diese Option aus.

• Stichwort: In dieser Variablen können mehrere Werte gespeichert werden, z.B. mehrere Bestellnummern. Es lassen sich jedoch nicht einzelne Werte aus dieser Variablen bei der Zuordnung auswählen - im Gegensatz zu Benutzer, Rolle und Vertretungsregel, die als Listen-Variable verwendet werden können.

• Benutzer aus einer Gruppe, Rolle und Vertretungsregel: Rolle und Vertretungsregel enthalten mehrere Werte – die Benutzer. Die Variable Benutzer aus einer Gruppe kann einen oder mehrere Werte enthalten.

  Für alle drei Variablen steht die Option Listen-Variable zur Verfügung. Ist sie aktiviert, lassen sich in einem späteren Schritt einzelne Benutzer aus der jeweiligen Liste auswählen.

Sie können eine Variable in der Variablenliste auch dann bearbeiten, wenn diese bereits im Workflow verwendet wird. Die Variable muss dafür nicht erst aus den Konfigurationen entfernt werden. Beim Ändern des Variablennamens wird dieser automatisch überall im Workflow ersetzt, wo er vorkommt, auch in freien SQL-Befehlen wie Datenzuweisungen.

Bindestriche können eingegeben werden, jedoch werden sie intern automatisch durch einen doppelten Unterstrich gespeichert. Bei der Auswahl der globalen Variable wird diese entsprechend mit doppeltem Unterstrich in der Liste angezeigt.