Variáveis de projeto no Jitterbit Design Studio

Introdução

As variáveis de projeto 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 Jitterbit—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 Jitterbit.)

As variáveis de projeto são criadas inicialmente através do Design Studio. Uma vez que uma variável de projeto é criada, você pode definir valores para ela tanto pelo Design Studio, quanto pelo Console de Gerenciamento ou pelo Citizen Integrator, proporcionando a flexibilidade de definir e alterar parâmetros e credenciais sem a necessidade de reimplantar o projeto.

As variáveis de projeto são componentes do projeto que são implantados junto com ele. Ao contrário das variáveis globais, as variáveis de projeto têm um valor padrão armazenado na configuração do projeto que é definido no momento do design e implantado com o projeto.

As variáveis de projeto são definidas antes da execução da operação e estão disponíveis para uso em todos os itens do projeto, incluindo fontes e destinos, scripts e transformações. Se você alterar o valor de uma variável de projeto durante a execução da operação, a variável é tratada como uma variável global com o valor alterado persistindo apenas durante a duração da cadeia de operações. Ou seja, alterar o valor de uma variável de projeto em tempo de execução não atualiza seu valor para todo o projeto.

Os usos comuns das variáveis de projeto incluem credenciais de endpoint, nomes de arquivos ou variáveis que podem mudar de ambiente para ambiente. Isso inclui qualquer variável que você queira poder editar através do Console de Gerenciamento ou Citizen Integrator.

Criar e atualizar variáveis de projeto

Você cria e atualiza variáveis de projeto a partir do Design Studio. Uma vez criadas no Design Studio, as variáveis de projeto podem ser atualizadas no Console de Gerenciamento e no Citizen Integrator.

Design Studio

Dentro do seu projeto no Design Studio, existem as seguintes maneiras de criar uma nova variável de projeto:

• Vá para Arquivo > Novo > Nova Variável de Projeto; ou
• No painel à esquerda, clique com o botão direito na seção Variáveis de Projeto e selecione Nova Variável de Projeto; ou
• Na barra de ferramentas superior, clique no ícone de fórmula .

Uma tela de configuração será aberta na visualização principal do Design Studio, onde você pode editar sua variável de projeto. Você pode retornar à configuração de uma variável de projeto existente usando o painel à esquerda sob Variáveis de Projeto:

A tela de configuração da variável de projeto será semelhante a este exemplo:

• Nome: O campo de nome é o nome da variável que você está declarando. O campo de nome não pode ficar vazio e não deve conter espaços. O nome substituirá o espaço reservado padrão "NewProjectVariable" conforme visto no painel à esquerda. Você não pode deixar o nome da variável de projeto como o espaço reservado padrão. Os nomes podem ser compostos por caracteres alfanuméricos (as letras a-z e A-Z, e os dígitos 0-9), pontos (.) e sublinhados (_). (Outros caracteres, como hífens, não são recomendados e podem causar problemas.) Os nomes das variáveis de projeto não diferenciam maiúsculas de minúsculas; uma variável chamada GlobalVar é tratada da mesma forma que globalvar.

  Nota

  Pode ser uma boa prática usar pontos ou sublinhados ao definir variáveis globais para que sejam fáceis de encontrar. Por exemplo, uma variável global criada em um Script Jitterbit chamada org.account.filename começa com org, seguida de account, etc., organizando efetivamente por domínio quando em uma lista entre outras variáveis globais construídas de forma semelhante. Observe que para variáveis globais criadas em JavaScript (ou para variáveis globais de Script Jitterbit que podem ser usadas posteriormente em JavaScript) recomendamos usar sublinhados em vez de pontos. Usar pontos em variáveis globais definidas pelo usuário em JavaScript causa problemas em tempo de execução. Mais informações são fornecidas na subseção JavaScript abaixo.

  Aviso

  Se você planeja usar suas variáveis de projeto em JavaScript mais tarde, é recomendável usar sublinhados em vez de pontos. Mais informações são fornecidas abaixo em Usar variáveis de projeto em scripts ou transformações.

• Valor Padrão: Insira um valor padrão para a variável de projeto, se aplicável. Se você não quiser um valor padrão, deixe este campo em branco. O padrão, se fornecido, será usado como o valor inicial, que pode ser modificado através de scripts.

• Ocultar Valor: Selecione a caixa de seleção para ocultar o valor da variável de projeto substituindo-o por asteriscos ao exibi-lo na interface do usuário. Você pode querer usar isso se o valor contiver informações sensíveis que você não deseja visíveis na interface do usuário. Ao usar tanto a versão do agente 12.5 ou posterior quanto a versão do Design Studio 11.61 ou posterior, os valores mascarados também são ocultados na saída do script de teste, mensagens de log de operação escritas usando WriteToOperationLog e mensagens de erro escritas usando RaiseError. Limpar a caixa de seleção Ocultar Valor removerá qualquer valor existente inserido como Valor Padrão.

• Rótulo: Insira um rótulo para descrever o nome da variável, se desejado. Este rótulo aparecerá quando você passar o cursor sobre o nome da variável em scripts.

• Descrição: Insira uma descrição para fornecer mais detalhes sobre a variável, se desejado.

Management Console

Uma vez que uma variável de projeto tenha sido criada, você pode editá-la na Management Console na página Projects da aba Variáveis de Projeto.

Para abrir a variável de projeto para edição, use o menu suspenso Ação para selecionar Editar:

Na janela pop-up, você pode editar o valor, mostrar ou ocultar o valor, ou editar a descrição.

Citizen Integrator

Uma vez que uma variável de projeto foi criada, ela pode ser usada dentro das receitas do Citizen Integrator. Veja Citizen Integrator - Configurar receita para mais informações.

Recuperar variáveis de projeto em scripts ou transformações

No Design Studio, o valor de uma variável de projeto pode ser retornado usando Jitterbit Script ou JavaScript.

Jitterbit Script

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

• $: Começando com um sinal de dólar $, o exemplo de $org.netsuite.auth.username retorna o mesmo valor (ou campo em uma transformação).
• Get: Usando a função Get(), o exemplo de Get("org.netsuite.auth.username") obtém o valor (ou campo em uma transformação) da variável de projeto chamada org.netsuite.auth.username.

JavaScript

No JavaScript usado dentro de scripts criados em uma operação, a sintaxe usada para recuperar o valor de uma variável de projeto depende de o nome da variável de projeto conter um ponto.

• Nome não inclui um ponto (recomendado): O valor de uma variável de projeto que não contém nenhum ponto em seu nome pode ser recuperado começando com um sinal de dólar $.

  • $: Começando com um sinal de dólar $, o exemplo de $org_netsuite_auth_username retorna o valor da variável de projeto chamada org_netsuite_auth_username.

• Nomes com pontos (recomendado apenas para variáveis Jitterbit e valores de objetos JavaScript): Uma variável que contém um ponto em seu nome pode ser atualizada ou recuperada em JavaScript apenas com as funções Jitterbit.SetVar e Jitterbit.GetVar. Como essas funções não são destinadas a variáveis globais definidas pelo usuário, consulte variáveis Jitterbit para mais informações.

  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 prefixação $ 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.

  Se um JavaScript falhar, quaisquer alterações feitas no valor de uma variável global são perdidas. Apenas se o JavaScript for concluído com sucesso, as variáveis globais modificadas estarão disponíveis fora do script.

Usar variáveis de projeto em telas de definição

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

Por exemplo, se você estiver usando a variável de projeto 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 [org.netsuite.auth.username].