Wiki-Quellcode von regio iT: Postkorb-Plugin

Verstecke letzte Bearbeiter
awa 11.28 1 {{info}}
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 {{/info}}
4
awa 3.2 5 {{content/}}
awa 1.1 6
awa 7.5 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.
awa 1.1 8
awa 11.28 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.
awa 1.1 10
awa 7.2 11 == Postkorb-Aktion ==
12
13 {{figure image="plugin_regioit_postkorb_workflow_select_action_de.png" width="400"}}
14 Durch Klick auf //neue Aktion// kann die Postkorbschnittstellen-Aktion zum Worfklow hinzugefügt werden.
15 {{/figure}}
16
awa 7.4 17 {{figure image="plugin_regioit_postkorb_workflow_action_base_de.png" width="400"}}
awa 7.2 18 Grundlegende Einstellungen zum Versenden einer Nachricht an der Postkorb. Hier kann der Empfänger und der Inhalt der Nachricht eingestellt werden.
19 {{/figure}}
20
awa 7.4 21 {{figure image="plugin_regioit_postkorb_workflow_action_advanced_de.png" width="400"}}
awa 7.2 22 Fortgeschrittene Einstellungen für den Postkorb. Hier können die Metadaten des Vorgangs geändert werden, der im Postkorb erstellt wird.
23 {{/figure}}
24
awa 11.3 25 {{figure image="plugin_regioit_postkorb_workflow_action_guest_de.png" width="400"}}
awa 11.2 26 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.
27 {{/figure}}
28
awa 11.29 29 Sobald das Plugin richtig konfiguriert ist, kann in der Statusverarbeitung die Aktion //Nachricht im Postkorb erstellen// ausgewählt werden.
awa 7.2 30
awa 7.5 31 === Konfiguration ===
awa 7.2 32
awa 11.2 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.
awa 7.2 34
awa 11.2 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.
awa 7.5 36
awa 11.4 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.
38
awa 11.2 39 ==== Angaben zum Empfänger ====
40
awa 7.2 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.
43 ; Kontonummer des Empfängers oder Antragstellers
awa 11.17 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.
awa 11.2 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.
47
48 Folgende Eingabefelder erscheinen, wenn die Option //Als Gast versenden// aktiviert wurde:
49
50 ; E-Mail des Gasts
awa 11.17 51 : Falls ein Vorgang als Gast erstellt werden soll: Die E-Mail-Adresse des Gasts. Diese Einstellung entspricht dem Parameter //gast.email// der Postkorbschnittstelle.
awa 11.2 52 ; Anrede des Gasts
awa 11.17 53 : 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.
awa 11.2 54 ; Titel des Gasts
awa 11.17 55 : 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.
awa 11.2 56 ; Vorname des Gasts
awa 11.17 57 : Falls ein Vorgang als Gast erstellt werden soll: Der Vorname des Gasts. Diese Einstellung entspricht dem Parameter //gast.vorname// der Postkorbschnittstelle.
awa 11.2 58 ; Nachname des Gasts
awa 11.17 59 : Falls ein Vorgang als Gast erstellt werden soll: Der Nachname des Gasts. Diese Einstellung entspricht dem Parameter //gast.familienname// der Postkorbschnittstelle.
awa 11.4 60
awa 11.21 61 ==== Inhalt der Nachricht ====
awa 11.4 62
awa 11.5 63 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.
awa 11.4 64
65 ; Absendername
awa 11.17 66 : 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.
awa 11.4 67 ; Betreff
awa 11.17 68 : Ein einzeiliger Betreff der zu sendenden Nachricht. Diese Einstellung entspricht dem Parameter //nachricht.betreff// der Postkorbschnittstelle.
awa 11.5 69 ; Nachricht
awa 11.17 70 : 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.
awa 11.4 71 ; Anhänge aus vorigen Aktionen
awa 11.17 72 : Optional können Dateien aus vorigen Aktionen als Anhang mitgesendet werden. Diese Einstellung entspricht den Parametern //anhang.[1-10].*// der Postkorbschnittstelle.
awa 11.4 73 ; Anhänge aus Formular-Uploads
awa 11.17 74 : Optional können Dateien aus Upload-Feldern im Formular als Anhang mitgesendet werden. Diese Einstellung entspricht den Parametern //anhang.[1-10].*// der Postkorbschnittstelle.
awa 11.7 75
awa 11.21 76 ==== Auswahl des Vorgangs ====
awa 11.7 77
78 ; Neuer Status des Vorgangs im Postkorb
awa 11.17 79 : 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.
80 ; Externe ID des Vorgangs im Postkorb
81 : 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.
awa 11.7 82 ; Name des Vorgangs im Postkorb
awa 11.17 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 ; Link (URL) für den Vorgang im Postkorb
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.
awa 11.7 86 ; Beschreibungs des Vorgangs im Postkorb
awa 11.17 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.
awa 11.7 88
awa 11.21 89 ==== Überschreiben der globalen Plugin-Konfiguration ====
awa 11.7 90
91 ; Aktion bei Fehler mit Exception abbrechen
awa 11.21 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.
awa 11.26 93 ; ID der Dienstleistung aus BIS
awa 11.24 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.
awa 11.7 95 ; Präfix für ID des Vorgangs im Postkorb
awa 11.24 96 : 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.
awa 11.7 97
98 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.
awa 11.28 99
100 == Konfiguration des Plugins ==
101
102 {{figure image="plugin_regioit_postkorb_settings_de.png" width="600"}}
103 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.
104 {{/figure}}
105
106 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.
107
108 Die Konfiguration gliedert sich in die folgenden fünf Abschnitte.
109
110 === Verbindungseinstellungen ===
111
112 Diese Einstellung sind notwendig, damit eine Verbindung zur Postkorbschnittstelle aufgebaut werden kann. In der Regel werden diese Informationen von der regio iT mitgeteilt.
113
114 ; Endpunkt-URL für Postkorbschnittstelle
115 : 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//).
116 ; Nutzername
117 : Der Benutzername für die Verbindung zur Postkorbschnittstelle.
118 ; Passwort
119 : Das Passwort für die Verbindung zur Postkorbschnittstelle.
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//.
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//.
124 ; Vorher immer PING durchführen
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
127 === Standardeinstellung für Anfragen ===
128
129 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.
130
131 ; ID der Dienstleistung aus BIS
132 : 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.
133 ; Präfix für die ID des Vorgangs im Postkorb
134 : 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.
135
136 === TLS/SSL-Einstellungen ===
137
138 Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle Zertifikate verwendet, die nicht auf dem FORMCYCLE-Server beziehungsweise im Java-Truststore vorhanden sind.
139
140 ; Zusätzliches Zertifikat für TLS/SSL (Mandantdatei)
141 : Der Name einer Mandantdatei mit einem gültigen X509-Zertifikat.
142 ; Passwort für das Zertifikat
143 : Das Passwort, um das angegebene Zertifikat öffnen zu können.
144
145 === HTTP-Basic-Auth-Einstellungen ===
146
147 Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle eine HTTP-Basic-Authentication erfordert.
148
149 ; Nutzername für HTTP-Basic-Auth
150 : Der zu benutzende Benutzername für HTTP-Basic-Auth.
151 ; Passwort für HTTP-Basic-Auth
152 : Das zu benutzende Passwort für HTTP-Basic-Auth.
153
154 === Proxy-Server-Einstellungen ===
155
156 Diese Einstellungen sind nur erforderlich, falls der FORMCYLE-Server einen Proxy-Server benötigt, um sich mit der Postkorbschnittstelle verbinden zu können.
157
158 ; URL des Proxy-Servers
159 : Die URL des Proxy-Servers.
160 ; Port des Proxy-Servers
161 : Der Port des Proxy-Servers.
162 ; Nutzername für Proxy-Server
163 : Nutzername, falls nötig, um eine Verbindungs zum Proxy-Server herzustellen.
164 ; Passwort für den Proxy-Server
165 : Nutzername, falls nötig, um eine Verbindungs zum Proxy-Server herzustellen.

Navigation

Copyright 2000-2025