Salesforce-Funktionen im Jitterbit Design Studio
Salesforce-Funktionen bieten Anmelde- und Sitzungsinformationen sowie Abfragen für Salesforce-Instanzen. Beachten Sie, dass die beiden DataLoader-Funktionen veraltet sind, möglicherweise in Zukunft entfernt werden und Ersatzfunktionen empfohlen werden.
FromDataLoaderDate
Deklaration
date FromDataLoaderDate(string inputDate, string timeZoneId, bool isEuropeanFormat)
Syntax
FromDataLoaderDate(<inputDate>, <timeZoneId>, <isEuropeanFormat>)
Beschreibung
Konvertiert ein Eingabedatum in das von Salesforce erforderliche Format.
Warning
Diese Methode ist veraltet und könnte in einer zukünftigen Version von Jitterbit entfernt werden. Verwenden Sie stattdessen die Funktion GetUTCFormattedDate
.
FromDataLoaderDateTime
Deklaration
date FromDataLoaderDateTime(string inputDate, string timeZoneId, bool isEuropeanFormat
Syntax
FromDataLoaderDateTime(<inputDate>, <timeZoneId>, <isEuropeanFormat>)
Beschreibung
Konvertiert ein Eingabedatum und eine Uhrzeit in das von Salesforce erforderliche Format.
Warning
Diese Methode ist veraltet und könnte in einer zukünftigen Version von Jitterbit entfernt werden. Verwenden Sie stattdessen die Funktion GetUTCFormattedDateTime
.
GetSalesforceTimestamp
Deklaration
string GetSalesforceTimestamp(string url, string sessionId[, string timeZoneId])
Syntax
GetSalesforceTimestamp(<url>, <sessionId>[, <timeZoneId>])
Erforderliche Parameter
url
: Die URL, die beim Aufrufen von Salesforce verwendet werden soll, aus dem Aufruf vonSalesforceLogin
sessionId
: Die Salesforce-Sitzungs-ID, aus dem Aufruf vonSalesforceLogin
Optionale Parameter
timeZoneId
: Eine Zeitzonen-ID, die verwendet werden soll, wie unter Zeitzonencodes beschrieben. Standardmäßig wird die Zeitzone der Salesforce-Org verwendet, die durch die Salesforce-Sitzungs-ID identifiziert wird.
Beschreibung
Ruft die aktuelle Systemzeit von Salesforce ab.
Der Zeitstempel wird im Format yyyy-mm-dd HH:MM:SS
zurückgegeben, standardmäßig unter Verwendung der Zeitzoneneinstellung Ihrer Salesforce-Org. Sie müssen sich zuvor mit der Funktion SalesforceLogin
bei Salesforce angemeldet haben, bevor Sie diese Funktion verwenden. Die Funktion gibt einen Nullwert zurück, wenn der Aufruf fehlschlägt. Verwenden Sie die Funktion GetLastError
, um in diesem Fall die Fehlermeldung abzurufen.
Das optionale dritte Argument kann verwendet werden, um die zu verwendende Zeitzone festzulegen. Die Zeitzone Ihrer Salesforce-Org wird standardmäßig verwendet, wenn keine Zeitzone angegeben ist. Das Zeitzonenargument muss eine von Java erkannte Zeitzone sein, die in der TimeZone-Klasse definiert ist.
In einem typischen Szenario wird zuerst die Funktion SalesforceLogin
aufgerufen. Die URL und die Sitzungs-ID sind dann in diesen globalen Variablen verfügbar:
$Salesforce.ServerUrl
$Salesforce.SessionId
Als Alternative zu dieser Funktion siehe auch die Funktion LoginToSalesforceAndGetTimestamp
.
Beispiele
// Start by logging into Salesforce
if(!SalesforceLogin("..."), RaiseError(GetLastError()));
timestamp = GetSalesforceTimestamp($Salesforce.ServerUrl,
$Salesforce.SessionId);
// Check for any errors before proceeding further
if(IsNull(timestamp), RaiseError(GetLastError()));
// Retrieving the timestamp in UTC:
timestamp = GetSalesforceTimestamp($Salesforce.ServerUrl,
$Salesforce.SessionId, "UTC");
// Retrieving the timestamp in Pacific Standard Time:
timestamp = GetSalesforceTimestamp($Salesforce.ServerUrl,
$Salesforce.SessionId, "PST");
LoginToSalesforceAndGetTimeStamp
Deklaration
string LoginToSalesforceAndGetTimestamp(string salesforceOrg[, string timeZoneId])
Syntax
LoginToSalesforceAndGetTimestamp(<salesforceOrg>[, <timeZoneId>])
Erforderliche Parameter
salesforceOrg:
Eine Salesforce-Org im aktuellen Projekt
Optionale Parameter
timeZoneId
: Eine Zeitzonen-ID, die verwendet werden soll, wie unter Zeitzonencodes beschrieben. Die Standardzeitzone ist die Zeitzone der Salesforce-Org.
Beschreibung
Meldet sich bei Salesforce an, verwendet eine Salesforce-Org und ruft die aktuelle Systemzeit von Salesforce ab.
Die in diesem Funktionsaufruf verwendete Salesforce-Org muss als Salesforce-Org im aktuellen Projekt definiert sein. Siehe die Anweisungen zum Einfügen von Projektelementen.
Der Anmeldeaufruf erfolgt mit den Anmeldeinformationen der angegebenen Salesforce-Org. Der Zeitstempel wird im Format yyyy-mm-dd HH:MM:SS
zurückgegeben, wobei standardmäßig die Zeitzoneneinstellung Ihrer Salesforce-Org verwendet wird. Die Funktion gibt einen Nullwert zurück, wenn der Aufruf fehlschlägt. Verwenden Sie in diesem Fall die Funktion GetLastError
, um die Fehlermeldung abzurufen.
Das optionale Argument kann verwendet werden, um die zu verwendende Zeitzone festzulegen. Die Zeitzone Ihrer Salesforce-Org wird standardmäßig verwendet, wenn keine Zeitzone angegeben ist. Das Zeitzonenargument muss eine von Java erkannte Zeitzone sein, die in der TimeZone-Klasse definiert ist.
Sobald diese Funktion aufgerufen wurde, sind die Salesforce-URL und die Sitzungs-ID in diesen globalen Variablen verfügbar:
$Salesforce.ServerUrl
$Salesforce.SessionId
Als Alternative zu dieser Funktion siehe auch die Funktion GetSalesforceTimestamp
.
Beispiele
// Logs into Salesforce and retrieves the timestamp
timestamp = LoginToSalesforceAndGetTimestamp("<TAG>Salesforce Orgs/...");
// Check for any errors before proceeding further
if(IsNull(timestamp), RaiseError(GetLastError()));
// Retrieving the timestamp in UTC:
timestamp = LoginToSalesforceAndGetTimestamp("<TAG>Salesforce Orgs/...",
"UTC");
// Retrieving the timestamp in Pacific Standard Time:
timestamp = LoginToSalesforceAndGetTimestamp("<TAG>Salesforce Orgs/...",
"PST");
SalesforceLogin
Deklaration
bool SalesforceLogin(string salesforceOrg)
Syntax
SalesforceLogin(<salesforceOrg>)
Erforderliche Parameter
salesforceOrg
: Eine Salesforce-Org im aktuellen Projekt
Beschreibung
Meldet sich bei Salesforce an, indem die angegebene Salesforce-Org verwendet wird.
Die in diesem Funktionsaufruf verwendete Salesforce-Org muss als Salesforce-Org im aktuellen Projekt definiert sein. Siehe die Anweisungen zum Einfügen von Projektelementen.
Nach einer erfolgreichen Anmeldung werden diese globalen Variablen gesetzt und können in nachfolgenden Skripten oder Zuordnungen verwendet werden:
$Salesforce.SessionID
: Die Salesforce-Sitzungs-ID$Salesforce.ServerURL
: Die URL, die in nachfolgenden Aufrufen an Salesforce in derselben Sitzung verwendet werden soll$Salesforce.UserID
: Die ID des Salesforce-Benutzers
Die Funktion gibt true zurück, wenn die Anmeldung erfolgreich war, und false, wenn die Anmeldung fehlgeschlagen ist. Verwenden Sie die Funktion GetLastError
, um die Fehlermeldung in diesem Fall abzurufen.
Hinweis
Endpunkte, die mit dieser Funktion erstellt wurden, sind in Endpoint-Nutzungsberichten enthalten und zählen zu Ihrer Lizenz.
Beispiele
// Logs into Salesforce
result = SalesforceLogin("<TAG>Salesforce Orgs/...</TAG>");
// Check for any errors before proceeding further
if(!result, RaiseError(GetLastError()));
SetSalesforceSession
Deklaration
void SetSalesforceSession(string salesforceOrg, string sessionId, string serverURL)
Syntax
SetSalesforceSession(<salesforceOrg>, <sessionId>, <serverURL>)
Erforderliche Parameter
salesforceOrg
: Eine Salesforce-Org im aktuellen ProjektsessionID
: Eine Salesforce-Sitzungs-IDserverURL
: Eine Salesforce-Server-URL
Beschreibung
Setzt die Salesforce-Sitzungsinformationen für die angegebene Salesforce-Org. Verwenden Sie diese Funktion, wenn Sie eine vorhandene Salesforce-Sitzungs-ID und Server-URL haben. Der Aufruf dieser Funktion deaktiviert die automatische Salesforce-Anmeldung und verwendet stattdessen die bereitgestellten Sitzungsinformationen.
Die Salesforce-Org, die in diesem Funktionsaufruf verwendet wird, muss im aktuellen Projekt als Salesforce-Org definiert sein. Siehe die Anweisungen zum Einfügen von Projektelementen.
Nach einem erfolgreichen Funktionsaufruf werden diese globalen Variablen gesetzt und können in nachfolgenden Skripten oder Zuordnungen verwendet werden:
$Salesforce.SessionID
: Die Salesforce-Sitzungs-ID.$Salesforce.ServerURL
: Die URL, die in nachfolgenden Aufrufen an Salesforce in derselben Sitzung verwendet wird.
Diese Funktion validiert die Eingabe nicht; sie schlägt nur fehl, wenn entweder die Sitzungs-ID oder die Server-URL leer sind oder die referenzierte Salesforce-Org nicht existiert. Wenn entweder die Sitzungs-ID oder die Server-URL ungültig ist, schlagen nachfolgende Salesforce-Operationen fehl.
Verwenden Sie die Eval
-Funktion, um Fehler abzufangen, und rufen Sie die GetLastError
-Funktion auf, um die Fehlermeldung abzurufen.
Warnung
Es ist ein bekanntes Problem, dass die Funktion SetSalesforceSession
nicht korrekt funktioniert und nicht verwendet werden sollte. Wenn sie verwendet wird, kann das Skript einen Fehler generieren oder auch nicht. Selbst wenn das Skript keinen Fehler generiert, wird die Funktion nicht korrekt funktionieren. Da die Funktion nicht funktioniert, wird die integrierte Sitzungsverwaltung des Salesforce-Connectors verwendet.
Beispiele
// Sets the Salesforce session information
sfOrg = "<TAG>Salesforce Orgs/first.last@example.com</TAG>";
sfSessionID = "00D5...SE";
sfURL = "https://example.my.salesforce.com/services/Soap/u/39.0/...";
// Logs into Salesforce
Eval(SetSalesforceSession(sfOrg, sfSessionID, sfURL),
RaiseError("Failed to set Salesforce session: " + GetLastError()));
SfCacheLookup
Deklaration
string SfCacheLookup(string salesforceOrg, string soql)
Syntax
SfCacheLookup(<salesforceOrg>, <soql>)
Erforderliche Parameter
salesforceOrg
: Eine Salesforce-Org im aktuellen Projektsoql
: Eine Abfrage, die in Salesforce Object Query Language (SOQL) geschrieben ist
Beschreibung
Meldet sich bei Salesforce an (falls erforderlich) und ruft das Ergebnis der Abfrage von Salesforce ab. Es wird nur der Wert aus dem ersten Feld des ersten Datensatzes zurückgegeben.
Werte werden zwischengespeichert, sodass nachfolgende Aufrufe mit denselben genauen Parametern (Salesforce-Org und SOQL) keinen Aufruf an Salesforce auslösen. Salesforce wird nur beim ersten Mal aufgerufen. Der Cache ist für die Dauer der Operation, in der er aufgerufen wird, gültig.
Die Funktion gibt null
zurück, wenn die Anmeldung fehlschlägt, die Abfrage keine Datensätze zurückgibt oder die API fehlschlägt. Verwenden Sie die Funktion GetLastError
, um in diesem Fall die Fehlermeldung abzurufen.
Beispiele
// Logs into Salesforce and retrieves the first result of a query
// If the query is cached, it uses the cached value
myId = SFCacheLookup("<TAG>Salesforce Orgs/...</TAG>",
"SELECT Id FROM Account WHERE Name='My Account'");
// Checks for any errors before proceeding
if(IsNull(myId), RaiseError(GetLastError()));
SfLookup
Deklaration
string SfLookup(string salesforceOrg, string soql)
Syntax
SfLookup(<salesforceOrg>, <soql>)
Erforderliche Parameter
salesforceOrg
: Eine Salesforce-Org im aktuellen Projektsoql
: Eine Abfrage, die in Salesforce Object Query Language (SOQL) geschrieben ist
Beschreibung
Meldet sich bei Salesforce an (falls erforderlich) und ruft das Ergebnis der Abfrage von Salesforce ab. Es wird nur der Wert aus dem ersten Feld des ersten Datensatzes zurückgegeben.
Die Funktion gibt null
zurück, wenn die Anmeldung fehlschlägt, die Abfrage keine Datensätze zurückgibt oder die API fehlschlägt. Verwenden Sie die Funktion GetLastError
, um in diesem Fall die Fehlermeldung abzurufen.
Siehe auch die Funktionen SFLookupAll
und SFLookupAllToFile
.
Beispiele
// Logs into Salesforce and retrieves the first result of a query
myId = SFLookup("<TAG>Salesforce Orgs/...</TAG>",
"SELECT Id FROM Account WHERE Name='My Account'");
// Checks for any errors before proceeding
if(IsNull(myId), RaiseError(GetLastError()));
SfLookupAll
Deklaration
array_2D SfLookupAll(string salesforceOrg, string soql)
Syntax
SfLookupAll(<salesforceOrg>, <soql>)
Erforderliche Parameter
salesforceOrg
: Eine Salesforce-Org im aktuellen Projektsoql
: Eine Abfrage, die in Salesforce Object Query Language (SOQL) geschrieben ist
Beschreibung
Meldet sich bei Salesforce an (falls erforderlich) und ruft das Ergebnis der Abfrage von Salesforce ab. Das zurückgegebene Array ist zweidimensional; ein Array von Datensätzen, wobei jeder Datensatz ein Array von benannten Feldern ist.
Die Funktion gibt null
zurück, wenn die Anmeldung fehlschlägt, die Abfrage keine Datensätze zurückgibt oder die API fehlschlägt. Verwenden Sie die Funktion GetLastError
, um in diesem Fall die Fehlermeldung abzurufen.
Es gibt Einschränkungen, wenn eine Beziehungsabfrage verwendet wird:
- Nur unmittelbare Beziehungen können abgerufen werden. Die Abfrage kann keine Enkelbeziehungen enthalten.
- Für jeden Abfrage-Datensatz darf jedes Kind nicht mehrere Datensätze haben.
- In der Abfrageanweisung sollten die Felder unter demselben Kind zusammengefasst werden.
Siehe auch die Funktionen SFLookup
und SFLookupAllToFile
.
Beispiele
// Logs into Salesforce and retrieves the results of a query
records = SFLookupAll("<TAG>Salesforce Orgs/...</TAG>",
"SELECT Id,Name FROM Account");
firstId = records[0][0];
firstAccountName = records[0]["name"];
// Logs into Salesforce and retrieves the results of a query
soql = "SELECT Id,Name,CreatedBy.ContactId,
CreatedBy.FirstName,CreatedBy.LastName FROM Account";
rs = SfLookupAll("<TAG>Salesforce Orgs/...</TAG>", soql);
firstId = rs[0][0];
firstAccountName = rs[0]["name"];
lastName = rs[0]["CreatedBy.LastName"];
// or using an index:
last_name = rs[0][5];
SfLookupAllToFile
Deklaration
int SfLookupAllToFile(string salesforceOrg, string soql, string targetId)
Syntax
SfLookupAllToFile(<salesforceOrg>, <soql>, <targetId>)
Erforderliche Parameter
salesforceOrg
: Eine Salesforce-Org im aktuellen Projektsoql
: Eine Abfrage, die in Salesforce Object Query Language (SOQL) geschrieben isttargetID
: Ziel vom Dateityp im aktuellen Projekt
Beschreibung
Meldet sich bei Salesforce an (falls erforderlich) und schreibt die Ergebnisse der Abfrage von Salesforce in eine CSV-Datei. Die Funktion gibt die Anzahl der abgerufenen Datensätze zurück.
Der Anmeldeaufruf erfolgt mit den Anmeldeinformationen in der angegebenen Salesforce-Org.
Das in diesem Funktionsaufruf verwendete Ziel vom Dateityp muss als Ziel im aktuellen Projekt definiert sein. Siehe die Anweisungen zum Einfügen von Projektelementen.
Die Funktion gibt null
zurück, wenn die Anmeldung fehlschlägt, die Abfrage keine Datensätze zurückgibt oder die API fehlschlägt. Verwenden Sie die Funktion GetLastError
, um in diesem Fall die Fehlermeldung abzurufen.
Siehe auch die Funktionen SFLookup
und SFLookupAll
.
Beispiele
// Logs into Salesforce,
// retrieves the results of a query,
// and writes the results to a target
nrec = SFLookupAllToFile("<TAG>Salesforce Orgs/...</TAG>",
"SELECT Id,Name FROM Account",
"<TAG>Targets/...</TAG>");
// Logs into Salesforce,
// retrieves the results of a query
// specified in a local variable,
// and writes the results to a target
soql = "SELECT Id,Name,CreatedBy.ContactId,
CreatedBy.FirstName,CreatedBy.LastName FROM Account";
nrec = SfLookupAllToFile("<TAG>Salesforce Orgs/...</TAG>",
soql, "<TAG>Targets/...</TAG>");