Ir para o conteúdo

Funções do Salesforce no Jitterbit Studio

As funções do Salesforce fornecem informações de login e sessão e buscas para instâncias do Salesforce.

GetSalesforceTimestamp

Declaração

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

Sintaxe

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

Parâmetros obrigatórios

  • url: A URL a ser usada ao chamar o Salesforce, obtida ao chamar SalesforceLogin
  • sessionId: O ID de sessão do Salesforce, obtido ao chamar SalesforceLogin

Parâmetros opcionais

  • timeZoneId: Um ID de fuso horário a ser usado, conforme descrito em Códigos de fuso horário. O padrão é o fuso horário do endpoint do Salesforce identificado pelo ID de sessão do Salesforce.

Descrição

Recupera a hora atual do sistema do Salesforce.

O timestamp é retornado no formato yyyy-mm-dd HH:MM:SS, usando a configuração de fuso horário do endpoint do Salesforce por padrão. É necessário ter feito login no Salesforce usando a função SalesforceLogin antes de usar esta função. A função retorna um valor nulo se a chamada falhar. Use a função GetLastError para recuperar a mensagem de erro nesse caso.

O terceiro argumento opcional pode ser usado para definir o fuso horário a ser utilizado. O fuso horário do endpoint do Salesforce é usado por padrão se um fuso horário não for fornecido. O argumento de fuso horário deve ser um fuso horário reconhecido pela classe TimeZone do Java.

Em um cenário comum, a função SalesforceLogin é chamada primeiro. A URL e o ID de sessão ficam então disponíveis nessas variáveis globais:

  • $Salesforce.ServerUrl
  • $Salesforce.SessionId

Como alternativa a esta função, consulte também a função LoginToSalesforceAndGetTimestamp.

Exemplos

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

[Voltar ao topo]

LoginToSalesforceAndGetTimeStamp

Declaração

string LoginToSalesforceAndGetTimestamp(string salesforceOrg[, string timeZoneId])

Sintaxe

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

Parâmetros obrigatórios

  • salesforceOrg: Uma referência de caminho de string para uma conexão do Salesforce no projeto atual

Parâmetros opcionais

  • timeZoneId: Um ID de fuso horário a ser usado, conforme descrito em Códigos de fuso horário. O padrão é o fuso horário do endpoint do Salesforce.

Descrição

Faz login no Salesforce usando um endpoint do Salesforce e recupera a hora atual do sistema do Salesforce.

O endpoint do Salesforce usado nesta chamada de função deve ser definido como uma conexão do Salesforce no projeto atual. Para mais informações, consulte as instruções sobre inserção de endpoints na seção Endpoints em Jitterbit Script.

A chamada de login é feita usando as credenciais no endpoint do Salesforce especificado. O timestamp é retornado no formato yyyy-mm-dd HH:MM:SS, usando a configuração de fuso horário do endpoint do Salesforce por padrão. A função retorna um valor nulo se a chamada falhar. Use a função GetLastError para recuperar a mensagem de erro nesse caso.

O argumento opcional pode ser usado para definir o fuso horário a ser utilizado. O fuso horário do endpoint do Salesforce é usado por padrão se um fuso horário não for fornecido. O argumento de fuso horário deve ser um fuso horário reconhecido pela classe TimeZone do Java.

Após essa função ser chamada, a URL do Salesforce e o ID da sessão ficam disponíveis nessas variáveis globais:

  • $Salesforce.ServerUrl
  • $Salesforce.SessionId

Como alternativa a essa função, consulte também a função GetSalesforceTimestamp.

Exemplos

// Logs in to Salesforce and retrieves the timestamp
timestamp = LoginToSalesforceAndGetTimestamp("<TAG>endpoint:salesforce/Salesforce</TAG>");

// Check for any errors before proceeding further
if(IsNull(timestamp), RaiseError(GetLastError()));

// Retrieving the timestamp in UTC:
timestamp = LoginToSalesforceAndGetTimestamp("<TAG>endpoint:salesforce/Salesforce</TAG>", "UTC");

// Retrieving the timestamp in Pacific Standard Time:
timestamp = LoginToSalesforceAndGetTimestamp("<TAG>endpoint:salesforce/Salesforce</TAG>", "PST");

[Back to top]

SalesforceLogin

Declaração

bool SalesforceLogin(string salesforceOrg)

Sintaxe

SalesforceLogin(<salesforceOrg>)

Parâmetros obrigatórios

  • salesforceOrg: Um caminho de referência de string para uma conexão do Salesforce no projeto atual

Descrição

Faz login no Salesforce usando o endpoint do Salesforce especificado.

O endpoint do Salesforce usado nessa chamada de função deve ser definido como uma conexão do Salesforce no projeto atual. Para mais informações, consulte as instruções sobre inserção de endpoints na seção Endpoints em Jitterbit Script.

Após um login bem-sucedido, essas variáveis globais terão sido definidas e poderão ser usadas em scripts ou mapeamentos subsequentes:

  • $Salesforce.SessionID: O ID da sessão do Salesforce
  • $Salesforce.ServerURL: A URL a ser usada em chamadas subsequentes ao Salesforce na mesma sessão
  • $Salesforce.UserID: O ID do usuário do Salesforce

A função retorna true se o login foi bem-sucedido e false se o login falhou. Use a função GetLastError para recuperar a mensagem de erro nesse caso.

Nota

Os endpoints criados com essa função são incluídos no relatório de uso de endpoints e contam para sua licença.

Exemplos

// Logs in to Salesforce
result = SalesforceLogin("<TAG>endpoint:salesforce/Salesforce</TAG>");

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

[Back to top]

SetSalesforceSession

Declaração

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

Sintaxe

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

Parâmetros obrigatórios

  • salesforceOrg: Um caminho de referência de string para uma conexão do Salesforce no projeto atual
  • sessionID: Um ID de sessão do Salesforce
  • serverURL: Uma URL de servidor do Salesforce

Descrição

Define informações de sessão do Salesforce para o endpoint do Salesforce especificado. Use essa função se você tiver um ID de sessão do Salesforce e uma URL de servidor existentes. Chamar essa função desabilitará o login automático do Salesforce e usará as informações de sessão fornecidas.

O endpoint do Salesforce usado nessa chamada de função deve ser definido como uma conexão do Salesforce no projeto atual. Para mais informações, consulte as instruções sobre inserção de endpoints na seção Endpoints em Jitterbit Script.

Após uma chamada de função bem-sucedida, essas variáveis globais terão sido definidas e poderão ser usadas em scripts ou mapeamentos subsequentes:

  • $Salesforce.SessionID: O ID da sessão do Salesforce.
  • $Salesforce.ServerURL: A URL a ser usada em chamadas subsequentes ao Salesforce na mesma sessão.

Essa função não valida a entrada; ela só falha se o ID da sessão ou a URL do servidor estiverem vazios ou se o endpoint do Salesforce referenciado não existir. Se o ID da sessão ou a URL do servidor forem inválidos, as operações subsequentes do Salesforce falharão.

Use a função Eval para capturar erros, chamando a função GetLastError para recuperar a mensagem de erro.

Aviso

É um problema conhecido que a função SetSalesforceSession não funciona corretamente e não deve ser usada. Se usada, o script pode ou não gerar um erro. Mesmo que o script não gere um erro, a função não funcionará corretamente. Como a função não funciona, o tratamento de sessão integrado do conector do Salesforce será usado.

Exemplos

// Sets the Salesforce session information
sfOrg = "<TAG>endpoint:salesforce/Salesforce</TAG>";
sfSessionID = "00D5...SE";
sfURL = "https://example.my.salesforce.com/services/Soap/u/39.0/...";
// Logs in to Salesforce
Eval(SetSalesforceSession(sfOrg, sfSessionID, sfURL),
    RaiseError("Failed to set Salesforce session: " + GetLastError()));

[Voltar ao topo]

SfCacheLookup

Declaração

string SfCacheLookup(string salesforceOrg, string soql)

Sintaxe

SfCacheLookup(<salesforceOrg>, <soql>)

Parâmetros obrigatórios

  • salesforceOrg: Uma referência de caminho de string para uma conexão Salesforce no projeto atual**
  • soql: Uma consulta escrita em Salesforce Object Query Language (SOQL)

Descrição

Faz login no Salesforce (se necessário) e recupera o resultado da consulta do Salesforce. Apenas o valor do primeiro campo do primeiro registro é retornado.

O endpoint Salesforce usado nesta chamada de função deve ser definido como uma conexão Salesforce no projeto atual. Para mais informações, consulte as instruções sobre inserção de endpoints na seção Endpoints em Jitterbit Script.

Os valores são armazenados em cache para que chamadas subsequentes com os mesmos parâmetros exatos (endpoint Salesforce e SOQL) não disparem uma chamada ao Salesforce. O Salesforce é chamado apenas na primeira vez. O cache é válido durante a cadeia de operações em que é chamado.

A função retorna null se o login falhar, a consulta não retornar registros ou a API falhar. Use a função GetLastError para recuperar a mensagem de erro nesse caso.

Exemplos

// Logs in to Salesforce and retrieves the first result of a query
// If the query is cached, it uses the cached value
myId = SFCacheLookup("<TAG>endpoint:salesforce/Salesforce</TAG>",
    "SELECT Id FROM Account WHERE Name='My Account'");

// Checks for any errors before proceeding
if(IsNull(myId), RaiseError(GetLastError()));

[Voltar ao topo]

SfLookup

Declaração

string SfLookup(string salesforceOrg, string soql)

Sintaxe

SfLookup(<salesforceOrg>, <soql>)

Parâmetros obrigatórios

  • salesforceOrg: Uma referência de caminho de string para uma conexão Salesforce no projeto atual**
  • soql: Uma consulta escrita em Salesforce Object Query Language (SOQL)

Descrição

Faz login no Salesforce (se necessário) e recupera o resultado da consulta do Salesforce. Apenas o valor do primeiro campo do primeiro registro é retornado.

O endpoint Salesforce usado nesta chamada de função deve ser definido como uma conexão Salesforce no projeto atual. Para mais informações, consulte as instruções sobre inserção de endpoints na seção Endpoints em Jitterbit Script.

A função retorna null se o login falhar, a consulta não retornar registros ou a API falhar. Use a função GetLastError para recuperar a mensagem de erro nesse caso.

Veja também as funções SFLookupAll e SFLookupAllToFile.

Para solução de problemas, consulte Uma função falha quando seu campo de conexão de endpoint é definido como uma variável no guia de solução de problemas de operação.

Exemplos

// Logs in to Salesforce and retrieves the first result of a query
myId = SFLookup("<TAG>endpoint:salesforce/Salesforce</TAG>",
    "SELECT Id FROM Account WHERE Name='My Account'");

// Checks for any errors before proceeding
if(IsNull(myId), RaiseError(GetLastError()));

[Voltar ao topo]

SfLookupAll

Declaração

array_2D SfLookupAll(string salesforceOrg, string soql)

Sintaxe

SfLookupAll(<salesforceOrg>, <soql>)

Parâmetros obrigatórios

  • salesforceOrg: Uma referência de caminho de string para uma conexão Salesforce no projeto atual**
  • soql: Uma consulta escrita em Salesforce Object Query Language (SOQL)

Descrição

Faz login no Salesforce (se necessário) e recupera o resultado da consulta do Salesforce. O array retornado é bidimensional; um array de registros, sendo cada registro um array de campos nomeados.

O endpoint do Salesforce usado nesta chamada de função deve ser definido como uma conexão do Salesforce no projeto atual. Para mais informações, consulte as instruções sobre inserção de endpoints na seção Endpoints em Jitterbit Script.

A função retorna null se o login falhar, a consulta não retornar registros ou a API falhar. Use a função GetLastError para recuperar a mensagem de erro nesse caso.

Existem limitações ao usar uma consulta de relacionamento:

  • Apenas o relacionamento imediato pode ser recuperado. A consulta não pode incluir um relacionamento de neto.
  • Para cada registro de consulta, cada filho não pode ter múltiplos registros.
  • Na instrução de consulta, os campos sob o mesmo filho devem ser agrupados juntos.

Consulte também as funções SFLookup e SFLookupAllToFile.

Exemplos

Exemplo 1
// Logs in to Salesforce and retrieves the results of a query
records = SFLookupAll("<TAG>endpoint:salesforce/Salesforce</TAG>",
    "SELECT Id,Name FROM Account");
firstId = records[0][0];
firstAccountName = records[0]["name"];
Exemplo 2
// Logs in to Salesforce and retrieves the results of a query
soql = "SELECT Id,Name,CreatedBy.ContactId,
    CreatedBy.FirstName,CreatedBy.LastName FROM Account";
rs = SfLookupAll("<TAG>endpoint:salesforce/Salesforce</TAG>", soql);
firstId = rs[0][0];
firstAccountName = rs[0]["name"];
lastName = rs[0]["CreatedBy.LastName"];
// or using an index:
last_name = rs[0][5];

[Back to top]

SfLookupAllToFile

Declaração

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

Sintaxe

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

Parâmetros obrigatórios

  • salesforceOrg: Uma referência de caminho de string para uma conexão do Salesforce no projeto atual
  • soql: Uma consulta escrita em Salesforce Object Query Language (SOQL)
  • targetID: Uma atividade de string associada a um endpoint do tipo arquivo no projeto atual

Descrição

Faz login no Salesforce (se necessário) e escreve os resultados da consulta do Salesforce em um arquivo CSV. A função retorna o número de registros recuperados.

A chamada de login é feita usando as credenciais no endpoint do Salesforce especificado. O endpoint do Salesforce usado nesta chamada de função deve ser definido como uma conexão do Salesforce no projeto atual.

O destino usado nesta chamada de função deve ser definido como uma atividade associada a um endpoint do tipo arquivo no projeto atual. Isso inclui atividades configuradas de Compartilhamento de Arquivo, FTP, HTTP, Armazenamento Local e Armazenamento Temporário.

Para mais informações, consulte as instruções sobre inserção de endpoints na seção Endpoints em Jitterbit Script.

A função retorna null se o login falhar, a consulta não retornar registros ou a API falhar. Use a função GetLastError para recuperar a mensagem de erro nesse caso.

Consulte também as funções SFLookup e SFLookupAll.

Exemplos

Exemplo 1
// Logs in to Salesforce,
// retrieves the results of a query,
// and writes the results to a target
nrec = SFLookupAllToFile("<TAG>endpoint:salesforce/Salesforce</TAG>",
    "SELECT Id,Name FROM Account",
    "<TAG>activity:/...</TAG>");
Exemplo 2
// Logs in to 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>endpoint:salesforce/Salesforce</TAG>",
    soql, "<TAG>activity:/...</TAG>");

[Back to top]