Änderungen von Dokument regio iT: Postkorb-Plugin

Von Version < 19.1 >

bearbeitet von awa
am 18.03.2020, 14:24

Auf Version < 19.6

bearbeitet von gru
am 29.01.2021, 16:42

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1
          +1,1 @@
--XWiki.awa
++XWiki.gru

Inhalt

@@ -1,3
          +1,5 @@
++[[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/regio%20iT%3A%20Postkorb-Plugin%20(fc-plugin-regioit-postkorb)%20&fileid=13417||target="_blank"]] (erfordert Anmeldung)
++
  {{info}}
  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.
  {{/info}}
@@ -8,7
          +8,7 @@
  {{content/}}
--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 Nachrichten an den Postkorb des [[Serviceportals>>https://servicekonto.nrw/]] geschickt werden.
++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.
  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.
@@ -45,7
          +45,7 @@
  ; Art des Versendens
  : Die Postkorbschnittstelle bietet zwei Möglichkeiten: Es kann (a) eine neuer Vorgang im Postkorb mit einer initialen 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.
  ; Kontonummer des Empfängers oder Antragstellers
--: 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.
++: 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: //[%$user.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.
  ; Als Gast versenden
  : 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.
@@ -67,7
          +67,7 @@
  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.
  ; Absendername
--: 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.
++: Der Name des Absenders der Nachricht. Standardmäßig ist hier der Platzhalter [%user.displayName%] hinterlegt. Dieser wird mit dem Namen des Benutzers ersetzt, der sich am Formular angemeldet hat. Diese Einstellung entspricht dem Parameter //nachricht.absender// der Postkorbschnittstelle.
  ; Betreff
  : Ein einzeiliger Betreff der zu sendenden Nachricht. Diese Einstellung entspricht dem Parameter //nachricht.betreff// der Postkorbschnittstelle.
  ; Nachricht
@@ -101,8
          +101,46 @@
  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.
++=== Rückgabewerte
++
++Nachdem das Aktions-Plugin ausgeführt wurde, stehen folgende zusätzliche Aktionsplatzhalter zur Verfügung:
++
++; success
++: //true//, falls die Nachricht erfolgreich an der Postkorb versendet werden konnte, andernfalls //false//.
++; status
++: Der durch die Postkorbschnittstelle zurückgelieferte Status, entweder //SUCCESS// oder //ERROR//.
++; messageThreadId
++: Falls ein neuer Vorgang im Postkorb angelegt wurde: Die ID des angelegten Vorgangs, wie diese von der Postkorbschnittstelle zurückgeliefert wurde.
++; errorCode
++: Ein von diesem Plugin definierter, nummerischer Fehlercode. Eine Liste von Fehlercodes findet sich nachfolgend.
++; errorType
++: Technischer Name des Fehlercodes, siehe die nachfolgende Liste.
++; errorDetails
++: Lokalisierte Nachricht des Fehlercodes.
++; exceptionMessage
++: Inhalt der durch Java geworfenen Exception.
++
++=== Statuscodes
++
++Folgende Fehlercodes werden aktuell durch dieses Plugin definiert:
++
++{{table dataTypeAlpha="1" dataTypeNum="0" preSort="0-asc"}}
++|=Statuscode|=Technischer Name|=Beschreibung
++|0|SERVICE_COULD_NOT_BE_CREATED|Die Verbindung zur Postkorbschnittstelle konnte nicht aufgebaut werden.
++|10|PING_REQUEST_FAILED|Die PING-Anfrage vor der eigentlichen Anfrage ist fehlgeschlagen (falls dies in der Konfiguration aktiviert wurde).
++|20|INVALID_SERVICE_REQUEST|Die Anfrage an die Postkorbschnittstelle enthält ungültige Daten und kann deshalb nicht versendet werden. Die Konfiguration des Plugins und der Verarbeitungsaktion sollte überprüft werden.
++|30|POSTKORB_SERVICE_ERROR|Der Webservice hat auf die gestellte Anfrage keine Antwort zurückgeliefert. Es sollte die Verfügbarkeit der Postkorbschnittstelle geprüft werden und ob diese durch den FORMCYCLE-Server erreichbar ist.
++|40|INVALID_SERVICE_RESPONSE|Die von der Postkorbschnittstelle zurückgelieferte Antwort enhtält ungültige Daten und kann daher nicht verarbeitet werden. Es sollte die Version der Postkorbschnittstelle geprüft werden, gegebenenfalls muss dieses Plugin aktualisiert werden.
++|50|SERVICE_REQUEST_FAILED|Die Postkorbschnittstelle hat zwar eine Antwort zurückgeliefert, aber die hat den Status ERROR.
++|200|INTERNAL_ERROR|Ein unvorhergesehener, nicht weiter spezifierbarer Fehler ist aufgetreten.
++{{/table}}
++
  == Konfiguration des Plugins ==
++{{info}}
++  Hinweis zum [[Logging>>doc:Formcycle.SystemSettings.UserInterface.Logging]]: Das Logging von diesem Plugin kann über die Package-Pfade //de.xima.fc.plugin.regioit.postkorb// und //de.xima.fc.plugin.utils// gesteuert werden.
++{{/info}}
++
  {{figure image="plugin_regioit_postkorb_settings_de.png" width="600"}}
  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.
  {{/figure}}
@@ -142,7
          +142,7 @@
  Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle Zertifikate verwendet, die nicht auf dem FORMCYCLE-Server beziehungsweise im Java-Truststore vorhanden sind.
  ; Zusätzliches Zertifikat für TLS/SSL (Mandantdatei)
--: Der Name einer Mandantdatei mit einem gültigen X509-Zertifikat.
++: Der Name einer [[Mandantdatei>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] mit einem gültigen X509-Zertifikat.
  ; Passwort für das Zertifikat
  : Das Passwort, um das angegebene Zertifikat öffnen zu können.
@@ -167,3
          +167,11 @@
  : Nutzername, falls nötig, um eine Verbindung zum Proxy-Server herzustellen.
  ; Passwort für den Proxy-Server
  : Nutzername, falls nötig, um eine Verbindung zum Proxy-Server herzustellen.
++
++== Changelog
++
++In diesem Abschnitt werden die vorhandenen Versionen des Postkorb-Plugins und die jeweiligen Änderungen in dieser Version beschrieben.
++
++=== 1.0.0
++
++* Initialer Release

Änderungen von Dokument regio iT: Postkorb-Plugin

Zusammenfassung

Details

Navigation