| ... |
... |
@@ -101,46
+101,8 @@ |
| 101 |
101 |
|
| 102 |
102 |
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. |
| 103 |
103 |
|
| 104 |
|
-=== Rückgabewerte |
| 105 |
|
- |
| 106 |
|
-Nachdem das Aktions-Plugin ausgeführt wurde, stehen folgende zusätzliche Aktionsplatzhalter zur Verfügung: |
| 107 |
|
- |
| 108 |
|
-; success |
| 109 |
|
-: //true//, falls die Nachricht erfolgreich an der Postkorb versendet werden konnte, andernfalls //false//. |
| 110 |
|
-; status |
| 111 |
|
-: Der durch die Postkorbschnittstelle zurückgelieferte Status, entweder //SUCCESS// oder //ERROR//. |
| 112 |
|
-; messageThreadId |
| 113 |
|
-: Falls ein neuer Vorgang im Postkorb angelegt wurde: Die ID des angelegten Vorgangs, wie diese von der Postkorbschnittstelle zurückgeliefert wurde. |
| 114 |
|
-; errorCode |
| 115 |
|
-: Ein von diesem Plugin definierter, nummerischer Fehlercode. Eine Liste von Fehlercodes findet sich nachfolgend. |
| 116 |
|
-; errorType |
| 117 |
|
-: Technischer Name des Fehlercodes, siehe die nachfolgende Liste. |
| 118 |
|
-; errorDetails |
| 119 |
|
-: Lokalisierte Nachricht des Fehlercodes. |
| 120 |
|
-; exceptionMessage |
| 121 |
|
-: Inhalt der durch Java geworfenen Exception. |
| 122 |
|
- |
| 123 |
|
-=== Statuscodes |
| 124 |
|
- |
| 125 |
|
-Folgende Fehlercodes werden aktuell durch dieses Plugin definiert: |
| 126 |
|
- |
| 127 |
|
-{{table dataTypeAlpha="1" dataTypeNum="0" preSort="0-asc"}} |
| 128 |
|
-|=Statuscode|=Technischer Name|=Beschreibung |
| 129 |
|
-|0|SERVICE_COULD_NOT_BE_CREATED|Die Verbindung zur Postkorbschnittstelle konnte nicht aufgebaut werden. |
| 130 |
|
-|10|PING_REQUEST_FAILED|Die PING-Anfrage vor der eigentlichen Anfrage ist fehlgeschlagen (falls dies in der Konfiguration aktiviert wurde). |
| 131 |
|
-|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. |
| 132 |
|
-|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. |
| 133 |
|
-|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. |
| 134 |
|
-|50|SERVICE_REQUEST_FAILED|Die Postkorbschnittstelle hat zwar eine Antwort zurückgeliefert, aber die hat den Status ERROR. |
| 135 |
|
-|200|INTERNAL_ERROR|Ein unvorhergesehener, nicht weiter spezifierbarer Fehler ist aufgetreten. |
| 136 |
|
-{{/table}} |
| 137 |
|
- |
| 138 |
138 |
== Konfiguration des Plugins == |
| 139 |
139 |
|
| 140 |
|
-{{info}} |
| 141 |
|
- 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. |
| 142 |
|
-{{/info}} |
| 143 |
|
- |
| 144 |
144 |
{{figure image="plugin_regioit_postkorb_settings_de.png" width="600"}} |
| 145 |
145 |
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. |
| 146 |
146 |
{{/figure}} |
| ... |
... |
@@ -180,7
+180,7 @@ |
| 180 |
180 |
Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle Zertifikate verwendet, die nicht auf dem FORMCYCLE-Server beziehungsweise im Java-Truststore vorhanden sind. |
| 181 |
181 |
|
| 182 |
182 |
; Zusätzliches Zertifikat für TLS/SSL (Mandantdatei) |
| 183 |
|
-: Der Name einer [[Mandantdatei>>doc:Formcycle.UserInterface.FilesAndTemplates.WebHome]] mit einem gültigen X509-Zertifikat. |
|
145 |
+: Der Name einer Mandantdatei mit einem gültigen X509-Zertifikat. |
| 184 |
184 |
; Passwort für das Zertifikat |
| 185 |
185 |
: Das Passwort, um das angegebene Zertifikat öffnen zu können. |
| 186 |
186 |
|