Allgemeine Funktionen im Jitterbit Integration Studio

Allgemeine Funktionen sind solche Funktionen, die nicht spezifisch für eine bestimmte Interaktion sind, sondern in fast jedem Skript angewendet werden können.

ArgumentList

Deklaration

null ArgumentList(type var1[,... ])

Syntax

ArgumentList(<var1>[,... ])

Erforderliche Parameter

• var1: Eine lokale Variable, die aus der Argumentliste der aufrufenden Instanz initialisiert werden soll

Optionale Parameter

• var2,... varN: Zusätzliche Variablen, die aus der Argumentliste der aufrufenden Instanz initialisiert werden sollen

Beschreibung

Diese Funktion initialisiert eine Menge lokaler Variablen aus ihrer Argumentliste.

Die Konstruktion der lokalen Variablen hängt davon ab, welcher dieser Fälle zutrifft:

• Fall 1: Transformationszuordnungen Wenn der Funktionsaufruf in der Zuordnung eines Zielfeldes erfolgt. (Ein Aufruf der Funktion SetInstances muss zuvor erfolgt sein.) Die lokalen Variablen werden aus den entsprechenden globalen Variablen in der Instanz konstruiert, die durch die Funktion SetInstances angegeben wird.
• Fall 2: Ausführen eines Skripts Wenn der Funktionsaufruf in einem Skript erfolgt. Die lokalen Variablen werden aus den entsprechenden Argumenten in der Liste konstruiert, die durch die aufrufende RunScript-Anweisung bereitgestellt wird. Diese Variablen können auch über den Index angesprochen werden, wie _1, _2...

Ein Nullwert wird von dieser Funktion zurückgegeben und kann ignoriert werden. Als Alternative siehe die Funktion GetInstance.

Beispiele

// Assuming a parent mapping contains these statements:
...
s = "SELECT key_name, key_value, key_type FROM key_values";
r = DBLookupAll("<TAG>endpoint:database/My Database</TAG>", s);
SetInstances("DETAILS", r);
...

// In the DETAILS target node, a field could
// have as a mapping:
<trans>
ArgumentList(key, value, type);
key + " = " + value + " (of type " + type + ")";
</trans>

// This code fragment calls a script
// "CalculateDisplayString":
...
RunScript("<TAG>script:CalculateDisplayString</TAG>", "John", 35);
// The result will be the string
// "John is 35 years old."
...

// The script "CalculateDisplayString", using
// names:
<trans>
ArgumentList(name, age);
name + " is " + age + " years old.";
</trans>

// Same script "CalculateDisplayString",
// using indices:
<trans>
// ArgumentList: name, age
_1 + " is " + _2 + " years old.";
</trans>

AutoNumber

Declaration

int AutoNumber()

Syntax

AutoNumber()

Description

Gibt die Nummer einer Instanz innerhalb einer bestimmten Hierarchie zurück.

Examples

Angenommen, eine Zielarchitektur hat zwei oberste Datensätze: PO1 und PO2:

• PO1 ist ein Elternteil von drei Kinddatensätzen: PO1_record1, PO1_record2 und PO1_record3.
• PO2 ist ein Elternteil von zwei Kinddatensätzen: PO2_record1 und PO2_record2.

Wenn die Funktion AutoNumber() aufgerufen wird:

• AutoNumber() auf der Elternebene gibt 1 bei PO1 und 2 bei PO2 zurück.
• AutoNumber() auf der Kindebene von PO1 gibt 1 bei PO1_record1, 2 bei PO1_record2 und 3 bei PO1_record3 zurück, da PO1 3 Kinddatensätze hat.

CancelOperation

Declaration

void CancelOperation(string operationInstanceGUID)

Syntax

CancelOperation(<operationInstanceGUID>)

Required parameters

• operationInstanceGUID: Der String-Verweis auf den Pfad zur Operation im aktuellen Projekt, die abgebrochen werden soll

Description

Bricht eine bestimmte Operation ab, die durch den Verweis-Pfad der Operation angegeben ist. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Operationen im Abschnitt Operations in Jitterbit Script.

Wie im folgenden Beispiel gezeigt, rufen Sie die Funktion GetOperationQueue auf, um Instanzen von laufenden Operationen abzurufen. Die GUID der Betriebsinstanz befindet sich an Index 4 der von der Funktion GetOperationQueue zurückgegebenen Unterarrays. Siehe die Funktion GetOperationQueue für weitere Details.

Beispiele

// Cancel all instances of a particular
// operation
opt = "<TAG>operation:My Operation</TAG>";
queue = GetOperationQueue(opt);
n = Length(queue);
i = 0;
message = "Cancelling operation instance: ";
While(i < n, op_inst = queue[i][4];
  WriteToOperationLog(message + op_inst);
  CancelOperation(op_inst);
  i++;
);

CancelOperationChain

Deklaration

void CancelOperationChain(string message)

Syntax

CancelOperationChain(<message>)

Erforderliche Parameter

• message: Wenn es sich um eine nicht leere Zeichenfolge handelt, wird sie als Warnmeldung im Betriebsprotokoll protokolliert.

Beschreibung

Wenn die aktuelle Operation entweder Erfolgs- oder Fehlermeldungen hat, führt der Aufruf dieser Methode dazu, dass diese Operationen abgebrochen werden. Alle durch eine Bedingung verknüpften Operationen werden ebenfalls abgebrochen. Skripte in der aktuellen Operation werden jedoch abgeschlossen.

Dies kann nützlich sein, wenn eine Operation in einer Schleife ausgeführt wird und die Bedingung zum Stoppen der Schleife erreicht wurde.

Beispiele

CancelOperationChain("Die Erfolgsoperation muss nicht ausgeführt werden.");

Eval

Deklaration

string Eval(type expToEvaluate, type defaultResult)

Syntax

Eval(<expToEvaluate>, <defaultResult>)

Erforderliche Parameter

• expToEvaluate: Ein Ausdruck, der ausgewertet werden soll; wenn gültig, wird das Ergebnis zurückgegeben
• defaultResult: Standardergebnis, das ausgewertet und zurückgegeben wird, wenn expToEvaluate nicht gültig ist

Beschreibung

Bewertet das erste Argument; wenn gültig, wird das Ergebnis als Zeichenfolge zurückgegeben. Andernfalls wird der Standardwert ausgewertet und dessen Ergebnisse werden als Zeichenfolge zurückgegeben.

Dies kann als "try-catch"-Anweisung verwendet werden, da das zweite Argument nur ausgewertet wird, wenn das erste fehlschlägt.

Beispiele

// Returns a value of "100": the string
// representation of 4 multiplied by 25:
entry = Eval(4*25,"Bad Entry");

// Returns "Bad Entry", as strings cannot be
// multiplied:
book = "";
entry = Eval(book*36.4, "Bad Entry");

// Execute a SQL statement and terminate an operation if it fails:
results = Eval(
  DBLookup("<TAG>endpoint:database/My Database</TAG>",
    "SELECT col FROM table"),
  RaiseError("Failed to execute SQL statement: "
    + GetLastError())
);

Get

Deklaration

type Get(string name)

type Get(string name[, int index1, int index2,... int indexN])

type Get(array name[, int index1, int index2,... int indexN])

Syntax

Get(<name>[, <index1>, <index2>,... <indexN>])

Erforderliche Parameter

• name: Der Name einer globalen Variablen, entweder ein Skalar oder ein Array, oder ein Array

Optionale Parameter

• index1,... indexN: Indizes, die das gewünschte Element im Array oder einem Unter-Array angeben

Beschreibung

Gibt den Wert einer globalen Variablen mit einem bestimmten Namen zurück. Wenn ein Array oder der Name einer globalen Variablen, die ein Array ist, übergeben wird, gibt es ein Element des Arrays zurück. Siehe auch die ergänzende Set-Funktion.

Wenn das erste Argument entweder ein Array oder der Name einer globalen Variablen ist, die ein Array ist, ruft die Funktion ein bestimmtes Element anhand seines Index (oder Indizes für ein mehrdimensionales Array wie ein Datensatz) unter Verwendung der verbleibenden Argumente ab.

Arrays sind nullbasiert; das erste Element befindet sich an Index 0 und das letzte Element (des Arrays $array) befindet sich an Index [Length($array)-1].

Der Versuch, ein Element über das Ende des Arrays hinaus abzurufen, führt zu einem Rückgabewert von null.

Beispiele

// Returns the value of the global variable "Count"
Get("Count");

// Returns the third element of an array (0-based)
Get($arr, 2);

// For arrays, this is the same as previous,
// as "arr" is equivalent to $arr in the case of arrays
Get("arr", 2);

// Returns the n-th element of the m-th array in $arr
Get($arr, m-1, n-1);

GetChunkDataElement

Deklaration

type GetChunkDataElement(string name)

Syntax

GetChunkDataElement(<name>)

Erforderliche Parameter

• name: Der Name der Chunk-Variablen

Beschreibung

Gibt den Wert der Chunk-Variablen mit einem bestimmten Namen zurück. Eine Chunk-Variable wird ausgewertet, während jeder Chunk von Daten verarbeitet wird. Eine alternative Methode ist die Verwendung der SCOPE_CHUNK-Syntax der Set-Funktion. Siehe auch die Funktionen SetChunkDataElement und Set.

Beispiele

// If used in a transformation mapping, this sets
// the value of the chunk variable "CustomerFileName" to
// the results of a calculation using the value of the "Customer" field
// at the time of the chunking to create a filename for that chunk:

SetChunkDataElement("CustomerFilename", "customer_" + CustomerID + ".csv");

// This global variable would be available as a variable in the
// filenames field of the connection parameters of a target as:

[CustomerFilename]

// It would also be available in scripts in the same chunk as:

GetChunkDataElement("CustomerFilename");

// With each chunk created, a unique filename for that customer ID
// will be created, such as (depending on the values of CustomerID):
customer_1009.csv
customer_2019.csv
customer_5498.csv


// Returns the value of a chunk variable
result = GetChunkDataElement("Count");

GetHostByIP

Deklaration

string GetHostByIP(string ipAddress)

Syntax

GetHostByIP(<ipAddress>)

Erforderliche Parameter

• ipAddress: Ein String mit einer IP-Adresse

Beschreibung

Löst eine IP-Adresse in einen Hostnamen auf.

Beispiele

GetHostByIP("127.0.0.1");

GetInputString

Deklaration

string GetInputString(type arg)

Syntax

GetInputString(<arg>)

Erforderliche Parameter

• arg: Eine globale Variable

Beschreibung

Gibt den unformatierten Input als String zurück, basierend auf einer Quell-Globalvariable.

Dies ist nützlich, wenn die Standard-Jitterbit-Darstellung eines Datentyps (wie ein Datum oder Double) nicht geeignet ist und der "rohe" Input erforderlich ist. Wenn diese Methode auf ein Objekt aufgerufen wird, das keine Quell-Globalvariable ist, wird ein leerer String zurückgegeben.

Beispiele

// Der Input ist zu groß für ein Jitterbit Double
// gebe stattdessen den rohen Input zurück
$SessionId = GetInputString(root$transaction$body$GetMachineList$req$SessionID$)

GetLastOperationRunStartTime

Deklaration

date GetLastOperationRunStartTime(string operationId)

Syntax

GetLastOperationRunStartTime(<operationId>)

Erforderliche Parameter

• operationId: Ein String-Verweis auf einen Pfad zu einer Operation im aktuellen Projekt

Beschreibung

Gibt das letzte Datum und die Uhrzeit zurück, zu der die angegebene Operation ausgeführt wurde. Der Rückgabewert ist ein Datum (das Datum und Uhrzeit umfasst). Soll nur mit einem einzelnen privaten Agenten verwendet werden.

Die in diesem Funktionsaufruf verwendete Operation muss als Operation im aktuellen Projekt definiert sein. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Operationen im Abschnitt Operations in Jitterbit Script.

Das zurückgegebene Datum ist in UTC (ohne spezifische Zeitzone). Verwenden Sie die Funktion ConvertTimeZone, um in eine lokale Zeit zu konvertieren, wie im folgenden Beispiel gezeigt.

Beispiele

op = "<TAG>operation:MyOperation</TAG>";
lastOpRun = GetLastOperationRunStartTime(op);
// Converting to a local time zone
$lorInMyTimeZone = ConvertTimeZone(lastOpRun,
    "UTC", "CST");

GetName

Deklaration

string GetName(type arg)

Syntax

GetName(<arg>)

Erforderliche Parameter

• arg: Eine Variable oder globale Variable

Beschreibung

Gibt den Namen einer Variable oder einer globalen Variable zurück.

Bestimmte Funktionen geben ein benanntes Array globaler Variablen zurück; wenn definiert, ruft diese Funktion den Namen des Wertes ab.

Beispiele

x = {a="var1", b="var2"};
GetName(x[0]);
// Returns the string "a"
GetName(x)[0];
// Also returns the string "a"

// The source is a simple text and [] represents the source element
values = GetSourceInstanceArray([]);
// Returns the first field name of the source element
GetName(values[0]);

GetOperationQueue

Deklaration

array GetOperationQueue([string operationTag])

Syntax

GetOperationQueue([<operationTag>])

Optionale Parameter

• operationTag: Ein String-Verweis auf einen Vorgang im aktuellen Projekt; andernfalls werden alle Vorgänge im aktuellen Projekt verwendet

Beschreibung

Gibt den Inhalt der Vorgangswarteschlange als Array zurück. Es werden nur Vorgänge zurückgegeben, für die der aktuelle Benutzer Lesezugriff hat. Nur mit einem einzelnen privaten Agenten zu verwenden.

Das Ergebnis wird als Array von Arrays zurückgegeben, mit diesen Elementen in jedem Unter-Array:

• 0: Vorgangs-GUID (String)
• 1: Das IsExecuting-Flag (Boolean)
• 2: Zeitstempel (Datum), wann der Vorgang zur Warteschlange hinzugefügt wurde
• 3: Sekunden im aktuellen Status (Integer)
• 4: Vorgangsinstanz-GUID (String)
• 5: Vorgangsname (String)

Das Argument für das Vorgangs-Tag ist optional. Wenn das Argument für das Vorgangs-Tag vorhanden ist, werden nur Warteschlangeneinträge für diesen bestimmten Vorgang zurückgegeben. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Vorgängen im Abschnitt Operations in Jitterbit Script.

Beispiele

// Write the queue for a particular operation to
// the operation log:
op = "<TAG>operation:MyOperation</TAG>";
queue = GetOperationQueue(op);
n = Length(queue);
i = 0;
// Loop over the queue entries
While(i < n,
  WriteToOperationLog("Queue Entry: "
    + "GUID=" + queue[i][0]
    + "; IsExecuting=" + queue[i][1]
    + "; Added at: " + queue[i][2]);
  i++;
);

GetServerName

Deklaration

string GetServerName()

Syntax

GetServerName()

Beschreibung

Gibt den Namen der Maschine zurück, auf der der Agent ausgeführt wird.

Beispiele

GetServerName();
// Gibt den Servernamen zurück

GUID

Deklaration

string GUID()

Syntax

GUID()

Beschreibung

Gibt eine GUID-Zeichenfolge zurück (ein global eindeutiger Bezeichner, auch bekannt als universell eindeutiger Bezeichner oder UUID).

Das Format der GUID ist xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, wobei M die Version (4) und N die Variante (8) ist.

Beispiele

GUID();
// Gibt eine Zeichenfolge wie "c056f89d-1f45-458e-8b25-9ecf2ed10842" zurück

IfEmpty

Deklaration

type IfEmpty(type arg, type default)

Syntax

IfEmpty(<arg>, <default>)

Erforderliche Parameter

• arg: Ein Argument, das ausgewertet wird, um zu prüfen, ob es null oder eine leere Zeichenfolge ist
• default: Standardwert, der zurückgegeben wird, wenn arg null oder eine leere Zeichenfolge ist

Beschreibung

Gibt den Standardwert zurück, wenn das erste Argument null ist oder die Zeichenfolgendarstellung des Arguments eine leere Zeichenfolge ist. Andernfalls wird das erste Argument zurückgegeben. Dies ist eine Abkürzung für eine If-Funktionsanweisung:

If(IsNull(arg)| |Length(arg)==0, default, arg)

Siehe auch die Funktion IsNull.

Beispiele

// Wenn die Variable "myDate" null oder leer ist,
// gibt das aktuelle Datum zurück, andernfalls "myDate"
result = IfEmpty(myDate, Now());

IfNull

Deklaration

type IfNull(type arg, type default)

Syntax

IfNull(<arg>, <default>)

Erforderliche Parameter

• arg: Ein Argument, das ausgewertet wird, um zu prüfen, ob es null ist
• default: Standardwert, der zurückgegeben wird, wenn arg null ist

Beschreibung

Gibt den Standardwert zurück, wenn das erste Argument null ist, andernfalls wird das erste Argument zurückgegeben.

Dies ist eine Abkürzung für eine If-Funktionsanweisung:

If(IsNull(arg), default, arg)

Siehe auch die Funktionen IsNull und IfEmpty.

Beispiele

// Wenn die Variable "myDate" null ist,
// gibt das aktuelle Datum zurück, andernfalls gibt es "myDate" zurück
result = IfNull(myDate, Now());

InitCounter

Deklaration

long InitCounter(type counter[, long initialValue])

Syntax

InitCounter(<counter>, <initialValue>)

Erforderliche Parameter

• counter: Der Name einer Variablen oder ein Verweis auf eine globale Variable, die als Zähler verwendet werden soll

Optionale Parameter

• initialValue: Der Anfangswert, auf den der Zähler gesetzt werden soll; Standard ist 0

Beschreibung

Initialisiert einen Zähler und übergibt optional einen Anfangswert. Soll nur mit einem einzelnen Agenten verwendet werden.

Wenn kein Anfangswert gesetzt ist, wird der Anfangswert auf 0 gesetzt. Das erste Argument ist entweder der Name einer Variablen oder ein Verweis auf eine Variable (siehe die Beispiele). Diese Methode muss nur in ein-Thread-Kontexten aufgerufen werden. Der Aufruf dieser Methode in einem mehr-Thread-Kontext führt zu einem Fehler. Siehe auch Variablen mit Chunking verwenden unter Betriebsoptionen.

Beispiele

// Initialize counter to 0 using the name of a global variable
InitCounter("counter");

// Initialize counter to 100 using a reference to a global variable
InitCounter($counter, 100);

InList

Deklaration

int InList(type x[, type arg1, ... type argN])

Unterstützte Datentypen für type

int, float, long, double, string, bool, date, binary, collection, map

Syntax

InList(<x>[, <arg1>, ... <argN>])

Erforderliche Parameter

• x: Ein Element, das auf Übereinstimmung überprüft werden soll

Optionale Parameter

• arg1...argN: Eine Reihe von Argumenten, mit denen x verglichen werden soll

Beschreibung

Überprüft, ob x in der Liste der Argumente (arg1 bis argN) enthalten ist. Wenn eine Übereinstimmung (nach Wert) gefunden wird, gibt diese Funktion eine Ganzzahl zurück, die die Position der Übereinstimmung in der Liste darstellt, wobei die erste Position in der Liste durch die Ganzzahl 1 dargestellt wird.

Wenn die Liste mehr als eine Instanz von x enthält, gibt diese Funktion die Position der ersten Übereinstimmung zurück (die Übereinstimmung mit dem niedrigsten Positionsindex). 0 wird zurückgegeben, wenn die Liste keinen übereinstimmenden Wert enthält oder wenn nur ein einzelnes Argument bereitgestellt wird.

Beispiele

InList("x","a","b","c","x");
// Returns 4

InList("a","a","b","c","a");
// Returns 1

InList("x","a","b","c");
// Returns 0

InList("x");
// Returns 0

InList("1", 123, "12", true);
// Returns 3 due to implicit conversion

IsInteger

Deklaration

bool IsInteger(type x)

Syntax

IsInteger(<x>)

Erforderliche Parameter

• x: Ein zu bewertendes Element

Beschreibung

Gibt true zurück, wenn das Argument vom Typ Integer oder Long ist oder ohne Informationsverlust in einen Integer oder Long konvertiert werden kann.

Beispiele

$s="1";
IsInteger($s);
// Returns true
$s="1a";
IsInteger($s);
// Returns false
$s=12.12;
IsInteger($s);
// Returns false
$s=12.00;
IsInteger($s);
// Returns true

IsNull

Deklaration

bool IsNull(type x)

Syntax

IsNull(<x>)

Erforderliche Parameter

• x: Ein zu bewertendes Element

Beschreibung

Gibt true zurück, wenn das Argument null ist. Gilt für Datenbankfelder, Variablen und Funktionen, die null zurückgeben können.

Siehe auch die Funktionen IfNull und IfEmpty für Abkürzungen, die anstelle dieser Funktion verwendet werden können.

Beispiele

// Wenn der "POHeader.Vendor_Code" null ist,
// gibt er den String "VC" zurück, andernfalls gibt er den Code zurück
If(IsNull(POHeader.Vendor_Code), POHeader.Vendor_Code, "VC")

IsValid

Deklaration

bool IsValid(type x)

Syntax

IsValid(<x>)

Erforderliche Parameter

• x: Ein zu bewertendes Element

Beschreibung

Gibt true zurück, wenn die Auswertung des Arguments ohne Fehler erfolgt.

Beispiele

IsValid(Date("abc"))
// Returns false, since the string "abc"
// cannot be successfully converted to a date

IsValid(3/0)
// Returns false, since division by 0
// is not permitted

IsValid(0/3)
// Returns true, since 0/3 is a legal expression
// evaluating to 0

Length

Deklaration

int Length(type x)

Syntax

Length(<x>)

Erforderliche Parameter

• x: Ein Element, das ausgewertet werden soll

Beschreibung

Gibt die Länge des Eingabearguments zurück.

Das Verhalten dieser Methode hängt vom Argumenttyp ab:

• string: die Länge des Strings wird zurückgegeben
• array: die Anzahl der Elemente im Array wird zurückgegeben
• binäre Daten: die Anzahl der Bytes wird zurückgegeben
• Für alle anderen Typen wird versucht, das Argument in einen String zu konvertieren, und die Länge des resultierenden Strings wird zurückgegeben.
• Wenn das Argument nicht in einen String konvertiert werden kann oder das Argument null oder von unbekanntem Typ ist, wird 0 zurückgegeben.

Beispiele

// String length:
Length("Mississippi"); // returns 11

// Array length:
// Count the number of email address nodes
$nodes = SelectNodesFromXMLAny("cust:EmailAddress", Customer$Any#.,
"cust=urn:xmlns:25hoursaday-com:customer");
Length($nodes);

// Binary arguments:
Length(HexToBinary("b2082fee"));
// Returns 4, because the input is a 4-byte binary value

// Numeric arguments:
Length(1234567); // Returns 7
Length(123.45678); // Returns 9

// Miscellaneous:
Length(true); // Returns 1
Length(Now()); // Returns 19 since the default date format is "yyyy-MM-DD hh:mm:ss"
Length(Null()); // Returns 0

Null

Deklaration

null Null()

Syntax

Null()

Beschreibung

Gibt null zurück.

Beispiele

Diese Funktion kann verwendet werden, um einen null-Wert in bestimmte Spalten einer Datenbank einzufügen.

Random

Deklaration

int Random(int min, int max)

Syntax

Random(<min>, <max>)

Erforderliche Parameter

• min: Ganzzahlwert der minimalen Zufallszahl
• max: Ganzzahlwert der maximalen Zufallszahl

Beschreibung

Generiert eine zufällige ganze Zahl zwischen den angegebenen Minimal- und Maximalwerten, einschließlich dieser Werte. Siehe auch die Funktion RandomString.

Beispiele

// Creates a random number from 0 to 9999999 (inclusive)
Random(0, 9999999);


// Creates a random number from 1 to 10
Random(1, 10);
// Returns a random 7-character string
// using the characters "0123456789"
RandomString(7, "0123456789");

// Returns a random 5-digit hexadecimal string
RandomString(5, "0123456789ABCDEF");

// Returns a random 7-digit integer string
// with no leading zeroes
RandomString(1, "123456789") +
  RandomString(6, "0123456789");

RandomString

Deklaration

string RandomString(int len[, string chars])

Syntax

RandomString(<len>[, <chars>])

Erforderliche Parameter

• len: Länge des resultierenden zufälligen Strings

Optionale Parameter

• chars: Zeichenkette, die die Zeichen enthält, die im resultierenden zufälligen String verwendet werden

Beschreibung

Generiert einen zufälligen String der angegebenen Länge. Standardmäßig verwendet die Funktion alphanumerische Zeichen; die Menge umfasst a-z, A-Z und 0-9. Siehe auch die Funktion Random.

Beispiele

// Creates a random 5-digit hexadecimal string
RandomString(5, "0123456789ABCDEF");

// Creates a random 7-digit integer string
// with no leading zeroes
RandomString(1, "123456789") + RandomString(6, "0123456789");

ReadArrayString

Deklaration

array ReadArrayString(string arrayString[, string type])

Syntax

ReadArrayString(<arrayString>[, <type>])

Erforderliche Parameter

• arrayString: Eine Zeichenkette, die ein Array darstellt

Optionale Parameter

• type: Eine Zeichenkette, die den Typ beschreibt, den die Array-Zeichenkette darstellt, wie "string", "int", "double", "bool"

Beschreibung

Liest eine Zeichenkette, die ein eindimensionales oder mehrdimensionales Array darstellt.

Das Array wird dargestellt, indem die Array-Elemente mit einem Paar geschweifter Klammern ('{' und '}') umschlossen werden. Jedes Array-Element kann ein Array oder ein skalare Element sein, die durch ein Komma (',') getrennt sind. Die Elemente in einem Array müssen entweder alle Skalarwerte oder alle Arrays sein.

Der skalare Wert kann durch einen CSV-String dargestellt werden. Doppelte Anführungszeichen zur Einfassung des Strings sind optional, es sei denn, der String enthält Sonderzeichen wie ",{}\n (doppelte Anführungszeichen, Komma, geschweifte Klammern, Tabs, Zeilenumbrüche oder Wagenrückläufe). Innerhalb des doppelt angeführten Strings muss jedes doppelte Anführungszeichen durch zwei doppelte Anführungszeichen escaped werden. Das optionale zweite Argument dient dazu, den Datentyp des skalarwerts anzugeben. Der Typ wird als String angenommen, wenn er nicht ausdrücklich angegeben ist.

Beispiele

// One-dimensional array with four string values
ReadArrayString("{John,Steve,Dave,Eric}");

// One-dimensional array with three boolean values
ReadArrayString("{1,0,1}", "bool");

// Two-dimensional array
// The first array element is an array with three string values
// The second array element is an array with two string values
// The second element of the second array contains a trailing line break
ReadArrayString('{{abc,"a,b","a""b"},{"de","d
"}}');

RecordCount

Deklaration

int RecordCount()

Syntax

RecordCount()

Beschreibung

Gibt die Instanznummer der Zielschleife zurück, die derzeit generiert wird.

Wenn es in einer Bedingung aufgerufen wird, gibt es die Instanznummer der letzten generierten Instanz zurück. Beim ersten Aufruf dieser Methode in einer Schleife gibt es 0 (null) zurück, wenn es in einer Bedingung aufgerufen wird; andernfalls gibt es 1 (eins) zurück. Der Zähler wird jedes Mal auf 0 zurückgesetzt, wenn eine neue Schleife gestartet wird.

Beispiele

RecordCount() gibt einen Wert von 5 zurück, während die fünfte Zeile in einem Zielschleifen-Knoten generiert wird.

ReRunOperation

Deklaration

bool ReRunOperation([bool runSynchronously])

Syntax

ReRunOperation([<runSynchronously>])

Optionale Parameter

• runSynchronously: Flag, um anzugeben, ob die Operation synchron (Standard) oder asynchron ausgeführt werden soll.

Beschreibung

Führt die aktuelle Operation erneut aus.

Das Verhalten dieser Methode in Bezug auf den Rückgabewert und globale Variablen ist identisch mit der Funktion RunOperation. Siehe diese Funktion für eine Beschreibung, wie das erneute Ausführen der Operation synchron oder asynchron globale Variablen beeinflusst.

Beispiele

ReRunOperation();
// Re-runs the current operation synchronously
ReRunOperation(false);
// Re-runs the current operation asynchronously

RunOperation

Deklaration

bool RunOperation(string operationId[, bool runSynchronously])

Syntax

RunOperation(<operationId>[, <runSynchronously>])

Erforderliche Parameter

• operationId: Ein String-Referenzpfad zu einer Operation im aktuellen Projekt

Optionale Parameter

• runSynchronously: Flag, um anzugeben, ob die Operation synchron (Standard) oder asynchron ausgeführt werden soll

Beschreibung

Ruft eine Operation synchron oder asynchron auf, wobei synchron die Standardoption ist.

Die in diesem Funktionsaufruf verwendete Operation muss als Operation im aktuellen Projekt definiert sein. Für weitere Informationen siehe die Anweisungen zum Einfügen von Operationen im Abschnitt Operationen in Jitterbit Script.

Synchronizität

Wenn run_synchronously true ist, wird die aufgerufene (Kind-)Operation oder Operationenkette sequenziell von der aufrufenden (Eltern-)Operation ausgeführt. Alle globalen Variablen werden von der Kindoperation geerbt, und alle Änderungen an den globalen Variablen werden in der Elternoperation widergespiegelt. Dies ist das Standardverhalten, wenn das zweite Argument nicht angegeben ist. Gibt false zurück, wenn die aufgerufene Operation zu einem Fehler geführt hat.

Wenn run_synchronously false ist, wird die aufgerufene (Kind-)Operation oder Operationenkette gleichzeitig mit der aufrufenden (Eltern-)Operation ausgeführt. Die aufgerufene Operation wird der Jitterbit-Verarbeitungsschlange hinzugefügt, um verarbeitet zu werden, sobald alle vorhergehenden Operationen verarbeitet wurden. Alle globalen Variablen werden von der Kindoperation geerbt, aber Änderungen an diesen Variablen werden nicht in der Elternoperation widergespiegelt. Die Elternoperation wird unabhängig von der Kindoperation weiterlaufen, und es gibt keine Garantie dafür, welche Operation zuerst abgeschlossen wird. Gibt false zurück, wenn die Kindoperation nicht zur Warteschlange hinzugefügt werden konnte. Im asynchronen Modus werden diese globalen Variablen durch Wert und nicht durch Referenz an die aufgerufene Operation übergeben, was sicherstellt, dass Änderungen an den Variablen nicht in anderen Operationen widergespiegelt werden.

Für weitere Informationen siehe Synchronicity, wie sie für das Invoke Operation (Beta) Tool beschrieben ist.

Wenn die Funktion false zurückgibt, um einen Fehler anzuzeigen, oder wenn die aufgerufene Operation nicht in die Warteschlange gestellt werden konnte, rufen Sie GetLastError auf, um die Fehlermeldung abzurufen.

Beispiele

// Führt die "MyOp" aus
RunOperation("<TAG>operation:MyOp</TAG>");

RunPlugin

Deklaration

bool RunPlugin(string pluginId)

Syntax

RunPlugin(<pluginId>)

Erforderliche Parameter

• pluginId: Ein String-Verweis auf einen Plugin im aktuellen Projekt

Beschreibung

Führt ein angegebenes Plugin aus und setzt dann die Ausführung des aktuellen Skripts fort. Wenn mehrere Versionen eines Plugins auf einem Agenten installiert sind, wird die höchste verfügbare Version verwendet.

Im Integration Studio UI werden nur die Plugins angezeigt, die innerhalb eines Skripts ausgeführt werden können; Plugins, die bei Aktivitäten ausgeführt werden, sind ausgeblendet. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Plugins im Abschnitt Plugins in Jitterbit Script.

Gibt true zurück, wenn das Plugin ohne Fehler abgeschlossen wird. Gibt false zurück, wenn das Plugin nicht ausgeführt werden konnte oder die Plugin-Implementierung selbst einen Fehler zurückgab. Rufen Sie GetLastError auf, um die Fehlermeldung abzurufen.

Beispiele

// Führt das Jitterbit HMACSHA1Generator-Plugin aus
RunPlugin("<TAG>plugin:http://www.jitterbit.com/plugins/pipeline/user/HMACSHA1Generator</TAG>");

RunScript

Deklaration

string RunScript(string scriptId[, type var1, type var2, ..., type varN])

Syntax

RunScript(<scriptId>[, <var1>, <var2>, ..., <varN>])

Erforderliche Parameter

• scriptId: Ein String-Verweis auf ein Skript im aktuellen Projekt

Optionale Parameter

• var1...varN: Zusätzliche Variablen, die an das aufgerufene Skript übergeben werden sollen

Beschreibung

Führt das angegebene Skript aus und setzt dann die Ausführung des aktuellen Skripts fort. Diese Methode gibt bei Erfolg den Rückgabewert des aufgerufenen Skripts als String zurück.

Das in diesem Funktionsaufruf verwendete Skript muss entweder als Jitterbit Script oder JavaScript im aktuellen Projekt definiert sein. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Skripten unter Jitterbit Script oder JavaScript.

Eine Liste von Werten kann als Eingangsvariablen an eine RunScript-Funktion übergeben werden. Das Skript erstellt lokale Variablen mit diesen Werten unter Verwendung von Standardnamen wie _1, _2 ....

Wenn umfassende Namen bevorzugt werden, kann die ArgumentList-Funktion verwendet werden, um eine Liste von lokalen Variablennamen der Liste von _1, _2 ... zuzuordnen. Siehe die ArgumentList-Funktion für Beispiele.

Beispiele

// Runs the script "CalculateStuff"
RunScript("<TAG>script:CalculateStuff</TAG>");

RunScript("<TAG>script:CalculateStuff</TAG>",
   "abc", 1);

// Sends the script "CalculateStuff" the
// string "abc" and the number 1
// Inside "CalculateStuff", these will be
// available as _1 and _2

Set

Deklaration

type Set(string name, type value)

type Set(string name, type value, int index1[, int index2, ..., int indexN])

type Set(array name, type value, int index1[, int index2, ..., int indexN])

Syntax

Set(<name>, <value>[, <index1>, <index2>, ..., <indexN>])

Erforderliche Parameter

• name: Der Name einer globalen Variable, entweder ein Skalar oder ein Array
• value: Ein Wert, der der globalen Variable zugewiesen werden soll

Optionale Parameter

• index1...indexN: Index oder Indizes, die verwendet werden, um die Position eines Elements zu beschreiben, wenn ein Element in einem Array gesetzt wird

Beschreibung

Setzt den Wert einer globalen Variable mit einem gegebenen Namen auf einen Wert und gibt den Wert zurück. Siehe auch die ergänzende Get-Funktion.

Erste Form: Skalare

In der ersten Form wird ein String-Name einer globalen Variablen mit dem angegebenen Namen und Wert festgelegt.

(Obwohl eine lokale Variable als Referenz übergeben werden kann, wird dies nicht empfohlen, da die Ergebnisse inkonsistent sein können. Lokale Variablen sind nicht dafür gedacht, über diesen Mechanismus gesetzt zu werden.)

Siehe die Beispiele unten.

Zweite und dritte Form: Arrays

In der zweiten und dritten Form liefern zusätzliche Argumente die Indizes zum Setzen eines Elements in einem Array.

Wenn das erste Argument ein Array (oder der Name einer globalen Variablen, die ein Array ist) ist, können Sie den Wert eines Array-Elements festlegen, indem Sie seinen Index (oder Indizes für mehrdimensionale Arrays) als zusätzliche Argumente angeben.

Um Daten zu einem Array hinzuzufügen, übergeben Sie entweder einen negativen Indexwert oder die Größe des Arrays. Die Größe kann mit der Funktion Length als Length($array) bestimmt werden.

Arrays sind nullbasiert; das erste Element befindet sich am Index 0 und das letzte Element (des Arrays $array) befindet sich am Index [Length($array)-1]. Arrays können entweder mit den Funktionen Array oder ReadArrayString erstellt werden.

Der Versuch, ein Element über das Ende des Arrays hinaus zu setzen, führt dazu, dass zusätzliche Nullwert-Elemente zum Array hinzugefügt werden, um das Array auf die richtige Größe zu polstern.

SCOPE_CHUNK-Präfixsyntax

Das Setzen eines Variablennamens, der mit dem Ausdruck SCOPE_CHUNK beginnt, erstellt eine globale Variable, die ausgewertet wird, während jeder Datenchunk verarbeitet wird. Dies kann bei der Erstellung von globalen Variablen verwendet werden, deren Wert einzigartig für einen bestimmten Chunk ist, und kann dann diesen Chunk identifizieren, wenn eine Datei oder ein Datensatz an einem Ziel erstellt wird. Siehe auch die Funktionen GetChunkDataElement und SetChunkDataElement als alternative Methode, die die Verwendung anderer Variablennamen ermöglicht.

Siehe zusätzliche Beispiele zur Verwendung von SCOPE_CHUNK, um flache CSV-Daten oder hierarchische JSON-Daten zu chunkieren unter Eine Datei in einzelne Datensätze aufteilen.

Beispiele

// Scalars:
// All of these forms are equivalent:
// they increase the global variable "count" by 1
result1 = Set("count", Get("count")+1);
$count++;
$count = $count + 1;

// Arrays:
// Appending a value to the array "arr"
// These are equivalent
Set($arr, "value", -1);
Set($arr, "value", Length($arr));

// Set the n:th entry in an array "arr"
// to the string "value"
Set($arr, "value", n-1);

// Set the n:th entry of the m:th array
// of "record_set"
Set($record_set, "value", m-1, n-1);

// SCOPE_CHUNK Prefix:
// Example from a mapping using the SCOPE_CHUNK syntax to
// create a global variable that is unique in value to a
// particular chunk.
// It uses the field "CustomerID" to identify the chunk:

Set("SCOPE_CHUNK_CustomerID",
    "customer_"+CustomerID+".csv");

// This variable will be available in the filenames field of
// the connection parameters of a target as:

[SCOPE_CHUNK_CustomerID]

// With each chunk created, a unique filename for that
// customer ID will be created, such as (depending on the
// values of Customer ID):
customer_1009.csv
customer_2019.csv
customer_5498.csv

SetChunkDataElement

Deklaration

type SetChunkDataElement(string name, type value)

Syntax

SetChunkDataElement(<name>, <value>)

Erforderliche Parameter

• name: Der Name der Chunk-Variablen
• value: Der Wert, auf den die Chunk-Variable gesetzt werden soll

Beschreibung

Setzt den Wert einer bestimmten Chunk-Variablen und gibt den Wert zurück. Eine Chunk-Variable wird ausgewertet, während jeder Chunk von Daten verarbeitet wird. Eine alternative Methode ist die Verwendung der SCOPE_CHUNK Syntax der Set Funktion.

Siehe auch die Funktionen GetChunkDataElement und Set.

Beispiele

// If used in a transformation mapping, this sets
// the value of the chunk variable "CustomerFileName"
// to the results of a calculation using the value of
// the "Customer" field at the time of the chunking
// to create a filename for that chunk:

SetChunkDataElement("CustomerFilename",
    "customer_"+CustomerID+".csv");

// This global variable would be available as a
// variable in the filenames field of the connection
// parameters of a target as:

[CustomerFilename]

// It would also be available in scripts in the same
// chunk as:

GetChunkDataElement("CustomerFilename");

// With each chunk created, a unique filename for that
// customer ID will be created, such as (depending on
// the values of Customer ID):
customer_1009.csv
customer_2019.csv
customer_5498.csv

Sleep

Deklaration

void Sleep(int seconds)

Syntax

Sleep(<seconds>)

Erforderliche Parameter

• seconds: Die Ganzzahlanzahl von Sekunden, um die aktuelle Operation zu unterbrechen

Beschreibung

Verursacht, dass die Ausführung für eine bestimmte Anzahl von Sekunden unterbrochen wird.

Beispiele

// Unterbricht die aktuelle Operation für 1 Minute
Sleep(60);

SourceInstanceCount

Deklaration

int SourceInstanceCount()

Syntax

SourceInstanceCount()

Beschreibung

Gibt die Instanzanzahl des zuletzt verwendeten Generators zurück.

Der Wert ist unabhängig davon, ob die Zielinstanz generiert wurde oder nicht; derselbe Wert wird zurückgegeben, wenn er in einem Bedingungsskript oder in einem Mapping-Skript aufgerufen wird.

Wenn die erste Quellinstanz als Generator verwendet wird, wird 1 zurückgegeben, dann 2 und so weiter.

Siehe auch die Funktion TargetInstanceCount.

Siehe ein zusätzliches Beispiel zur Verwendung von SourceInstanceCount unter Teilen einer Datei in einzelne Datensätze mit SourceInstanceCount.

Beispiele

// Gibt die Instanzanzahl des zuletzt verwendeten Generators zurück
currentSourceInstance = SourceInstanceCount();

TargetInstanceCount

Deklaration

int TargetInstanceCount()

Syntax

TargetInstanceCount()

Beschreibung

Gibt die Instanzanzahl eines generierenden Zielschleifen-Knotens zurück.

Wenn sie in einer Bedingung aufgerufen wird, gibt sie die Anzahl der Zielinstanzen zurück, die bisher für den aktuellen Schleifenknoten generiert wurden. Die von dieser Methode zurückgegebene Zahl wird um eins geringer sein, wenn sie in einer Bedingung aufgerufen wird, da in einer Bedingung nicht bekannt ist, ob die aktuelle Zielinstanz generiert wird oder nicht.

Wenn die erste Zielinstanz generiert wird, wird 1 zurückgegeben, dann 2 und so weiter. Wenn sie in einer Bedingung aufgerufen wird, wird die Sequenz stattdessen 0, 1 und so weiter sein.

Siehe auch die Funktion SourceInstanceCount.

Beispiele

// Gibt die Instanzanzahl des zuletzt verwendeten Zielgenerators zurück
currentTargetInstance = TargetInstanceCount();

WaitForOperation

Deklaration

void WaitForOperation(string operationId[, int timeOutSec, int pollIntervalSec])

Syntax

WaitForOperation(<operationId>[, <timeOutSec>, <pollIntervalSec>])

Erforderliche Parameter

• operationID: Ein String-Verweis auf eine Operation im aktuellen Projekt

Optionale Parameter

• timeOutSec: Eine lokale Variable
• pollIntervalSec: Eine lokale Variable

Beschreibung

Stoppt die Ausführung eines Skripts oder einer Zuordnung, bis alle Instanzen der angegebenen Operation, die sich derzeit in der Betriebsschlange befinden, die Verarbeitung abgeschlossen haben. Diese Methode ist nützlich, wenn viele Instanzen einer Operation zur Warteschlange für die parallele Verarbeitung hinzugefügt werden sollen und dann auf deren Abschluss gewartet werden soll.

Die in diesem Funktionsaufruf verwendete Operation muss als Operation im aktuellen Projekt definiert sein. Weitere Informationen finden Sie in den Anweisungen zum Einfügen von Operationen im Abschnitt Operations in Jitterbit Script.

Hinweis:

• Für jede Operation (identifiziert durch ihre operationID), auf die gewartet werden soll, muss ein Aufruf dieser Methode erfolgen.
• Operationen, die (durch Aufrufe der Funktion RunOperation) nach diesem Aufruf hinzugefügt werden, werden nicht berücksichtigt.
• Der aktuelle Benutzer muss Lesezugriff auf die Operation haben, auf die gewartet wird.

Das zweite (optionale) Argument ist das Timeout in Sekunden. Das Standard-Timeout beträgt 1 Stunde (3600 Sekunden), und wenn alle Operationen innerhalb dieser Zeit nicht abgeschlossen sind, wird ein Fehler ausgelöst. Wenn Sie erwarten, dass Ihre Operationen unter normalen Bedingungen länger laufen, müssen Sie das Timeout erhöhen. Sie können diesen Fehler mit der Funktion Eval behandeln.

Das dritte (optionale) Argument ist das Abfrageintervall in Sekunden. Das Abfrageintervall ist die Zeit zwischen den Überprüfungen der Betriebsschlange. Das Standard-Abfrageintervall beträgt 10 Sekunden. Das Standardintervall wird keine signifikante Leistungseinbuße verursachen, aber wenn Ihre Operationen voraussichtlich sehr lange laufen, möchten Sie möglicherweise das Abfrageintervall erhöhen.

Beispiele

// Add ten operation instances to the queue
// and wait for all of them to finish
i = 0;
while(i < 10,
  RunOperation("<TAG>operation:MyOperation</TAG>", false);
  i++;
);

WaitForOperation("<TAG>operation:MyOperation</TAG>");