imma-prozess

Beispielprozess zur elektronischen Immatrikulation mit Hilfe der BPMN-Process-Engine Camunda

Lokale Installation / Konfiguration

Damit Sie den dargestellen "Prozess 1.0" auf ihrem System ausführen können, müssen Sie die folgenden Schritte umsetzen:

1. Laden Sie sich einen Camunda Tomcat Server (7.6+) auf ihr System und entpacken Sie diesen. Zusätzlich benötigen sie eine aktuellen Version des Java SE Development Kit's (JDK).
   • Hinweis für Windows-Systeme: Damit der entpackte Tomcat Server starten kann, müssen Sie zwei Umgebungsvariablen zum installierten JDK definieren. Der Name der ersten Variable sollte "JAVA_HOME" und der Pfad sollte auf Ihren lokalen Speicherort verweisen, z.B. "C:\Programm Files\Java\jdk1.8.0_91".. Der Name der zweiten Variable sollte "JRE_Home" und der Pfad sollte auf Ihren lokalen Speicherort verweisen, z.B. "C:\Programm Files\Java\jre1.8.0_151".
2. Kopieren Sie aus dem Ordner "Mail Connector" die Datei "camunda-bpm-mail-core-1.3.0-SNAPSHOT.jar" in das untergeordnete lib-Verzeichnis des Tomcat (Verzeichnis: [Camunda Tomcat]\server\apache-tomcat-8.0.24\lib).
3. Danach kopieren Sie aus dem gleichen Ordner "Mail Connector" die Datei "mail-config.properties" in das untergeordnete conf-Verzeichnis des Tomcat (Verzeichnis: [Camunda Tomcat]\server\apache-tomcat-8.0.24\conf). Diese Datei ist für den Zugriff auf ein Mail-Konto notwendig. Öffnen Sie im Anschluss die Datei und richten den Zugriff auf ein E-Mail Konto ein.
   • Hinweis: Sollten Sie ihr privates E-Mail Konto benutzen, achten Sie darauf, die Datei nicht mit Dritten zu teilen.
   • Hinweis für Windows-Systeme: Damit der Tomcat die .properties Datei finden kann, müssen Sie die Umgebungsvariable für die Datei definieren. Der Name der Variable sollte "MAIL_CONFIG" lauten und der Pfad sollte lauten "[Camunda Tomcat]\server\apache-tomcat-8.0.24\conf\mail-config.properties".
   • Siehe auch: E-Mail Connector und E-Mail Connector Beispiel.
4. Anschließend installieren Sie einen lokalen Webserver welcher cURL unterstützt (z.B. XAMPP ). Nachdem sie diesen installiert haben, kopieren Sie aus dem Ordner "Externe Webseiten Formulare" alle .php Formulare in den "htdocs" Ordner ihres Webservers.
   • Hinweis: Achten Sie darauf, über welche URL der Webserver angesprochen wird. Sollt diese nicht "http://127.0.0.1/" lauten, muss die URL des Webservers oder die E-Mail-Beschreibung der Sende-Aufgaben und -Ereignisse im Prozess angepasst werden.
5. Kopieren aus dem Ordner "Prozess (.war)" die Datei "imma-0.1.0-SNAPSHOT.war" in das untergeordnete Verzeichnis "webapps" (Verzeichnis: [Camudna Tomcat]\server\apache-tomcat-8.0.24\webapps).

Prozess bearbeiten (Maven Java-Projekt)

Zur Bearbeitung des „Prozess 1.0“ müssen Sie sich ein Java Entwicklertool installieren, wie z.B. Camunda Eclipse oder NetBeans. Nachdem Sie dies erledigt haben, müssen Sie den Prozess aus dem Unterordner „Prozess (maven project)“ importieren bzw. laden. Achten Sie darauf, dass ist sich dabei um ein Maven Projekt handelt und dementsprechend auch als solches geöffnet wird.

• Hinweis: Weitere Informationen dazu finden Sie auf der offiziellen Camunda Dokumentation.

Konfiguration des Prozesses

Der Prozess dreht sich im Kern um den Dokumentenupload und die -prüfung. Es gibt unterschiedliche Stellen die bei Änderungen bearbeitet werden müssen und im nachfolgenden zusammenfassend erläutert werden:

• E-Mail: Diese können nur im Prozess über den Camunda Modeler bearbeitet werden. Alle sendenden Nachrichten-Aufgaben wurden mit dem Mail Connector verbunden und können im „Properties Pannel“ untern dem Reiter "Connector" bearbeitet werden. Alle möglichen Einstellungen können Sie der Dokumentation des Mail Connector‘s entnehmen.
• DMN Tabelle: Bei der DMN-Tabelle „Dokumente bestimmen“, sind die verschiedenen Output-Parameter in einen Array zwischengespeichert (Camunda Modeler: Map Decision Result = singelResult). Damit die Process Engine die verschiedenen Output-Parameter verarbeiten kann, wurden die einzelnen Werte des Arrays über die JAVA-Klasse „ParseDecisionListener“ entsprechend deklariert und an die Process Engine übergeben. Sollten Sie die DMN-Tabelle ändern, müssen Sie gegeben Falls auch die angegebene JAVA-Klasse anpassen.
• Dynamische Web-Formulare: Damit die Process Engine weiß, welche Dokumente erwartet werden, wurden für jeden Anwendungsfall ein Webseiten-Formular erstellt (Benutzer-Aufgaben: „Dokumente hochladen“ und „Gebühr bezahlen & Nachweis hochladen“). Die Namen werden – je nach Anwendungsfall – über die DMN-Tabelle „Dokumente bestimmen“, als Variable, abgerufen. Sollten Dokumente dem Prozess hinzugefügt oder entfernt werden, müssen auch die Prozessinternen Webformulare (/src/main/webapp/) sowie die DMN-Tabelle überarbeitet werden.
• True / False Dokumente: Die True / False Werte der DMN-Tabelle „Dokumente bestimmen“ werden über den beigefügten E-Mail Link an die „externen Webseiten Formulare“ übermittelt, wodurch es möglich ist, Webformulare dynamisch aufzubauen. Sollten Dokumente dem Prozess hinzugefügt oder entfernt werden, muss nicht nur die DMN-Tabelle, sondern auch die URL (Link) sowie die externen Webseiten-Formulare entsprechend überarbeitet werden.

Rest-API ansteuern

Um die Benutzer-Aufgaben oder Nachrichten-Ereignisse von außerhalb auslösen zu können, müssen Sie auf die REST API von Camunda zugreifen. Die REST API wird im „Prozess 1.0“ über die „externen Webseiten Formulare“ via cURL (PHP) angesteuert.

$csendfile = curl_init('http://localhost:8080/engine-rest/task/'.$taskid.'/submit-form');
curl_setopt($csendfile, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($csendfile, CURLOPT_POSTFIELDS, $data);
curl_setopt($csendfile, CURLOPT_RETURNTRANSFER, true);
curl_setopt($csendfile, CURLOPT_HTTPHEADER, array(
			'Content-Type: application/json')
);  

Im Prozess werden jedoch nicht alle Nachriten-Ereignisse über die Webseiten-Formulare angesteuert. Um diese auszulösen können REST-Client’s eingesetzt werden (z.B. Advanced REST Client ). Diese dienen zur Simulation und Testung eines REST-Aufrufs.

Wichtig hierbei ist, dass die „Request URL“ und der „Body“ des JSON-Strings richtig geschrieben sind. Die URL sollte für lokale Anwendungen immer folgendermaßen beginnen „http://localhost:8080/engine-rest/“ alle nachfolgenden Informationen sind REST-Aufruf spezifisch. Die Einstellungen für den Body müssen Sie der Camunda Dokumentation entnehmen.

• Hinweis: Die Request URL für ein empfangendes Nachrichten-Ereignis setzt sich folgender Maßen zusammen: "http://localhost:8080/engine-rest/" + "message". Dies ergibt dann: http://localhost:8080/engine-rest/message
• Hinweis: Die Request URL zum beenden einer Benutzer-Aufgabe lautet: "http://localhost:8080/engine-rest/" + "task/{id}/submit-form" Dies ergibt dann: http://localhost:8080/engine-rest/task/a901185b-f58b-11e7-81d5-00090ffe0001/submit-form