JavaScript Jitterbit e funções comuns no Design Studio

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

Funções do 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: Uma string que representa a fonte 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. Consulte a função DBExecute do Jitterbit Script para mais detalhes.

Jitterbit.DbLookup

Declaração

string Jitterbit.DbLookup(string databaseId, string sql)

Sintaxe

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

Parâmetros obrigatórios

• databaseId: Uma string que representa a fonte 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. Consulte a função DBLookup do Jitterbit Script para mais detalhes.

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

Descrição

Retorna o valor de uma variável Jitterbit (uma variável global pré-definida que está embutida no agente e começa com jitterbit.). As variáveis disponíveis podem ser vistas no Design Studio e estão documentadas em variáveis Jitterbit.

Examples

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

Jitterbit.ReadFile

Declaration

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

Syntax

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

Required parameters

• sourceId: Fonte do tipo arquivo no projeto atual

Optional parameters

• fileFilter: Filtro de arquivo ou nome de arquivo para substituir a definição da fonte

Description

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

A fonte do tipo arquivo usada nesta chamada de função deve ser definida como uma fonte no projeto atual.

Consulte as instruções sobre inserindo itens do projeto.

O método retorna o conteúdo do arquivo apontado pela fonte. Se o filtro da fonte selecionar mais de um arquivo, o primeiro será utilizado. Recomenda-se especificar uma fonte que identifique de forma única um único arquivo.

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

A partir da versão 8.20 do Harmony, se a função ReadFile falhar, 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, todas as variáveis Jitterbit $jitterbit.source.http.* serão preenchidas.

Exemplos

// Reads the first file retrieved from a source
var fileContents = Jitterbit.ReadFile("<TAG>Sources/Customer CSV FTP</TAG>");

// Use the filename "test.txt" instead of what is defined in the source
var fileContents = Jitterbit.ReadFile("<TAG>Sources/Customer CSV FTP</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
• value: Um valor a ser atribuído à variável

Descrição

Define o valor de uma variável Jitterbit (uma variável global pré-definida que está embutida no agente e começa com jitterbit.). As variáveis disponíveis podem ser vistas no Design Studio e estão documentadas em Variáveis Jitterbit.

Exemplos

// Define uma variável Jitterbit
Jitterbit.SetVar("$jitterbit.scripting.db.max_rows", 1000);

Jitterbit.WriteFile

Declaração

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

Sintaxe

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

Parâmetros obrigatórios

• targetId: Alvo do tipo arquivo no projeto atual

Parâmetros opcionais

• fileContents: Dados a serem escritos no arquivo
• filename: Nome do arquivo para substituir a definição do alvo

Descrição

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

O alvo do tipo arquivo usado nesta chamada de função deve ser definido como um alvo no projeto atual.

As variáveis disponíveis podem ser vistas no Jitterbit Studio e estão documentadas em variáveis Jitterbit.

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

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

A partir da versão 8.20 do Harmony, se a função WriteFile falhar, a operação não falha. Um script será abortado, um aviso 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>Targets/FTP Target</TAG>", $contents);

// Use the filename "test.txt" instead of what is defined in the target
Jitterbit.WriteFile("<TAG>Targets/FTP Target</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 da função RunScript.

Exemplos

// In the calling Jitterbit Script script:
$result = RunScript("<TAG>Scripts/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 alias para a função SetScriptOutput. Veja SetScriptOutput para detalhes.

WriteToOperationLog

Declaração

string WriteToOperationLog(string message)

Sintaxe

WriteToOperationLog(<message>)

Parâmetros obrigatórios

• message: Uma mensagem em string

Descrição

Escreve uma mensagem no Log de Operações.

Exemplos

// Escreve uma mensagem no Log de Operações
WriteToOperationLog("O campo de origem 'Preço' tem um valor inválido.");

Funções comuns de JavaScript

Essas funções comuns de JavaScript—parte do ECMA-262 v5.1—são suportadas nos JavaScripts do Jitterbit.