| ... |
... |
@@ -1,6
+1,6 @@ |
| 1 |
1 |
{{content/}} |
| 2 |
2 |
|
| 3 |
|
-Dieses Plugin ermöglicht die Anbindung der Postkorbschnittstelle von der regio iT. Über eine Workflow-Aktion können dann Nachrichten an den Postkorb des [[Serviceportals>>https://servicekonto.nrw/]] geschickt werden. |
|
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 |
4 |
|
| 5 |
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 |
6 |
|
| ... |
... |
@@ -12,9
+12,9 @@ |
| 12 |
12 |
|
| 13 |
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 |
14 |
|
| 15 |
|
-Die Konfiguration gliedert sich in fünf Abschnitte: |
|
15 |
+Die Konfiguration gliedert sich in die folgenden fünf Abschnitte. |
| 16 |
16 |
|
| 17 |
|
-=== Verbindungseinstellungen |
|
17 |
+=== Verbindungseinstellungen === |
| 18 |
18 |
|
| 19 |
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 |
20 |
|
| ... |
... |
@@ -31,7
+31,7 @@ |
| 31 |
31 |
; Vorher immer PING durchführen |
| 32 |
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 |
33 |
|
| 34 |
|
-=== Standardeinstellung für Anfragen |
|
34 |
+=== Standardeinstellung für Anfragen === |
| 35 |
35 |
|
| 36 |
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 |
37 |
|
| ... |
... |
@@ -40,7
+40,7 @@ |
| 40 |
40 |
; Präfix für die ID des Vorgangs im Postkorb |
| 41 |
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 |
42 |
|
| 43 |
|
-=== TLS/SSL-Einstellungen |
|
43 |
+=== TLS/SSL-Einstellungen === |
| 44 |
44 |
|
| 45 |
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 |
46 |
|
| ... |
... |
@@ -49,7
+49,7 @@ |
| 49 |
49 |
; Passwort für das Zertifikat |
| 50 |
50 |
: Das Passwort, um das angegebene Zertifikat öffnen zu können. |
| 51 |
51 |
|
| 52 |
|
-=== HTTP-Basic-Auth-Einstellungen |
|
52 |
+=== HTTP-Basic-Auth-Einstellungen === |
| 53 |
53 |
|
| 54 |
54 |
Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle eine HTTP-Basic-Authentication erfordert. |
| 55 |
55 |
|
| ... |
... |
@@ -58,7
+58,7 @@ |
| 58 |
58 |
; Passwort für HTTP-Basic-Auth |
| 59 |
59 |
: Das zu benutzende Passwort für HTTP-Basic-Auth. |
| 60 |
60 |
|
| 61 |
|
-=== Proxy-Server-Einstellungen |
|
61 |
+=== Proxy-Server-Einstellungen === |
| 62 |
62 |
|
| 63 |
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 |
64 |
|
| ... |
... |
@@ -77,25
+77,58 @@ |
| 77 |
77 |
Durch Klick auf //neue Aktion// kann die Postkorbschnittstellen-Aktion zum Worfklow hinzugefügt werden. |
| 78 |
78 |
{{/figure}} |
| 79 |
79 |
|
| 80 |
|
-{{figure image="plugin_regioit_postkorb_workflow_action_base_de.png"}} |
|
80 |
+{{figure image="plugin_regioit_postkorb_workflow_action_base_de.png" width="400"}} |
| 81 |
81 |
Grundlegende Einstellungen zum Versenden einer Nachricht an der Postkorb. Hier kann der Empfänger und der Inhalt der Nachricht eingestellt werden. |
| 82 |
82 |
{{/figure}} |
| 83 |
83 |
|
| 84 |
|
-{{figure image="plugin_regioit_postkorb_workflow_action_advanced_de.png"}} |
|
84 |
+{{figure image="plugin_regioit_postkorb_workflow_action_advanced_de.png" width="400"}} |
| 85 |
85 |
Fortgeschrittene Einstellungen für den Postkorb. Hier können die Metadaten des Vorgangs geändert werden, der im Postkorb erstellt wird. |
| 86 |
86 |
{{/figure}} |
| 87 |
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 |
+ |
| 88 |
88 |
Nach Konfiguration des Plugins kann in der Statusverarbeitung die Aktion //Nachricht im Postkorb erstellen// ausgewählt werden. |
| 89 |
89 |
|
| 90 |
|
-=== Konfiguration |
|
94 |
+=== Konfiguration === |
| 91 |
91 |
|
| 92 |
|
-Die Einstellungen für die Postkorb-Aktion sind ähnlich zur E-Mail-Aktion und in 4 Bereiche unterteil. 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. |
|
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. |
| 93 |
93 |
|
| 94 |
|
-==== Angaben zum Empfänger |
| 95 |
|
- |
|
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 |
+ |
| 96 |
96 |
; Art des Versendens |
| 97 |
97 |
: 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. |
| 98 |
98 |
; Kontonummer des Empfängers oder Antragstellers |
| 99 |
|
-: 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 voreingstellte Wert ausreichend: //[%$last_user.preferred_username%//) Dies ist ein Platzhalter, der mit der Kontonummer des angemeldeten Nutzers ersetzt wird. |
| 100 |
|
-; |
| 101 |
|
-: |
|
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. |
|
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. |
|
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. |
|
117 |
+; Titel des Gasts |
|
118 |
+: Falls ein Vorgang als Gast erstellt werden soll: Der optionale Titel für den Gast, etwa //Dr.//. |
|
119 |
+; Vorname des Gasts |
|
120 |
+: Falls ein Vorgang als Gast erstellt werden soll: Der Vorname des Gasts. |
|
121 |
+; Nachname des Gasts |
|
122 |
+: Falls ein Vorgang als Gast erstellt werden soll: Der Nachname des Gasts. |
|
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. |
|
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. |
|
130 |
+; Betreff |
|
131 |
+: Nachricht |
|
132 |
+; Anhänge aus vorigen Aktionen |
|
133 |
+: |
|
134 |
+; Anhänge aus Formular-Uploads |