Zum Hauptinhalt springen

Exportkonfigurationen

Fachlicher Hintergrund​

Der Export von Daten in Dateien ist ein häufiger Anwendungsfall, vor allem für das Übermitteln an externe Geräte und Dienste. Mit dem Exportkonfigurationen-Modul können nun Exportvorgänge eingerichtet werden, mit denen dynamisch Dateien für Übermittlungsschnittstellen erstellt werden können.

Modulaufbau​

Name-Seite​

Auf dieser Seite können grundsätzliche Einstellungen zu dem Export vorgenommen werden.

VerfĂĽgbare Felder

  • Kurzbezeichnung

    Kurzbezeichnung der Exportkonfiguration

  • Beschreibung

    Bezeichnung der Exportkonfiguration.

  • Datentyp

    Bestimmt welche Datensätze mit dieser Exportkonfiguration exportiert werden können. (z.B. Probe)

  • Zeige Logging-Konsole

    Wenn aktiviert, wird nach dem Export eine Auswertung angezeigt. (z.B. exportierte Dateien und erstellte Log-Einträge)

  • Logging-Level

    Bestimmt den Schweregrad, ab dem Log-Einträge geschrieben werden. (z.B. WARN bewirkt, dass alle Warnungen und Fehler aufgezeichnet werden.)

  • Ablagepfad

    Skript für die Definition des Ablagepfades der zu exportierenden Dateien. Hier können Informationen des angemeldeten Benutzers, Exportzeitpunkt und des exportierten Datensatzes verwendet werden um den Pfad (Verzeichnis und Dateiname) zu spezifizieren.

  • Codepage

    Die Kodierung der zu exportierenden Dateien.

  • Format

    Datei-Format, in das Daten mit dieser Konfiguration exportiert werden sollen. Es stehen tabellarische (CSV und Text mit festen Feldlängen ) oder hierarchische Formate (XML und JSON)1 zur Verfügung.

  • Kopfzeile erstellen

    Nur fĂĽr CSV und Text. Wenn aktiviert, wird der Name der Felder als SpaltenĂĽberschrift verwendet.

  • Stapelverarbeitung

    Nur für CSV und Text. Wenn aktiviert, werden alle Datensätze des Exportvorgangs in eine gemeinsame Datei geschrieben. Andernfalls wird für jeden Datensatz eine eigene Datei erzeugt.

  • Dezimaltrennzeichen

    Nur fĂĽr CSV und Text. Das zu verwendende Dezimaltrennzeichen fĂĽr Zahlenwerte.

  • Text-Trennzeichen

    Nur für CSV. Das zu verwendende Texttrennzeichen. (z.B. mit Anführungszeichen „Beispieltext, mit Komma“)

  • Feld-Trennzeichen

    Nur fĂĽr CSV. Das zu verwendende Feldtrennzeichen.

  • Zeilen-Trennzeichen

    Nur fĂĽr CSV und Text. Das zu verwendende Zeilentrennzeichen.

Felder-Seite​

Hier können die Felder (auch Export-Spaltenkonfigurationen genannt) zu der Exportkonfiguration gepflegt werden. Die Pflege unterscheidet sich je nach gewählten Exportformat:

  • CSV und Text

Felder lassen sich in einer flachen Hierarchie (eine Ebene) pflegen. Jedes Feld beschreibt eine Spalte in der Exportdatei. Wohingegen jeder Datensatz mindestens eine Zeile umfasst. (mehrere Zeilen, wenn der Wert des Feldes eine Liste von Werten ist)

  • XML und JSON

Felder lassen sich in einer verschachtelten Hierarchie pflegen. XML und JSON erwarten genau ein Wurzelelement. Daher wird eine entsprechende Export-Spaltenkonfiguration vorausgesetzt. Darunter lässt sich ein beliebiger Baum von Export-Spaltenkonfigurationen aufbauen. Jede Export-Spaltenkonfiguration beschreibt ein Element in der Exportdatei, sodass die Form der Feldhierarchie ungefähr den Aufbau der exportieren Baumstruktur wieder spiegelt. (Elemente werden wiederholt, wenn der Wert des Feldes eine Liste ist)

Die Verschachtelungstiefe kann in den Optionen unter Module -> Exportkonfigurationen -> 'ExportKonfigurationAnweisungMaxHierarchyDepth'1 eingestellt werden.

warnung

Eine komplexe Baumstruktur kann sich negativ auf die Leistung auswirken!

Schaltflächen

  • Export-Spaltenkonfiguration erzeugen

    Es wird eine neue Export-Spaltenkonfiguration auf höchster Ebene erstellt.

  • Unterkonfiguration erzeugen

    Es wird eine Unterkonfiguration zu der aktuell selektierten Konfiguration erstellt. Sie erhält die nächsthöhere verfügbare Ordnung.

  • Export-Spaltenkonfiguration löschen

    Löscht die selektierte(n) Export-Spaltenkonfiguration(en)

  • Export-Spaltenkonfiguration duplizieren

    Erstellt ein Duplikat der ausgewählten Export-Spaltenkonfiguration

  • Export-Spaltenkonfiguration sortieren

    Ermöglicht das Sortieren der Export-Spaltenkonfigurationen. Die Sortierung bestimmt, in welcher Reihenfolge die Anweisungen ausgeführt werden. Die Abarbeitungsreihenfolge verläuft aufsteigend nach der Ordnung.

  • Export-Spaltenkonfigurationen kopieren/einfĂĽgen

    Kopiert die ausgewählte Export-Spaltenkonfiguration in die Zwischenablage, bzw. fügt eine kopierte Export-Spaltenkonfiguration aus der Zwischenablage ein.

  • Exportvorschau anzeigen (nur CSV und Text)

    Hiermit lässt sich testen, wie Daten in das gepflegte Format überführt werden.

Exportvorschau anzeigen

Es wird ein Dialog angezeigt, in dem ein Testdatensatz ausgewählt werden kann. Bei dem Betätigen von 'Ausführen' werden die Daten in die angezeigte Tabelle überführt.

Log-Einträge-Seite​

Auf dieser Seite können Logeinträge eingesehen werden, die erstellt werden, wann immer ein Export mit der Exportkonfiguration erfolgt. Sollte das entstandene Log eines Exportprozesses zu lang werden, werden mehrere Einträge auf einmal erstellt. Die Log-Einträge enthalten Logs, die mindestens dem an der Exportkonfiguration eingestellten Logging-Level entsprechen.

Schaltflächen

  • Log-Eintrag löschen

    Löscht selektierte(n) Log-Einträg(e)

Exportkonfigurationen als Makro einrichten​

Mit der Funktion können Sie eine zuvor erstellte Exportkonfiguration als manuelle Schnittstelle, in Form eines Makros im Modul des Datentyps, einrichten.

  1. Ă–ffnen Sie das Modul Exportkonfigurationen.
  2. Wählen Sie die gewünschte Exportkonfiguration aus.
  3. Betätigen Sie die Schaltfläche Export-Makro erzeugen.
  4. Es wird ein Makro im Modul Makros erstellt und zur Bearbeitung geöffnet. Es ist mit folgenden Informationen vorbelegt:
    1. Beschreibung: entsprechend der Beschreibung der Exportkonfiguration
    2. Kontext: Modul
    3. Datentyp: entsprechend dem Datentyp der Exportkonfiguration
    4. Typ: Anzeigen oder Drucken
    5. Hilfetext: Exportiert selektierte [...] mit der folgenden Exportkonfiguration: [...]
    6. Benutzer: der aktuell angemeldete Benutzer
    7. Code: Skript, dass die selektieren Datensätze mit der Exportkonfiguration exportiert
  5. Versetzen Sie ggf. das Makro in den Status zugelassen.
  6. Das Makro steht beim nächsten Start des Modules zur Verfügung.

Die erzeugten Logeinträge beim Ausführen des Makros können über die Exportkonfiguration eingestellt werden. Dazu kann der Wert in der Spalte Logging-Level im Exportkonfigurationen-Modul verwendet werden.

Footnotes​

  1. Ab Version 2027.1 ↩ ↩2