Das kostenpflichtige FIT Connect Plugin dient zur Übertragung von Antragsdaten aus Formularen an ein zuständiges Fachverfahren.

Für den Betrieb des Plugins wird mindestens formcycle in Version >= 8.1.x benötigt.

Installation

Die Installation erfolgt unter System > Systemplugins.

Konfiguration der Verbindungsdaten zu FIT-Connect:

FIT-Connect Zugangsdaten

• Anzubindende Umgebung (Pflichtangabe): Definiert die anzubindende FIT-Connect Umgebung. Folgende Werte werden unterstützt: TEST, PROD, STAGE
  
  
• Client-ID (Pflichtangabe): Client-ID aus dem FITKO Self Service Portal (SSP). Muss zum hinterlegten Client-Secret passen.
  
  
• Client-Secret (Pflichtangabe): Client-Secret aus dem FITKO SSP. Muss zur hinterlegten Client-ID passen.
  
  

Proxy-Server Konfiguration

• Host: Host-Name oder IP-Adresse eines Proxy-Servers, welcher für die Kommunikation zu FIT-Connect genutzt werden soll.
  
  
• Port: Portangabe (Zahl) für die Kommunikation über eine Proxy-Server.
  
  

Konfiguration Verbindungs-Timeouts

• Connection Timeout (in Sekunden): Beschreibt den Zeitraum, wie lange für einen Verbindungsaufbau über die FIT-Connect Schnittstelle gewartet wird. Unterstützt wird ein Wert > 0 (Standardwert ist 30).
  
  
• Read Timeout (in Sekunden): Beschreibt den Zeitraum, wie lange auf eine Antwort der FIT-Connect Schnittstelle gewartet wird. Unterstützt wird ein Wert > 0 (Standardwert ist 30)

Workflow-Aktion: Senden an FIT-Connect

Für die Übermittlung von Formulardaten an FIT-Connect stellt das Plugin die Workflow-Aktion Senden an FIT-Connect zur Verfügung. Über diese Aktion ist es möglich Daten in Form von XML oder JSON an einen zuvor festgelegten FIT-Connect "Zustellpunkt".

Konfiguration Nachrichten-Empfänger

Um Daten an FIT-Connect zu übermitteln muss im Vorfeld ein Empfänger festgelegt werden. Dies erfolgt über die Einbindung eines FIT-Connect Zustellpunktes. Die verfügbaren Zustellpunkte wiederum, werden über das FITKO Self Service Portal (SSP) konfiguriert und anderen Anwendungen zur Verfügung gestellt. 

Im Bereich des Nachrichten-Empfängers können folgende Eigenschaften konfiguriert werden:

• Empfänger- / Zustellpunkt-UUID (Pflichtangabe): Ein Identifier der den Empfänger der Nachricht in FIT-Connect eindeutig referenziert (Angabe in Form einer UUID: 00000000-0000-0000-0000-000000000000).
  
  
• FIT-Connect Vorgangs-ID: Durch Angabe einer existierenden FIT-Connect Vorgangs-ID, kann die übermittelte Einreichung diesem FIT-Connect Vorgang hinzugefügt werden, ansonsten wird auf Seiten von FIT-Connect ein neuer Vorgang erzeugt.
  
  
• Service Identifier (Verwaltungsleistung / LeiKa-ID) (Pflichtangabe): Eine ID zum Identifizieren einer konkreten Service-/Verwaltungsleistung. Ist in URN-Notation (Uniform Resource Name) anzugeben, zum Beispiel mittels eines LeistungsKatalog (LeiKa) - Schlüssels
  z.B.: urn:de:fim:leika:leistung:99108008252000, urn:myleistung
  
  
• Service Bezeichnung: Bezeichnung für den Service. Wenn an dieser Eigenschaft kein Wert definiert ist, wird der Name der Workflow-Aktion als Bezeichnung an FIT-Connect übermittelt.

Konfiguration Einstellungen für Datenübermittlung

Im Bereich der Einstellungen für Datenübermittlung können folgende Eigenschaften konfiguriert werden:

• Art der Nachricht (Pflichtangabe): Definiert die Quelle (aus Datei oder aus Textfeld) und den Typ (JSON oder XML) der zu übermittelnden Nachricht. Je nach Festlegung in diesem Feld, wird entweder eine Texteditor zur direkten Erzeugen der Nachricht, oder ein Dateiauswahl-Feld zur Angabe einer Nachrichtendatei für die weitere Konfiguration angezeigt.
  
  
• Nachricht im JSON / XML - Format (Pflichtangabe): Im eingeblendeten Editor muss, je nach der zuvor festgelegten Nachrichten - Art (JSON oder XML) eine entsprechende Datenstruktur angelegt werden. Dabei können Platzhalter verwendet werden. Zum Ausführungszeitpunkt der Plugin-Aktion wird die erzeugte Nachricht (mit ersetzten Platzhaltern) grundsätzlich in Hinblick auf den festgelegten Nachrichten-Typ (JSON oder XML) hin, geprüft. Wenn diese Prüfung fehlschlägt, so wird die Plugin-Verarbeitung mit dem Fehlercode PARAMETER_FORMAT_ERROR beendet.
  Eine konkrete Prüfung der Nachricht, gegen das in der Eigenschaft Schema-URI definierte Schema, erfolgt nicht, da dies Aufgabe der FIT-Connect-Schnittstelle ist.
  
  
• oder 
  Nachrichten-Datei im JSON / XML - Format (Pflichtangabe): Hier kann eine Datei aus einer vorherigen Workflow-Aktion, einem Upload-Feld oder einer externen Ressourcen-URL ausgewählt werden. Es ist dabei auf den zuvor festgelegten Nachrichten-Typ (JSON oder XML) zu achten. Zum Ausführungszeitpunkt der Plugin-Aktion wird der Nachrichten-Typ (JSON oder XML) geprüft, wenn diese Prüfung fehlschlägt, so wird die Plugin-Verarbeitung mit dem Fehlercode PARAMETER_FORMAT_ERROR beendet.
  
  
• Schema-URI (Pflichtangabe): URI zur Definition des Schemas, welches dem gemeinsamen Datenaustausch zwischen Sender und Empfänger dient und die Struktur der übermittelten Daten definiert. Eine Prüfung gegen das definierte Schema erfolgt auf Seiten von FIT-Connect. Wenn diese Überprüfung fehlschlägt, wird diese mit einem entsprechenden Fehlercode (WEBSERVICE_ERROR) an der Plugin-Aktion quittiert.

Konfiguration zusätzlich zu übermittelnder Anhänge

Im Bereich der zusätzlich zu übermittelnden Anhänge können folgende Eigenschaften konfiguriert werden:

• Dateien: Hier können Dateien aus einer vorherigen Workflow-Aktion, Upload-Feldern oder einer externen Ressourcen-URL ausgewählt werden. 

Übersteuerung der FIT-Connect Verbindung

Im Bereich Übersteuerung der FIT-Connect Verbindung können folgende Eigenschaften konfiguriert werden:

• Anzubindende Umgebung: Übersteuert die global angegebene FIT-Connect Umgebung. Folgende Werte werden unterstützt: TEST, PROD, STAGE 
• Client-ID: Übersteuert die global definierte Client-ID, für die Anbindung eines konkreten Clients aus dem FITKO SSP.
• Client-Secret: Übersteuert das global definierte Client-Secret, für die Anbindung eines konkreten Clients aus dem FITKO SSP.

Über den Button Verbindung prüfen wird anhand der globalen Verbindungs-Einstellungen und den eventuell vorhandenen Übersteuerungs-Einstellungen eine Verbindungsprüfung zwischen formcycle und er jeweiligen FIT-Connect Umgebung durchgeführt. Das Ergebnis wird dem Nutzer im Bereich der internen Nachrichten angezeigt.

Rückgabewerte

Wenn eine Nachricht erfolgreich an FIT-Connect übermittelt werden konnte, terminiert die Plugin-Aktion normal und liefert folgende Informationen als Rückgabeparameter zurück:

• Einreichungs-ID: ([%$Senden an FIT-Connect.RESULT.submissionId%]) Die von FIT-Connect zurück gelieferte ID der Einreichung.
  
  
• Vorgangs-ID: ([%$Senden an FIT-Connect.RESULT.caseId%]) Die von FIT-Connect gelieferte Vorgangs-ID, unter der die aktuelle Einreichung abgespeichert wurde. (Kann in einer weiteren Senden an FIT-Connect Aktion dazu genutzt werden, eine weitere Einreichung dem gleichen Vorgang zuzuordnen.)
  
  
• ID des Zustellpunktes: ([%$Senden an FIT-Connect.RESULT.destinationId%]) ID des Zustellpunktes, an den die Einreichung übermittelt wurde.

Bei erfolgreicher Nachrichtenübermittlung an FIT-Connect werden die aktuelle Einreichungs-ID, die FIT-Connect Vorgangs-ID und die UUID des genutzten Zustellpunktes als Information im Postkorb-Verlauf hinterlegt.

Fehler, während der Plugin-Verarbeitung, welche zu einem Abbruch der Workflow-Verarbeitungskette führen:

• AUTHORIZATION_FAILED: Tritt auf, wenn mit den hinterlegten Login-Daten keine erfolgreiche Authentifizierung am FIT-Connect System durchgeführt werden konnte.
  
  
• MANDATORY_PARAMETER_MISSING: Tritt auf, wenn der FIT-Connect Service aufgrund fehlender Parameter zu Laufzeit nicht aufgerufen werden konnte.
  
  
• NO_MESSAGE_FILE_FOUND: Tritt auf, wenn keine Nachricht zur Übertragung an FIT-Connect ermittelt werden konnte.
  
  
• PARAMETER_FORMAT_ERROR: Tritt auf, wenn die zu übermittelnde Nachricht nicht dem geforderten JSON oder XML Format entsprach.
  
  
• WEBSERVICE_ERROR: Tritt auf, wenn der Aufruf einer FIT-Connect Webservice-Methode einen Fehler zurück lieferte.
  
  
• INTERNAL_ERROR: Tritt auf, wenn es bei der Verarbeitung zu einer Ausnahme kam, welche nicht mit den anderen Fehler-Typen bereits verarbeitet wurde.

Fehler, während der Plugin-Verarbeitung, welche nicht zu einem Abbruch der Workflow-Verarbeitungskette führen:

• NO_ATTACHMENTS_FOUND: Tritt auf, wenn zur Laufzeit keine Daten zusätzlichen Anhänge ermittelt werden konnten, obwohl diese an der Plugin-Aktion definiert sind.
  Es wird eine Warnung über das Auftreten dieser Ausnahme im Protokoll erzeugt.