Pläne einrichten

Ein Imexporter-Plan ist eine Reihe von Handlungsanweisungen, Schritte oder Steps genannt, sowie einigen wenigen Zusatzinformationen. Ein Plan wird in einer XML-Datei definiert. Bei der Ausführung eines Plans wird eine Liste mit Eingabedateien sowie eine Liste an Variablen verwendet. Beide Listen können auch leer sein.

Beispiel

Planeigenschaften

Mit Hilfe der folgenden Attribute können Export-Definitionen im easydb-Frontend integriert werden. Sie sind anschließend über das Selektions-/Auswahl-Menü aufrufbar.

Name (Attribut name)

Ein frei wählbarer Name, der nach Möglichkeit aber eindeutig sein sollte, da man die Exporter im Frontend sonst nicht unterscheiden kann.

Recht (Attribut right)

Ein frei wählbarer Bezeichner, in der easydb wird für Exporter dafür ein Systemrecht nach dem Schema IMEXPORTER_<right> angelegt, das standardmäßig nicht gewährt ist.

Kontext

Eine anwendungsabhängige Beschreibung der Verwendungsmöglichkeiten. Die easydb verwendet für Exporter folgendes Schema: <table>:<column>:<callers>:<cardinality>. Die einzelnen, durch Doppelpunkt getrennten Felder können leer gelassen werden, Doppelpunkte am Ende können weggelassen werden. Zu den einzelnen Feldern:

• table: Name der Tabelle, auf die der Exporter anwendbar ist. Wenn nicht gesetzt, für alle Tabellen.
• column: Name der Spalte. Wenn leer, wird id angenommen.
• callers: Komma-getrennte Liste der möglichen Verwender, sollte leergelassen werden.
• cardinality: Ist der Exporter für den Export einzelner oder mehrerer Datensätze ausgelegt. Dabei steht 1 für Einzeldatensätze und n für mehrere Datensätze (was auch die Vorgabe ist).

Beispiele für gültige Kontext-Definitionen:

• item:item_id::1
• bilder:::n
• test

gemeinsame Eigenschaften der Schritte

Kardinalität

Jeder Schritt legt fest, ob er als Eingabe keine (0), eine (1) oder mehrere (n) Dateien akzeptiert. Diese Eingabekardinalität wird in der folgenden Aufstellung mit I angegeben. Außerdem hat jeder Schritt keine (0), eine (1) oder mehrere (m) Ausgabedateien, in der Liste mit O angegeben.

Die Eingabekardinalität eines Schritts muss zu der Ausgabekardinalität des vorherigen Schritts passen, ein Schritt darf nicht eine Datei (1) erwarten, wenn der vorherige Schritt keine (0) ausgibt. Schritte, die I=1 und O=1 haben, können jedoch hinter einen Schritt gehängt werden, der die Ausgabe O=m gesetzt hat. Der entsprechende Schritt wird dann mehrfach, für jede Eingabedatei ein Mal, ausgeführt und die Ergebnisse werden wieder zusammengeführt. Ein Schritt mit der Eingabe I=n kann natürlich auch hinter einem Schritt mit O=1 folgen.

Ein-/Ausgabetypen

Jeder Schritt hat, sofern anwendbar, auch eine Definition der möglichen Ein- und Ausgabedateitypen. Diese werden allerdings noch nicht überprüft, die Verantwortung liegt daher momentan beim Ersteller des Plans.

Verfügbare Schritte

splitxml (I=1, O=m)

Zerlegt eine XML-Datei in mehrere kleine XML-Dateien. Auf welcher Hierarchieebene die Trennung stattfindet, muss festgelegt werden. Dieser Schritt macht nur bei in ihrer Struktur regelmäßigen Daten Sinn, dabei kann er aber helfen, den Speicherbedarf anderer Schritte, z.B. der XSLT-Transformation zu reduzieren.

Parameter:

• num-tuples: nach wievielen Elementen (auf einer Ebene) eine neue Datei angefangen wird.
• split-level: Ebene, auf der die Trennung vorgenommen werden soll.

Beispiel:

xslt (I=1, O=1)

Eine XSLT-Transformation der Eingabedatei wird vorgenommen.

Parameter:

• xsl-file: XSLT-Stylesheet

Beispiel:

xml2csv (I=1, O=1)

Eine XML-Datei im Imexporter-Datenformat wird in eine CSV-Datei umgewandelt.

Beispiel:

csv2xml (I=1, O=1)

Eine CSV-Datei wird in eine XML-Datei im Imexporter-Datenformat umgewandelt.

Parameter:

• result-table-name (optional, Vorgabe csv): Name der Ausgabe-Tabelle (<table>-Tag im XML)
• separator (optional, Vorgabe ,): CSV-Feldtrenner
• quote (optional, Vorgabe "): Textbegrenzungszeichen
• first-skip (optional, Vorgabe 0): Einstellung, ob die erste Zeile übersprungen wird (hier können Spaltennamen stehen)
• first-as-column-names (optional, Vorgabe 0): Einstellung, ob die Spaltennamen aus der ersten Zeile extrahiert werden sollen
• skip-unnamed-columns (optional, Vorgabe 0): Einstellung, ob Spalten ohne Namen ignoriert werden sollen
• column-names (optional, Vorgabe leer): Liste (einzelne Einträge als Attribut name in <column>-Tags) der Spaltennamen

Beispiel:

pdflatex (I=1, O=1)

Erstellt eine PDF-Datei aus der als LaTeX-Quelle vorliegenden Eingabedatei.

Beispiel:

databaseimport (I=n, O=0)

Importiert die XML-Dateien im Imexporter-Datenformat in die Datenbank.

Parameter:

• description-file: Importdefinition

Beispiel:

databaseexport (I=0, O=1)

Exportiert aus der Datenbank in eine XML-Datei im Imexporter-Datenformat.

Parameter:

• description-file: Exportdefinition

Beispiel:

fetchassets (I=1, O=1)

Holt Assets aus dem EAS. Die Eingabe-XML-Datei muss dazu vorher mit EAS-Annotationen versehen werden.

Beispiel:

archive (I=n, O=1)

Verpackt die Dateien in einem Archiv.

Parameter:

• cleanup: Wenn gesetzt, werden die verpackten Dateien gelöscht, andernfalls werden sie neben dem Archiv an den nächsten Schritt weitergeleitet.
• format: Ausgabeformat, mögliche Werte sind zip, tar.gz, tar.bz2, tar.xz und tar.lzma.
• files: Liste der zu verpackenden Dateien:
  • input (optional): die Eingabedateien
  • match (optional, kann mehrfach verwendet werden): weitere Dateien, die auf das angegebene Pattern passen
• base-pattern (optional, ab Version 5.0.2): Name des im Archiv verwendeten Verzeichnisses. Wenn nicht angegeben, wird der temporäre Verzeichnisname verwendet. Durch Setzen eines leeren Wertes kann aber auch explizit auf das Verzeichnis im Archiv verzichtet werden.

Beispiel:

rename (I=n, O=m)

Benennt die Eingabedateien um.

Parameter:

• pattern: Ausgabedateiname, dabei werden folgende Platzhalter ersetzt:
  • %i: fortlaufende Nummer, mit 0 beginnend
  • %n: fortlaufende Nummer, mit 1 beginnend
  • %e: Dateierweiterung der Eingabedatei, ohne Punkt
  • %{<variable>}: Eingabe-Variable, z.B. %{id} oder %{basename}

Gibt es mehr als eine Eingabedatei, muss eine fortlaufende Nummer verwendet werden. Die einzelnen Platzhalter können jeweils noch mit Modifikatoren erweitert werden:

• %4n: gibt die Nummer mit einer Breite von 4 Zeichen rechtsbündig aus, der zusätzliche Platz wird mit Leerzeichen gefüllt.
• %02n: gibt die Nummer mit einer Breite von 2 Zeichen rechtsbündig aus, der Platz wird mit Nullen (0) aufgefüllt.

Beispiel: