Änderungen von Dokument regio iT: Postkorb-Plugin

Von Version < 18.68 >

bearbeitet von awa
am 18.03.2020, 14:21

Auf Version < 19.1 >

bearbeitet von awa
am 18.03.2020, 14:24

< >

Änderungskommentar: Zurück zur Version 18.1

Rohform
Im Layout

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

@@ -1,207
          +1,169 @@
  {{info}}
--The section regarding the plugin configuration is required only for administrators who need to configure the Postkorb web service. See the //Postkorb action// section on how to send a message to the Postkorb.
++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}}
  {{info}}
--The Postkorb ("inbox") is a feature offered by the service portal. The Postkorb consists of so-called processes or message threads. Each message thread contains one more messages. This plugin lets you send message to an existing message thread from {{formcycle/}}. You can also create new message threads with an initial message.
++Der Postkorb ist eine Funktion des Serviceportals. Im Postkorb können sogenannte Vorgänge angelegt werden, etwa wenn jemand ein Antragsformular ausgefüllt hat. Zu jedem Vorgang können dann mehrere Nachrichten gesendet werden. Dieses Plugin ermöglicht es, Nachrichten an einen Vorgang aus {{formcycle/}} heraus zu senden. Der Vorgang im Postkorb sollte nicht mit dem Vorgang in {{formcycle/}} verwechselt werden.
  {{/info}}
  {{content/}}
--This plugin implements the Porstkorb web service provided by regio iT. It adds a new [[workflow action>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]] that lets you send messages to the Postkorb of the [[service portal>>https://servicekonto.nrw/]].
++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.
--You can install this plugin both as a system plugin as well as a client plugin. Once the plugin is installed, you (or an administrator) needs to configure the connection to the Postkorb web service. Once it is configured, you can start using the Postkorb workflow action.
++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.
--== Postkorb action ==
++== Postkorb-Aktion ==
--{{figure image="plugin_regioit_postkorb_workflow_select_action_en.png" width="400"}}
--  Click on //New action// to add a new Postkorb action to the workflow.
++{{figure image="plugin_regioit_postkorb_workflow_select_action_de.png" width="400"}}
++Durch Klick auf //neue Aktion// kann die Postkorbschnittstellen-Aktion zum Worfklow hinzugefügt werden.
  {{/figure}}
--{{figure image="plugin_regioit_postkorb_workflow_action_base_en.png" width="400"}}
--  Basic settings for sending a message to a Postkorb message thread. Here you can the recipient and the content of the message.
++{{figure image="plugin_regioit_postkorb_workflow_action_base_de.png" width="400"}}
++Grundlegende Einstellungen zum Versenden einer Nachricht an der Postkorb. Hier kann der Empfänger und der Inhalt der Nachricht eingestellt werden.
  {{/figure}}
--{{figure image="plugin_regioit_postkorb_workflow_action_advanced_en.png" width="400"}}
--  Advanced settings for sending a messag to a Postkorb message thread. Here you can change the metadata of the Postkorb message thread that is created.
++{{figure image="plugin_regioit_postkorb_workflow_action_advanced_de.png" width="400"}}
++Fortgeschrittene Einstellungen für den Postkorb. Hier können die Metadaten des Vorgangs geändert werden, der im Postkorb erstellt wird.
  {{/figure}}
--{{figure image="plugin_regioit_postkorb_workflow_action_guest_en.png" width="400"}}
--  You can also create a new message thread as a guest. This requires you to enter a few details about the guest, such as the name and email address. Please note that creating message threads as guests may be restricted by the web service - please contact your service provider for details.
++{{figure image="plugin_regioit_postkorb_workflow_action_guest_de.png" width="400"}}
++Eine neue Nachricht kann auch als Gast an den Postkorb gesendet werden. In dem Fall müssen einige Daten zum Gast eingetragen werden. Es kann sein, dass die Postkorbschnitstelle die Nutzung als Gast nicht erlaubt - dies sollte vorher mit dem Dienstanbieter der Postkorbschnittstelle geklärt werden.
  {{/figure}}
--Once the plugin is configured correctly, you can select the new workflow action //Create Postkorb message// in the workflow configuration.
++Sobald das Plugin richtig konfiguriert ist, kann in der Statusverarbeitung die Aktion //Nachricht im Postkorb erstellen// ausgewählt werden.
--=== Configuration ===
++=== Konfiguration ===
--The configuration for the Postkorb action is similar to the email action and separated into 4 sections.  Most settings have a default set that you do not need to change normally - usually you just have to enter a subject and message text.
++Die Einstellungen für die Postkorb-Aktion sind ähnlich zur E-Mail-Aktion und in 4 Bereiche unterteilt. 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.
--Most settings allow the use of [[variables>>doc:Formcycle.UserInterface.Variables]] to insert data from the submitted form. All settings that allow variables have a little book icon next to them that opens the variable selection dialog.
++An den meisten Feldern ist die Verwendung von [[Platzhaltern>>doc:Formcycle.UserInterface.Variables]] möglich, um Daten aus dem Formular einzutragen. Alle Felder, an denen das Nutzen von Platzhaltern möglich sind, haben rechts am Eingabefeld eine kleines Buch-Symbol.
--In order to send am message to the Postkorb, a few pieces of information about the recipient are required, such as their account number and name. We recommend that you allow users to sign in via the services provided by regio iT (OpenID Connect). This lets you prefill the settings with the data from the registered user via [[variables>>doc:Formcycle.UserInterface.Variables]].
++Für das Senden von Nachrichten sind einige Informationen zum Empfänger notwendig, wie zum Beispiel dessen Kontonummer im Serviceportal. Es wird empfohlen, die Anmeldung am Formular per regio iT (technisch: OpenID Connect) zu aktivieren. So können diese Daten aus dem Nutzerkonto des angemeldeten Benutzers per [[Platzhalter>>doc:Formcycle.UserInterface.Variables]] übernommen werden.
--==== Message type and recipient ====
++==== Angaben zum Empfänger ====
--; Message type
--: The Postkorb service offers two possibilies: You can (a) create a new message thread with an initial message, or (b) send a message to an existing message thread. In case you know for certain whether a message thread exists already, you can select the option //Create new message thread// or //Reply to existing message thread//. Otherwise, if you are uncertain and would like to create a new message thread in case none exists yet, you can select the option //Create message thread if none exists yet//
--; Recipient account number
--: Here you need to enter the account number of the recipient who should receive the Postkorb message. Usually the user would sign in via the login service provided by regio iT (OpenID Connect). In that case, you do not have to change the default value: //[%$last_user.preferred_username%//] This is a [[variable>>doc:Formcycle.UserInterface.Variables]] that is replace with the account number of the user who submitted the form. This setting corresponds to the parameter //fall.portalkonto// of the Postkorb web service.
--; Send as guest
--: The Postkorb also allows you to create a new message thread as a guest, that is, without having an account number. Please note that it is not possible to reply to existing message threads as a guest. When this option is selected, a few more input fields will show up that let you enter the guests' data. Important: Please check with your Postkorb service provider whether they have allowed guests to create message threads.
++; 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.
++; 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.
--The following input fields are available when the option //Send as guest// is checked:
++Folgende Eingabefelder erscheinen, wenn die Option //Als Gast versenden// aktiviert wurde:
--; Guest' email
--: The email of the guest. This setting corresponds the the parameter //gast.email// of the Postkorb web service.
--; Guest's form of address
--: An optional form of address for the guest. Please note that only certain options such as //Herr// and //Frau// are supported. This setting corresponds the the parameter //gast.anrede// of the Postkorb web service.
--; Guest's title
--: An optional title for the guest, such as //Dr. med.//. This setting corresponds the the parameter //gast.titel// of the Postkorb web service.
--; Guest's first name
--: The first or given name of the guest. This setting corresponds the the parameter //gast.vorname// of the Postkorb web service.
--; Guest's family name
--: The last of family name of the guest. This setting corresponds the the parameter //gast.familienname// of the Postkorb web service.
++; E-Mail des Gasts
++: Falls ein Vorgang als Gast erstellt werden soll: Die E-Mail-Adresse des Gasts. Diese Einstellung entspricht dem Parameter //gast.email// der Postkorbschnittstelle.
++; Anrede des Gasts
++: Falls ein Vorgang als Gast erstellt werden soll: Die optionale Anrede des Gasts, etwa //Herr// oder //Frau//. Hinweis: Die Postkorbschnittstelle unterstützt nur spezielle Werte für die Anrede. Diese Einstellung entspricht dem Parameter //gast.anrede// der Postkorbschnittstelle.
++; Titel des Gasts
++: Falls ein Vorgang als Gast erstellt werden soll: Der optionale Titel für den Gast, etwa //Dr.//. Diese Einstellung entspricht dem Parameter //gast.titel// der Postkorbschnittstelle.
++; Vorname des Gasts
++: Falls ein Vorgang als Gast erstellt werden soll: Der Vorname des Gasts. Diese Einstellung entspricht dem Parameter //gast.vorname// der Postkorbschnittstelle.
++; Nachname des Gasts
++: Falls ein Vorgang als Gast erstellt werden soll: Der Nachname des Gasts. Diese Einstellung entspricht dem Parameter //gast.familienname// der Postkorbschnittstelle.
--==== Message content ====
++==== Inhalt der Nachricht ====
--The content of the message that is sent to the Postkorb. Optionally you can also send up to 10 files as an attachment. Please note that the Postkorb web service does not support more than 10 files.
++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.
--; Sender
--: The name of the message' sender. By default this is set to the variable //[%last_user.name%]//, which is replaced with the name of the user who submitted the form. This setting corresponds the the parameter //nachricht.absender// of the Postkorb web service.
--; Subject
--: A single line of text with the subject of the message. This setting corresponds the the parameter //nachricht.betreff// of the Postkorb web service.
--; Message
--: The message that is sent to the Postkorb. A few formating options such as bold text and lists are supported by Postkorb. This setting corresponds the the parameter //nachricht.inhalt// of the Postkorb web service.
--; Attachments from previous actions
--: Optionally you can also add files produced by previous actions as an attachment. This setting corresponds the the parameters //anhang.[1-10].*// of the Postkorb web service.
--; Attachments from form uploads
--: Optionaly you can also add files uploaded by the user as an attachment. This setting corresponds the the parameters //anhang.[1-10].*// of the Postkorb web service.
++; 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.
++; Betreff
++: Ein einzeiliger Betreff der zu sendenden Nachricht. Diese Einstellung entspricht dem Parameter //nachricht.betreff// der Postkorbschnittstelle.
++; Nachricht
++: Die mehrzeilige Nachricht, welche an den Postkorb gesendet werden soll. Der Postkorb unterstützt die Nutzung einiger Formatierungsoptionen wie etwa fetter Schrift oder Aufzählungszeichen. Diese Einstellung entspricht dem Parameter //nachricht.inhalt// der Postkorbschnittstelle.
++; Anhänge aus vorigen Aktionen
++: Optional können Dateien aus vorigen Aktionen als Anhang mitgesendet werden. Diese Einstellung entspricht den Parametern //anhang.[1-10].*// der Postkorbschnittstelle.
++; Anhänge aus Formular-Uploads
++: Optional können Dateien aus Upload-Feldern im Formular als Anhang mitgesendet werden. Diese Einstellung entspricht den Parametern //anhang.[1-10].*// der Postkorbschnittstelle.
--==== Postkorb message thread ====
++==== Auswahl des Vorgangs ====
--; New message thread state
--: You can optionallt change the status of the message thread. The available status, as defined by the Postkorb, are //open//, //in progress//, //settled// and //canceled//. The default settings does not change the status (new message threads are automatically set to //open//). Please note that the two status //in progress// und //canceled// are available only when repying to an existing message thread, not when creating a new messag e thread. This setting corresponds the the parameter //fall.status// of the Postkorb web service.
--; Message thread external ID
--: The external ID of the message thread. Each message thread receives an internal ID used by the Postkorb service internally, as well as an external ID that identifies the form record in {{formcycle/}}. The default settings is //[%$PROCESS_ID%]//. This variable is replace with the form record ID of the {{formcycle/}} form record - this should be sufficient for most use cases. In case you want to use a different external ID, please note that the Postkorb does not allow certain characters such as spaces.  This setting corresponds the the parameter //extern.id// of the Postkorb web service.
--; Message thread name
--: The name that is shown in the Postkorb for the message thread. This name is also shown in the list of existing message threads. This setting is available only when creating a new message thread. By default this is set to //[%$PROJECT_NAME%] - [%$PROCESS_ID%]//. These variables are replaced with the name of the form and ID of the form record, respectively, which results in message thread names such as //Registration form - 7581f9c5-0ba9-4b9a-b7c1-cfb475eabafd//. To make it easier to identify a message thread in the Postkorb, consider using other data submitted by the user, such as their email address. This setting corresponds the the parameter //extern.titel// of the Postkorb web service.
--; Message thread link
--: An optional URL that is shown in the Postkorb. This setting is available only when a new message thread is created. Defaults to //[%$FORM_PROCESS_LINK%]//, which is replaced with the link to the submitted form. This setting corresponds the the parameter //extern.url// of the Postkorb web service.
--; Message thread description
--: An optional description for the message thread. This setting is available only when creating a new message thread. This setting corresponds the the parameter //fall.info// of the Postkorb web service.
++; Neuer Status des Vorgangs im Postkorb
++: Es ist möglich, den Status des Vorgangs im Postkorb zu ändern. Es gibt dabei die Status //offen//, //in Bearbeitung//, //abgeschlossen// und //storniert//. Standardeinstellung ist, dass der Status nicht geändert wird. Neue angelegte Vorgänge erhalten dabei automatisch den Status //offen//. Es ist zu beachten, dass die Status //in Bearbeitung// und //storniert// nur verfügbar sind, wenn auf einen vorhandenen Vorgang geantwortet wird, aber nicht beim Erstellen eines neuen Vorgangs. Diese Einstellung entspricht dem Parameter //fall.status// der Postkorbschnittstelle.
++; Externe ID des Vorgangs im Postkorb
++: Die externe ID des Vorgangs im Postkorb. Jeder Vorgang im Postkorb hat sowohl eine interne ID, die vom Postkorb intern genutzt wird, als auch eine externe ID. Die externe ID identifiziert den Vorgang gegenüber einem Drittsystem, in dem Fall also {{formcycle/}}. Standardmäßig ist hier der Wert //[%$PROCESS_ID%]// eingetragen. Dieser Platzhalter wird mit der Vorgangs-ID des abgesendeten Formulars ersetzt. Im Regelfall braucht dies nicht geändert zu werden. Es sollte beachtet werden, dass die Postkorbschnittstelle bestimmte Zeichen wie Leerzeichen nicht in der externen ID erlaubt. Diese Einstellung entspricht dem Wert nach dem Doppelpunkt des Parameters //extern.id// der Postkorbschnittstelle.
++; Name des Vorgangs im Postkorb
++: Der Name, der im Postkorb für den Vorgang angezeigt wird. Nur verfügbar, wenn ein neuer Vorgang erstellt wird. Dieser Name wird etwa auch in der Übersicht aller Vorgänge angezeigt. Als Standard ist hier der Wert //[%$PROJECT_NAME%] - [%$PROCESS_ID%]// eingetragen. Diese Platzhalter werden durch den Namen des Formulars und die Vorgangs-ID ersetzt, sodass Namen wie //Anmeldeformular - 7581f9c5-0ba9-4b9a-b7c1-cfb475eabafd// erzeugt werden. Zur Erhöhung der Lesbarkeit kann statt der Prozess-ID etwa die E-Mail des Benutzers etc. verwendet werden. Diese Einstellung entspricht dem Wert nach dem Doppelpunkt des Parameters //extern.titel// der Postkorbschnittstelle.
++; Link (URL) für den Vorgang im Postkorb
++: Eine optionale URL auf den Vorgang im Drittsystem (also {{formcycle/}}). Nur verfügbar, wenn ein neuer Vorgang erstellt wird. Hier ist standardmäßig der Platzhalter //[%$FORM_PROCESS_LINK%]// eingetragen, welcher durch den Link auf das abgesendete Formular ersetzt wird. Diese Einstellung entspricht dem Wert nach dem Doppelpunkt des Parameters //extern.url// der Postkorbschnittstelle.
++; Beschreibung des Vorgangs im Postkorb
++: Eine optionale Beschreibung für den Vorgang im Postkorb. Nur verfügbar, wenn ein neuer Vorgang erstellt wird. Diese Einstellung entspricht dem Wert nach dem Doppelpunkt des Parameters //fall.info// der Postkorbschnittstelle.
--==== Global plugin configuration overrides ====
++==== Überschreiben der globalen Plugin-Konfiguration ====
--; Throw hard exception if action fails
--: Controls the behavior when the workflow action fails, i.e. when the message could not be sent to the Postkorb. When this option is activated, an exception is thrown, which aborts the workflow processing and returns an error page to the user. You can use the  [[error handling settings>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.ErrorHandling]] to control that behavior. Otherwise, when this option is deactivated, the Postkorb action is always successful and return an appropriate status code that indicates whether the message could be sent (see below). In that case you can use [[workflow conditions>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.ActionConditions]] in combination with action result variables to check the status code and act accordingly.
--; Service ID (BIS)
--: Lets you override the global value configured in the plugin settings, if neccessary. See the //Service ID (BIS)// option in the plugin configuration for more details.
--; Message thread ID prefix
--: Lets you override the global value configured in the plugin settings, if neccessary. See the //Message thread ID prefix// option in the plugin configuration for more details.
++; Aktion bei Fehler mit Exception abbrechen
++: 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.
++; ID der Dienstleistung aus BIS
++: 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.
++; Präfix für ID des Vorgangs im Postkorb
++: Hier kann die globale Einstellung aus der Plugin-Konfiguration überschrieben werden, falls dies notwendig ist. Siehe //ID der Dienstleistung aus BIS// im Abschnitt //Präfix für die ID des Vorgangs im Postkorb// oben für mehr Informationen.
--Finally, you can also check the availability of the Postkorb service. This only checks the connection details as configured in the plugin settings, not whether the data configured for this Postkorb action is valid. Technically speaking, this sends a so-called //PING// service request to the Postkorb web service.
++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.
--=== Return values ===
++== Konfiguration des Plugins ==
--After the plugin action was executed, the following additional [[action variables>>doc:Formcycle.UserInterface.Variables]] are available:
--
--; success
--: //true// if the message could be sent to the Postkorb, //false// otherwise.
--; status
--: The status code as returned by the Postkorb web service, either //SUCCESS// or //ERROR//.
--; messageThreadId
--: If the request was successful and a new message thread was created: The ID of the newly created message thread, as returned by the Postkorb web service.
--; errorCode
--: A numerical error code defined by this plugin. See the following list for the available codes.
--; errorType
--: Technical name of the error code, see below.
--; errorDetails
--: Localized name of the error code.
--; exceptionMessage
--: Message of the exception that was thrown by Java, if any.
--
--=== Error codes ===
--
--The following error codes are currently defined by this plugin:
--
--{{table dataTypeAlpha="1" dataTypeNum="0" preSort="0-asc"}}
--|=Status code|=Technical name|=Description
--|0|SERVICE_COULD_NOT_BE_CREATED|The connection to the Postkorb web service could not be established.
--|10|PING_REQUEST_FAILED|The PING request preceding the actual request failed (only if enabled in the configuration).
--|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//.
--|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.
++{{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}}
--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.WebHome]] 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