Ir para o conteúdo

Variáveis de Jitterbit

Visão Geral

Variáveis Jitterbit são um dos tipos de elementos de dados globais disponíveis no Harmony. Os outros tipos de elementos de dados globais — variáveis de projeto, variáveis globais e palavras-chave de nome de arquivo — também estão disponíveis globalmente em todo o projeto. Elas são definidas de forma diferente, conforme descrito em Variáveis do Projeto, Variáveis globais e Palavras-chave do nome do arquivo, respectivamente. No entanto, como todos os elementos de dados globais partilham o mesmo espaço de nomes, os seus nomes devem ser exclusivos quando comparados com todos os outros elementos de dados globais.

O caso de uso mais comum para variáveis Jitterbit é ler uma variável para que você possa coletar informações sobre o que ocorreu durante uma operação ou buscar informações globais, como o nome do arquivo de origem atual. Outro caso de uso comum é usar variáveis Jitterbit para alterar as configurações padrão usadas para processar a cadeia de operação.

Se uma variável Jitterbit afeta a maneira como uma função funciona, ele deve ser configurado acima na cadeia da chamada de função. Operações a montante ou scripts são aqueles que estão ligados dentro de uma cadeia de operação usando ações de operação ou o RunOperation ou RunScript funções. Upstream neste contexto também se refere à alteração do valor da variável Jitterbit no mesmo script, mas antes da chamada da função.

Se estiver usando um Agente Privado, você pode alterar programaticamente o comportamento do Jitterbit alterando o valor padrão de uma variável Jitterbit predefinida ou criando e predefinindo sua própria variável Jitterbit.

Consulte estas páginas para obter documentação sobre as variáveis Jitterbit predefinidas:

Exibição de Variáveis jitterbit

Variáveis Jitterbit são exibidas em vários lugares:

  • No editor de script, as variáveis Jitterbit são exibidas na paleta de componentes à direita na aba Variáveis na subguia Variáveis Jitterbit. Este local fornece acesso fácil para inserir referências de variáveis Jitterbit em scripts, inclusive dentro de scripts de transformação em modo de script.
  • Em transformação modo de mapeamento, as variáveis Jitterbit são exibidas na aba Variáveis à esquerda na categoria Variáveis Jitterbit. Este local fornece acesso fácil para inserir referências de variáveis Jitterbit durante o mapeamento de transformação no modo de mapeamento.
  • Em telas de configuração do endpoint, as variáveis Jitterbit podem ser acessadas e usadas em qualquer campo que tenha um ícone de variável ícone de variável. Como alternativa à seleção de uma variável Jitterbit, você pode inserir manualmente a referência da variável usando a sintaxe de colchetes padrão do Jitterbit Script.

Definir Variáveis jitterbit em Scripts Ou Transformações

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

Dica

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

Jitterbit Script

No Jitterbit Script usado em scripts e transformações, o valor de uma variável Jitterbit pode ser definido começando com um cifrão $ ou ligando para o Set função.

  • $: Usando o cifrão $ sintaxe, $jitterbit.api.response="Success" define a resposta da API (jitterbit.api.response) para retornar a string "Success" ao aplicativo solicitante.
  • Set: Usando o Set função, Set("jitterbit.api.response", "Success") define a resposta da API (jitterbit.api.response) para retornar a string "Success" ao aplicativo solicitante.

Nota

Para variáveis Jitterbit com um hífen no nome, use o Get e Set funções para recuperar e definir seus valores. Por exemplo: Set("jitterbit.target.http.response.header.X-Jitterbit-Authorization", $authorization).

Em scripts e transformações, as variáveis Jitterbit também são exibidas na aba Variáveis da paleta de componentes de script, dentro da subguia Variáveis Jitterbit. Consulte Adicionar uma variável Jitterbit a um Script abaixo.

JavaScript

Em JavaScript usado em scripts criado como um componente do projeto, as variáveis Jitterbit predefinidas pelo Jitterbit podem ser definidas apenas com o Jitterbit.SetVar função. Isso ocorre porque todas as variáveis Jitterbit predefinidas pelo 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" ao aplicativo solicitante.

Aviso

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

Em JavaScript, não misture e combine seu uso de SetVar (e GetVar) com $-prefacing 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 são exibidas na aba Variáveis da paleta de componentes de script, dentro da subguia Variáveis Jitterbit. Consulte Adicionar uma variável Jitterbit a um Script abaixo.

Recuperar Variáveis jitterbit em um Script Ou Transformação

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

Jitterbit Script

Em scripts e transformações, você pode começar com um cifrão $ ou use o Get função para recuperar o valor de uma variável Jitterbit:

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

Nota

Para variáveis Jitterbit com um hífen no nome, use o Get e Set funções para recuperar e definir seus valores. Por exemplo: Get("jitterbit.target.http.response.header.X-Jitterbit-Authorization").

Em scripts e transformações, as variáveis Jitterbit também são exibidas na aba Variáveis da paleta de componentes de script, dentro da subguia Variáveis Jitterbit. Consulte Adicionar uma variável Jitterbit a um Script abaixo.

JavaScript

Em JavaScript scripts dentro de uma operação, as variáveis Jitterbit predefinidas pelo Jitterbit podem ser acessadas apenas com o Jitterbit.SetVar e Jitterbit.GetVar funções. Isso ocorre porque todas as variáveis Jitterbit predefinidas pelo 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 cifrão inicial $ é opcional antes do nome ao recuperar valores. Os nomes jitterbit.operation.name e $jitterbit.operation.name são equivalentes ao recuperar valores.

Em scripts e transformações, as variáveis Jitterbit também são exibidas na aba Variáveis da paleta de componentes de script, dentro da subguia Variáveis Jitterbit. Consulte Adicionar uma variável Jitterbit a um Script abaixo.

Aviso

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

Em JavaScript, não misture e combine seu uso de SetVar (e GetVar) com $-prefacing 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.

Adicionar uma Variável Jitterbit a um Script

Em Jitterbit Script ou JavaScript usado em scripts criadas em uma operação, as variáveis Jitterbit são exibidas na aba Variáveis da paleta de componentes, dentro da subguia Variáveis Jitterbit:

variáveis de jitterbit

Para adicionar a sintaxe da variável a um script (Jitterbit Script ou JavaScript), use um destes métodos:

  • Arraste a variável da paleta para o script para inserir a sintaxe da variável.
  • Clique duas vezes na variável na paleta para inserir a sintaxe da variável no local do cursor dentro do script.
  • Comece digitando o nome da variável e pressione Control+Space para exibir uma lista de sugestões de preenchimento automático. Selecione uma variável para inserir a sintaxe da variável.
  • Insira manualmente a sintaxe da variável.

Use Variáveis jitterbit nas Telas de Configuração

Durante a configuração de vários componentes do projeto, incluindo a configuração do endpoint usando conectores, você pode usar variáveis Jitterbit em qualquer campo que tenha um ícone de variável ícone de variável. As variáveis podem ser usadas em campos junto com outras entradas, inclusive com outras variáveis ou palavras-chave. Essas ações são abordadas abaixo:

Selecione uma Variável Jitterbit

Para acessar as variáveis do Jitterbit, você pode clicar no ícone da variável ícone da variável ou insira um colchete aberto [ para exibir uma lista de variáveis e palavras-chave (se disponíveis para o campo atual).

Dentro da lista, o tipo de variável ou palavra-chave é indicado pelo ícone próximo ao seu nome:

  • palavra-chave do nome do arquivo para palavra-chave de nome de arquivo
  • palavra-chave do nome do arquivo para variável global
  • variável do projeto para variável do projeto
  • variável jitterbit para variável Jitterbit

Na lista, passe o mouse sobre o nome da variável para visualizar informações sobre ela:

variável de seleção de nomes de arquivos de gravação ftp

O Valor e Descrição que aparecem no pop-up de informações estão sempre vazios para uma variável Jitterbit. Para obter uma descrição de como cada variável é usada, consulte as páginas deste tópico.

Um valor padrão para uma variável Jitterbit não pode ser definido em um campo de configuração. Em vez disso, você pode definir valores para determinadas variáveis Jitterbit em um script para serem avaliadas em tempo de execução.

Selecione uma variável para adicionar ao campo no local do cursor, em qualquer lugar da string. A variável é exibida em formato de comprimido semelhante ao mostrado abaixo:

pílula de gravação de nomes de arquivos ftp

Para revisar informações sobre a variável, passe o mouse sobre o quadro da variável:

ftp escrever nomes de arquivos pílula pairar

Alternar Formatos Entre Comprimido e Texto

Para alterar o formato padrão do comprimido variável para formato de texto, clique no ícone de recolhimento ícone de recolhimento:

colapso da pílula de nomes de arquivos de gravação de ftp

Isso alterna a exibição do formato de comprimido para um formato de texto, com o nome da variável entre colchetes [ ]:

ftp escreve texto de nomes de arquivos

Para mudar de um formato de texto para o formato de comprimido, mude o foco do campo, clicando em outro campo configurável. A entrada do campo retorna automaticamente ao formato de comprimido padrão.

Remover uma Variável

Para remover a variável, clique no ícone de remoção ícone fechar:

ftp write filenames pill remove

Tutoriais Sobre Variáveis jitterbit

Esta seção inclui detalhes sobre o uso de variáveis Jitterbit em projetos.

Crie Novas Variáveis ou Defina 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 de uso 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.

A alteração dos valores padrão ou a criação de novas variáveis Jitterbit é feita nestas seções do arquivo de configuração do Agente Privado:

  • [PredefinedGlobalVariables]
    Verifique ou altere os valores padrão das 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 destes 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 é substituído pela versão mais recente.

Aviso

Ao criar novas variáveis Jitterbit, não é recomendado usar pontos em um nome de variável se você planeja acessá-los com JavaScript. Em vez disso, é recomendável criar variáveis Jitterbit que não contenham pontos e, em vez disso, usar sublinhados no lugar de pontos. Consulte informações sobre variáveis globais, que também é aplicável a variáveis Jitterbit.

Para obter mais informações sobre edição ou criação de variáveis Jitterbit, consulte Editar o arquivo de configuração (jitterbit.conf).