Ir para o conteúdo

Variáveis Jitterbit no Design Studio

Visão Geral

As variáveis Jitterbit são um dos três tipos de elementos de dados globais disponíveis no Harmony. (Os outros dois tipos de elementos de dados globais—variáveis globais e variáveis de projeto—também estão disponíveis globalmente em todo o projeto. Eles são configurados de maneira diferente, conforme descrito em Variáveis globais e Variáveis de projeto.)

As variáveis Jitterbit estão sempre disponíveis em todo o seu projeto. Elas são pré-definidas pela Jitterbit ou configuradas no arquivo de configuração Jitterbit.

Os casos de uso mais comuns para variáveis Jitterbit são ler uma variável para que você possa reunir informações sobre o que ocorreu durante uma operação ou buscar informações globais, como o nome do arquivo de origem atual. Menos frequentemente, as variáveis Jitterbit são escritas ao alterar as configurações padrão usadas para processar a cadeia de operações.

Se uma variável Jitterbit afeta a forma como uma função funciona, ela deve ser configurada antes da chamada da função. As operações ou scripts anteriores são aqueles que estão vinculados dentro de uma cadeia de operações usando ações de operação ou as funções RunOperation ou RunScript. Anterior neste contexto também se refere a alterar o valor da variável Jitterbit no mesmo script, mas antes da chamada da função.

Como essas variáveis são variáveis pré-definidas, projetos raramente criam ou alteram o valor padrão de uma variável Jitterbit. No entanto, ao usar um agente privado, variáveis Jitterbit podem ser criadas ou seu valor padrão modificado. Veja Criar novas variáveis ou definir padrões em agentes privados abaixo para mais detalhes.

Consulte estas páginas para documentação sobre as variáveis pré-definidas do Jitterbit:

Exibição das variáveis Jitterbit

Ao projetar seu projeto, as variáveis Jitterbit estão disponíveis na aba Elementos de Dados do construtor de scripts acessível a partir das telas de scripts e transformações. Cada variável Jitterbit pré-definida pelo Jitterbit está documentada em uma página sob esta seção.

Definir variáveis Jitterbit em scripts ou transformações

Embora o uso mais comum das variáveis Jitterbit seja para ler informações, existem algumas variáveis Jitterbit que você pode querer definir para comunicar algo a um agente. No Integration Studio, as variáveis Jitterbit podem ser definidas usando Jitterbit Script ou JavaScript, da mesma forma que qualquer variável global pode ser definida.

Dica

Consulte a documentação para cada variável Jitterbit para obter informações sobre quais variáveis podem ser definidas e quais valores podem ser atribuídos a elas.

Jitterbit Script

No Jitterbit Script utilizado dentro de scripts e transformações, o valor de uma variável Jitterbit pode ser definido começando com um sinal de dólar $ ou chamando a função Set().

  • $: Usando a sintaxe do sinal de dólar $, $jitterbit.api.response="Success" define a resposta da API (jitterbit.api.response) para retornar a string "Success" para a aplicação solicitante.
  • Set: Usando a função Set(), Set("jitterbit.api.response", "Success") define a resposta da API (jitterbit.api.response) para retornar a string "Success" para a aplicação solicitante.

Em scripts e transformações, as variáveis Jitterbit também serão exibidas na aba Variáveis do painel de componentes do script, dentro da sub-aba Variáveis Jitterbit.

JavaScript

No JavaScript utilizado dentro de scripts criados como um componente de projeto, as variáveis Jitterbit pré-definidas pela Jitterbit podem ser definidas apenas com a função Jitterbit.SetVar(). Isso ocorre porque todas as variáveis Jitterbit pré-definidas pela Jitterbit contêm pontos dentro do nome da variável.

  • Jitterbit.SetVar: Usando Jitterbit.SetVar, o exemplo de código Jitterbit.SetVar("$jitterbit.api.response", "Success") define a resposta da API para retornar a string "Success" para o aplicativo solicitante.

Em scripts e transformações, as variáveis Jitterbit também serão exibidas na aba Variáveis do painel de componentes do script, dentro da sub-aba Variáveis Jitterbit.

Aviso

As funções JavaScript Jitterbit.SetVar e Jitterbit.GetVar são projetadas especificamente para acessar as variáveis Jitterbit predefinidas. Elas não devem ser usadas para acessar variáveis globais definidas pelo usuário.

Em JavaScript, não misture o uso de SetVar (e GetVar) com a precedência de $ ao definir (e recuperar) uma variável. Use apenas uma sintaxe. Misturar as duas sintaxes diferentes para a mesma variável pode causar problemas em tempo de execução.

Recuperar variáveis Jitterbit em scripts ou transformações

O valor de uma variável Jitterbit pode ser retornado usando Jitterbit Script (em scripts ou transformações) ou usando JavaScript (apenas em scripts criados como um componente de projeto) da mesma forma que uma variável global pode ser recuperada.

Aviso

Há um problema conhecido que variáveis de mapeamento com pontos no nome da variável não funcionam corretamente, resultando em um mapeamento de campo de destino incorreto na transformação. Até que esse problema seja resolvido, as variáveis Jitterbit não podem ser referenciadas diretamente dentro de uma transformação. A script pode ser usada para criar um mecanismo de contorno para passar valores.

Jitterbit Script

Em scripts e transformações, você pode começar com um sinal de dólar $ ou usar a função Get() para recuperar o valor de uma variável Jitterbit:

  • $: Prefixado com um sinal de dólar $, o exemplo de código $jitterbit.operation.error recupera o valor da variável Jitterbit "jitterbit.operation.error".
  • Get: Usando a função Get(), o exemplo de código Get("jitterbit.operation.error") retorna o mesmo valor.

Em scripts e transformações, as variáveis Jitterbit também serão exibidas na aba Variáveis do painel de componentes de script, dentro da sub-aba Variáveis Jitterbit.

JavaScript

Em scripts JavaScript dentro de uma operação, as variáveis Jitterbit pré-definidas pela Jitterbit podem ser acessadas apenas com as funções Jitterbit.SetVar() e Jitterbit.GetVar(). Isso ocorre porque todas as variáveis Jitterbit pré-definidas pela Jitterbit contêm pontos dentro do nome da variável.

  • Jitterbit.GetVar: Usando Jitterbit.GetVar, o exemplo de código Jitterbit.GetVar("$jitterbit.operation.error") retorna o valor da variável Jitterbit chamada "jitterbit.operation.error". Observe que um sinal de dólar $ à frente é opcional antes do nome ao recuperar valores. Os nomes jitterbit.operation.name e $jitterbit.operation.name são equivalentes ao recuperar valores.

Aviso

As funções JavaScript Jitterbit.SetVar e Jitterbit.GetVar são projetadas especificamente para acessar as variáveis Jitterbit pré-definidas. Elas não devem ser usadas para acessar variáveis globais definidas pelo usuário.

Em JavaScript, não misture o uso de SetVar (e GetVar) com a precedência de $ ao definir (e recuperar) uma variável. Use apenas uma sintaxe. Misturar as duas sintaxes diferentes para a mesma variável pode causar problemas em tempo de execução.

Em scripts e transformações, as variáveis Jitterbit também serão exibidas na aba Variáveis do painel de componentes de script, dentro da sub-aba Variáveis Jitterbit.

Use Jitterbit variables in definition screens

Em uma tela de definição (durante a configuração de fontes ou destinos), você pode referenciar variáveis Jitterbit usando a sintaxe [JitterbitVariableName].

Por exemplo, se você estiver usando a variável Jitterbit como parte de um nome de arquivo ou como uma propriedade de um objeto diferente que não está em um script, então você pode referenciá-la usando colchetes, como [jitterbit.source.filename].

Criar novas variáveis ou definir padrões em agentes privados

Aqueles que usam agentes privados podem alterar programaticamente o comportamento padrão das variáveis Jitterbit, bem como criar novas variáveis Jitterbit através do arquivo de configuração do agente privado. No entanto, observe que isso é usado apenas em casos raros implementados por usuários avançados. A maioria dos casos de uso pode ser tratada criando uma variável de projeto em vez de uma variável Jitterbit.

Alterar valores padrão ou criar novas variáveis Jitterbit é feito a partir dessas seções do arquivo de configuração do agente privado:

  • [PredefinedGlobalVariables]
    Verifique ou altere os valores padrão para variáveis Jitterbit.

  • [PredefinedServerGlobalDataElement]
    Defina suas próprias variáveis Jitterbit personalizadas e valores padrão.

Os nomes das variáveis Jitterbit podem ser compostos por esses caracteres: letras (a-z, A-Z), números (0-9), pontos e sublinhados. Outros caracteres não são recomendados e podem causar problemas.

Nota

Ao atualizar um agente privado, o arquivo de configuração é preservado e não é sobrescrito com a versão mais recente.

Aviso

Ao criar novas variáveis Jitterbit, não é recomendável usar pontos em um nome de variável se você planeja acessá-las com JavaScript. Em vez disso, recomenda-se que você crie variáveis Jitterbit que não contenham pontos e use sublinhados no lugar dos pontos. Consulte informações sobre variáveis globais, que também se aplicam às variáveis Jitterbit.

Para mais informações sobre como editar ou criar variáveis Jitterbit, veja Editar o arquivo de configuração (jitterbit.conf).