Achtung, diese Hilfeseite beschreibt die Konfiguration und Einsatz für das FIT-Connect Plugin ab Version 2.x.x. Sollten Sie eine ältere Version des FIT-Connect Plugins einsetzen, so folgen Sie den Anweisungen für den Einsatz der Workflow-Aktion auf dieser Seite.

INHALTSVERZEICHNIS

• Übersicht
• Sender-Funktionalität
  • Workflow-Aktion: Senden an FIT-Connect
    • Einstellungen für FIT-Connect Zustellpunkt
    • Einstellung für Datenübermittlung
    • Konfiguration von Antwortkanälen (ab Version 2.3.0)
    • Konfiguration zusätzlich zu übermittelnder Anhänge
    • Rückgabewerte
• Empfänger-Funktionalität
  • Workflow-Ereignis: FIT-Connect Einreichungsabruf
    • Zustellpunkt-Einstellungen
    • Informationen zum ausgewählten Zustellpunkt
    • Rückgabewerte 
      • Bereitgestellte Werte
      • Bereitgestellte Dateien
• Antwort-Funktionalität (Bidirektionale Kommunikation)
  • Workflow-Aktion: Antworten an FIT-Connect
    • Einstellungen für FIT-Connect Zustellpunkt
    • Antwortdaten
    • Zusätzlich zu übermittelnde Anhänge
    • Rückgabewerte
  • Workflow-Ereignis: FIT-Connect Antwortabruf
    • Onlinedienst Einstellungen
    • Rückgabewerte
      • Bereitgestellte Werte
      • Bereitgestellte Dateien

Übersicht

Das kostenpflichtige FIT-Connect Plugin dient zur Übertragung von (verschlüsselten) Antragsdaten aus Formularen an ein zuständiges Fachverfahren. Ab Version 2.0.0 des Plugins kann formcycle auch als Fachverfahren agieren und die eingereichten Daten aus FIT-Connect abrufen und in einem Formular-Projekt weiter verarbeiten.

Mit dem Einsatz des Plugins lassen sich somit sowohl FIT-Connect Sender- (Onlinedienste) als auch Empfänger-Systeme (Verwaltungssysteme) abbilden.

Sender-Funktionalität

Um die FIT-Connect Sender Funktionalität in formcycle abzubilden müssen folgende Voraussetzungen gegeben sein:

• Im FIT-Connect Portal muss ein Onlinedienst registriert sein, sodass ein Zugriff auf FIT-Connect möglich wird
• Im FIT-Connect Portal muss ein Zustellpunkt existent sein, an den man Daten versenden kann. Das heißt, der Zustellpunkt darf entweder keine Absenderbeschränkung aufweisen, oder muss den gewählten Onlinedienst Zugang gewähren. Die DestinationId des Zustellpunktes muss bekannt sein.
• In formcycle muss ein Anbindung an einen Onlinedienst konfiguriert sein.
• In formcycle muss ein Formular existieren, welches die nachfolgend beschriebene Workflow-Aktion Senden an FIT-Connect beinhaltet.

Workflow-Aktion: Senden an FIT-Connect

Das Workflow-Aktion Senden an FIT-Connect kann in einem Formular als Datenexporteur an das FIT-Connect Portal genutzt werden.

Einstellungen für FIT-Connect Zustellpunkt

Im Bereich Einstellungen für FIT-Connect Zustellpunkt können folgende Einstellungen konfiguriert werden:

• FIT-Connect Onlinedienst (Pflicht): An dieser Stelle muss eine FIT-Connect Verbindung vom Typ Onlinedienst ausgewählt werden. Diese Verbindung wird zur Laufzeit zum Senden der Einreichungen an FIT-Connect verwendet.
  Näheres zu Konfiguration von FIT-Connect Onlinedienst-Verbindungen finden Sie hier.
  
  Über den Buttonlässt sich prüfen, ob mit dem ausgewählten Onlinedienst eine Verbindung zu FIT-Connect hergestellt werden kann.
  
  
• 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).
  
  Über den Button können die Zustellpunkt-Einstellungen vom FIT-Connect Portal ermittelt werden. Je nachdem, ob die Abfrage ein Ergebnis liefert, wird das nachfolgende Feld Service Identifier (Verwaltungsleistung / LeiKa-ID) mit einer Auswahlliste der möglichen Verwaltungsleistungen vorbelegt.

Der konfigurierte FIT-Connect Zustellpunkt muss mindestens ein Metadatenschema in der Version 1.3 oder größer unterstützen. Die veralteten Metadatenschemata-Versionen < 1.3 werden durch das eingebundene FIT-Connect SDK nicht mehr unterstützt. 
Die unterstützten Metadatenschemen lassen sich direkt am jeweiligen Zustellpunkt über das FITKO SSP konfigurieren.

• FIT-Connect Vorgangs-ID (Optional): 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 Leistungs-Katalog (LeiKa) - Schlüssels
  z.B.: urn:de:fim:leika:leistung:99108008252000, urn:myleistung
  
  Wenn dieses Feld durch eine Zustellpunkt-Abfrage befüllt und ein entsprechender Wert aus der entstandenen Auswahl gewählt wurde, so werden automatisch die Felder Schema-URI und Art der Nachricht vorbefüllt.
  
  
• Service-Bezeichnung (Optional): 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.

Einstellung für Datenübermittlung

In diesem Bereich können folgende Eigenschaften konfiguriert werden:

• 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.
  
  Wenn dieses Feld durch eine Zustellpunkt-Abfrage und anschließender Auswahl eines konkreten Service Identifiers befüllt wurde, so werden hier die unterstützen Schema-URI zur Auswahl gestellt.
  
  
• Daten gegen Fachschema prüfen?: Bei Aktivierung dieser Einstellung werden die zu übermittelnden Daten vor dem Senden an FIT-Connect geprüft. Die Angabe im Feld Schema-URI dient dabei als Fachdaten-Schema-Quelle. Bei Validierungsfehlern wird die weitere Verarbeitung innerhalb der Aktion mit dem Fehlercode SCHEMA_VALIDATION_ERROR beendet.
  
  
• Fachdaten-Quelle (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.
  
  Wenn dieses Feld durch eine Zustellpunkt-Abfrage und anschließender Auswahl eines konkreten Service Identifiers befüllt wurde, so stehen hier nur noch die von der Verwaltungsleistung unterstützen Nachrichten-Arten, JSON oder XML, zur Auswahl.
  
  
• Daten 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.
• oder 
  Fachdaten-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.
  
  

Konfiguration von Antwortkanälen (ab Version 2.3.0)

• Antwortkanal nutzen? (optional): Bestimmt, ob für die Einreichung eine Antwortmöglichkeit unterstützt werden soll.
  
  
• Unterstützte Antwortkanäle: Hier werden die durch die Verwaltungslesitung und von formcycle unterstützten Antwortkanäle angezeigt. Aktuell wird nur der Antwortkanal FIT-Connect unterstützt. Wenn hier keine Auswahl angezeigt wird, so ist an der Verwaltungsleistung im FIT-Connect Portal keine entsprechende Unterstützung konfiguriert.
  
  
• Prozess Standards (Pflichtfeld, nur vorhanden wenn Antwortkanal FIT-Connect ist): Hier werden die für eine Antwort zur Verfügung stehenden Schematas zur Auswahl angezeigt. Diese ergeben sich aus der Konfiguration für den Rückkanal im FIT-Connect Portal
  
  
• Callback aktivieren? (optional, nur vorhanden wenn Antwortkanal FIT-Connect ist): Ist diese Option aktiv, wird zur Laufzeit ein Callback-URL generiert und an FIT-Connect übermittelt. Sobald später zur Antwortdaten im FIT-Connect Portal eingehen, werden diese an die Callback-URL weiter geleitet. Ist diese Option nicht aktiv, erfolgt keine automatische Weiterleitung und die Antwortdaten müssen manuell (mittels "Polling") abgeholt werden.
  
  
• Callback Server (muss über das Internet erreichbar sein) (Pflichtfeld, wenn Callback aktivieren? ausgewählt ist): Enthält eine Auflistung aller Base-URLs zum Master-Server und den verfügbaren Frontend-Servern, die aus dem formcycle System ermittelt wurden und potenziell als URLs für eine Rückleitung der Antwortdaten in Frage kommen. Beachten Sie, dass die ausgewählte Domain über das Internet erreichbar sein muss, damit die Rückleitung aus dem FIT-Connect Portal erfolgreich stattfinden kann.
  
  

Konfiguration zusätzlich zu übermittelnder Anhänge

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

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

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:

• 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.
  
  
• Schema-URI: ([%$Senden an FIT-Connect.RESULT.schemaUri%]) Die zum Übermittlungszeitpunkt genutzte Schema-URI, die das Fachdaten-Schema ausweist.
  
  
• Service-ID / URN der Verwaltungsleistung: ([%$Senden an FIT-Connect.RESULT.serviceId%]) Die zum Übermittlungszeitpunkt genutzte URN der Verwaltungsleistung
  
  
• Einreichungs-ID: ([%$Senden an FIT-Connect.RESULT.submissionId%]) Die von FIT-Connect zurück gelieferte ID der Einreichung.

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 Postfach-Verlauf hinterlegt.

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

• PARAMETER_FORMAT_ERROR: Tritt auf, wenn die zu übermittelnde Nachricht nicht dem geforderten JSON oder XML Format entsprach.
  
  
• NO_MESSAGE_FILE_FOUND: Tritt auf, wenn keine Nachricht zur Übertragung an FIT-Connect ermittelt werden konnte.
  
  
• WEBSERVICE_ERROR: Tritt auf, wenn der Aufruf einer FIT-Connect Webservice-Methode einen Fehler zurück lieferte.
  
  
• SCHEMA_VALIDATION_ERROR: Tritt auf, wenn die Daten-Validierung gegen das Fachschema fehlschlägt.
  
  
• MANDATORY_PARAMETER_MISSING: Tritt auf, wenn der FIT-Connect Service aufgrund fehlender Parameter zu Laufzeit nicht aufgerufen werden konnte.

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 aus 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.

Empfänger-Funktionalität

Um die FIT-Connect Empfänger Funktionalität in formcycle abzubilden müssen folgende Voraussetzungen gegeben sein:

• Im FIT-Connect Portal muss ein Verwaltungssystem registriert sein
• Im FIT-Connect Portal muss ein Zustellpunkt konfiguriert sein.  Inklusive der notwendigen öffentlichen Schlüssel (JWKs) zum Verschlüsseln und Signieren. Der Zustellpunkt muss dem Verwaltungssystem zugeordnet sein, sodass dieses auf den Zustellpunkt zugreifen darf
• In formcycle muss ein Anbindung an ein Verwaltungssystem konfiguriert sein. An dieser Verbindung müssen die privaten Schlüssel zum Entschlüsseln und zur Signaturprüfung hinterlegt sein.
• In formcycle muss ein Formular existieren, welches das nachfolgend beschriebene Workflow-Ereignis FIT-Connect Datenabruf beinhaltet.

Workflow-Ereignis: FIT-Connect Einreichungsabruf

Das Ereignis FIT-Connect Einreichnungsabruf kann in einem Formular als Einstieg für den Empfang von Einreichungsdaten aus FIT-Connect genutzt werden. Dabei gibt es 2 Möglichkeiten den Datenempfang zu realisieren:

• die Anbindung mittels "Callback":
  Bei diesem Mechanismus wird formcycle vollautomatisch von FIT-Connect über neue Einreichungen informiert.
  Im eingebundenen Formular wird für jede neue Einreichung automatisch ein neuer Vorgang angelegt und die übermittelten Einreichungsdaten werden diesem Vorgang zur Verfügung gestellt.
  
  
• oder mittels "Polling":
  Dafür muss manuell eine Abfrage nach neuen Einreichungen gestartet werden. Ermittelt die Abfrage neue Einreichungen wird für jede Einreichung ebenfalls ein neuer Vorgang erstellt.

Hinweis:
Damit ein Datenempfang mittels Callback möglich wird, muss der angebundene Zustellpunkt an der genutzten Verwaltungssystem-Anbindung entsprechend konfiguriert sein. 
Wenn kein "Callback" am Zustellpunkt konfiguriert ist, steht automatisch das "Polling" als Abfragemethodik zur Verfügung.

Jeder verarbeitete Vorgang, der auf Grundlage einer ermittelten Einreichung entstanden ist, wird im Protokoll des entsprechenden Mandanten vermerkt.

Zustellpunkt-Einstellungen

• Angebundenes Verwaltungssystem (Pflicht): An dieser Stelle muss eine FIT-Connect Verbindung vom Typ Verwaltungssystem ausgewählt werden. Diese Verbindung wird zur Laufzeit zum Empfangen von Einreichungen aus FIT-Connect verwendet. Näheres zu Konfiguration von FIT-Connect Verwaltungssystem-Verbindungen finden Sie hier.
  
  
• Empfänger- / Zustellpunkt-UUID (Pflicht): Hier werden alle an der Verwaltungssystem-Verbindung gebundenen und vollständig konfigurierten Zustellpunkte aufgeführt und zur Auswahl angezeigt. Näheres zur Verwaltung der Zustellpunkte an der Verwaltungssystem-Verbindung finden Sie hier.

Hinweis:
Ein Zustellpunkt gilt als "vollständig konfiguriert", wenn er an eine Verwaltungssystem-Verbindung "gebunden" ist und die privaten Schlüssel zum Entschlüsseln und zur Verifizierung der Signierung hinterlegt sind.

• Abgerufene Einreichungsdaten an Vorgang anhängen?: Wenn diese Option aktiviert ist, werden die abgerufenen Einreichungsdaten automatisch an den Vorgang angehangen.
  
  
• Abgerufene Dateianhänge an Vorgang anhängen?: Wenn diese Option aktiviert ist, werden die zur Einreichung zugehörigen Dateianhänge automatisch an den Vorgang angehangen.
  
  

Informationen zum ausgewählten Zustellpunkt

Sobald die oben beschriebenen Einstellungen korrekt hinterlegt sind, wird mit diesen Konfigurationsdaten ein Abgleich mit dem konfigurierten Verwaltungssystem im FIT-Connect Portal. Das Ergebnis dieses Abgleichs wird in diesem Bereich angezeigt und beinhaltet folgenden Informationen:

• Name: "sprechender" Name des angebundenen Zustellpunktes aus dem FIT-Connect Portal
  
  
• Zugeordnete Callback-URL: Dieses Feld ist nur vorhanden, wenn die Anbindung mittels "Callback" erfolgt und enthält die aktuell am Zustellpunkt aus dem FIT-Connect Portal hinterlegte Callback-URL. Über diese URL informiert das FIT-Connect Portal das formcycle System über neue Einreichungen.

Da die Rückmeldung (Callback) aus dem FIT-Connect Portal heraus über das Internet passiert, muss die hier hinterlegte URL/Domain auch über das Internet erreichbar sein. Sollte dies nicht der Fall sein, so müssen an der Verwaltungssystem-Anbindung entsprechende Anpassungen vorgenommen werden, um ein Callback zu ermöglichen.

• Verbindungsstatus: Zeigt den aktuellen Status der Callback Verbindung an. Gleicht dabei den Wert der Callback-URL am angebundenen Zustellpunkt in formcycle, mit dem ermittelten Wert des Zustellpunktes aus dem FIT-Connect Portal, ab.

Sind die Werte nicht gleich oder konnte kein Wert für die Callback-URL aus FIT-Connect Portal ermittelt werden, so ist aktuell kein Callback möglich und es wird 
der Buttonangezeigt.
 
Mittels Klick auf den Button kann dann eine Abfrage an das FIT-Connect Portal über neuen Einreichungen gestellt werden. Werden neue Einreichungen gefunden, so wird für diese Einreichung jeweils ein neuer Vorgang am aktuellen Formular erzeugt und das Ereignis wird entsprechend in den Vorgängen aufgerufen und dabei werden die jeweils übermittelten Daten im Workflow zur Verfügung gestellt.

Rückgabewerte 

Bereitgestellte Werte

• Vorgangs-ID: ([%$Trigger.caseId%]) Die von FIT-Connect gelieferte Vorgangs-ID, unter der die aktuelle Einreichung registriert ist.
  
  
• Daten als JSON-Objekt (Optional): ([%$Trigger.dataAsJson%]) Dieses Objekt steht nur zur Verfügung, wenn die aus der Einreichung stammenden Daten vom Typ JSON sind. Dann kann mittels JSON-Path Notation innerhalb des Platzhalters auf einzelne Eigenschaften des Daten-Objektes zugegriffen werden.
  
  
• Daten als Text-Objekt: ([%$Trigger.dataAsText%]) Dieses Objekt steht immer zur Verfügung. Es enthält die in der Einreichung übermittelten Daten als Text (Die Datenstruktur kann XML oder JSON sein). 
  
  
• ID des Zustellpunktes: ([%$Trigger.destinationId%]) ID des Zustellpunktes, an den die Einreichung übermittelt wurde.
  
  
• Metadaten der Einreichung: ([%$Trigger.metadata%]) Metadaten zur abgerufenen Einreichung. Wird als JSON-Objekt zur Verfügung gestellt. Man kann mittels JSON-Path Notation innerhalb des Platzhalters auf einzelne Eigenschaften des Metadaten-Objektes zugreifen.
  
  
• Einreichungs-ID: ([%$Trigger.submissionId%]) Die von FIT-Connect zurück gelieferte ID der Einreichung.

Bereitgestellte Dateien

Auf die bereitgestellten Dateien kann mittels "datei-verarbeitender" Workflow-Aktionen zugegriffen werden.

• Attachments (Optional): Enthält die an der Einreichung hinterlegten Datei-Anlagen als eine Liste von Dateien.
  
  
• Data: Enthält die übermittelten Einreichungsdaten als Datei-Objekt. Wird zusätzlich zu den Objekten Daten als JSON-Objekt und Daten als Text-Objekt zur Verfügung gestellt und ist im weitesten Sinne dafür gedacht, wenn die Daten der Einreichung ungefiltert an Drittsysteme (z.B. zur Ablage in einem angebundenen DMS, als E-Mail Anhang etc.) weiter gereicht werden sollen.

Antwort-Funktionalität (Bidirektionale Kommunikation)

Die "Antwort"-Funktionalität ermöglicht es dem Empfänger von Einreichungen (Verwaltungssystem) auf Nachrichten von Sender (Onlinedienst) zu antworten. Dabei kommt es zu einer Kommunikationsumkehr, der vormalige Empfänger wird zum Sender eine Antwort-Nachricht und der vormalige Sender wird zum Empfänger dieser Antwort-Nachricht. 

Damit Antworten auf Einreichungen gesendet werden können, müssen folgende Bedingungen erfüllt sein:

• die jeweilige Verwaltungsleistung in FIT-Connect muss Antworten über den Rückkanal FIT-Connect unterstützen.
  (Dies muss im FIT-Connect Portal entsprechend freigeschalten sein)
  
  
• in der Aktion Senden an FIT-Connect muss vor dem Absenden einer Einreichung der Rückkanal FIT-Connect entsprechend konfiguriert sein, damit der öffentliche Schlüssel zum Verschlüsseln der späteren Antwortnachricht beim Absenden einer Einreichung mit an das Zielsystem übermittelt werden kann.

Workflow-Aktion: Antworten an FIT-Connect

Die Aktion dient dazu eine Antwort auf eine Einreichung an das FIT-Connect Portal zu übermitteln. 

Einstellungen für FIT-Connect Zustellpunkt

• Workflow-Ereignis für Rückkanal (Pflichtfeld): An dieser Stelle muss ein Workflow-Ereignis definiert werden, auf das sich der Rückkanal beziehen soll. Dies heißt, das Versenden von Antwortdaten erfolgt nur für den Zustellpunkt, der am referenzierten FIT-Connect Einreichungsabruf - Ereignis definiert ist.
  
  
• Service Identifier (Verwaltungsleistung / LeiKa-ID) (Pflichtfeld): Eine ID zum Identifizieren einer konkreten Verwaltungsleistung am Zustellpunkt. Die hier zur Verfügung stehende Auswahl wird durch den Zustellpunkt aus dem Rückkanal-Ereignis bestimmt. Es werden nur Verwaltungsleistungen zur Auswahl angeboten, die FIT-Connect als Rückkanal im FIT-Connect Portal unterstützen.
  
  

Eine leere Auswahlliste für den Service Identifier bedeutet, dass der, über das referenzierte Workflow-Ereignis, verknüpfte Zustellpunkt keine Verwaltungsleistungen mit FIT-Connect-Rückkanal unterstützt. Es können somit keine Antworten über FIT-Connect zurück an den Onlinedienst versendet werden.

• Prozess-Standard (Pflichtfeld): Der Prozess-Standard wird durch die gewählte Verwaltungsleistung bestimmt und entsprechend vom Zustellpunkt aus dem FIT-Connect Portal erfragt. Der Prozess-Standard definiert gleichzeitig auch das Fachdaten-Schema, gegen das die Antwortdaten geprüft werden.
  
  
• Antwort-Daten gegen Fachschema prüfen?: Bei Aktivierung dieser Einstellung werden die zu übermittelnden Antwortdaten vor dem Senden an FIT-Connect geprüft. Die Angabe im Prozess-Standard dient dabei als Fachdaten-Schema-Quelle. Bei Validierungsfehlern wird die weitere Verarbeitung innerhalb der Aktion mit dem Fehlercode SCHEMA_VALIDATION_ERROR beendet.

Antwortdaten

• Antwortdaten-Quelle (Pflichtfeld): Definiert die Quelle (aus Datei oder aus Textfeld) und den Typ (JSON oder XML) der zu übermittelnden Antwort. Je nach Auswahl, wird entweder ein Texteditor zur direkten Erzeugen der Antwortdaten oder ein Dateiauswahl-Feld zur Angabe einer Datei für die weitere Konfiguration angezeigt.
• Antwortdaten (Pflichtangabe): Im eingeblendeten Editor muss, je nach der zuvor festgelegten Antwortdaten-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 Daten-Typ (JSON oder XML), geprüft. Wenn diese Prüfung fehlschlägt, so wird die Plugin-Verarbeitung mit dem Fehlercode PARAMETER_FORMAT_ERROR beendet.
  
  
• oder
  Antwortdaten-Datei (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 Antwortdaten-Typ (JSON oder XML) zu achten. Zum Ausführungszeitpunkt der Plugin-Aktion wird der Daten-Typ (JSON oder XML) geprüft, wenn diese Prüfung fehlschlägt, so wird die Plugin-Verarbeitung mit dem Fehlercode PARAMETER_FORMAT_ERROR beendet.
  
  

Zusätzlich zu übermittelnde Anhänge

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

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

Rückgabewerte

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

• Vorgangs-ID: ([%$Antworten an FIT-Connect.RESULT.caseId%]) Die von FIT-Connect gelieferte Vorgangs-ID, unter der die aktuelle Antwort abgespeichert wurde.
  
  
• Antwort-ID: ([%$Antworten an FIT-Connect.RESULT.replyId%]) ID der Antwort, unter der der übermittelte Antwort-Datensatz im FIT-Connect Portal hinterlegt ist.

Bei erfolgreicher Antwort-Übermittlung an FIT-Connect werden die aktuelle FIT-Connect Antwort-ID sowie die FIT-Connect Vorgangs-ID als Informationen im Postfach-Verlauf hinterlegt. 

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

• PARAMETER_FORMAT_ERROR: Tritt auf, wenn die zu übermittelnde Nachricht nicht dem geforderten JSON oder XML Format entsprach.
  
  
• CASE_INFO_NOT_FOUND: Tritt auf, wenn zu einer vorhandenen FIT-Connect Vorgangs-ID keine spezifischen Metadaten am Vorgang gefunden wurden.
  
  
• SCHEMA_VALIDATION_ERROR: Tritt auf, wenn die Daten-Validierung gegen das Fachschema fehlschlägt.
  
  
• WEBSERVICE_ERROR: Tritt auf, wenn der Aufruf einer FIT-Connect Webservice Methode nicht erfolgreich war.
  
  
• MANDATORY_PARAMETER_MISSING: Tritt auf, wenn der FIT-Connect Service aufgrund fehlender Pflicht-Parameter zu Laufzeit nicht aufgerufen werden konnte.
  
  
• NO_WORKFLOW_RETRIEVE_SUBMISSION_EVENT_FOUND: Tritt auf, wenn kein korrespondierendes Ereignis, zur Abrufung von Einreichungen aus FIT-Connect, ermittelt werden konnte.
  
  
• CASE_ID_NOT_FOUND: Tritt auf, wenn zum Ausführungszeitpunkt keine FIT-Connect Vorgangs-ID ermittelt werden konnte.
  
  
• NO_REPLY_DATA_FILE_FOUND: Tritt auf, wenn keine Antwortdaten zum Übertragen an FIT-Connect ermittelt bzw. erzeugt werden konnten.

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 aus 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.
  
  
• REPLY_NOT_SUPPORTED: Tritt auf, wenn zum Ausführungszeitpunkt ermittelt wird, dass die korrespondierende Einreichung "FIT-Connect" als Antwortkanal nicht unterstützt und damit kein Schlüssel zum Verschlüsseln der Antwortdaten übermittelt wurde. Es wird eine Warnung über das Auftreten dieser Ausnahme im Protokoll erzeugt.

Workflow-Ereignis: FIT-Connect Antwortabruf

Dieses Workflow-Ereignis dient dazu, Antworten auf Einreichungen in einem Workflow verarbeiten zu können.

Da die Antwort mit der zuvor versendeten Einreichung im Zusammenhang steht, kann dieses Workflow-Ereignis nur in einem Workflow korrekt konfiguriert werden, der auch eine Senden an FIT-Connect Workflow-Aktion enthält.

Voraussetzung für den Abruf von Antworten ist, dass der FIT-Connect-Antwortkanal in der entsprechenden Senden an FIT-Connect Workflow-Aktion aktiviert wurde, wodurch die benötigten Schlüssel zur Ver- und Entschlüsselung vorab generiert und übermittelt werden.

Onlinedienst Einstellungen

• Workflow-Aktion für FIT-Connect Rückkanal (Pflichtfeld): An dieser Stelle sind alle im aktuelle Formular-Projekt verfügbaren Senden an FIT-Connect Workflow-Aktionen aufgeführt. Diese bestimmen den FIT-Connect Zustellpunkt, von dem die Antwort stammen muss, damit sie verarbeitet wird.
  
  
• Über den Button können aktuell vorhandene Antworten aus dem FIT-Connect Portal abgerufen werden. Wenn Antworten vorhanden sind, wird der jeweilige formcycle Vorgang mit den abgerufenen Antwortdaten (je nach Konfiguration innerhalb der Verarbeitungskette) aktualisiert.

Der Button ist nur vorhanden, wenn die zugeordnete Senden an FIT-Connect Aktion einen Callback nicht konfigurativ unterstützt, da eine Prüfung auf neu eingegangene Antworten im FIT-Connect Portal dann manuell erfolgen muss.

• Abgerufene Antwortdaten an Vorgang anhängen?: Wenn diese Option aktiviert ist, werden die abgerufenen Antwortdaten automatisch an den Vorgang angehangen.
  
  
• Abgerufene Dateianhänge an Vorgang anhängen?: Wenn diese Option aktiviert ist, werden die zur Antwort zugehörigen Dateianhänge automatisch an den Vorgang angehangen. 

Rückgabewerte

Bereitgestellte Werte

• Vorgangs-ID: ([%$Trigger.caseId%]) Die von FIT-Connect gelieferte Vorgangs-ID, unter der die aktuelle Einreichung registriert ist.
  
  
• Daten als JSON-Objekt: (Optional): ([%$Trigger.dataAsJson%]) Dieses Objekt steht nur zur Verfügung, wenn die aus der Antwort stammenden Daten vom Typ JSON sind. Dann kann mittels JSON-Path Notation innerhalb des Platzhalters auf einzelne Eigenschaften des Daten-Objektes zugegriffen werden.
  
  
• Daten als Text-Objekt: ([%$Trigger.dataAsText%]) Dieses Objekt steht immer zur Verfügung. Es enthält die in der Antwort übermittelten Fachdaten als Text (Die Datenstruktur kann XML oder JSON sein und richtet sich nach dem verwendeten Prozess-Standard).
  
  
• Metadaten der Antwort: ([%$Trigger.metadata%]) Metadaten zur abgerufenen Antwort. Wird als JSON-Objekt zur Verfügung gestellt. Mittels JSON-Path Notation kann innerhalb des Platzhalters auf einzelne Eigenschaften des Metadaten-Objektes zugegriffen werden.
  
  
• Antwort-ID: ([%$Trigger.replyId%]) Die von FIT-Connect zurück gelieferte ID der Antwort.
  
  

Bereitgestellte Dateien

Auf die bereitgestellten Dateien kann mittels "datei-verarbeitender" Workflow-Aktionen zugegriffen werden.

• Attachments (Optional): Enthält die an einer Antwort hinterlegten Datei-Anlagen als eine Liste von Dateien.
  
  
• Data: Enthält die übermittelten Antwortdaten als Datei-Objekt. Wird zusätzlich zu den Objekten Daten als JSON-Objekt und Daten als Text-Objekt zur Verfügung gestellt und ist dazu gedacht, die Antwort-Daten direkt an Drittsysteme (z.B. zur Ablage in einem angebundenen DMS, als E-Mail Anhang etc.) weiter zu reichen.