Wiki-Quellcode von RegioItPostkorbPlugin

Verstecke letzte Bearbeiter
awa 3.2 1 {{content/}}
awa 1.1 2
awa 7.5 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.
awa 1.1 4
awa 3.2 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.
awa 1.1 6
awa 3.2 7 == Konfiguration des Plugins ==
8
awa 3.3 9 {{figure image="plugin_regioit_postkorb_settings_de.png" width="600"}}
awa 3.2 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
awa 3.5 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.
awa 3.2 14
awa 7.5 15 Die Konfiguration gliedert sich in die folgenden fünf Abschnitte.
awa 3.2 16
awa 7.5 17 === Verbindungseinstellungen ===
awa 3.2 18
awa 3.4 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
awa 3.2 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
awa 7.5 34 === Standardeinstellung für Anfragen ===
awa 3.4 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
awa 7.5 43 === TLS/SSL-Einstellungen ===
awa 3.5 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
awa 7.5 52 === HTTP-Basic-Auth-Einstellungen ===
awa 3.5 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
awa 7.5 61 === Proxy-Server-Einstellungen ===
awa 3.5 62
awa 3.7 63 Diese Einstellungen sind nur erforderlich, falls der FORMCYLE-Server einen Proxy-Server benötigt, um sich mit der Postkorbschnittstelle verbinden zu können.
awa 3.5 64
awa 3.7 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.
awa 3.6 73
awa 7.2 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
awa 7.4 80 {{figure image="plugin_regioit_postkorb_workflow_action_base_de.png" width="400"}}
awa 7.2 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
awa 7.4 84 {{figure image="plugin_regioit_postkorb_workflow_action_advanced_de.png" width="400"}}
awa 7.2 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 Nach Konfiguration des Plugins kann in der Statusverarbeitung die Aktion //Nachricht im Postkorb erstellen// ausgewählt werden.
89
awa 7.5 90 === Konfiguration ===
awa 7.2 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.
93
94 ==== Angaben zum Empfänger
awa 7.5 95 ====
96
awa 7.2 97 ; Art des Versendens
98 : 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.
99 ; Kontonummer des Empfängers oder Antragstellers
awa 7.5 100 : 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>>doc:Formcycle.UserInterface.Variables]], der mit der Kontonummer des angemeldeten Nutzers ersetzt wird.
101 ;
102 :

Navigation

Copyright 2000-2025