Dateifunktionen in Jitterbit Studio

Dateifunktionen ermöglichen es Skripten, Dateien auf Agenten zu manipulieren. Sie sind über konfigurierte dateibasierte Aktivitäten verfügbar, die als Quellen oder Ziele verwendet werden können.

ArchiveFile

Declaration

void ArchiveFile(string sourceId, string targetId[, bool deleteSource])

Syntax

ArchiveFile(<sourceId>, <targetId>[, <deleteSource>])

Erforderliche Parameter

• sourceId: Ein String-Referenzpfad zu einer Aktivität, die einem dateibasierten Endpunkt im aktuellen Projekt zugeordnet ist
• targetId: Ein String-Referenzpfad zu einer Aktivität, die einem dateibasierten Endpunkt im aktuellen Projekt zugeordnet ist

Optionale Parameter

• deleteSource: Boolesches Flag (Standard false), das angibt, ob die Quelle nach erfolgreichem Schreiben zum Ziel gelöscht werden soll

Description

Liest eine Datei aus einer dateibasierten Quellaktivität und schreibt sie in eine dateibasierte Zielaktivität. Diese Funktion kombiniert die Funktionen ReadFile und WriteFile, führt automatisch FlushFile durch und bietet die Möglichkeit, die Quelldatei zu löschen.

Die in diesem Funktionsaufruf verwendete Quelle und das Ziel müssen als Aktivitäten definiert sein, die dateibasierten Endpunkten im aktuellen Projekt zugeordnet sind. Dazu gehören konfigurierte File Share-, FTP-, HTTP-, Local Storage- und Temporary Storage-Aktivitäten. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Endpunkten im Abschnitt Endpoints in Jitterbit Script.

Da nur eine Datei archiviert wird, wird empfohlen, die Quelle so zu konfigurieren, dass sie nur eine einzelne Datei zurückgibt. Wenn mehrere Dateien zurückgegeben werden, wird nur die erste verwendet.

Wie die Funktion WriteFile überschreibt diese Funktion keine vorhandene Datei auf dem Ziel.

Wenn die Funktion ArchiveFile fehlschlägt, schlägt der Vorgang nicht fehl. Ein Skript wird abgebrochen, eine Warnung wird zum Vorgangsprotokoll hinzugefügt, und der Vorgang wird fortgesetzt. Wenn deleteSource auf true gesetzt ist und die Quelldatei nicht gelöscht werden kann, kann der Fehler von Eval bei Verwendung von Agent-Version 12.5 oder später abgefangen werden.

Archivieren versus Kopieren

• Wenn deleteSource auf true gesetzt ist, wird die Datei von der Quelle zum Ziel archiviert (d. h. verschoben) und aus der Quelle entfernt.
• Wenn deleteSource auf false gesetzt ist, wird die Datei von der Quelle zum Ziel kopiert und bleibt auf der Quelle.

Zur Fehlerbehebung siehe Dateifunktionen: Vorgang wird nach ArchiveFile- oder ReadFile-Fehler fortgesetzt im Leitfaden zur Vorgangsfehlersuche.

Examples

// Retrieve list of files from a source
localFiles = FileList("<TAG>activity:localstorage/Local Storage Endpoint/localstorage_read/CSV Files</TAG>");

// Create a global archive filename
$archiveFilename = "archive.[date]-[time]." + localFiles[0];

// Archive (moves) a file, using [archiveFilename] in the target filename(s) field
ArchiveFile("<TAG>activity:localstorage/Local Storage Endpoint/localstorage_read/CSV Files</TAG>",
    "<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>", true);

// Copies a file, using [archiveFilename] in the target filename(s) field
ArchiveFile("<TAG>activity:localstorage/Local Storage Endpoint/localstorage_read/CSV Files</TAG>",
    "<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>", false);

DeleteFile

Declaration

int DeleteFile(string sourceId[, string fileFilter])

Syntax

DeleteFile(<sourceId>[, <fileFilter>])

Erforderliche Parameter

• sourceId: Ein String-Referenzpfad zu einer Aktivität, die einem dateibasierten Endpunkt im aktuellen Projekt zugeordnet ist

Optionale Parameter

• fileFilter: Dateifilter oder Dateiname zum Überschreiben der Aktivitätskonfiguration

Description

Löscht eine Datei aus der angegebenen Quelle.

Die in diesem Funktionsaufruf verwendete Quelle muss als Aktivität definiert sein, die einem Datei-Typ-Endpunkt im aktuellen Projekt zugeordnet ist. Dazu gehören konfigurierte File Share-, FTP-, HTTP-, Local Storage- und Temporary Storage-Aktivitäten. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Endpunkten im Abschnitt Endpunkte in Jitterbit Script.

Wenn der Quellfilter mehr als eine Datei auswählt, wird ein Fehler ausgelöst. Um mehrere Dateien zu löschen, verwenden Sie stattdessen die Funktion DeleteFiles.

Die Methode gibt eine Ganzzahl von entweder 0 oder 1 zurück: Sie gibt 1 zurück, wenn die Datei gelöscht wurde; 0, wenn die Datei nicht gefunden werden konnte.

Der zweite Parameter fileFilter ist optional und kann verwendet werden, um den in der Aktivitätskonfiguration verwendeten Dateifilter zu überschreiben. Ein Dateiname kann verwendet werden. Alternativ kann eine globale Variable verwendet werden, um den Dateifilter in der Aktivitätskonfiguration zu überschreiben. Globale Variablen werden in der Aktivitätskonfiguration als [de_name] referenziert.

Beispiele

// Delete the file "ExampleFile.txt" from the "CSV Files"
DeleteFile("<TAG>activity:localstorage/Local Storage Endpoint/localstorage_read/CSV Files</TAG>",
    "ExampleFile.txt");

DeleteFiles

Deklaration

int DeleteFiles(string sourceId[, string fileFilter])

Syntax

DeleteFiles(<sourceId>[, <fileFilter>])

Erforderliche Parameter

• sourceId: Ein String-Referenzpfad zu einer Aktivität, die einem Datei-Typ-Endpunkt im aktuellen Projekt zugeordnet ist

Optionale Parameter

• fileFilter: Dateifilter oder Dateiname zum Überschreiben der Aktivitätskonfiguration

Beschreibung

Löscht eine oder mehrere Dateien aus der angegebenen Quelle.

Die in diesem Funktionsaufruf verwendete Quelle muss als Aktivität definiert sein, die einem Datei-Typ-Endpunkt im aktuellen Projekt zugeordnet ist. Dazu gehören konfigurierte File Share-, FTP-, HTTP-, Local Storage- und Temporary Storage-Aktivitäten. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Endpunkten im Abschnitt Endpunkte in Jitterbit Script.

Diese Methode löscht mehrere Dateien, falls vorhanden, basierend auf dem Dateifilter der Aktivitätskonfiguration. Eine Ganzzahl wird zurückgegeben, die angibt, wie viele Dateien gelöscht wurden. Die Rückgabe von 0 bedeutet, dass keine Dateien gefunden wurden, die dem Dateifilter entsprechen.

Wenn ein angegebener Pfad in der Quelle nicht gefunden werden kann, wird ein Fehler ausgelöst. Falls dies möglich ist, sollte die Funktion in eine Eval-Funktion eingebunden werden.

Um eine einzelne Datei zu löschen, verwenden Sie stattdessen die Funktion DeleteFile.

Der zweite Parameter fileFilter ist optional und kann verwendet werden, um den in der Aktivitätskonfiguration verwendeten Dateifilter zu überschreiben. Ein Dateiname kann verwendet werden. Alternativ kann eine globale Variable verwendet werden, um den Dateifilter in der Aktivitätskonfiguration zu überschreiben. Globale Variablen werden in der Aktivitätskonfiguration als [de_name] referenziert.

Informationen zur Fehlerbehebung finden Sie unter DeleteFiles: Fehler, wenn der Quellpfad nicht gefunden werden kann im Leitfaden zur Fehlerbehebung bei Vorgängen.

Beispiele

// Delete all text (".txt") files in the "FTP Files"
DeleteFiles("<TAG>activity:ftp/FTP Endpoint/ftp_read/FTP Files</TAG>", "*.txt");

DirList

Deklaration

array DirList(string sourceId[, string path, string fileFilter])

Syntax

DirList(<sourceId>[, <path>, <fileFilter>])

Erforderliche Parameter

• sourceId: Ein String-Referenzpfad zu einer Aktivität, die einem dateitypgestützten Endpunkt im aktuellen Projekt zugeordnet ist

Optionale Parameter

• path: Dateipfad zum Überschreiben der Aktivitätskonfiguration
• fileFilter: Dateifilter oder Dateiname zum Überschreiben der Aktivitätskonfiguration

Beschreibung

Gibt eine Liste der Verzeichnisse zurück, die sich in einer Quelle befinden, und ermöglicht optional die Angabe eines Pfads und eines Filters, um die Ergebnisse einzuschränken.

Diese Methode gibt ein Array mit den Verzeichnisnamen zurück.

Die in diesem Funktionsaufruf verwendete Quelle muss als Aktivität definiert sein, die einem dateitypgestützten Endpunkt im aktuellen Projekt zugeordnet ist. Dazu gehören konfigurierte Aktivitäten für Dateifreigabe, FTP, HTTP, lokalen Speicher und temporären Speicher. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Endpunkten im Abschnitt Endpunkte in Jitterbit Script.

Der Parameter fileFilter ist optional und kann verwendet werden, um den in der Aktivitätskonfiguration verwendeten Dateifilter zu überschreiben. Ein Dateiname kann verwendet werden. Alternativ kann eine globale Variable verwendet werden, um den Dateifilter in der Aktivitätskonfiguration zu überschreiben. Globale Variablen werden in der Aktivitätskonfiguration als [de_name] referenziert.

Beispiele

// Returns the count of the list of all the text
// files (".txt") in the "example" folder of the
// File Share Read "File Share"
Length(DirList("<TAG>activity:fileshare/File Share Endpoint/fileshare_read/File Share</TAG>",
        "\\\\server\\example","*.txt"));

FileList

Deklaration

array FileList(string sourceId[, string path, string fileFilter])

Syntax

FileList(<sourceId>[, <path>, <fileFilter>])

Erforderliche Parameter

• sourceId: Ein String-Referenzpfad zu einer Aktivität, die einem dateitypgestützten Endpunkt im aktuellen Projekt zugeordnet ist

Optionale Parameter

• path: Dateipfad zum Überschreiben der Aktivitätskonfiguration
• fileFilter: Dateifilter oder Dateiname zum Überschreiben der Aktivitätskonfiguration

Beschreibung

Gibt eine Liste der Dateinamen zurück, die sich in einer Quelle befinden. Dies ist die gleiche Liste von Dateien, die beim Testen der Verbindung einer dateitypgestützten Quelle empfangen wird, es sei denn, es wird ein Dateifilter angegeben, um den in der Aktivitätskonfiguration angegebenen Filter zu überschreiben.

Die in diesem Funktionsaufruf verwendete Quelle muss als Aktivität definiert sein, die einem dateitypgestützten Endpunkt im aktuellen Projekt zugeordnet ist. Dazu gehören konfigurierte Aktivitäten für Dateifreigabe, FTP, HTTP, lokalen Speicher und temporären Speicher. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Endpunkten im Abschnitt Endpunkte in Jitterbit Script.

Der Parameter path ist optional und kann verwendet werden, um den in der Aktivitätskonfiguration verwendeten Pfad zu überschreiben.

Der Parameter fileFilter ist optional und kann verwendet werden, um den in der Aktivitätskonfiguration verwendeten Dateifilter zu überschreiben. Ein Dateiname kann verwendet werden. Alternativ kann eine globale Variable verwendet werden, um den Dateifilter in der Aktivitätskonfiguration zu überschreiben. Globale Variablen werden in der Aktivitätskonfiguration als [de_name] referenziert.

Die Methode gibt ein Array mit den Dateinamen zurück, die entweder dem Dateifilter der Quellaktivität oder der überschriebenen Quelle entsprechen.

Beispiele

// Returns the count of the list of all the
// files in the FTP endpoint "FTP Files"
Length(FileList("<TAG>activity:ftp/FTP Endpoint/ftp_read/FTP Files</TAG>"));

FlushAllFiles

Deklaration

void FlushAllFiles([string targetId])

Syntax

FlushAllFiles([<targetId>])

Optionale Parameter

• targetId: Ein String-Referenzpfad zu einer Aktivität, die einem Datei-Typ-Endpunkt im aktuellen Projekt zugeordnet ist

Beschreibung

Speichert Daten, die mit WriteFile in einen Dateipuffer geschrieben wurden.

Das in diesem Funktionsaufruf verwendete Ziel muss als Aktivität definiert sein, die einem Datei-Typ-Endpunkt im aktuellen Projekt zugeordnet ist. Dazu gehören konfigurierte Dateifreigabe-, FTP-, HTTP-, lokale Speicher- und temporäre Speicheraktivitäten. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Endpunkten im Abschnitt Endpunkte in Jitterbit Script.

Wenn FlushAllFiles mit einer targetId als Argument aufgerufen wird, werden alle mit diesem Ziel geschriebenen Dateien geleert (siehe die Funktion FlushFile). Wenn FlushAllFiles ohne Argument aufgerufen wird, werden alle mit WriteFile in Aktivitäten geschriebenen Dateien, die als Ziele verwendet werden, in ihren jeweiligen Zielen gespeichert.

Siehe auch die Funktion FlushFiles.

Zur Fehlerbehebung siehe FlushFile / FlushAllFiles: Fehler, wenn Zieldatei bereits vorhanden ist im Leitfaden zur Fehlerbehebung bei Vorgängen.

Beispiele

// Write the value of "contents1" to the file specified by
// the FTP Write activity "FTP Files"
WriteFile("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>",
    contents1);

// Write  the value of "contents2" to a file "copy.txt", overriding
// that specified by the FTP Write activity "FTP Files"
WriteFile("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>",
    contents2, "copy.txt");

// Flush both files to the FTP Write activity "FTP Files"
FlushAllFiles("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>");

FlushFile

Deklaration

void FlushFile(string targetId[, string filename])

Syntax

FlushFile(<targetId>[, <filename>])

Erforderliche Parameter

• targetId: Ein String-Referenzpfad zu einer Aktivität, die einem Datei-Typ-Endpunkt im aktuellen Projekt zugeordnet ist

Optionale Parameter

• filename: Dateiname zum Überschreiben der Aktivitätskonfiguration

Beschreibung

Speichert Daten, die mit WriteFile in einen Dateipuffer geschrieben wurden. Wenn FlushFile aufgerufen wird, wird der aktuelle Inhalt des Puffers in das Ziel geschrieben und der lokale Puffer verworfen.

Das in diesem Funktionsaufruf verwendete Ziel muss als Aktivität definiert sein, die einem Datei-Typ-Endpunkt im aktuellen Projekt zugeordnet ist. Dazu gehören konfigurierte Dateifreigabe-, FTP-, HTTP-, lokale Speicher- und temporäre Speicheraktivitäten. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Endpunkten im Abschnitt Endpunkte in Jitterbit Script.

Der optionale Parameter filename kann verwendet werden, um den in der Aktivitätskonfiguration verwendeten Dateinamen zu überschreiben, falls dieser auch im Aufruf der Funktion WriteFile überschrieben wurde. Das Leeren einer Datei, in die nie geschrieben wurde, hat keine Auswirkung.

Alternativ kann eine globale Variable verwendet werden, um den Dateinamen in der Aktivitätskonfiguration zu überschreiben. Globale Variablen werden in der Aktivitätskonfiguration als [de_name] referenziert. Wenn ein Überschreibungs-Dateiname verwendet wird, wird jeder Puffer separat für jeden eindeutigen Namen geleert.

Siehe auch die Funktion FlushAllFiles.

Zur Fehlerbehebung siehe FlushFile / FlushAllFiles: Fehler, wenn Zieldatei bereits vorhanden ist im Leitfaden zur Fehlerbehebung bei Operationen.

Beispiele

// Write the variable "contents" to the file specified by
// the FTP Write activity "FTP Files"
WriteFile("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>",
    contents);

// Flushing (actually writing) to the activity
FlushFile("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>");

// Write to another file (overriding the filename in the target)
WriteFile("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>",
    contents, "test.txt");

// Flushing the "test.txt" file explicitly
FlushFile("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>",
    "test.txt");

ReadFile

Deklaration

string ReadFile(string sourceId[, string fileFilter])

Syntax

ReadFile(<sourceId>[, <fileFilter>])

Erforderliche Parameter

• sourceId: Ein String-Referenzpfad zu einer Aktivität, die einem Dateityp-Endpunkt im aktuellen Projekt zugeordnet ist

Optionale Parameter

• fileFilter: Dateifilter oder Dateiname zum Überschreiben der Aktivitätskonfiguration

Beschreibung

Liest den Inhalt einer Datei aus einer Quelle.

Die in diesem Funktionsaufruf verwendete Quelle muss als Aktivität definiert sein, die einem Dateityp-Endpunkt im aktuellen Projekt zugeordnet ist. Dazu gehören konfigurierte Aktivitäten für Dateifreigabe, FTP, HTTP, lokalen Speicher und temporären Speicher. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Endpunkten im Abschnitt Endpunkte in Jitterbit Script.

Die Methode gibt den Inhalt der Datei zurück, auf die die Quelle verweist. Wenn der Quellenfilter mehr als eine Datei auswählt, wird die erste verwendet. Es wird empfohlen, eine Quelle anzugeben, die eine einzelne Datei eindeutig identifiziert.

Der Parameter fileFilter ist optional und kann verwendet werden, um den in der Aktivitätskonfiguration verwendeten Dateifilter zu überschreiben. Ein Dateiname kann verwendet werden. Alternativ kann eine globale Variable verwendet werden, um den Dateifilter in der Aktivitätskonfiguration zu überschreiben. Globale Variablen werden in der Aktivitätskonfiguration als [de_name] referenziert.

Wenn die Funktion ReadFile() fehlschlägt, schlägt die Operation nicht fehl. Ein Skript wird abgebrochen, eine Warnung zum Operationsprotokoll hinzugefügt und die Operation wird fortgesetzt.

Diese Methode kann verwendet werden, um Daten aus einer HTTP-Quelle zu lesen. In diesem Fall werden alle Jitterbit-Variablen $jitterbit.source.http.* gefüllt.

Zur Fehlerbehebung siehe ReadFile: Teilweise Lesevorgänge mit binärem Dateiinhalt und ReadFile-Inhalt mit Bytes ohne UTF-8 schlägt fehl, wenn er in eine UTF-8-XML- oder JSON-Nutzlast zugeordnet wird im Leitfaden zur Fehlerbehebung bei Operationen.

Beispiele

$fileContents = ReadFile("<TAG>activity:ftp/FTP Endpoint/ftp_read/FTP Files</TAG>")

WriteFile

Deklaration

void WriteFile(string targetId, type fileContents[, string filename])

Syntax

WriteFile(<targetId>, <fileContents>[, <filename>])

Erforderliche Parameter

• targetId: Ein String-Referenzpfad zu einer Aktivität, die einem Datei-Typ-Endpunkt im aktuellen Projekt zugeordnet ist

Optionale Parameter

• fileContents: Daten, die in die Datei geschrieben werden sollen
• filename: Dateiname zum Überschreiben der Aktivitätskonfiguration

Beschreibung

Schreibt fileContents in das durch targetId angegebene Ziel. Wenn fileContents vom Typ Binary ist, werden die Binärdaten in die Datei geschrieben. In allen anderen Fällen wird eine String-Darstellung der Daten geschrieben.

Das in diesem Funktionsaufruf verwendete Ziel muss als Aktivität definiert sein, die einem Datei-Typ-Endpunkt im aktuellen Projekt zugeordnet ist. Dazu gehören konfigurierte File Share-, FTP-, HTTP-, Local Storage- und Temporary Storage-Aktivitäten. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Endpunkten im Abschnitt Endpunkte in Jitterbit Script.

Der dritte Parameter filename ist optional und kann verwendet werden, um den in der Aktivitätskonfiguration verwendeten Dateinamen zu überschreiben. Alternativ kann eine globale Variable verwendet werden, um den Dateinamen in der Aktivitätskonfiguration zu überschreiben. Globale Variablen werden in der Aktivitätskonfiguration als [de_name] referenziert.

Diese Methode kann auch verwendet werden, um Daten in ein HTTP-Ziel zu schreiben/zu posten. In diesem Fall werden $jitterbit.target.http.*-Variablen gefüllt.

Wenn die Funktion WriteFile() fehlschlägt, schlägt der Vorgang nicht fehl. Ein Skript wird abgebrochen, eine Warnung zum Vorgangsprotokoll hinzugefügt und der Vorgang wird fortgesetzt.

Puffer und Flush

Der Dateiinhalt wird lokal gepuffert, bis entweder FlushFile oder FlushAllFiles für das Ziel aufgerufen wird oder die Transformation erfolgreich abgeschlossen ist. Das mehrfache Aufrufen von WriteFile ohne Aufrufen von FlushFile fügt Daten zum aktuellen Puffer hinzu und alles wird nur dann in das eigentliche Datei-Typ-Ziel geschrieben, wenn es geleert wird. Ein Dateipuffer wird eindeutig durch das Ziel (und möglicherweise den filename) identifiziert. Beispielsweise kann dasselbe Ziel verwendet werden, um in verschiedene Dateien im selben Verzeichnis zu schreiben, indem ein Dateiname angegeben wird, und jeder Dateipuffer ist separat.

Dateien werden in einer Test-Transformation nicht tatsächlich in das Ziel geschrieben, es sei denn, FlushFile oder FlushAllFiles wird aufgerufen. Wenn eine Transformation in einem Vorgang oder als Teil eines Test-Vorgangs ausgeführt wird, wird die Datei geschrieben, wenn entweder die Transformation erfolgreich abgeschlossen ist oder wenn FlushFile oder FlushAllFiles im Skript aufgerufen wird.

Siehe auch die Funktionen FlushAllFiles und FlushFiles.

Beispiele

// Write "contents" to a file in an activity
WriteFile("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>", contents);

// Use the filename "test.txt" instead of
// what is defined in an activity
WriteFile("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>", contents, "test.txt");