Wiki-Quellcode von regio iT: Postkorb-Plugin

Zeige letzte Bearbeiter
1 {{content/}}
2
3 Dieses Plugin ermöglicht die Anbindung der Postkorbschnittstelle von der regio iT. Über eine [[Workflow-Aktion>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]] können dann Nachrichten an den Postkorb des [[Serviceportals>>https://servicekonto.nrw/]] geschickt werden.
4
5 Das Plugin kann sowohl als System- als auch als Mandantplugin installiert werden. Nach Installation des Plugins müssen in der Plugin-Konfiguration die Verbindungsdaten zur Postkorbschnittstelle eingetragen werden.
6
7 == Konfiguration des Plugins ==
8
9 {{figure image="plugin_regioit_postkorb_settings_de.png" width="600"}}
10 Konfiguration des Postkorb-Plugins. Erforderlich sind nur die URL zur Postkorbschnittstelle sowie Benutzername, Passwort und die Service-ID. Weitere Einstellungen zu Proxy-Server und Zertifikaten sind optional.
11 {{/figure}}
12
13 Nach dem das Plugin installiert wurde, muss hier die URL auf die Postkorbschnittstelle sowie Nutzername und Passwort eingetragen werden. Weitere Einstellungen zu Proxy-Servern und SSL-Zertifikaten sind optional und nur notwendig, falls ein Proxy-Server benutzt wird beziehungsweise Zertifikate genutzt werden, die nicht im Java-Truststore enthalten sind. Bei allen Einstellungen erscheint ein Tooltip, wenn man mit der Maus darüber fährt.
14
15 Die Konfiguration gliedert sich in die folgenden fünf Abschnitte.
16
17 === Verbindungseinstellungen ===
18
19 Diese Einstellung sind notwendig, damit eine Verbindung zur Postkorbschnittstelle aufgebaut werden kann. In der Regel werden diese Informationen von der regio iT mitgeteilt.
20
21 ; Endpunkt-URL für Postkorbschnittstelle
22 : Hier wird die URL zur Postkorbschnittstelle eingetragen. Es ist zu beachten, dass hier nicht die URL zur WSDL-Datei eingetragen werden darf (diese endet meist auf //wsdl//).
23 ; Nutzername
24 : Der Benutzername für die Verbindung zur Postkorbschnittstelle.
25 ; Passwort
26 : Das Passwort für die Verbindung zur Postkorbschnittstelle.
27 ; Connection timeout
28 : Verbindungszeitüberschreitung (Connection-Timeout) für das Herstellen der Verbindung zur Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500 ms// oder //2 min//.
29 ; Read timeout
30 : Lesezeitüberschreitung (Read-Timeout) für das Auslesen einer Methode der Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500 ms// oder //2 min//.
31 ; Vorher immer PING durchführen
32 : Entweder //true// oder //false//. In der Spezifikation der Postkorbschnittstelle wird empfohlen, vor jeder Anfrage eine sogenannte PING-Anfrage durchzuführen, um die Verfügbarkeit der Schnittstelle zu prüfen. In der Regel kann diese Einstellung aber deaktiviert werden.
33
34 === Standardeinstellung für Anfragen ===
35
36 Diese Einstellungen betreffen grundlegende Daten, die bei jeder Anfrage an die Postkorbschnittstelle mitgesendet werden müssen. In der Regel werden diese Informationen von der regio iT mitgeteilt.
37
38 ; ID der Dienstleistung aus BIS
39 : Das Dienstleistungs-ID, welche benutzt wird, um neue Nachrichten im Postkorb zu erstellen. Dies ist in der Regel eine 5-stellige Zahl. Meist sollte diese Einstellung für das gesamte System gleich sein, bei Bedarf kann diese Einstellung aber pro Workflow-Aktion auch überschrieben werden. Diese Einstellung entspricht dem Parameter //fall.dienstleistung// der Postkorbschnittstelle.
40 ; Präfix für die ID des Vorgangs im Postkorb
41 : Das Präfix wird als erster Teil der ID (vor dem Doppelpunkt) des externen Fachverfahrens verwendet. Meist sollte diese Einstellung für das gesamte System gleich sein, bei Bedarf kann diese Einstellung aber pro Workflow-Aktion auch überschrieben werden. Diese Einstellung entspricht dem ersten Teil des Parameters //extern.id// der Postkorbschnittstelle.
42
43 === TLS/SSL-Einstellungen ===
44
45 Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle Zertifikate verwendet, die nicht auf dem FORMCYCLE-Server beziehungsweise im Java-Truststore vorhanden sind.
46
47 ; Zusätzliches Zertifikat für TLS/SSL (Mandantdatei)
48 : Der Name einer Mandantdatei mit einem gültigen X509-Zertifikat.
49 ; Passwort für das Zertifikat
50 : Das Passwort, um das angegebene Zertifikat öffnen zu können.
51
52 === HTTP-Basic-Auth-Einstellungen ===
53
54 Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle eine HTTP-Basic-Authentication erfordert.
55
56 ; Nutzername für HTTP-Basic-Auth
57 : Der zu benutzende Benutzername für HTTP-Basic-Auth.
58 ; Passwort für HTTP-Basic-Auth
59 : Das zu benutzende Passwort für HTTP-Basic-Auth.
60
61 === Proxy-Server-Einstellungen ===
62
63 Diese Einstellungen sind nur erforderlich, falls der FORMCYLE-Server einen Proxy-Server benötigt, um sich mit der Postkorbschnittstelle verbinden zu können.
64
65 ; URL des Proxy-Servers
66 : Die URL des Proxy-Servers.
67 ; Port des Proxy-Servers
68 : Der Port des Proxy-Servers.
69 ; Nutzername für Proxy-Server
70 : Nutzername, falls nötig, um eine Verbindungs zum Proxy-Server herzustellen.
71 ; Passwort für den Proxy-Server
72 : Nutzername, falls nötig, um eine Verbindungs zum Proxy-Server herzustellen.
73
74 == Postkorb-Aktion ==
75
76 {{figure image="plugin_regioit_postkorb_workflow_select_action_de.png" width="400"}}
77 Durch Klick auf //neue Aktion// kann die Postkorbschnittstellen-Aktion zum Worfklow hinzugefügt werden.
78 {{/figure}}
79
80 {{figure image="plugin_regioit_postkorb_workflow_action_base_de.png" width="400"}}
81 Grundlegende Einstellungen zum Versenden einer Nachricht an der Postkorb. Hier kann der Empfänger und der Inhalt der Nachricht eingestellt werden.
82 {{/figure}}
83
84 {{figure image="plugin_regioit_postkorb_workflow_action_advanced_de.png" width="400"}}
85 Fortgeschrittene Einstellungen für den Postkorb. Hier können die Metadaten des Vorgangs geändert werden, der im Postkorb erstellt wird.
86 {{/figure}}
87
88 {{figure image="plugin_regioit_postkorb_workflow_action_guest_de.png" width="400"}}
89 Eine neue Nachricht kann auch als Gast an den Postkorb gesendet werden. In dem Fall müssen einige Daten zum Gast eingetragen werden. Es kann sein, dass die Postkorbschnitstelle die Nutzung als Gast nicht erlaubt - dies sollte vorher mit dem Dienstanbieter der Postkorbschnittstelle geklärt werden.
90 {{/figure}}
91
92 Nach Konfiguration des Plugins kann in der Statusverarbeitung die Aktion //Nachricht im Postkorb erstellen// ausgewählt werden.
93
94 === Konfiguration ===
95
96 Die Einstellungen für die Postkorb-Aktion sind ähnlich zur E-Mail-Aktion und in 4 Bereiche unterteilt. Für die meisten Einstellungen sind Standardwerte gesetzt, welche im Regelfall nicht geändert werden müssen - meistens sollten nur die Felder //Betreff// und //Nachricht// geändert werden.
97
98 An den meisten Feldern ist die Verwendung von [[Platzhaltern>>doc:Formcycle.UserInterface.Variables]] möglich, um Daten aus dem Formular einzutragen. Alle Felder, wo Platzhalter möglich sind, haben rechts am Eingabefeld eine kleines Buch-Symbol.
99
100 Für das Senden von Nachrichten sind einige Informationen zum Empfänger notwendiger, etwa dessen Kontonummer im Serviceportal. Es wird empfohlen, die Anmeldung am Formular per regio iT (technisch: OpenID Connect) zu aktivieren. Dann können diese Daten aus dem Nutzerkonto des angemeldeten Benutzers per [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] übernommen werden.
101
102 ==== Angaben zum Empfänger ====
103
104 ; Art des Versendens
105 : Die Postkorbschnittstelle bietet zwei Möglichkeiten: Es kann (a) eine neuer Vorgang mit einer intialen Nachricht erstellt werden oder (b) eine Nachricht an einen bestehenden Vorgang gesendet werden. Falls bekannt ist, ob der Vorgang im Postkorb schon existiert, kann hier die Option //Neuen Vorgang erstellen// beziehungsweise //Auf bestehenden Vorgang antworten// ausgewählt werden. Andernfalls, wenn es nicht sicher ist, ob der Vorgang bereits existiert, sollte hier die Option //Vorgang anlegen wenn noch nicht vorhanden// ausgewählt werden. Es wird dann zuerst versucht, auf einen bestehenden Vorgang zu antworten. Falls dies fehlschlägt, wird ein neuer Vorgang angelegt.
106 ; Kontonummer des Empfängers oder Antragstellers
107 : Hier muss die Kontonummer des Empfängers oder Antragstellers eingetragen werden, an den die Nachricht gesendet werden soll. Im Regelfall melden sich Benutzer über die regio iT am Formular an (technisch: OpenID Connect). In dem Fall ist der voreingestellte Wert ausreichend: //[%$last_user.preferred_username%//) Dies ist ein [[Platzhalter>>doc:Formcycle.UserInterface.Variables]], der mit der Kontonummer des angemeldeten Nutzers ersetzt wird. Diese Einstellung entspricht dem Parameter //fall.portalkonto// der Postkorbschnittstelle.
108 ; Als Gast versenden
109 : Es ist beim Postkorb möglich, eine Nachricht als Gast zu versenden, also ohne Kontonummer im Serviceportal zu haben. Dabei ist es nur möglich, einen neuen Vorgang anzulegen, aber nicht auf einen bestehenden zu antworten. Ist diese Option aktiviert, erscheinen zusätzliche Eingabefelder für die Angaben zum Gast. Hinweis: Abhängig vom eingstellten Nutzernamen und Passwort der Postkorbschnittstelle ist es möglich, dass ein Versenden als Gast nicht erlaubt ist. Dies sollte vorher mit dem Dienstanbieter der Postkorbschnittstelle abgeklärt werden.
110
111 Folgende Eingabefelder erscheinen, wenn die Option //Als Gast versenden// aktiviert wurde:
112
113 ; E-Mail des Gasts
114 : Falls ein Vorgang als Gast erstellt werden soll: Die E-Mail-Adresse des Gasts. Diese Einstellung entspricht dem Parameter //gast.email// der Postkorbschnittstelle.
115 ; Anrede des Gasts
116 : Falls ein Vorgang als Gast erstellt werden soll: Die optionale Anrede des Gasts, etwa //Herr// oder //Frau//. Hinweis: Die Postkorbschnittstelle unterstützt nur spezielle Werte für die Anrede. Diese Einstellung entspricht dem Parameter //gast.anrede// der Postkorbschnittstelle.
117 ; Titel des Gasts
118 : Falls ein Vorgang als Gast erstellt werden soll: Der optionale Titel für den Gast, etwa //Dr.//. Diese Einstellung entspricht dem Parameter //gast.titel// der Postkorbschnittstelle.
119 ; Vorname des Gasts
120 : Falls ein Vorgang als Gast erstellt werden soll: Der Vorname des Gasts. Diese Einstellung entspricht dem Parameter //gast.vorname// der Postkorbschnittstelle.
121 ; Nachname des Gasts
122 : Falls ein Vorgang als Gast erstellt werden soll: Der Nachname des Gasts. Diese Einstellung entspricht dem Parameter //gast.familienname// der Postkorbschnittstelle.
123
124 ==== Inhalt der Nachricht ====
125
126 Hier wird der Inhalt der Nachricht eingegeben, die an den Postkorb gesendet werden soll. Optional ist es auch möglich, bis zu 10 Dateien mitzusenden. Mehr als 10 Dateien werden von der Postkorbschnittstelle nicht unterstützt.
127
128 ; Absendername
129 : Der Name des Absenders der Nachricht. Standardmäßig ist hier der Platzhalter [%last_user.name%] hinterlegt. Dieser wird mit dem Namen des Benutzers ersetzt, der sich am Formular angemeldet hat. Diese Einstellung entspricht dem Parameter //nachricht.absender// der Postkorbschnittstelle.
130 ; Betreff
131 : Ein einzeiliger Betreff der zu sendenden Nachricht. Diese Einstellung entspricht dem Parameter //nachricht.betreff// der Postkorbschnittstelle.
132 ; Nachricht
133 : Die mehrzeilige Nachricht, welche an den Postkorb gesendet werden soll. Der Postkorb unterstützt die Nutzung einiger Formatierungsoptionen wie etwa fetter Schrift oder Aufzählungszeichen. Diese Einstellung entspricht dem Parameter //nachricht.inhalt// der Postkorbschnittstelle.
134 ; Anhänge aus vorigen Aktionen
135 : Optional können Dateien aus vorigen Aktionen als Anhang mitgesendet werden. Diese Einstellung entspricht den Parametern //anhang.[1-10].*// der Postkorbschnittstelle.
136 ; Anhänge aus Formular-Uploads
137 : Optional können Dateien aus Upload-Feldern im Formular als Anhang mitgesendet werden. Diese Einstellung entspricht den Parametern //anhang.[1-10].*// der Postkorbschnittstelle.
138
139 ==== Auswahl des Vorgangs ====
140
141 ; Neuer Status des Vorgangs im Postkorb
142 : Es ist möglich, den Status des Vorgangs im Postkorb zu ändern. Es gibt dabei die Status //offen//, //in Bearbeitung//, //abgeschlossen// und //storniert//. Standardeinstellung ist, dass der Status nicht geändert wird. Neue angelegte Vorgänge erhalten dabei automatisch den Status //offen//. Es ist zu beachten, dass die Status //in Bearbeitung// und //storniert// nur verfügbar sind, wenn auf einen vorhandenen Vorgang geantwortet wird, aber nicht beim Erstellen eines neuen Vorgangs. Diese Einstellung entspricht dem Parameter //fall.status// der Postkorbschnittstelle.
143 ; Externe ID des Vorgangs im Postkorb
144 : Die externe ID des Vorgangs im Postkorb. Jeder Vorgang im Postkorb hat sowohl eine interne ID, die vom Postkorb intern genutzt wird, als auch eine externe ID. Die externe ID identifiziert den Vorgang gegenüber einem Drittsystem, in dem Fall also {{formcycle/}}. Standardmäßig ist hier der Wert //[%$PROCESS_ID%]// eingetragen. Dieser Platzhalter wird mit der Vorgangs-ID des abgesendeten Formulars ersetzt. Im Regelfall braucht dies nicht geändert zu werden. Es sollte beachtet werden, dass die Postkorbschnittstelle bestimmte Zeichen wie Leerzeichen nicht in der externen ID erlaubt. Diese Einstellung entspricht dem Wert nach dem Doppelpunkt des Parameters //extern.id// der Postkorbschnittstelle.
145 ; Name des Vorgangs im Postkorb
146 : Der Name, der im Postkorb für den Vorgang angezeigt wird. Nur verfügbar, wenn ein neuer Vorgang erstellt wird. Dieser Name wird etwa auch in der Übersicht aller Vorgänge angezeigt. Als Standard ist hier der Wert //[%$PROJECT_NAME%] - [%$PROCESS_ID%]// eingetragen. Diese Platzhalter werden durch den Namen des Formulars und die Vorgangs-ID ersetzt, sodass Namen wie //Anmeldeformular - 7581f9c5-0ba9-4b9a-b7c1-cfb475eabafd// erzeugt werden. Zur Erhöhung der Lesbarkeit kann statt der Prozess-ID etwa die E-Mail des Benutzers etc. verwendet werden. Diese Einstellung entspricht dem Wert nach dem Doppelpunkt des Parameters //extern.titel// der Postkorbschnittstelle.
147 ; Link (URL) für den Vorgang im Postkorb
148 : Eine optionale URL auf den Vorgang im Drittsystem (also {{formcycle/}}). Nur verfügbar, wenn ein neuer Vorgang erstellt wird. Hier ist standardmäßig der Platzhalter //[%$FORM_PROCESS_LINK%]// eingetragen, welcher durch den Link auf das abgesendete Formular ersetzt wird. Diese Einstellung entspricht dem Wert nach dem Doppelpunkt des Parameters //extern.url// der Postkorbschnittstelle.
149 ; Beschreibungs des Vorgangs im Postkorb
150 : Eine optionale Beschreibung für den Vorgang im Postkorb. Nur verfügbar, wenn ein neuer Vorgang erstellt wird. Diese Einstellung entspricht dem Wert nach dem Doppelpunkt des Parameters //fall.info// der Postkorbschnittstelle.
151
152 ==== Überschreiben der globalen Plugin-Konfiguration ====
153
154 ; Aktion bei Fehler mit Exception abbrechen
155 : Steuert, was bei einem Fehler passiert, also wenn die Nachricht nicht an den Postkorb gesendet werden konnte. Wenn diese Option aktiviert ist, wird ein Fehler geworfen, wodurch die weitere Verarbeitung abgebrochen wird und dem Nutzer eine Fehlerseite angezeigt wird. Weiterhin kann dann über die [[Fehlerbehandlung>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.ErrorHandling]] in der Status- und Aktionsverarbeitung geändert werden, was genau im Fehlerfall passieren soll. Ist andererseits diese Option deaktiviert, ist die Postkorb-Aktion immer erfolgreich und liefert bei Fehlern einen entsprechenden Statuscode (siehe unten) zurück. Über [[Abarbeitungsbedingungen>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.ActionConditions]] und Aktionsplatzhalter kann dann der Statuscode entsprechend abgefragt werden.
156 ; Dienstleistungs-ID aus BIS
157 : Hier kann die globale Einstellung aus der Plugin-Konfiguration überschrieben werden, falls dies notwendig ist. Siehe //ID der Dienstleistung aus BIS// im Abschnitt //Konfiguration des Plugins// oben für mehr Informationen.
158 ; Präfix für ID des Vorgangs im Postkorb
159 : Hier kann die globale Einstellung aus der Plugin-Konfiguration überschrieben werden, falls dies notwendig ist. Siehe //ID der Dienstleistung aus BIS// im Abschnitt //Präfix für die ID des Vorgangs im Postkorb// oben für mehr Informationen.
160
161 Schließlich kann auch die Erreichbarkeit der Postkorbschnittstelle geprüft werden. Hierbei werden nur die Daten aus der globalen Plugin-Konfiguration geprüft, nicht, ob die Daten in dieser Aktion korrekt sind. Technisch handelt es sich dabei um ein sogenannten //PING//-Request an die Postkorbschnittstelle.

Navigation

Copyright 2000-2025