Änderungen von Dokument regio iT: Postkorb-Plugin

Von Version < 18.67 >

bearbeitet von awa
am 18.03.2020, 14:19

Auf Version < 18.64 >

bearbeitet von awa
am 18.03.2020, 13:53

< >

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

Rohform
Im Layout

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

@@ -131,77
          +131,73 @@
  |20|INVALID_SERVICE_REQUEST|The request to the Postkorb web service contains invalid data and cannot be sent. Check the configuration of the plugin and the workflow action.
  |30|POSTKORB_SERVICE_ERROR|The Postkorb web service did not return any response to the request. Check whether the web service is available and can be reached from your network.
  |40|INVALID_SERVICE_RESPONSE|The response returned by the Postkorb web service is invalid and could not be parsed. Check the version of the web service and this plugin, you may have to update this plugin.
--|50|SERVICE_REQUEST_FAILED|The Postkorb web service returned a response, but the status of that response was //ERROR//.
++|50|SERVICE_REQUEST_FAILED|The Postkorb web service returned a response, but the status of that response was ERROR.
  |200|INTERNAL_ERROR|A unexpected error occurred that cannot be specified further.
  {{/table}}
  == Plugin configuration ==
--{{info}}
--  A note on [[logging>>doc:Formcycle.SystemSettings.UserInterface.Logging]]: You can control the logging messages of this plugin via the package paths //de.xima.fc.plugin.regioit.postkorb// and //de.xima.fc.plugin.utils//.
--{{/info}}
--
  {{figure image="plugin_regioit_postkorb_settings_en.png" width="600"}}
--  Configuration of the Postkorb plugin. Required are only the URL to the web service as well as the username, password and service ID. Additional settings regarding the proxy server and SSL certificates are optional.
++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}}
--Before you can use this plugin, you need to configure the connection to the Postkorb web service. This includes the endpoint URL, the username and password, as well as the service ID. There are some additional settings available that are optional, such as proxy server and SSL settings. If the web service can be reached without a proxy and if it does not use non-standard certificates that are not in the default system or Java trust store, you can leave these settings empty.
++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.
--The configuration is split into five section. Hover over the name of a setting to see a tooltip.
++Die Konfiguration gliedert sich in die folgenden fünf Abschnitte.
--=== Connection configuration ===
++=== Verbindungseinstellungen ===
--These settings are required in order to establish a connection to the web service. You should have received these settings from your Postkorb provider.
++Diese Einstellung sind notwendig, damit eine Verbindung zur Postkorbschnittstelle aufgebaut werden kann. In der Regel werden diese Informationen von der regio iT mitgeteilt.
--; Endpoint URL for the Postkorb service
--: This the URL to the Postkorb SOAP web service. Please note that you **should not** enter the URL to the WSDL file here which usually ends on //wsdl//.
--; Username
--: The username for authenticating against the Postkorb web service.
--; Password
--: The password for authenticating against the Postkorb web service.
++; Endpunkt-URL für Postkorbschnittstelle
++: 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//).
++; Nutzername
++: Der Benutzername für die Verbindung zur Postkorbschnittstelle.
++; Passwort
++: Das Passwort für die Verbindung zur Postkorbschnittstelle.
  ; Connection timeout
--: Connection timeout, i.e. the maximum time allowed for establishing a HTTP connection. You should enter the duration with a unit, such //10 s//, //500 ms// oder //2 min//.
++: Verbindungszeitüberschreitung (Connection-Timeout) für das Herstellen der Verbindung zur Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500ms// oder //2min//.
  ; Read timeout
--: The read timeout, i.e. the maximum amount of time to spend waiting for a response from the web service. You should enter the duration with a unit, such //10 s//, //500 ms// oder //2 min//.
--; Always send a PING request first
--: Either //true// or //false//. The specification of the Postkorb service recommends that a PING is sent before each request, to check the availability of the web service. Usually you can turn this off.
++: Lesezeitüberschreitung (Read-Timeout) für das Auslesen einer Methode der Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500ms// oder //2min//.
++; Vorher immer PING durchführen
++: 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.
--=== Default request settings ===
++=== Standardeinstellung für Anfragen ===
--Each request to the Postkorb web service must include certain data, such as the service ID. Here you can set a system-wide default for these settings. If required, they can be overwritten by an individual workflow action. You should have received this information from your Postkob service provider.
++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.
--; Service ID (BIS)
--: The service ID used for sending messages to the Postkorb. Usually this is a number with 5 digits. This setting applies globally, but can be overwritten by an individual workflow action if neccessary. This setting corresponds to the parameter //fall.dienstleistung// of the Postkorb web service.
--; Message thread ID prefix
--: The prefix is used as the first part of the external ID, i.e. the part before the colon. This setting applies globally, but can be overwritten by an individual workflow action if neccessary.  This settings corresponds to the parameter //extern.id// of the Postkorb service.
++; ID der Dienstleistung aus BIS
++: 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.
++; Präfix für die ID des Vorgangs im Postkorb
++: 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.
--=== TLS/SSL configuration ===
++=== TLS/SSL-Einstellungen ===
--These settings are required only if the Postkorb web server uses non-standard certificates that are not known by the FORMCYCLE server or the Java trust store.
++Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle Zertifikate verwendet, die nicht auf dem FORMCYCLE-Server beziehungsweise im Java-Truststore vorhanden sind.
--; Additional certificate for TLS/SSL (client file)
--: The name of a [[client file>>doc:Formcycle.UserInterface.FilesAndTemplates]] with a valid X509 certificate.
--; Password for the certificate
--: The password for opening the certificate
++; Zusätzliches Zertifikat für TLS/SSL (Mandantdatei)
++: Der Name einer Mandantdatei mit einem gültigen X509-Zertifikat.
++; Passwort für das Zertifikat
++: Das Passwort, um das angegebene Zertifikat öffnen zu können.
--=== HTTP basic authorization configuration ===
++=== HTTP-Basic-Auth-Einstellungen ===
--These settings are required only if the Postkorb web server requires an HTTP basic authorization.
++Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle eine HTTP-Basic-Authentication erfordert.
--; Username for HTTP basic auth
--: The username for the HTTP basic authorization.
--; Password for HTTP basic auth
--: The password for the HTTP basic authorization.
++; Nutzername für HTTP-Basic-Auth
++: Der zu benutzende Benutzername für HTTP-Basic-Auth.
++; Passwort für HTTP-Basic-Auth
++: Das zu benutzende Passwort für HTTP-Basic-Auth.
--=== Proxy server settings ===
++=== Proxy-Server-Einstellungen ===
--These settings are required only if the FORMCYCLE server requires a proxy server to connect to the Postkorb web service.
++Diese Einstellungen sind nur erforderlich, falls der FORMCYLE-Server einen Proxy-Server benötigt, um sich mit der Postkorbschnittstelle verbinden zu können.
--; Proxy server URL
--: The URL to the proxy server.
--; Proxy server port
--: The port of the proxy server.
--; Proxy server username
--: The username, if neccessary, for connecting to the proxy server
--; Proxy server password
--: The password, if neccessary, for connecting to the proxy server
++; URL des Proxy-Servers
++: Die URL des Proxy-Servers.
++; Port des Proxy-Servers
++: Der Port des Proxy-Servers.
++; Nutzername für Proxy-Server
++: 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.

Änderungen von Dokument regio iT: Postkorb-Plugin

Zusammenfassung

Details

Navigation