Variáveis Jitterbit no Design Studio
Visão geral
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 definidos de forma diferente, conforme descrito em Variáveis globais e Variáveis do projeto.)
As variáveis Jitterbit estão sempre disponíveis em todo o seu projeto. Elas são predefinidas pelo Jitterbit ou definidas no arquivo de configuração do 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. Com menos frequência, variáveis Jitterbit são gravadas ao 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, deve ser definido a acima na cadeia da chamada da função. Upstream operações ou scripts são aqueles que estão vinculados dentro de uma cadeia de operação usando ações de operação ou 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.
Como essas variáveis são variáveis predefinidas, os projetos raramente criam ou alteram o valor padrão de uma variável Jitterbit. No entanto, ao usar um agente privado, as 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 obter documentação sobre as variáveis Jitterbit predefinidas:
- Variáveis Jitterbit da API
- Variáveis Jitterbit de endpoint hospedado
- Variáveis NetSuite Jitterbit
- Operação Variáveis Jitterbit
- Script de variáveis Jitterbit
- Variáveis SFDC Jitterbit
- Variáveis Jitterbit de origem
- Variáveis Jitterbit de destino
- Variáveis Jitterbit de texto
- Variáveis Jitterbit de Transformação
- Variáveis Jitterbit do serviço Web
- Variáveis Jitterbit diversas
Exibição de variáveis Jitterbit
Ao projetar seu projeto, as variáveis Jitterbit estão disponíveis na aba Data Elements do script builder, acessível a partir das telas de scripts e transformações. Cada variável Jitterbit predefinida pelo Jitterbit é documentada em uma página sob esta seção.
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. Em 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 de cada variável Jitterbit para obter informações sobre quais variáveis podem ser definidas e para que 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"
para o aplicativo solicitante.Set
: Usando oSet()
função,Set("jitterbit.api.response", "Success")
define a resposta da API (jitterbit.api.response
) para retornar a string"Success"
ao aplicativo solicitante.
Em scripts e transformações, as variáveis Jitterbit também serão exibidas na aba Variáveis da paleta de componentes de script, dentro da subaba Variáveis Jitterbit.
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
: UsandoJitterbit.SetVar
, o exemplo de códigoJitterbit.SetVar("$jitterbit.api.response", "Success")
define a resposta da API para retornar a string"Success"
ao aplicativo solicitante.
Em scripts e transformações, as variáveis Jitterbit também serão exibidas na aba Variáveis da paleta de componentes de script, dentro da subaba Variáveis Jitterbit.
Aviso
O JavaScript Jitterbit.SetVar
e Jitterbit.GetVar
funções 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 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.
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 (somente em scripts criados como um componente do projeto) da mesma forma que uma variável global pode ser recuperado.
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 incorreto do campo de destino na transformação. Até que esse problema seja resolvido, as variáveis Jitterbit não podem ser referenciadas diretamente em uma transformação. O script pode ser usado para criar um mecanismo de solução alternativa para passar valores.
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 oGet()
função, o exemplo de códigoGet("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 da paleta de componentes de script, dentro da subaba Variáveis Jitterbit.
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:
UsandoJitterbit.GetVar
, o exemplo de códigoJitterbit.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 nomesjitterbit.operation.name
e$jitterbit.operation.name
são equivalentes ao recuperar valores.
Aviso
O JavaScript Jitterbit.SetVar
e Jitterbit.GetVar
funções 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 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 serão exibidas na aba Variáveis da paleta de componentes de script, dentro da subaba Variáveis Jitterbit.
Use variáveis Jitterbit em telas de definição
Em uma tela de definição (durante a configuração de fontes ou destinos), você pode referenciar variáveis Jitterbit usando o [JitterbitVariableName]
sintaxe.
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, você pode referenciá-la usando colchetes como [jitterbit.source.filename]
.
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 por meio 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 de valores padrão ou a criação de novas variáveis Jitterbit é feita a partir destas 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 estes 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 no nome de uma variável se você planeja acessá-las com JavaScript. Em vez disso, é recomendado que você crie variáveis Jitterbit que não contenham pontos e, em vez disso, use sublinhados no lugar de pontos. Consulte as informações sobre variáveis globais, que também é aplicável a variáveis Jitterbit.
Para mais informações sobre como editar ou criar variáveis Jitterbit, veja Editar o arquivo de configuração (jitterbit.conf).