Wiki-Quellcode von regio iT: Postkorb-Plugin

Zeige letzte Bearbeiter
1 {{info}}
2 The section regarding the plugin configuration is required only for administrators who need to configure the Postkorb web service. See the //Postkorb action// section on how to send a message to the Postkorb.
3 {{/info}}
4
5 {{info}}
6 The Postkorb ("inbox") is a feature offered by the service portal. The Postkorb consists of so-called processes or message threads. Each message thread contains one more messages. This plugin lets you send message to an existing message thread from {{formcycle/}}. You can also create new message threads with an initial message.
7 {{/info}}
8
9 {{content/}}
10
11 This plugin implements the Porstkorb web service provided by regio iT. It adds a new [[workflow action>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]] that lets you send messages to the Postkorb of the [[service portal>>https://servicekonto.nrw/]].
12
13 You can install this plugin both as a system plugin as well as a client plugin. Once the plugin is installed, you (or an administrator) needs to configure the connection to the Postkorb web service. Once it is configured, you can start using the Postkorb workflow action.
14
15 == Postkorb action ==
16
17 {{figure image="plugin_regioit_postkorb_workflow_select_action_en.png" width="400"}}
18 Click on //New action// to add a new Postkorb action to the workflow.
19 {{/figure}}
20
21 {{figure image="plugin_regioit_postkorb_workflow_action_base_de.png" width="400"}}
22 Basic settings for sending a message to a Postkorb message thread. Here you can the recipient and the content of the message.
23 {{/figure}}
24
25 {{figure image="plugin_regioit_postkorb_workflow_action_advanced_de.png" width="400"}}
26 Advanced settings for sending a messag to a Postkorb message thread. Here you can change the metadata of the Postkorb message thread that is created.
27 {{/figure}}
28
29 {{figure image="plugin_regioit_postkorb_workflow_action_guest_de.png" width="400"}}
30 You can also create a new message thread as a guest. This requires you to enter a few details about the guest, such as the name and email address. Please note that creating message threads as guests may be restricted by the web service - please contact your service provider for details.
31 {{/figure}}
32
33 Once the plugin is configured correctly, you can select the new workflow action //Create Postkorb message// in the workflow configuration.
34
35 === Configuration ===
36
37 The configuration for the Postkorb action is similar to the email action and separated into 4 sections. Most settings have a default set that you do not need to change normally - usually you just have to enter a subject and message text.
38
39 Most settings allow the use of [[variables>>doc:Formcycle.UserInterface.Variables]] to insert data from the submitted form. All settings that allow variables have a little book icon next to them that opens the variable selection dialog.
40
41 In order to send am message to the Postkorb, a few pieces of information about the recipient are required, such as their account number and name. We recommend that you allow users to sign in via the services provided by regio iT (OpenID Connect). This lets you prefill the settings with the data from the registered user via [[variables>>doc:Formcycle.UserInterface.Variables]].
42
43 ==== Message type and recipient ====
44
45 ; Message type
46 : The Postkorb service offers two possibilies: You can (a) create a new message thread with an initial message, or (b) send a message to an existing
47 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.
48 ; Kontonummer des Empfängers oder Antragstellers
49 : 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.
50 ; Als Gast versenden
51 : 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.
52
53 Folgende Eingabefelder erscheinen, wenn die Option //Als Gast versenden// aktiviert wurde:
54
55 ; E-Mail des Gasts
56 : Falls ein Vorgang als Gast erstellt werden soll: Die E-Mail-Adresse des Gasts. Diese Einstellung entspricht dem Parameter //gast.email// der Postkorbschnittstelle.
57 ; Anrede des Gasts
58 : 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.
59 ; Titel des Gasts
60 : 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.
61 ; Vorname des Gasts
62 : Falls ein Vorgang als Gast erstellt werden soll: Der Vorname des Gasts. Diese Einstellung entspricht dem Parameter //gast.vorname// der Postkorbschnittstelle.
63 ; Nachname des Gasts
64 : Falls ein Vorgang als Gast erstellt werden soll: Der Nachname des Gasts. Diese Einstellung entspricht dem Parameter //gast.familienname// der Postkorbschnittstelle.
65
66 ==== Inhalt der Nachricht ====
67
68 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.
69
70 ; Absendername
71 : 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.
72 ; Betreff
73 : Ein einzeiliger Betreff der zu sendenden Nachricht. Diese Einstellung entspricht dem Parameter //nachricht.betreff// der Postkorbschnittstelle.
74 ; Nachricht
75 : 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.
76 ; Anhänge aus vorigen Aktionen
77 : Optional können Dateien aus vorigen Aktionen als Anhang mitgesendet werden. Diese Einstellung entspricht den Parametern //anhang.[1-10].*// der Postkorbschnittstelle.
78 ; Anhänge aus Formular-Uploads
79 : Optional können Dateien aus Upload-Feldern im Formular als Anhang mitgesendet werden. Diese Einstellung entspricht den Parametern //anhang.[1-10].*// der Postkorbschnittstelle.
80
81 ==== Auswahl des Vorgangs ====
82
83 ; Neuer Status des Vorgangs im Postkorb
84 : 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.
85 ; Externe ID des Vorgangs im Postkorb
86 : 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.
87 ; Name des Vorgangs im Postkorb
88 : 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.
89 ; Link (URL) für den Vorgang im Postkorb
90 : 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.
91 ; Beschreibung des Vorgangs im Postkorb
92 : 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.
93
94 ==== Überschreiben der globalen Plugin-Konfiguration ====
95
96 ; Aktion bei Fehler mit Exception abbrechen
97 : 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.
98 ; ID der Dienstleistung aus BIS
99 : 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.
100 ; Präfix für ID des Vorgangs im Postkorb
101 : 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.
102
103 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.
104
105 == Konfiguration des Plugins ==
106
107 {{figure image="plugin_regioit_postkorb_settings_de.png" width="600"}}
108 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.
109 {{/figure}}
110
111 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.
112
113 Die Konfiguration gliedert sich in die folgenden fünf Abschnitte.
114
115 === Verbindungseinstellungen ===
116
117 Diese Einstellung sind notwendig, damit eine Verbindung zur Postkorbschnittstelle aufgebaut werden kann. In der Regel werden diese Informationen von der regio iT mitgeteilt.
118
119 ; Endpunkt-URL für Postkorbschnittstelle
120 : 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//).
121 ; Nutzername
122 : Der Benutzername für die Verbindung zur Postkorbschnittstelle.
123 ; Passwort
124 : Das Passwort für die Verbindung zur Postkorbschnittstelle.
125 ; Connection timeout
126 : Verbindungszeitüberschreitung (Connection-Timeout) für das Herstellen der Verbindung zur Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500ms// oder //2min//.
127 ; Read timeout
128 : Lesezeitüberschreitung (Read-Timeout) für das Auslesen einer Methode der Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500ms// oder //2min//.
129 ; Vorher immer PING durchführen
130 : 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.
131
132 === Standardeinstellung für Anfragen ===
133
134 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.
135
136 ; ID der Dienstleistung aus BIS
137 : 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.
138 ; Präfix für die ID des Vorgangs im Postkorb
139 : 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.
140
141 === TLS/SSL-Einstellungen ===
142
143 Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle Zertifikate verwendet, die nicht auf dem FORMCYCLE-Server beziehungsweise im Java-Truststore vorhanden sind.
144
145 ; Zusätzliches Zertifikat für TLS/SSL (Mandantdatei)
146 : Der Name einer Mandantdatei mit einem gültigen X509-Zertifikat.
147 ; Passwort für das Zertifikat
148 : Das Passwort, um das angegebene Zertifikat öffnen zu können.
149
150 === HTTP-Basic-Auth-Einstellungen ===
151
152 Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle eine HTTP-Basic-Authentication erfordert.
153
154 ; Nutzername für HTTP-Basic-Auth
155 : Der zu benutzende Benutzername für HTTP-Basic-Auth.
156 ; Passwort für HTTP-Basic-Auth
157 : Das zu benutzende Passwort für HTTP-Basic-Auth.
158
159 === Proxy-Server-Einstellungen ===
160
161 Diese Einstellungen sind nur erforderlich, falls der FORMCYLE-Server einen Proxy-Server benötigt, um sich mit der Postkorbschnittstelle verbinden zu können.
162
163 ; URL des Proxy-Servers
164 : Die URL des Proxy-Servers.
165 ; Port des Proxy-Servers
166 : Der Port des Proxy-Servers.
167 ; Nutzername für Proxy-Server
168 : Nutzername, falls nötig, um eine Verbindung zum Proxy-Server herzustellen.
169 ; Passwort für den Proxy-Server
170 : Nutzername, falls nötig, um eine Verbindung zum Proxy-Server herzustellen.

Navigation

Copyright 2000-2025