Datei-Funktionen im Jitterbit Integration Studio

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

ArchiveFile

Deklaration

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

Syntax

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

Erforderliche Parameter

• sourceId: Ein String-Verweis auf einen Pfad zu einer Aktivität, die mit einem dateitypbezogenen Endpunkt im aktuellen Projekt verbunden ist
• targetId: Ein String-Verweis auf einen Pfad zu einer Aktivität, die mit einem dateitypbezogenen Endpunkt im aktuellen Projekt verbunden ist

Optionale Parameter

• deleteSource: Boolean-Flag (Standard false), das angibt, ob die Quelle nach dem erfolgreichen Schreiben in das Ziel gelöscht werden soll

Beschreibung

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

Die Quelle und das Ziel, die in diesem Funktionsaufruf verwendet werden, müssen als Aktivitäten definiert sein, die mit dateitypbezogenen Endpunkten im aktuellen Projekt verbunden 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 Endpunkte in Jitterbit Script.

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

Wie die Funktion WriteFile wird diese Funktion eine vorhandene Datei am Ziel nicht überschreiben.

Wenn die Funktion ArchiveFile fehlschlägt, schlägt die Operation nicht fehl. Ein Skript wird abgebrochen, eine Warnung wird zum Betriebsprotokoll hinzugefügt, und die Operation wird fortgesetzt.

Archivieren versus Kopieren

• Wenn deleteSource true ist, wird die Datei archiviert (mit anderen Worten, verschoben) vom Quell- zum Zielort und vom Quellort entfernt.
• Wenn deleteSource false ist, wird die Datei vom Quell- zum Zielort kopiert und bleibt am Quellort.

Beispiele

// 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

Deklaration

int DeleteFile(string sourceId[, string fileFilter])

Syntax

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

Erforderliche Parameter

• sourceId: Ein String-Verweis auf einen Pfad zu einer Aktivität, die mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden ist

Optionale Parameter

• fileFilter: Datei-Filter oder Dateiname, um die Aktivitätskonfiguration zu überschreiben

Beschreibung

Löscht eine Datei aus der angegebenen Quelle.

Die Quelle, die in diesem Funktionsaufruf verwendet wird, muss als Aktivität definiert sein, die mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden 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 im Aktivitätskonfigurationsfilter verwendeten Datei-Filter zu überschreiben. Ein Dateiname kann verwendet werden. Alternativ kann eine globale Variable verwendet werden, um den Datei-Filter in der Aktivitätskonfiguration zu überschreiben. Globale Variablen werden in der Aktivitätskonfiguration als [de_name] referenziert.

Beispiele

// Löschen Sie die Datei "ExampleFile.txt" aus den "CSV-Dateien"
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-Verweis auf einen Aktivitätspfad, der mit einem Datei-Typ-Endpunkt im aktuellen Projekt verbunden ist

Optionale Parameter

• fileFilter: Datei-Filter oder Dateiname, um die Aktivitätskonfiguration zu überschreiben

Beschreibung

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

Die in diesem Funktionsaufruf verwendete Quelle muss als Aktivität definiert sein, die mit einem Datei-Typ-Endpunkt im aktuellen Projekt verbunden 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, sofern welche gefunden werden, basierend auf dem Dateifilter der Aktivitätskonfiguration. Ein ganzzahliger Wert wird zurückgegeben, der angibt, wie viele Dateien gelöscht wurden. Ein Wert 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. Wenn dies möglich ist, sollte die Funktion in eine Eval-Funktion eingebettet 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.

Beispiele

// Löschen Sie alle Textdateien (".txt") im "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 mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden ist

Optionale Parameter

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

Beschreibung

Gibt eine Liste von Verzeichnissen zurück, die in einer Quelle enthalten sind, wobei optional ein Pfad und ein Filter angegeben werden können, um die Ergebnisse einzuschränken.

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

Die Quelle, die in diesem Funktionsaufruf verwendet wird, muss als Aktivität definiert sein, die mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden 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 Endpoints 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-Verweis auf einen Pfad zu einer Aktivität, die mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden ist

Optionale Parameter

• path: Dateipfad, um die Aktivitätskonfiguration zu überschreiben
• fileFilter: Dateifilter oder Dateiname, um die Aktivitätskonfiguration zu überschreiben

Beschreibung

Gibt eine Liste von Dateinamen zurück, die in einer Quelle enthalten sind. Dies wird die gleiche Liste von Dateien sein, die erhalten wird, wenn die Verbindung einer Dateityp-Quelle getestet wird, es sei denn, ein Dateifilter wird angegeben, um den in der Aktivitätskonfiguration angegebenen Filter zu überschreiben.

Der in diesem Funktionsaufruf verwendete Quellwert muss als Aktivität definiert sein, die mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden ist. Dazu gehören konfigurierte Aktivitäten wie File Share, FTP, HTTP, Local Storage und Temporary Storage. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Endpunkten im Abschnitt Endpoints 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 zurück, das die Dateinamen enthält, die entweder dem Dateifilter der Quellaktivität oder der überschriebenen Quelle entsprechen.

Beispiele

// Gibt die Anzahl der Liste aller
// Dateien im FTP-Endpunkt "FTP Files" zurück
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 mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden ist

Beschreibung

Persistiert Daten, die mit WriteFile in einen Datei-Puffer geschrieben wurden.

Der in diesem Funktionsaufruf verwendete Zielwert muss als Aktivität definiert sein, die mit einem Dateityp-Endpunkt im aktuellen Projekt verknüpft 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 Endpoints in Jitterbit Script.

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

Siehe auch die Funktion FlushFiles.

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-Verweis auf einen Pfad zu einer Aktivität, die mit einem Dateityp-Endpunkt im aktuellen Projekt verknüpft ist

Optionale Parameter

• filename: Dateiname, um die Aktivitätskonfiguration zu überschreiben

Beschreibung

Speichert Daten, die mit WriteFile in einen Datei-Puffer geschrieben wurden. Wenn FlushFile aufgerufen wird, werden die aktuellen Inhalte des Puffers in das Ziel geschrieben und der lokale Puffer wird verworfen.

Der Zielwert, der in diesem Funktionsaufruf verwendet wird, muss als Aktivität definiert sein, die mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden 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 Endpoints in Jitterbit Script.

Der optionale Parameter filename kann verwendet werden, um den in der Aktivitätskonfiguration verwendeten Dateinamen zu überschreiben, wenn er im Aufruf der Funktion WriteFile ebenfalls überschrieben wurde. Das Leeren einer Datei, die noch nie beschrieben wurde, hat keine Auswirkungen.

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 überschreibender Dateiname verwendet wird, wird jeder Puffer separat für jeden eindeutigen Namen geleert.

Siehe auch die Funktion FlushAllFiles.

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

Declaration

string ReadFile(string sourceId[, string fileFilter])

Syntax

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

Required parameters

• sourceId: Ein String-Verweis auf einen Pfad zu einer Aktivität, die mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden ist

Optional parameters

• fileFilter: Dateifilter oder Dateiname, um die Aktivitätskonfiguration zu überschreiben

Beschreibung

Liest den Inhalt einer Datei aus einer Quelle.

Die in diesem Funktionsaufruf verwendete Quelle muss als Aktivität definiert sein, die mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden 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 Endpoints in Jitterbit Script.

Die Methode gibt den Inhalt der Datei zurück, auf die die Quelle verweist. Wenn der Quellfilter 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 wird im Betriebsprotokoll 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 $jitterbit.source.http.* Variablen befüllt.

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-Verweis auf einen Pfad zu einer Aktivität, die mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden ist

Optionale Parameter

• fileContents: Daten, die in die Datei geschrieben werden sollen
• filename: Dateiname, um die Aktivitätskonfiguration zu überschreiben

Beschreibung

Schreibt die fileContents in das durch targetId angegebene Ziel. Wenn fileContents vom Typ binär ist, werden die binären Daten 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 mit einem Dateityp-Endpunkt im aktuellen Projekt verbunden 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 an ein HTTP-Ziel zu schreiben/zu posten. In diesem Fall werden die Variablen $jitterbit.target.http.* befüllt.

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

Puffer und Leeren

Die Dateiinhalte werden lokal gepuffert, bis entweder FlushFile oder FlushAllFiles auf dem Ziel aufgerufen wird oder die Transformation erfolgreich abgeschlossen ist. Mehrfaches Aufrufen von WriteFile, ohne FlushFile aufzurufen, fügt Daten zum aktuellen Puffer hinzu, und alles wird nur dann an das tatsächliche Dateityp-Ziel geschrieben, wenn es geleert wird. Ein Datei-Puffer wird eindeutig durch das Ziel (und möglicherweise den filename) identifiziert; zum Beispiel kann dasselbe Ziel verwendet werden, um in verschiedene Dateien im selben Verzeichnis zu schreiben, indem ein Dateiname angegeben wird, und jeder Datei-Puffer wird separat sein.

Dateien werden in einer Testtransformation nicht tatsächlich an das Ziel geschrieben, es sei denn, FlushFile oder FlushAllFiles wird aufgerufen. Wenn eine Transformation in einem Vorgang oder als Teil eines Testvorgangs 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");