| ... |
... |
@@ -2,11
+2,15 @@ |
| 2 |
2 |
Der Abschnitt zur Konfiguration des Plugins ist nur für Administratoren notwendig, welche die Verbindung zur Postkorbschnittstelle einrichten. Wie eine Nachricht an den Postkorb gesendet werden kann, wird im Abschnitt //Postkorb-Aktion// erläutert. |
| 3 |
3 |
{{/info}} |
| 4 |
4 |
|
|
5 |
+{{info}} |
|
6 |
+Der Postkorb ist eine Funktion des Serviceportals. Im Postkorb können sogenannte Vorgänge angelegt werden, etwa wenn jemand ein Antragsformular ausgefüllt hat. Zu jedem Vorgang können dann mehrere Nachrichten gesendet werden. Dieses Plugin ermöglicht es, Nachrichten an einen Vorgang aus {{formcycle/}} heraus zu senden. Der Vorgang im Postkorb sollte nicht mit dem Vorgang in {{formcycle/}} verwechselt werden. |
|
7 |
+{{/info}} |
|
8 |
+ |
| 5 |
5 |
{{content/}} |
| 6 |
6 |
|
| 7 |
|
-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. |
|
11 |
+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 Nachrichten an den Postkorb des [[Serviceportals>>https://servicekonto.nrw/]] geschickt werden. |
| 8 |
8 |
|
| 9 |
|
-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. Dann kann die Workflow-Aktion genutzt werden. |
|
13 |
+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. Danach kann die Workflow-Aktion genutzt werden. |
| 10 |
10 |
|
| 11 |
11 |
== Postkorb-Aktion == |
| 12 |
12 |
|
| ... |
... |
@@ -32,18
+32,18 @@ |
| 32 |
32 |
|
| 33 |
33 |
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. |
| 34 |
34 |
|
| 35 |
|
-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. |
|
39 |
+An den meisten Feldern ist die Verwendung von [[Platzhaltern>>doc:Formcycle.UserInterface.Variables]] möglich, um Daten aus dem Formular einzutragen. Alle Felder, an denen das Nutzen von Platzhaltern möglich sind, haben rechts am Eingabefeld eine kleines Buch-Symbol. |
| 36 |
36 |
|
| 37 |
|
-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. |
|
41 |
+Für das Senden von Nachrichten sind einige Informationen zum Empfänger notwendig, wie zum Beispiel dessen Kontonummer im Serviceportal. Es wird empfohlen, die Anmeldung am Formular per regio iT (technisch: OpenID Connect) zu aktivieren. So können diese Daten aus dem Nutzerkonto des angemeldeten Benutzers per [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] übernommen werden. |
| 38 |
38 |
|
| 39 |
39 |
==== Angaben zum Empfänger ==== |
| 40 |
40 |
|
| 41 |
41 |
; Art des Versendens |
| 42 |
|
-: 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. |
|
46 |
+: Die Postkorbschnittstelle bietet zwei Möglichkeiten: Es kann (a) eine neuer Vorgang im Postkorb mit einer initialen 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. |
| 43 |
43 |
; Kontonummer des Empfängers oder Antragstellers |
| 44 |
|
-: 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. |
|
48 |
+: 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. |
| 45 |
45 |
; Als Gast versenden |
| 46 |
|
-: 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. |
|
50 |
+: 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: Bitte versichern Sie sich vor dem Nutzen der Funktion bei dem Dienstanbieter der Postkorbschnittstelle ob das Versenden als Gast erlaubt ist. |
| 47 |
47 |
|
| 48 |
48 |
Folgende Eingabefelder erscheinen, wenn die Option //Als Gast versenden// aktiviert wurde: |
| 49 |
49 |
|
| ... |
... |
@@ -83,13
+83,13 @@ |
| 83 |
83 |
: 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. |
| 84 |
84 |
; Link (URL) für den Vorgang im Postkorb |
| 85 |
85 |
: 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. |
| 86 |
|
-; Beschreibungs des Vorgangs im Postkorb |
|
90 |
+; Beschreibung des Vorgangs im Postkorb |
| 87 |
87 |
: 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. |
| 88 |
88 |
|
| 89 |
89 |
==== Überschreiben der globalen Plugin-Konfiguration ==== |
| 90 |
90 |
|
| 91 |
91 |
; Aktion bei Fehler mit Exception abbrechen |
| 92 |
|
-: 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. |
|
96 |
+: 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 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. |
| 93 |
93 |
; ID der Dienstleistung aus BIS |
| 94 |
94 |
: 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. |
| 95 |
95 |
; Präfix für ID des Vorgangs im Postkorb |
| ... |
... |
@@ -118,9
+118,9 @@ |
| 118 |
118 |
; Passwort |
| 119 |
119 |
: Das Passwort für die Verbindung zur Postkorbschnittstelle. |
| 120 |
120 |
; Connection timeout |
| 121 |
|
-: 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//. |
|
125 |
+: Verbindungszeitüberschreitung (Connection-Timeout) für das Herstellen der Verbindung zur Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500ms// oder //2min//. |
| 122 |
122 |
; Read timeout |
| 123 |
|
-: 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//. |
|
127 |
+: Lesezeitüberschreitung (Read-Timeout) für das Auslesen einer Methode der Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500ms// oder //2min//. |
| 124 |
124 |
; Vorher immer PING durchführen |
| 125 |
125 |
: 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. |
| 126 |
126 |
|
| ... |
... |
@@ -160,6
+160,6 @@ |
| 160 |
160 |
; Port des Proxy-Servers |
| 161 |
161 |
: Der Port des Proxy-Servers. |
| 162 |
162 |
; Nutzername für Proxy-Server |
| 163 |
|
-: Nutzername, falls nötig, um eine Verbindungs zum Proxy-Server herzustellen. |
|
167 |
+: Nutzername, falls nötig, um eine Verbindung zum Proxy-Server herzustellen. |
| 164 |
164 |
; Passwort für den Proxy-Server |
| 165 |
|
-: Nutzername, falls nötig, um eine Verbindungs zum Proxy-Server herzustellen. |
|
169 |
+: Nutzername, falls nötig, um eine Verbindung zum Proxy-Server herzustellen. |