Funciones de Salesforce

Las funciones de Salesforce proporcionan información de inicio de sesión y de sesión y búsquedas para instancias de Salesforce. Tenga en cuenta que las dos funciones de DataLoader están en desuso, pueden eliminarse en el futuro y se recomiendan funciones de reemplazo.

`FromDataLoaderDate`

Declaración

date FromDataLoaderDate(string inputDate, string timeZoneId, bool isEuropeanFormat)

Sintaxis

FromDataLoaderDate(<inputDate>, <timeZoneId>, <isEuropeanFormat>)

Descripción

Convierte una fecha de entrada al formato requerido por Salesforce.

Advertencia

Este método ha quedado obsoleto y puede eliminarse en una versión futura de Jitterbit. Utilizar el GetUTCFormattedDate funcionar en su lugar.

[Volver arriba]

`FromDataLoaderDateTime`

Declaración

date FromDataLoaderDateTime(string inputDate, string timeZoneId, bool isEuropeanFormat

Sintaxis

FromDataLoaderDateTime(<inputDate>, <timeZoneId>, <isEuropeanFormat>)

Descripción

Convierte una fecha y hora de entrada al formato requerido por Salesforce.

Advertencia

Este método ha quedado obsoleto y puede eliminarse en una versión futura de Jitterbit. Utilizar el GetUTCFormattedDateTime funcionar en su lugar.

[Volver arriba]

`GetSalesforceTimestamp`

Declaración

string GetSalesforceTimestamp(string url, string sessionId[, string timeZoneId])

Sintaxis

GetSalesforceTimestamp(<url>, <sessionId>[, <timeZoneId>])

Parámetros Requeridos

url: La URL que se utilizará al llamar a Salesforce, desde llamar SalesforceLogin
sessionId: El ID de sesión de Salesforce, desde la llamada SalesforceLogin

Parámetros Opcionales

timeZoneId: Un ID de huso horario a utilizar, como se describe en Códigos de Huso Horario. El valor predeterminado es la huso horario de la organización de Salesforce identificada por el ID de sesión de Salesforce.

Descripción

Recupera la hora actual del sistema de Salesforce.

La marca de tiempo se devuelve en el formato yyyy-mm-dd HH:MM:SS, utilizando la configuración de huso horario de su organización de Salesforce de forma predeterminada. Debe haber iniciado sesión en Salesforce utilizando el SalesforceLogin función antes de utilizar esta función. La función devuelve un valor nulo si la llamada falla. Utilizar el GetLastError función para recuperar el mensaje de error en ese caso.

El tercer argumento opcional se puede utilizar para establecer la huso horario a utilizar. La huso horario de su organización de Salesforce se utiliza de forma predeterminada si no se proporciona una huso horario. El argumento de huso horario debe ser una huso horario reconocida por la clase TimeZone de Java.

En un escenario común, el SalesforceLogin la función se llama primero. La URL y el ID de sesión estarán disponibles en estas variables globales:

$Salesforce.ServerUrl
$Salesforce.SessionId

Como alternativa a esta función, consulte también la LoginToSalesforceAndGetTimestamp función.

Ejemplos

// 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");

[Volver arriba]

`LoginToSalesforceAndGetTimeStamp`

Declaración

string LoginToSalesforceAndGetTimestamp(string salesforceOrg[, string timeZoneId])

Sintaxis

LoginToSalesforceAndGetTimestamp(<salesforceOrg>[, <timeZoneId>])

Parámetros Requeridos

salesforceOrg: Una organización de Salesforce en el proyecto actual

Parámetros Opcionales

timeZoneId: Un ID de huso horario a utilizar, como se describe en Códigos de Huso Horario. El valor predeterminado es la huso horario de la organización de Salesforce.

Descripción

Inicia sesión en Salesforce utilizando una organización de Salesforce y recupera la hora actual del sistema de Salesforce.

La organización de Salesforce utilizada en esta llamada de función debe definirse como una organización de Salesforce en el proyecto actual. Consulte las instrucciones sobre insertar elementos del proyecto.

La llamada de inicio de sesión se realiza utilizando las credenciales en la organización de Salesforce especificada. La marca de tiempo se devuelve en el formato yyyy-mm-dd HH:MM:SS, utilizando la configuración de huso horario de su organización de Salesforce de forma predeterminada. La función devuelve un valor nulo si la llamada falla. Utilizar el GetLastError función para recuperar el mensaje de error en ese caso.

El argumento opcional se puede utilizar para establecer la huso horario a utilizar. La huso horario de su organización de Salesforce se utiliza de forma predeterminada si no se proporciona una huso horario. El argumento de huso horario debe ser una huso horario reconocida por la clase TimeZone de Java.

Una vez que se ha llamado a esta función, la URL de Salesforce y el ID de sesión están disponibles en estas variables globales:

$Salesforce.ServerUrl
$Salesforce.SessionId

Como alternativa a esta función, consulte también la GetSalesforceTimestamp función.

Ejemplos

// 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");

[Volver arriba]

`SalesforceLogin`

Declaración

bool SalesforceLogin(string salesforceOrg)

Sintaxis

SalesforceLogin(<salesforceOrg>)

Parámetros Requeridos

salesforceOrg: Una organización de Salesforce en el proyecto actual

Descripción

Inicia sesión en Salesforce, utilizando la organización de Salesforce especificada.

La organización de Salesforce utilizada en esta llamada de función debe definirse como una organización de Salesforce en el proyecto actual. Consulte las instrucciones sobre insertar elementos del proyecto.

Después de un inicio de sesión exitoso, estas variables globales se habrán configurado y podrán usarse en secuencias de comandos o asignaciones posteriores:

$Salesforce.SessionID: El ID de sesión de Salesforce
$Salesforce.ServerURL: La URL que se utilizará en llamadas posteriores a Salesforce en la misma sesión.
$Salesforce.UserID: El ID del usuario de Salesforce

La función devuelve verdadero si el inicio de sesión fue exitoso y falso si el inicio de sesión falló. Utilizar el GetLastError función para recuperar el mensaje de error en ese caso.

Ejemplos

// Logs into Salesforce
result = SalesforceLogin("<TAG>Salesforce Orgs/...</TAG>");

// Check for any errors before proceeding further
if(!result, RaiseError(GetLastError()));

[Volver arriba]

`SetSalesforceSession`

Declaración

void SetSalesforceSession(string salesforceOrg, string sessionId, string serverURL)

Sintaxis

SetSalesforceSession(<salesforceOrg>, <sessionId>, <serverURL>)

Parámetros Requeridos

salesforceOrg: Una organización de Salesforce en el proyecto actual
sessionID: Un ID de sesión de Salesforce
serverURL: Una URL del servidor de Salesforce

Descripción

Establece información de sesión de Salesforce para la organización de Salesforce especificada. Utilice esta función si tiene un ID de sesión de Salesforce y una URL de servidor existentes. Llamar a esta función deshabilitará el inicio de sesión automático de Salesforce y, en su lugar, utilizará la información de sesión proporcionada.

La organización de Salesforce utilizada en esta llamada de función debe definirse como una organización de Salesforce en el proyecto actual. Consulte las instrucciones sobre insertar elementos del proyecto.

Después de una llamada de función exitosa, estas variables globales se habrán configurado y podrán usarse en secuencias de comandos o asignaciones posteriores:

$Salesforce.SessionID: El ID de sesión de Salesforce.
$Salesforce.ServerURL: La URL que se utilizará en llamadas posteriores a Salesforce en la misma sesión.

Esta función no valida la entrada; solo falla si el ID de sesión o la URL del servidor están vacíos o si la organización de Salesforce a la que se hace referencia no existe. Si el ID de sesión o la URL del servidor no son válidos, las operaciones posteriores de Salesforce fallarán.

Utilizar el Eval función para detectar errores, llamando al GetLastError función para recuperar el mensaje de error.

Advertencia

Es un problema conocido que el SetSalesforceSession la función no funciona correctamente y no debe usarse. Si se utiliza, el secuencia de comandos puede generar o no un error. Incluso si el secuencia de comandos no genera un error, la función no funcionará correctamente. Como la función no funciona, se utilizará el manejo de sesiones integrado del conector de Salesforce.

Ejemplos

// 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()));

[Volver arriba]

`SfCacheLookup`

Declaración

string SfCacheLookup(string salesforceOrg, string soql)

Sintaxis

SfCacheLookup(<salesforceOrg>, <soql>)

Parámetros Requeridos

salesforceOrg: Una organización de Salesforce en el proyecto actual
soql: Una consultar escrita en el lenguaje de consulta de objetos de Salesforce (SOQL)

Descripción

Inicia sesión en Salesforce (si es necesario) y recupera el resultado de la consultar de Salesforce. Sólo se devuelve el valor del primer campo del primer registro.

Los valores se almacenan en caché para que las llamadas posteriores con exactamente los mismos parámetros (Salesforce Org y SOQL) no activen una llamada a Salesforce. Solo se llama a Salesforce la primera vez.

La función regresa null si el inicio de sesión falla, la consultar no devuelve registros o la API falla. Utilizar el GetLastError función para recuperar el mensaje de error en ese caso.

Ejemplos

// 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()));

[Volver arriba]

`SfLookup`

Declaración

string SfLookup(string salesforceOrg, string soql)

Sintaxis

SfLookup(<salesforceOrg>, <soql>)

Parámetros Requeridos

salesforceOrg: Una organización de Salesforce en el proyecto actual
soql: Una consultar escrita en el lenguaje de consulta de objetos de Salesforce (SOQL)

Descripción

Inicia sesión en Salesforce (si es necesario) y recupera el resultado de la consultar de Salesforce. Sólo se devuelve el valor del primer campo del primer registro.

La función regresa null si el inicio de sesión falla, la consultar no devuelve registros o la API falla. Utilizar el GetLastError función para recuperar el mensaje de error en ese caso.

Ver también el SFLookupAll y SFLookupAllToFile funciones.

Ejemplos

// 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()));

[Volver arriba]

`SfLookupAll`

Declaración

array_2D SfLookupAll(string salesforceOrg, string soql)

Sintaxis

SfLookupAll(<salesforceOrg>, <soql>)

Parámetros Requeridos

salesforceOrg: Una organización de Salesforce en el proyecto actual
soql: Una consultar escrita en el lenguaje de consulta de objetos de Salesforce (SOQL)

Descripción

Inicia sesión en Salesforce (si es necesario) y recupera el resultado de la consultar de Salesforce. La matriz devuelta es bidimensional; una serie de registros, y cada registro es una serie de campos con nombre.

La función regresa null si el inicio de sesión falla, la consultar no devuelve registros o la API falla. Utilizar el GetLastError función para recuperar el mensaje de error en ese caso.

Existen limitaciones si se utiliza una consultar de relación:

Sólo se puede recuperar la relación inmediata. La consultar no puede incluir una relación de nieto.
Para cada registro de consultar, cada niño no puede tener múltiples registros.
En la declaración de consultar, los campos del mismo hijo deben agruparse.

Ver también el SFLookup y SFLookupAllToFile funciones.

Ejemplos

Example 1

// 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]["nombre"];

Example 2

// 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]["nombre"];
lastName = rs[0]["Creado por.Apellido"];
// or using an index:
last_name = rs[0][5];

[Volver arriba]

`SfLookupAllToFile`

Declaración

int SfLookupAllToFile(string salesforceOrg, string soql, string targetId)

Sintaxis

SfLookupAllToFile(<salesforceOrg>, <soql>, <targetId>)

Parámetros Requeridos

salesforceOrg: Una organización de Salesforce en el proyecto actual
soql: Una consultar escrita en el lenguaje de consulta de objetos de Salesforce (SOQL)
targetID: Destino de tipo de archivo en el proyecto actual

Descripción

Inicia sesión en Salesforce (si es necesario) y escribe los resultados de Salesforce de la consultar en un archivo CSV. La función devuelve el número de registros recuperados.

La llamada de inicio de sesión se realiza utilizando las credenciales en la organización de Salesforce especificada.

El destino del tipo de archivo utilizado en esta llamada de función debe definirse como un destino en el proyecto actual. Consulte las instrucciones sobre insertar elementos del proyecto.

La función regresa null si el inicio de sesión falla, la consultar no devuelve registros o la API falla. Utilizar el GetLastError función para recuperar el mensaje de error en ese caso.

Ver también el SFLookupy SFLookupAll funciones.

Ejemplos

Example 1

// 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>");

Example 2

// 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>");

[Volver arriba]