Dieses Plugin ermöglicht die Anbindung der Postkorbschnittstelle von der regio iT. Über eine Workflow-Aktion können dann Nachrichten an den Postkorb des Serviceportals 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.

Konfiguration des Plugins

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 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, 500 ms oder 2 min.

Read timeout

Lesezeitüberschreitung (Read-Timeout) für das Auslesen einer Methode der Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa 10s, 500 ms oder 2 min.

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 Verbindungs zum Proxy-Server herzustellen.

Passwort für den Proxy-Server

Nutzername, falls nötig, um eine Verbindungs zum Proxy-Server herzustellen.

Postkorb-Aktion

Nach Konfiguration des Plugins kann in der Statusverarbeitung die Aktion Nachricht im Postkorb erstellen ausgewählt werden.

Konfiguration

Die Einstellungen für die Postkorb-Aktion sind ähnlich zur E-Mail-Aktion und in 4 Bereiche unterteil. 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.

Angaben zum Empfänger
 

Art des Versendens

Die Postkorbschnittstelle bietet zwei Möglichkeiten: Es kann (a) eine neuer Vorgang mit einer intialen 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 voreingstellte Wert ausreichend: [%$last_user.preferred_username%) Dies ist ein Platzhalter, der mit der Kontonummer des angemeldeten Nutzers ersetzt wird.