VFS Connector

Verwendung

Ein VFS (Virtual File System) Connector sorgt dafür, dass die INUBIT Process Engine mit lokalen und entfernten Dateisystemen, wie z.B. Windows Shared Verzeichnissen oder dem lokalen Repository kommunizieren kann. Der Konnektor unterstützt dafür das CIFS/Samba- und das Repository-Protokoll.

Konnektortypen

Sie haben folgende Konfigurationsmöglichkeiten:

  • Input Connector

    Holt Dateien aus einer virtuellen Verzeichnisstruktur und übergibt diese zur Weiterverarbeitung an einen Workflow.

  • Output Connector

    Schreibt das Ergebnis eines Workflows in eine Datei in einem virtuellen Verzeichnis.

Modulvariablen

Bei der Ausführung eines VFS Connectors werden Modulvariablen gesetzt.

Input Connector

Die folgenden Variablen sind verfügbar, wenn eine Datei gelesen wird und wenn als Ausgangsformat DATA gewählt wurde.

  • ReadFileDate

    Letztes Änderungsdatum der Eingangsdatei im Format yyyy-MM-dd’T’HH:mm:ss.

  • ReadFileName

    Name der Eingangsdatei mit Extension.

  • ReadFileSize

    Größe der Eingangsdatei, in Bytes.

Output Connector

Die folgenden Variablen sind verfügbar, wenn eine Datei geschrieben wird und wenn als Eingangsformat DATA gewählt wurde.

  • WriteFileDate

    Erzeugungsdatum der Ausgabedatei im Format yyyy-MM-dd’T’HH:mm:ss.

    Nur verfügbar beim Output Connector, wenn eine Datei geschrieben wird und wenn als Eingangsformat DATA gewählt wurde.

  • WriteFileName

    Name der Ausgabedatei.

    Nur verfügbar beim Output Connector, wenn eine Datei geschrieben wird und als Eingangsformat DATA gewählt wurde.

  • WriteFileDir

    Name des Ausgabeverzeichnisses

  • WriteFileSize

    Größe der Ausgabedatei

Für Informationen über weitere Variablen und deren Verwendung siehe Workflow-Variablen und Mappings.

Dialogbeschreibungen

Dialog VFS Connector Grundkonfiguration

Im Dialog Grundkonfiguration konfigurieren Sie die Grundeinstellungen des VFS Connectors. Diese Konfiguration müssen Sie sowohl für den Input als auch für Output Connector durchführen.

Protokoll

  • Protokoll

    Mögliche Protokolle sind:

    • cifs (Common Internet File System)

      Protokoll für den Fernzugriff auf Dateisysteme über ein Netzwerk.

      Aktivieren Sie die Checkbox, um sich mit dem DFS-Server zu verbinden.

    • repository

      Für den Zugriff auf das lokale INUBIT-Repository.

    • ftp (File Transfer Protocol)

      Protokoll für den Zugriff auf Dateien über IP-Netzwerke.

    • samba

      Zum Verbinden mit Samba 2 und höheren Versionen.

Authentifizierung

  • Typ

    • Wenn Sie für den Zugriff auf den Server keine Authentifizierung benötigen, markieren Sie Anonym.

    • Wenn Sie als Protokoll repository gewählt haben, steht auch der Typ Mit Benutzer/Gruppe des Workflows zur Auswahl. Der VFS Connector authentifiziert sich dann mit den Login-Daten des Workflows.

      Wenn Sie den Typ Mit Benutzer/Gruppe des Workflows benutzen, kann ein publizierter VFS Connector Dateien aus dem INUBIT-Repository nur lesen.

  • Statische Zugangsdaten verwenden

    • Login/Passwort

      Wenn für Ihren Server eine Authentifizierung notwendig ist, geben Sie hier die erforderlichen Login-Daten ein.

      Normalerweise wird die Art der Passwortversendung zwischen Server und Client ausgehandelt. Sie können jedoch bei Bedarf die Unterstützung von Klartextpasswörtern für alle CIFS-Verbindungen manuell deaktivieren. Dazu erstellen Sie ein neues Java System Property namens jcifs.smb.client.disablePlainTextPasswords mit dem Wert true, siehe Java System Properties.

      Beachten Sie, dass eine Fehlermeldung geworfen wird, falls nach der Deaktivierung ein Server explizit Klartextpasswörter verlangt!

      Über CIFS-Verbindungen unter Windows kann der VFS Connector beim Lesen der IBISDirectory-Struktur nur die Einstellungen von direkten Lese- und Schreibrechten der Dateien anzeigen. Die Rechte, die von den übergeordneten Verzeichnissen geerbt werden, können nicht ausgelesen werden.

  • Aus dem Credentials Manager auswählen

    Für die Authentifizierung können Sie auch Zugangsdaten verwenden, die im Credentials Manager verwaltet werden. Siehe Credentials Manager für die Authentifizierung verwenden.

Server-Konfiguration

  • Servername

    Domainname des Servers, z.B. xyz.INUBIT.com

  • Port

    • cifs: Die Standardportnummer ist 445.

    • ftp: Die Standardportnummer ist 21.

  • Standard

    • cifs: Stellt bei Bedarf die Standardportnummer 445 wieder ein.

    • ftp: Stellt bei Bedarf die Standardportnummer 21 wieder ein.

  • Windows Domäne (nur cifs und samba)

    Name der Windows-Domäne, falls der Server in einer solchen läuft und Sie sich über eine Windows-Domäne anmelden müssen.

  • Verbindungsmodus (nur FTP)

    • Aktiv

      Der Client öffnet den konfigurierten Port und teilt dem Server diesen Port und die eigene IP-Adresse über das PORT-Kommando mit.

    • Passiv

      Der Client sendet ein PASV-Kommando, der Server öffnet den konfigurierten Port und übermittelt diesen mitsamt IP-Adresse an den Client.

    • Standard

      Der Client nutzt die Server-Einstellungen.

  • Übertragungsart

    Geben Sie an, ob die zu übertragenden Dateien binär sind oder ASCII-Daten enthalten. Wählen Sie Standard, wenn der Client die Server-Einstellungen nutzen soll.

  • Gebietsschema

    Das Gebietsschema des Servers bestimmt u.a. die Art des Zeichensatzes und der Datumsangabe.

  • Kodierung

    Geben Sie die Kodierung des Kontrollkanals für die Kommunikation zwischen Konnektor und FTP-Server an.

    Über den Kontrollkanal werden die Befehle und dabei auch die Dateinamen als Zeichenketten übertragen. Um sicherzustellen, dass dabei z.B. Umlaute korrekt übertragen werden, ist die Definition der Kodierung notwendig, da diese von Server zu Server unterschiedlich sein kann.

  • Netzwerkgeschwindigkeitsbegrenzung aktivieren (nur für FTP/FTPS)

    Aktivieren Sie die Checkbox, um die Netzwerkbandbreite zu begrenzen. Diese Checkbox ist standardmäßig deaktiviert.

    Geschwindigkeit (KB/s)

    Wenn die Checkbox Netzwerkgeschwindigkeitsbegrenzung aktivieren aktiviert ist, konfigurieren Sie die Geschwindigkeit, indem Sie den gewünschten Wert einstellen (ganze Vielfache von 256 KB/s).

Verbindungstest

  • Verbindung testen

    Zum Testen, ob die Verbindung mit Ihren Angaben erfolgreich aufgebaut werden kann.

Dialog Input Connector-Konfiguration

In diesem Dialog konfigurieren Sie, wie der Konnektor Daten einliest.

Verzeichnis

  • Pfad

    Absoluter Pfad zu dem Verzeichnis, aus dem Dateien gelesen werden sollen. Bei Zugriff auf das Repository geben Sie den Pfad ein, der im Repository im Register Detaildaten angegeben ist. Siehe Detaildaten einer Repositorydatei. Sie können folgende Wildcards verwenden um, zum Beispiel Dateien aus Verzeichnissen mit sich ändernden Namen und in beliebiger Verzeichnistiefe abholen zu lassen:

    • * (ein Stern): Zum Filtern des Verzeichnisnamens oder Teilen davon. Sie können in einem Namen auch mehrere Wildcards verwenden. Beispiele:

    • /*/bar durchsucht /foo/bar

    • /*oo/bar durchsucht /foo/bar oder auch /goo/bar

    • /*o*/bar durchsucht /foo/bar oder auch /goa/bar

    • * * (zwei Sterne): Zum Filtern des Verzeichnisnamens oder Teilen davon in beliebiger Schachtelungstiefe:

      /**/bar durchsucht /foo/bar und /xyz/gfd/bar

      Bei der Nutzung von cifs oder samba muss der Share-Name dem Pfad vorangestellt werden.

  • Löschen von Verzeichnissen nach dem Lesen erzwingen (nur für FTP-Protokoll und Ausgangsformat XML oder ZIP)

    Wenn markiert, werden alle Dateien, Unterverzeichnisse, leere Unterverzeichnisse und das Verzeichnis selbst auf dem externen Dateisystem gelöscht.

    Wenn markiert, sind die beiden Optionen Leere Verzeichnisse löschen und Dateien nach dem Lesen löschen abgewählt und deaktiviert.

  • Leere Verzeichnisse löschen (nicht für samba verfügbar)

    Wenn markiert, werden leere Verzeichnisse gelöscht, wenn im Pfad eine Wildcard enthalten ist.

Datei

  • Name: Dateiname.

  • Mit Wildcard: Wenn markiert, können Sie beim Eingeben des Dateinamens Wildcards (Stern *) verwenden.

  • Mit regulärem Ausdruck

    Wenn markiert, können Sie mithilfe eines regulären Ausdrucks ein Muster angeben, dem die Dateinamen der einzulesenden Dateien entsprechen müssen. Siehe Reguläre Ausdrücke.

  • Auswahl umkehren

    Wenn markiert, wird das Muster, das für den Dateinamen durch Wildcard oder regulären Ausdruck angegeben wurde, umgekehrt. Damit werden alle Dateien gelesen, deren Name dem Muster nicht entspricht.

  • Dateien nach dem Lesen löschen: Wenn markiert, werden die gelesenen Dateien nach dem Lesen gelöscht.

  • Max. Anzahl v. Ausführungen pro zeitgesteuertem Aufruf

    Mit der Angabe legen Sie fest, wie oft pro auslösendem Event der Workflow maximal gestartet werden soll. Auslösendes Event ist das Erreichen eines Zeitpunktes. Dann wird der Workflow so oft gestartet, bis entweder

    • keine weiteren Daten zu holen/zu senden sind oder

    • die Anzahl erreicht wurde, welche bei maximale Ausführungen pro Aufruf konfiguriert wurde.

      Mit der Begrenzung der Ausführung steuern Sie die Systemauslastung der INUBIT Process Engine.
      Die Angabe wird im Test-Modus ignoriert, dann wird der Workflow genau einmal gestartet.

      Die Option ist nur bei aktiviertem Scheduler aktiv!

Lesereihenfolge

Wenn mehr als eine Datei übertragen wird, legen Sie fest, ob die Dateien sortiert eingelesen werden sollen und wenn ja, in welcher Reihenfolge.

Beschränkungen

  • Max. Anzahl Dateien

    Maximale Anzahl von Dateien, die eingelesen werden. Der Standardwert ist 1.

  • Max. Gesamtgröße

    Kumulative Maximalgröße, bis zu der Dateien pro Ausführung eingelesen werden.
    Wenn aktiviert, dann liest der VFS Connector solange Dateien ein, bis kumulativ der gewählte Maximalwert erreicht ist.

    Wenn als Ausgangsformat DATA gewählt wurde, wird grundsätzlich nur eine Datei eingelesen und dies so lange, bis die angegebene Maximalgröße für diese eine Datei erreicht ist.

    Standardwert ist 10 MB.

    Falls bei den Beschränkungen Werte im Bereich kleiner oder gleich Null gewählt werden, dann gibt es keine Beschränkung!

Konfiguration des Ausgangsformates

  • DATA

    Die Ausgangsnachricht enthält Daten, die unverändert weitergegeben werden sollen.

  • XML

    Legt fest, dass die Ausgangsnachricht im IBISDirectory XML-Format weitergegeben wird. Das XML Schema finden Sie im INUBIT-Repository im Verzeichnis /Global/System/Mapping Templates/File Connector.

  • ZIP

    Die Ausgangsnachricht wird in einer Zip-Datei komprimiert.

    Hinweis zur XML-/Zip-Ausgabe:

    Wenn Sie Wildcards im Verzeichnisnamen konfiguriert haben, dann werden die gelesenen Dateien im XML bzw. Zip als Baumstruktur ausgegeben. Als Basisverzeichnis dient dabei das letzte feste Verzeichnis.

    Beispiele:

    • Der Verzeichnisname ist /foo/bar/*/blub.

    • Es werden die Unterverzeichnisse ab /foo/bar abgebildet.

    • Der Verzeichnisname ist /foo/bar/xyz/blub.

    • Es wird das Verzeichnis /xyz/blub abgebildet.

XML-Konfiguration

(Bei Ausgabeformat XML)

  • Inklusive Verzeichnisse

    Wenn markiert, enthält die Ausgangsnachricht neben den Dateien auch die Verzeichnisse.

Haben Sie die beiden Optionen Inklusive Verzeichnisse und Erzeuge XML Ausgangsnachricht mit der *Statusinformation darüber, ob die Datei existiert oder nicht ausgewählt, wird die Verzeichnisstruktur der XML-Ausgangsdatei mitgegeben.

  • Inklusive Dateiinhalt

    Wenn markiert, dann wird die gesamte Datei gelesen und ihr Inhalt base64-kodiert der XML-Ausgangsdatei mitgegeben. Wenn nicht markiert, dann werden nur die Metadaten der Datei gelesenen, zum Beispiel Name, Dateigröße und Datum.

ZIP-Konfiguration

(Bei Ausgabeformat ZIP)

  • Inklusive Verzeichnisse

    Wenn markiert, enthält die Ausgangsnachricht neben den Dateien auch die Verzeichnisse.

  • Kodierung

    Die Auswahl legt die Kodierung der Dateinamen innerhalb des Zip-Archivs fest.

Dateiprüfung

  • Abbruch des Workflows, wenn die Datei nicht existiert

    • Im Testmodus:

      Wenn der Zugriff auf die angegebene Datei fehlschlägt, wird die Ausführung des Workflows mit einem Fehler abgebrochen.

    • Zeitgesteuerter Input-VFS-Connector:

      Der VFS Connector überprüft entsprechend dem eingestellten Intervall, ob eine Datei vorhanden ist. Der Workflow wird nur gestartet, wenn das der Fall ist.

    • Input Connector in der Mitte eines Workflows:

      Wenn die Datei nicht existiert, wird die Ausführung mit einer leeren Nachricht fortgesetzt. Es wird kein Log-Eintrag erzeugt.

  • Erzeuge XML Ausgangsnachricht mit der Statusinformation darüber, ob die Datei existiert oder nicht

    Der VFS Connector gibt eine XML-Datei aus, die ein einziges Attribut <FileExists> enthält. Dessen Wert ist entweder false, wenn die angegebene Datei nicht existiert oder true, wenn die angegebene Datei existiert.

    Haben Sie die beiden Optionen Erzeuge XML Ausgangsnachricht mit der Statusinformation darüber, ob die Datei existiert oder nicht und Inklusive Verzeichnisse ausgewählt, wird die Verzeichnisstruktur der XML-Ausgangsdatei mitgegeben.

  • Erzeuge XML-Ausgangsnachricht mit der Statusinformation darüber, dass die Datei nicht existiert, ansonsten Abbruch des Workflows

    Wenn die Eingabedatei fehlt, gibt der VFS Connector eine XML-Datei mit dem Element FileExists="false" aus. In allen anderen Fehlerfällen wird die Workflow-Ausführung mit einem Fehler abgebrochen.

Dialog Output Connector-Konfiguration

In diesem Dialog legen Sie fest, wie der Konnektor Daten ausgibt.

Eingangsformat

  • DATA

    Die Eingangsnachricht besteht aus Daten, die unverändert weitergegeben werden sollen. Die ist z.B. der Fall, wenn die Eingangsdaten als XML vorliegen.

  • XML

    Die Eingangsnachricht liegt im IBISDirectory XML-Format vor.

    Siehe Dialog Input Connector-Konfiguration Abschnitt Konfiguration des Ausgangsformates.

  • ZIP

    Die Eingabedaten sind in einer Zip-Datei komprimiert.

Kodierung

(Bei Eingangsformat ZIP)

Kodierung: Die Auswahl legt die Kodierung der Dateinamen fest.

Verzeichnis

  • Pfad

    Absoluter Pfad zu dem Verzeichnis, das der VFS Connector beim Schreiben von Dateien verwenden soll, nach dem Muster /Root/XY_TestGruppe/XY_Testdaten/.

  • Erzeuge fehlende Verzeichnisse

    Erzeugt alle nicht-existierenden Verzeichnisse aus der Pfadangabe.

Datei

(nur bei Eingangsformat DATA)

  • Name

    Dateiname. Optional mit Wildcard bzw. regulärem Ausdruck.

  • Bestehende Datei überschreiben

    Markiert: Wenn bereits eine Datei mit demselben Namen existiert, dann wird diese überschrieben.

  • Daten an die Datei anfügen

    Markiert: Die zu lesende Datei wird bei jeder Ausführung des Workflows an eine eventuell bereits existierende Datei angehängt. Dies ist z.B. sinnvoll, um Log-Daten kumulativ in einer Datei zu protokollieren.

    Diese Option kann nicht verwendet werden, wenn im Dateinamen Wildcards angegeben sind!

  • Fehler erzeugen, wenn Datei existiert

    Wenn markiert, dann wird im Queue Manager ein Fehlereintrag für den Workflow mit diesem VFS Connector angezeigt, falls bereits eine Datei mit dem gleichen Namen existiert. Ist ein Fehlerausgang konfiguriert, wird dieser durchlaufen. Sonst wird die Ausführung des Moduls abgebrochen.

Berechtigungen

(nur bei Protokoll repository für Output Konnektoren)

  • Anonym lesbar

    Leserechte für alle Benutzer setzen. Gilt nur für neu erzeugte Dateien, Leserechte an vorhandenen Dateien werden nicht verändert.