Änderungen von Dokument regio iT: Postkorb-Plugin


Von Version 2.1
bearbeitet von gru
am 04.03.2021, 10:12
Änderungskommentar: Imported from XAR
Auf Version 7.1
bearbeitet von gru
am 29.06.2021, 14:15
Änderungskommentar: Renamed back-links.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -10,7 +10,7 @@
10 10  
11 11  {{content/}}
12 12  
13 -Dieses kostenpflichtige 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.
13 +Dieses kostenpflichtige Plugin ermöglicht die Anbindung der Postkorbschnittstelle von der regio iT. Über eine [[Workflow-Aktion>>doc:Formcycle.Designer.Workflow.Actions.WebHome]] können Nachrichten an den Postkorb des [[Serviceportals>>https://servicekonto.nrw/]] geschickt werden.
14 14  
15 15  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.
16 16  
... ... @@ -95,7 +95,7 @@
95 95  ==== Überschreiben der globalen Plugin-Konfiguration ====
96 96  
97 97  ; Aktion bei Fehler mit Exception abbrechen
98 -: 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 +: 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.Designer.Workflow.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.FormDesigner.Workflow.LegacyWorkflow.ActionConditions]] und Aktionsplatzhalter kann dann der Statuscode entsprechend abgefragt werden.
99 99  ; ID der Dienstleistung aus BIS
100 100  : 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.
101 101  ; Präfix für ID des Vorgangs im Postkorb
... ... @@ -103,7 +103,7 @@
103 103  
104 104  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.
105 105  
106 -=== Rückgabewerte
106 +=== Rückgabewerte ===
107 107  
108 108  Nachdem das Aktions-Plugin ausgeführt wurde, stehen folgende zusätzliche Aktionsplatzhalter zur Verfügung:
109 109  
... ... @@ -122,7 +122,7 @@
122 122  ; exceptionMessage
123 123  : Inhalt der durch Java geworfenen Exception.
124 124  
125 -=== Statuscodes
125 +=== Statuscodes ===
126 126  
127 127  Folgende Fehlercodes werden aktuell durch dieses Plugin definiert:
128 128  
... ... @@ -208,10 +208,10 @@
208 208  ; Passwort für den Proxy-Server
209 209  : Nutzername, falls nötig, um eine Verbindung zum Proxy-Server herzustellen.
210 210  
211 -== Changelog
211 +== Changelog ==
212 212  
213 213  In diesem Abschnitt werden die vorhandenen Versionen des Postkorb-Plugins und die jeweiligen Änderungen in dieser Version beschrieben.
214 214  
215 -=== 1.0.0
215 +=== 1.0.0 ===
216 216  
217 217  * Initialer Release