Dokumentstartereignis

Ein Dokumentstartereignis vereinfacht den Start eines Prozesses, der Informationen aus einem ECM-System verwendet.

Sie können ein Dokumentstartereignis verwenden, um einen Prozess automatisch zu starten, wenn ein Dokument in einem ECM-System (Enterprise Content Management) erstellt wird.

Alternativ können Sie ein Dokumentstartereignis verwenden, um eine Prozessinstanz aus einem vorhandenen Dokument in einem ECM-System zu starten.

Zweck eines Dokumentstartereignisses

Enterprise Content Management-Systeme (ECM-Systeme) speichern sehr große Mengen an Informationen für Organisationen. Diese Informationen liegen in Form von Dokumenten wie Berichten, rechtsgültigen Dokumenten, Rechnungen und Angeboten vor. Darüber hinaus führen ECM-Systeme Tasks zur Verwaltung dieser Dokumente aus, z. B. bestimmen sie, ob einzelne Dokumente aktualisiert oder gelöscht werden können.

Sie können ein Dokumentstartereignis verwenden, um einen Prozess automatisch zu starten, wenn ein neues Dokument erstellt wird. Dies ist nützlich, wenn der Prozess einem bestimmten Typ von Dokument zugeordnet wird, z. B. einer Schadensmeldung. Ein Prozess könnte zum Beispiel eine Gruppe von Aktivitäten zur Untersuchung eines Versicherungsschadens enthalten. Der Prozess kann automatisch vom Dokumentstartereignis gestartet werden, sobald eine Schadensmeldung übergeben wird.

Sie können ein Dokumentstartereignis auch verwenden, um eine Prozessinstanz aus einem vorhandenen Dokument zu starten. Dies ist nützlich, wenn Sie bestimmte Operationen ausführen müssen, die dem Dokument zugeordnet sind, z. B. die Überprüfung durch ein Team. Um ein Team zu befähigen, das Dokument zu überprüfen, würde der Prozess einen entsprechenden Satz von parallelen oder sequenziellen Tasks definieren. Anschließend könnten Sie den Prozess aus dem Dokument heraus starten, um die Überprüfung durch das Team zu initialisieren. Derzeit können Sie einen Prozess nur auf diese Weise über die REST-API "Prozess starten" starten.

Erstellung eines Dokumentstartereignisses

Ein Dokumentstartereignis wird wie folgt erstellt:
  1. Wählen Sie in einer Prozessdefinition ein vorhandenes Startereignis-Symbol aus oder fügen Sie ein Dokumentstartereignis-Symbol aus der Palette aus.
  2. Öffnen Sie in der Ansicht Eigenschaften die Registerkarte Allgemein.
  3. Stellen Sie im Abschnitt Startereignis sicher, dass Dokument ausgewählt ist.
  4. Führen Sie im Abschnitt Ereigniseigenschaften die folgenden Schritte aus:
    1. Wählen Sie in der Schaltflächengruppe Auslöser die Option Dokument erstellt aus, um automatisch einen Prozess zu starten, wenn ein neues Dokument erstellt wird, oder wählen Sie Über Dokument gestartet aus, um eine Prozessinstanz aus einem vorhandenen Dokument zu starten.
      Hinweis: Um einen Prozess über ein Dokumentstartereignis mit einem Auslöser Über Dokument gestartet zu starten, muss der Prozess zum Starten verfügbar gemacht werden. Außerdem kann ein Prozess maximal ein Dokumentstartereignis mit einem Auslöser Über Dokument gestartet enthalten.
    2. Wählen Sie in der Dropdown-Liste Quelle einen Server aus. Die Server in der Liste sind die ECM-Server, die auf der Seite Einstellungen für Prozessanwendungen Ihrer Prozessanwendung aufgelistet sind.
    3. Wählen Sie in der Dropdown-Liste Typ einen Dokumenttyp aus. Die angezeigten Dokumenttypen sind die Dokumenttypen, die in der Quelle verfügbar sind.
    4. Wenn Sie die Dokumentuntertypen einbeziehen möchten, wählen Sie Untertypen einbeziehen aus. Beispiel: Ein medizinischer Dokumenttyp könnte einen zahnärztlichen Untertyp enthalten, den Sie einbeziehen möchten.
  5. Öffnen Sie die Registerkarte Datenzuordnung und ordnen Sie die Dokumenttypeigenschaften Ihren Prozessvariablen zu. Sie können auch das Pluszeichen (+) auswählen, um zusätzliche technische Eigenschaften anzuzeigen, die Sie ebenfalls zuordnen möchten. Sie könnten zum Beispiel eine Eigenschaft auswählen, die angibt, wer das Dokument erstellt hat, und diese Eigenschaft einer Prozessvariablen zuordnen.
  6. Klicken Sie auf Speichern oder Bearbeitung beenden.
Hinweis: Damit ein Dokumentstartereignis verwendet werden kann, um automatisch einen Prozess zu starten, wenn ein neues Dokument in einem externen ECM-System erstellt wird, muss auf diesem System ein Ereignishandler eingerichtet sein, der das Ereignis 'Dokument erstellt' sendet. Siehe Verwaltungstasks für eingehende Ereignisse ausführen. Außerdem muss der Benutzer, der in der Serverdefinition definiert ist, über die entsprechenden Berechtigungen zum Abrufen der Details für diese Dokumente verfügen. Diese Details werden zum Abrufen der erforderlichen Informationen für die Datenzuordnung verwendet. Damit Inhaltsereignisse verarbeitet werden können, muss sich der technische Benutzer für den ECM-Server in dem Team befinden, das für Ereignissenderangegeben ist (siehe Enterprise Content Management-Server hinzufügen).

Der Prozess wird im Standardsnapshot einer Prozessanwendung gestartet. In Business Automation Studioist die aktuelle Version die Standardversion, sofern keine andere Version explizit als Standardversion konfiguriert wurde. Wird der Prozess in einem Toolkit definiert, wird er nur gestartet, wenn ein Snapshot dieses Toolkits von einer Prozessanwendung referenziert wird. Referenzieren mehrere Prozessanwendungen dasselbe Toolkit, das einen Prozess mit einem Startdokument enthält, werden mehrere Prozessinstanzen gestartet.

Ein Dokumentstartereignis, das so konfiguriert ist, dass es ausgeführt wird, wenn ein Dokument erstellt wird, wird für den aktuellen (Tip-)Snapshot einer Toolkit-Anwendung nicht ausgelöst. Der Grund hierfür ist, dass von der Engine die aktuellen (Tip-)Snapshots der Prozessanwendungen überwacht und keine Artefakte in verwaisten Toolkits gesucht werden. Damit ein Ereignis getestet werden kann, muss die Prozessanwendung einen Snapshot des Toolkits umfassen, in dem die Ereignisdefinition enthalten ist.

JavaScript-Systemvariable für das Startdokument

Die Kennung des Startdokuments ist in einer JavaScript-Systemvariablen verfügbar. Für Prozesse und serverseitige Services verwenden Sie tw.system.currentProcessInstance.startingDocumentId, um die Kennung zurückzugeben. Sie können auch tw.system.currentProcessInstance.startingDocumentServerName verwenden, um den Servernamen des Dokuments zurückzugeben. Sie können diese Kennung und diesen Servernamen in Aktivitäten wie zum Beispiel Enterprise Content Management-Operationen verwenden.

Für clientseitige Benutzerservices verwenden Sie tw.system.processInstance.startingDocumentId, um die Kennung zurückzugeben. Verwenden Sie tw.system.processInstance.startingDocumentServerName, um den Servernamen des Dokuments zurückzugeben.