Zum Inhalt springen

Jitterbit-Variablen in Design Studio

Übersicht

Jitterbit-Variablen sind einer der drei Typen globaler Datenelemente, die in Harmony verfügbar sind. (Die beiden anderen Typen globaler Datenelemente – globale Variablen und Projektvariablen – sind ebenfalls global im gesamten Projekt verfügbar. Sie werden anders festgelegt, wie in Globale Variablen und Projektvariablen beschrieben.)

Die Jitterbit-Variablen sind immer im gesamten Projekt verfügbar. Sie werden von Jitterbit vordefiniert oder in der Jitterbit-Konfigurationsdatei festgelegt.

Die häufigsten Anwendungsfälle für Jitterbit-Variablen sind das Lesen einer Variablen, um Informationen darüber zu sammeln, was während eines Vorgangs aufgetreten ist, oder das Abrufen globaler Informationen wie dem Namen der aktuellen Quelldatei. Seltener werden Jitterbit-Variablen geschrieben, wenn Standardeinstellungen für die Verarbeitung der Vorgangskette geändert werden.

Wenn eine Jitterbit-Variable die Funktionsweise einer Funktion beeinflusst, muss sie vor dem Funktionsaufruf festgelegt werden. Vorgelagerte Vorgänge oder Skripte sind solche, die innerhalb einer Vorgangskette mithilfe von Vorgangsaktionen oder den Funktionen RunOperation oder RunScript verknüpft sind. Vorgelagert bezieht sich in diesem Kontext auch auf das Ändern des Werts der Jitterbit-Variablen im selben Skript, aber vor dem Funktionsaufruf.

Da es sich um vordefinierte Variablen handelt, erstellen oder ändern Projekte sehr selten den Standardwert einer Jitterbit-Variablen. Bei Verwendung eines privaten Agenten können Jitterbit-Variablen jedoch erstellt oder ihr Standardwert geändert werden. Weitere Informationen finden Sie unter Neue Variablen erstellen oder Standardwerte auf privaten Agenten festlegen.

Weitere Informationen zu den vordefinierten Jitterbit-Variablen finden Sie auf diesen Seiten:

Anzeige von Jitterbit-Variablen

Bei der Gestaltung des Projekts sind Jitterbit-Variablen auf der Registerkarte Datenelemente des Script-Builders verfügbar, auf den über die Skripte und Transformationsbildschirme zugegriffen werden kann. Jede von Jitterbit vordefinierte Jitterbit-Variable ist auf einer Seite in diesem Abschnitt dokumentiert.

Jitterbit-Variablen in Skripten oder Transformationen festlegen

Der häufigste Anwendungsfall für Jitterbit-Variablen ist das Lesen von Informationen. Es gibt jedoch einige Jitterbit-Variablen, die man festlegen kann, um etwas an einen Agent zu kommunizieren. In Studio lassen sich Jitterbit-Variablen mit Jitterbit Script oder JavaScript festlegen, genauso wie jede globale Variable.

Tipp

In der Dokumentation für jede Jitterbit-Variable findet man Informationen darüber, welche Variablen festgelegt werden können und auf welche Werte man sie setzen kann.

Jitterbit Script

In Jitterbit Script, das in Skripten und Transformationen verwendet wird, lässt sich der Wert einer Jitterbit-Variable durch ein Dollarzeichen $ oder durch Aufrufen der Funktion Set() festlegen.

  • $: Mit der Syntax $ setzt $jitterbit.api.response="Success" die API-Antwort (jitterbit.api.response) so, dass die Zeichenkette "Success" an die anfragende Anwendung zurückgegeben wird.
  • Set: Mit der Funktion Set() setzt Set("jitterbit.api.response", "Success") die API-Antwort (jitterbit.api.response) so, dass die Zeichenkette "Success" an die anfragende Anwendung zurückgegeben wird.

In Skripten und Transformationen werden Jitterbit-Variablen auch im Tab Variablen der Skriptkomponentenpalette im Unter-Tab Jitterbit-Variablen angezeigt.

JavaScript

In JavaScript, das in Skripten verwendet wird, die als Projektkomponente erstellt wurden, lassen sich von Jitterbit vordefinierte Jitterbit-Variablen nur mit der Funktion Jitterbit.SetVar festlegen. Das liegt daran, dass alle von Jitterbit vordefinierten Jitterbit-Variablen Punkte im Variablennamen enthalten.

  • Jitterbit.SetVar: Mit Jitterbit.SetVar setzt das Codebeispiel Jitterbit.SetVar("$jitterbit.api.response", "Success") die API-Antwort so, dass die Zeichenkette "Success" an die anfragende Anwendung zurückgegeben wird.

In Skripten und Transformationen werden Jitterbit-Variablen auch im Tab Variablen der Skriptkomponentenpalette im Unter-Tab Jitterbit-Variablen angezeigt.

Warnung

Die JavaScript-Funktionen Jitterbit.SetVar und Jitterbit.GetVar sind speziell für den Zugriff auf die vordefinierten Jitterbit-Variablen konzipiert. Sie sind nicht für den Zugriff auf benutzerdefinierte globale Variablen gedacht.

In JavaScript sollte man die Verwendung von SetVar (und GetVar) nicht mit dem Präfix $ vermischen, wenn man eine Variable festlegt (und abruft). Man sollte nur eine Syntax verwenden. Das Vermischen der beiden verschiedenen Syntaxen für dieselbe Variable kann zu Problemen zur Laufzeit führen.

Jitterbit-Variablen in Skripten oder Transformationen abrufen

Der Wert einer Jitterbit-Variable lässt sich mit Jitterbit Script (in Skripten oder Transformationen) oder mit JavaScript (nur in Skripten, die als Projektkomponente erstellt wurden) abrufen, genauso wie eine globale Variable abgerufen werden kann.

Warnung

Es gibt ein bekanntes Problem, bei dem Zuordnungsvariablen mit Punkten im Variablennamen nicht korrekt funktionieren, was zu einer falschen Zielfeldzuordnung in der Transformation führt. Bis dieses Problem behoben ist, können Jitterbit-Variablen nicht direkt in einer Transformation referenziert werden. Mit Skripten lässt sich ein Workaround-Mechanismus erstellen, um Werte zu übergeben.

Jitterbit Script

In Skripten und Transformationen lässt sich der Wert einer Jitterbit-Variable durch ein Dollarzeichen $ oder durch Verwendung der Funktion Get() abrufen:

  • $: Mit dem Präfix eines Dollarzeichens $ ruft das Codebeispiel $jitterbit.operation.error den Wert der Jitterbit-Variable "jitterbit.operation.error" ab.
  • Get: Mit der Funktion Get() gibt das Codebeispiel Get("jitterbit.operation.error") denselben Wert zurück.

In Skripten und Transformationen werden Jitterbit-Variablen auch im Tab Variablen der Skriptkomponentenpalette unter dem Untertab Jitterbit-Variablen angezeigt.

JavaScript

In JavaScript-Skripten innerhalb eines Vorgangs können auf vordefinierte Jitterbit-Variablen nur mit den Funktionen Jitterbit.SetVar und Jitterbit.GetVar zugegriffen werden. Dies liegt daran, dass alle von Jitterbit vordefinierten Jitterbit-Variablen Punkte im Variablennamen enthalten.

  • Jitterbit.GetVar: Mit Jitterbit.GetVar gibt das Codebeispiel Jitterbit.GetVar("$jitterbit.operation.error") den Wert der Jitterbit-Variable "jitterbit.operation.error" zurück. Beachten Sie, dass ein führendes Dollarzeichen $ beim Abrufen von Werten optional ist. Die Namen jitterbit.operation.name und $jitterbit.operation.name sind beim Abrufen von Werten gleichwertig.

Warnung

Die JavaScript-Funktionen Jitterbit.SetVar und Jitterbit.GetVar sind speziell für den Zugriff auf vordefinierte Jitterbit-Variablen konzipiert. Sie sind nicht für den Zugriff auf benutzerdefinierte globale Variablen bestimmt.

In JavaScript darf man die Verwendung von SetVar (und GetVar) mit $-Präfixierung beim Setzen (und Abrufen) einer Variable nicht vermischen. Verwenden Sie nur eine Syntax. Das Vermischen der beiden verschiedenen Syntaxen für dieselbe Variable kann zu Problemen zur Laufzeit führen.

In Skripten und Transformationen werden Jitterbit-Variablen auch im Tab Variablen der Skriptkomponentenpalette unter dem Untertab Jitterbit-Variablen angezeigt.

Jitterbit-Variablen in Definitionsbildschirmen verwenden

In einem Definitionsbildschirm (während der Konfiguration von Quellen oder Zielen) können Sie auf Jitterbit-Variablen mit der Syntax [JitterbitVariableName] verweisen.

Wenn Sie beispielsweise die Jitterbit-Variable als Teil eines Dateinamens oder als Eigenschaft eines anderen Objekts verwenden, das sich nicht in einem Skript befindet, können Sie mit Klammern wie [jitterbit.source.filename] darauf verweisen.

Neue Variablen erstellen oder Standardwerte auf privaten Agenten festlegen

Benutzer von privaten Agenten können das Standardverhalten von Jitterbit-Variablen programmgesteuert ändern und neue Jitterbit-Variablen über die Konfigurationsdatei des privaten Agenten erstellen. Beachten Sie jedoch, dass dies nur in seltenen Fällen von fortgeschrittenen Benutzern verwendet wird. Die meisten Anwendungsfälle können durch die Erstellung einer Projektvariablen statt einer Jitterbit-Variable gelöst werden.

Das Ändern von Standardwerten oder das Erstellen neuer Jitterbit-Variablen erfolgt aus diesen Abschnitten der Konfigurationsdatei des privaten Agenten:

  • [PredefinedGlobalVariables]
    Überprüfen oder ändern Sie Standardwerte für Jitterbit-Variablen.

  • [PredefinedServerGlobalDataElement]
    Definieren Sie Ihre eigenen benutzerdefinierten Jitterbit-Variablen und Standardwerte.

Jitterbit-Variablennamen können aus diesen Zeichen bestehen: Buchstaben (a–z, A–Z), Zahlen (0–9), Punkte und Unterstriche. Andere Zeichen werden nicht empfohlen und können zu Problemen führen.

Hinweis

Beim Upgrade eines privaten Agenten wird die Konfigurationsdatei beibehalten und nicht mit der neuesten Version überschrieben.

Warnung

Beim Erstellen neuer Jitterbit-Variablen wird nicht empfohlen, Punkte in einem Variablennamen zu verwenden, wenn Sie planen, auf diese mit JavaScript zuzugreifen. Stattdessen wird empfohlen, Jitterbit-Variablen zu erstellen, die keine Punkte enthalten, und stattdessen Unterstriche anstelle von Punkten zu verwenden. Weitere Informationen finden Sie unter Globale Variablen, was auch auf Jitterbit-Variablen anwendbar ist.

Weitere Informationen zum Bearbeiten oder Erstellen von Jitterbit-Variablen finden Sie unter Konfigurationsdatei bearbeiten (jitterbit.conf).