HINWEIS: Das TRANSCONNECT® Plugin ist eine Eigenentwicklung der SQL AG bitte wenden Sie sich bei Fragen oder Unterstützung an den Herausgeber.

Angaben zum Herausgeber:
SQL Projekt AG Franklinstraße 25a D-01069 Dresden
Telefon: +49 351 876 19-0 Telefax: +49 351 876 19-99

Supportunterstützung für TRANSCONNECT Wartungskunden:
https://www.transconnect-online.de/support-verwaltung/

Telefonischer Support
Der TRANSCONNECT®-Support steht Ihnen bei Problemen gern zur Seite.

Tel.: +49 (0) 351 87619-20
(Montag – Freitag, 08:00 – 18:00 Uhr, außer an sächsischen Feiertagen)

INHALTSVERZEICHNIS

• Installation
• Workflow-Aktion TRANSCONNECT
  • Daten für die Übermittlung an TRANSCONNECT
  • Zusätzliche Daten übermitteln
  • Globale Einstellungen übersteuern
  • Rückgabewerte
• Workflow für Datenübermittlung an TRANSCONNECT®
  • 1. Schritt: Formular erstellen
  • 2. Schritt Workflow konfigurieren

Das TRANSCONNECT®-Plugin für formcycle bietet eine zusätzliche Möglichkeit, Daten an Drittsysteme zu übermitteln. Dadurch können nun auch Fachverfahren angebunden werden, die keiner standardartisierten Schnittstelle folgen und nicht direkt von formcycle unterstützt werden.

HINWEIS: Aktivierung des TRANSCONNECT Plugin und Freischaltung der Anbindungsstrecke im Rahmen der Bereitstellung als Basiskomponente im Freistaat Sachsen

Das TRANSCONNECT Plugin wird/ist im Rahmen der Bereitstellung als Basiskomponente im Freistaat Sachsen systemweit für alle Mandanten aktiviert. Hinsichtlich notwendiger Freigaben für den jeweiligen formcycle-Mandanten (Verbindung zur TRANSCONNECT®-Instanz) wenden Sie sich bitte an die Anwendungsbetreuung der Basiskomponente Formularservice ([email protected]).

Installation

Die Installation des Plugins kann unter Mandant > Plugins oder unter System > Systemplugins erfolgen.

Konfiguration der Verbindung zu einer TRANSCONNECT Instanz:

• TRANSCONNECT Service Endpoint (Pflichtangabe): HTTP Eingangs-URL des TRANSCONNECT® Eingangs-Adapters
  
  
• Basic Auth Login: Login für eine Basic-Auth Authentifizierung (wenn notwendig)
  
  
• Basic Auth Passwort: Passwort für eine Basic-Auth Authentifizierung (wenn notwendig)
  
  
• Proxy Host: Host-Name oder IP-Adresse eines Proxy-Servers, wenn für die Kommunikation zu TRANSCONNECT® ein Proxy-Server genutzt werden soll.
   
• Proxy Port: Portangabe (Zahl) für die Kommunikation über einen Proxy-Server.
  
  
• Connection Timeout (in Sekunden): Beschreibt den Zeitraum, wie lange für einen Verbindungsaufbau zur TRANSCONNECT® Schnittstelle gewartet wird. Unterstützt wird ein Wert > 0 s (Standardwert ist 10 s).
  
  
• Read Timeout (in Sekunden): Beschreibt den Zeitraum, wie lange auf eine Antwort der TRANSCONNECT® gewartet wird. Unterstützt wird ein Wert > 0 s. (Standardwert ist 30 s)
  
  

Workflow-Aktion TRANSCONNECT

Der nachfolgende Abschnitte beschreiben die in der Workflow-Aktion TRANSCONNECT zur Verfügung stehenden Konfigurationsmöglichkeiten.

Daten für die Übermittlung an TRANSCONNECT

• Aliasnamen verwenden: Wenn diese Einstellung aktiv ist, werden die Aliasnamen anstatt der Formular-Elementnamen bei der Übermittlung an TRANSCONNECT® verwendet.
  
  
• Dateien: Hier können Dateien aus einer vorherigen Workflow-Aktion, Upload-Feldern oder einer externen Ressourcen-URL ausgewählt werden. Diese Dateien werden zur Laufzeit an TRANSCONNECT® übermittelt.

Zusätzliche Daten übermitteln

• Zusätzliche HTTP-Header Parameter: Hier können Header-Parameter definiert werden, welche bei der HTTP-Kommunikation zwischen formcycle und TRANSCONNECT® zum Einsatz kommen. In den Feldern für den Header-Namen, sowie dem Wert werden Platzhalter unterstützt.
  
  
• Zusätzliche HTTP-Request Parameter: Hier können zusätzliche Request-Parameter definiert werden, welche zur Laufzeit an TRANSCONNECT®  übermittelt werden. Bei der Definition der Wert werden Platzhalter unterstützt.

Globale Einstellungen übersteuern

Die in diesem Bereich hinterlegten Einstellungen übersteuern die zentral am Plugin festgelegten Einstellungen für die Kommunikation mit TRANSCONNECT®. Dadurch ist es möglich auf Formular-Ebene ein anderes TRANSCONNECT®-System anzusprechen, als das global Definierte.

• URL zu TRANSCONNECT: Übersteuert die global definierte Angabe der HTTP Eingangs-URL des TRANSCONNECT® Eingangs-Adapters
  
  
• HTTP-Basic-Authentifizierung benutzen?: Wenn dieses Feld aktiviert wird, so können zusätzlich Angaben zum Basic-Auth Login, sowie Basic-Auth Passwort vorgenommen werden. Diese Angaben übersteuern global festgelegte Definitionen.
  
  
• Proxy-Server benutzen?: Wenn dieses Feld aktiviert wird, so können zusätzlich Angaben für einen Proxy-Server Host, sowie Proxy-Server Port vorgenommen werden. Diese Angaben übersteuern global festgelegte Definitionen.
  
  

Rückgabewerte

Wenn eine Daten erfolgreich an TRANSCONNECT® übermittelt wurden, terminiert die Plugin-Aktion normal und liefert folgende Informationen als Rückgabeparameter zurück:

• Content: ([%$TRANSCONNECT.RESULT.content%]) Der von TRANSCONNECT® zurück gelieferte Inhalt.
  
  
• HttpStatus: ([%$TRANSCONNECT.RESULT.httpStatus%]) Der zurück gelieferte HTTP-Statuscode.
  
  

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

• AUTHORIZATION_FAILED: Tritt auf, wenn keine erfolgreiche Authentifizierung am Webservice durchgeführt werden konnte.
  
  
• SERVICE_CONNECTION_ERROR: Tritt auf, wenn keine Verbindung zum TRANSCONNECT® Service hergestellt werden konnte.
  
  
• SERVICE_ERROR: Tritt auf, wenn der TRANSCONNECT® Service einen Statuscode außerhalb des Bereiches von 299-399 und nicht 401 zurück lieferte. Der konkrete Statuscode kann über den Rückgabe-Parameter httpStatus ([%$TRANSCONNECT.ERROR.httpStatus%]) abgerufen werden.
  
  
• 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_PAYLOAD_DATA: Tritt auf, wenn zur Laufzeit keine Daten für eine Übermittlung an TRANSCONNECT® ermittelt werden konnte, obwohl diese an der Plugin-Aktion definiert sind.

Workflow für Datenübermittlung an TRANSCONNECT®

Die nachfolgenden Abschnitte skizzieren kurz die notwendigen Schritte um Formulardaten an TRANSCONNECT® zu übermitteln.    

1. Schritt: Formular erstellen

Im ersten Schritt ist ein Formular über formcycle anzulegen.

Es können dabei verschiedene Eingabe-Elemente (Textfelder, Auswahlfelder, Upload-Elemente etc.) sowie Schaltflächen verwendet werden.

Es ist darauf zu achten, dass die Eingabefelder "sprechend" benannt werden, da die später im XML übermittelten Werte unter diesem Namen auftauchen.

2. Schritt Workflow konfigurieren

In der Workflow-Ansicht, definiert man, was mit den Formulardaten gemacht werden soll. Hier findet man auch die TRANSCONNECT® Workflow-Aktion.

Im Standard-Anwendungsfall ist das Formular als XML zu exportieren und dieses im Feld für die Dateiauswahl auszuwählen. Zur Laufzeit wird das XML mit den aktuellen Formulardaten dann mittels Plugin an TRANSCONNECT® übermittelt.
Eventuell vorhandene Anhänge (z.B. aus Upload-Elementen) können, analog zum erstellten XML, im Feld für die Dateiauswahl ebenfalls mit angegeben werden.