JavaScript Jitterbit e Funções Comuns¶

Jitterbit JavaScripts podem acessar, além das funções JavaScript padrão que fazem parte do ECMA-262 v5.1 — essas funções específicas do Jitterbit. Como ECMA-262 v5.1 é uma versão mais antiga do JavaScript do que a normalmente disponível em navegadores e outros mecanismos JavaScript, incluímos tabelas de funções JavaScript comuns e padrão que estão disponíveis em Jitterbit JavaScripts.

Funções de Jitterbit¶

Jitterbit.DbExecute¶

Declaração¶

array Jitterbit.DbExecute(string databaseId, string sql)

int Jitterbit.DbExecute(string databaseId, string sql, string outputVariable,...)

Sintaxe¶

Jitterbit.DbExecute(<databaseId>, <sql>)

Jitterbit.DbExecute(<databaseId>, <sql>, <outputVariable>,...])

Parâmetros Obrigatórios¶

• databaseId: Um caminho de referência de string para uma conexão de banco de dados no projeto atual
• sql: O comando SQL a ser executado no banco de dados
• outputVariable: (Segunda forma) Um parâmetro de saída que corresponde aos campos retornados no comando SQL. Argumentos adicionais podem ser especificados conforme necessário.

Descrição¶

Executa uma instrução SQL em um banco de dados e retorna os resultados. Veja o Jitterbit Script DBExecute função para obter detalhes.

O banco de dados utilizado nesta chamada de função deve ser definido como uma conexão de banco de dados no projeto atual. Para obter mais informações, consulte as instruções sobre como inserir endpoints em Endpoints em JavaScript.

Jitterbit.DbLookup¶

Declaração¶

string Jitterbit.DbLookup(string databaseId, string sql)

Sintaxe¶

Jitterbit.DbLookup(<databaseId>, <sql>)

Parâmetros Obrigatórios¶

• databaseId: Um caminho de referência de string para uma conexão de banco de dados no projeto atual
• sql: O comando SQL a ser executado no banco de dados

Descrição¶

Executa uma instrução SQL em um banco de dados e retorna o primeiro campo do primeiro resultado que corresponde aos critérios especificados. Veja o Jitterbit Script DBLookup função para obter detalhes.

O banco de dados utilizado nesta chamada de função deve ser definido como uma conexão de banco de dados no projeto atual. Para obter mais informações, consulte as instruções sobre como inserir endpoints em Endpoints em JavaScript.

Jitterbit.GetVar¶

Declaração¶

string Jitterbit.GetVar(string jitterbitVariableName)

Sintaxe¶

Jitterbit.GetVar(<jitterbitVariableName>)

Parâmetros Obrigatórios¶

• jitterbitVariableName: O nome de uma variável Jitterbit ou variável global

Descrição¶

Retorna o valor de uma variável Jitterbit (as variáveis globais predefinidas que são incorporadas ao Harmony e começam com "$jitterbit.") ou outra variável global. O cifrão é opcional e pode ser omitido. As variáveis disponíveis podem ser vistas no Cloud Studio e estão documentadas em Variáveis Jitterbit. Variáveis globais definidas no projeto atual também podem ser recuperadas pelo mesmo mecanismo.

Exemplos¶

// Retrieves the value of the Jitterbit variable "jitterbit.api.request"
var request = Jitterbit.GetVar("$jitterbit.api.request");

// Retrieves the value of the global variable "email"
var email = Jitterbit.GetVar("email");

// Another method for retrieving a global variable
var email = Jitterbit.GetVar("$email");

Jitterbit.ReadFile¶

Declaração¶

string Jitterbit.ReadFile(string sourceId[, string fileFilter])

Sintaxe¶

Jitterbit.ReadFile(<sourceId>[, <fileFilter>])

Parâmetros Obrigatórios¶

• sourceId: Um caminho de referência de string para uma atividade associada a um endpoint de tipo de arquivo no projeto atual

Parâmetros Opcionais¶

• fileFilter: Filtro de arquivo ou nome de arquivo para substituir a configuração da atividade

Descrição¶

Lê o conteúdo de um arquivo de uma origem.

A origem usada nesta chamada de função deve ser definida como uma atividade associada a um endpoint de tipo de arquivo no projeto atual. Isso inclui atividades configuradas de compartilhamento de arquivos, FTP, HTTP, armazenamento local e armazenamento temporário. Para obter mais informações, consulte as instruções sobre como inserir endpoints em Endpoints em JavaScript.

O método retorna o conteúdo do arquivo apontado pela fonte. Caso o filtro de origem selecione mais de um arquivo, o primeiro será utilizado. Recomenda-se especificar uma fonte que identifique exclusivamente um único arquivo.

O parâmetro fileFilter é opcional e pode ser usado para substituir o filtro de arquivo usado na configuração da atividade. Um nome de arquivo pode ser usado. Alternativamente, uma variável global pode ser usada para substituir o filtro de arquivo na configuração da atividade. Variáveis globais são referenciadas como [de_name] na configuração da atividade.

Se o ReadFile função falha, a operação não falha. Um script será abortado, um aviso será adicionado ao log da operação e a operação continuará.

Este método pode ser usado para ler dados de uma fonte HTTP. Nesse caso, todos os Jitterbit $jitterbit.source.http.* variáveis serão preenchidas.

Exemplos¶

// Reads the first file retrieved from a source
var fileContents = Jitterbit.ReadFile("<TAG>activity:ftp/FTP Endpoint/ftp_read/FTP Files</TAG>");

// Use the filename "test.txt" instead of what is defined in the source
var fileContents = Jitterbit.ReadFile("<TAG>activity:ftp/FTP Endpoint/ftp_read/FTP Files</TAG>", "test.txt");

Jitterbit.SetVar¶

Declaração¶

Jitterbit.SetVar(string jitterbitVariableName, string value)

Sintaxe¶

Jitterbit.SetVar(<jitterbitVariableName>, <value>)

Parâmetros Obrigatórios¶

• jitterbitVariableName: O nome de uma variável Jitterbit ou variável global
• value: Um valor a ser atribuído à variável

Descrição¶

Define o valor de uma variável Jitterbit (as variáveis globais predefinidas que são incorporadas ao Jitterbit e começam com "$jitterbit.") ou outra variável global. O cifrão é opcional e pode ser omitido. As variáveis disponíveis podem ser vistas no Cloud Studio e estão documentadas em Variáveis Jitterbit. Variáveis globais definidas no projeto atual também podem ser recuperadas pelo mesmo mecanismo.

Exemplos¶

// Sets a Jitterbit variable and a global variable
Jitterbit.SetVar("$jitterbit.scripting.db.max_rows", 1000);
Jitterbit.SetVar("$email", "first.lastname@example.com");

Jitterbit.WriteFile¶

Declaração¶

void Jitterbit.WriteFile(string targetId, type fileContents[, string filename])

Sintaxe¶

Jitterbit.WriteFile(<targetId>, <fileContents>[, <filename>])

Parâmetros Obrigatórios¶

• targetId: Um caminho de referência de string para uma atividade associada a um endpoint de tipo de arquivo no projeto atual

Parâmetros Opcionais¶

• fileContents: Dados a serem gravados no arquivo
• filename: Nome do arquivo para substituir a configuração da atividade

Descrição¶

Escreve o fileContents para o alvo especificado por targetId. Se fileContents for do tipo binário, os dados binários serão gravados no arquivo. Em todos os outros casos, uma representação em string dos dados é gravada. O arquivo é automaticamente liberado e fechado pela função.

O destino usado nesta chamada de função deve ser definido como uma atividade associada a um endpoint de tipo de arquivo no projeto atual. Isso inclui atividades configuradas de compartilhamento de arquivos, FTP, HTTP, armazenamento local e armazenamento temporário. Para obter mais informações, consulte as instruções sobre como inserir endpoints em Endpoints em JavaScript.

O terceiro parâmetro, filename, é opcional e pode ser usado para substituir o nome do arquivo usado na configuração da atividade. Alternativamente, uma variável global pode ser usada para substituir o nome do arquivo na configuração da atividade. Variáveis globais são referenciadas como [de_name] na configuração da atividade.

Este método também pode ser usado para gravar/postar dados em um destino HTTP. Nesse caso, $jitterbit.target.http.* variáveis serão preenchidas.

Se o WriteFile() função falha, a operação não falha. Um script será abortado, um aviso será adicionado ao log da operação e a operação continuará.

Exemplos¶

//  Writes the value of $contents to the file defined by a target
Jitterbit.WriteFile("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>", $contents);

// Use the filename "test.txt" instead of what is defined in the target
Jitterbit.WriteFile("<TAG>activity:ftp/FTP Endpoint/ftp_write/FTP Files</TAG>", $contents, "test.txt");

SetScriptOutput¶

Declaração¶

void SetScriptOutput(string data)

Sintaxe¶

SetScriptOutput(<data>)

Parâmetros Obrigatórios¶

• data: Dados a serem retornados pelo script

Descrição¶

Define o valor retornado por um script.

O valor de retorno de um script pode ser acessado como o valor de retorno do RunScript função.

Exemplos¶

// In the calling Jitterbit Script script:
$result = RunScript("<TAG>script:CalculateSomething</TAG>", value_to_be_calculated);

// In the Jitterbit JavaScript script "CalculateSomething":
var calculated_value = ...;
...
SetScriptOutput(calculated_value);

SetScriptResult¶

Declaração¶

void SetScriptResult(string data)

Sintaxe¶

SetScriptResult(<data>)

Parâmetros Obrigatórios¶

• data: Dados a serem retornados pelo script

Descrição¶

Um apelido para o SetScriptOutput função. Ver SetScriptOutput para detalhes.

WriteToOperationLog¶

Declaração¶

string WriteToOperationLog(string message)

Sintaxe¶

WriteToOperationLog(<message>)

Parâmetros Obrigatórios¶

• message: Uma mensagem de string

Descrição¶

Grava uma mensagem no log de operação.

Exemplos¶

// Writes a message to the operation log
WriteToOperationLog("The source field 'Price' has an invalid value.");

funções Comuns do JavaScript¶

Essas funções JavaScript comuns — parte do ECMA-262 v5.1 — são compatíveis com Jitterbit JavaScripts.