regio iT: Postkorb-Plugin
This plugin implements the Porstkorb web service provided by regio iT. It adds a new workflow action that lets you send messages to the Postkorb of the service portal.
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.
Postkorb action
Once the plugin is configured correctly, you can select the new workflow action Create Postkorb message in the workflow configuration.
Configuration
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.
Most settings allow the use of 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.
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.
Message type and recipient
- 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 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.
The following input fields are available when the option Send as guest is checked:
- 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.
Message content
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.
- 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.
Postkorb message thread
- 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 Xima® Formcycle. The default settings is [%$PROCESS_ID%]. This variable is replace with the form record ID of the Xima® 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.
Global plugin configuration overrides
- 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 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 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.
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.
Plugin configuration
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.
Die Konfiguration gliedert sich in die folgenden fünf Abschnitte.
Verbindungseinstellungen
Diese Einstellung sind notwendig, damit eine Verbindung zur Postkorbschnittstelle aufgebaut werden kann. In der Regel werden diese Informationen von der regio iT mitgeteilt.
- 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
- 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
- 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.
Standardeinstellung für Anfragen
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.
- 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-Einstellungen
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.
- Passwort für das Zertifikat
- Das Passwort, um das angegebene Zertifikat öffnen zu können.
HTTP-Basic-Auth-Einstellungen
Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle eine HTTP-Basic-Authentication erfordert.
- 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-Einstellungen
Diese Einstellungen sind nur erforderlich, falls der FORMCYLE-Server einen Proxy-Server benötigt, um sich mit der Postkorbschnittstelle verbinden zu können.
- 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.