Variáveis de projeto no Jitterbit Integration Studio

Introdução

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

As variáveis de projeto são definidas antes da execução de uma operação e estão disponíveis para uso em todos os componentes de um projeto, incluindo scripts, transformações e endpoints criados usando conectores. 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 de variáveis de projeto incluem credenciais de endpoint, nomes de arquivos ou variáveis que podem mudar de ambiente para ambiente, ou qualquer variável que você queira poder editar através do Console de Gerenciamento ou Citizen Integrator.

Ao implantar uma variável de projeto que já foi implantada na nuvem Harmony, você é apresentado a opções para selecionar quais valores de variáveis de projeto usar. Isso é abordado em Selecionar cronogramas e variáveis de projeto em Implantação de projeto.

Criar e atualizar variáveis de projeto

Você cria e atualiza variáveis de projeto a partir do Integration Studio, assim como atualiza variáveis de projeto existentes de um projeto implantado a partir do Console de Gerenciamento e do Integrador Cidadão.

As próximas seções descrevem como criar uma nova variável de projeto a partir de diferentes locais no Integration Studio:

• Aba Variáveis de Projeto do painel do projeto
• Painel do projeto
• Editor de script
• Modo de mapeamento de transformação
• Configurações de endpoint

Novas variáveis de projeto são criadas com o nome padrão New_Project_Variable. Variáveis de projeto subsequentes com o nome padrão são acrescidas de um número incrementado.

Uma vez que uma nova variável de projeto foi criada, você a configura — dependendo de como foi criada — na visualização de painel ou individualmente, conforme descrito abaixo em Configurar uma variável de projeto.

Aba Variáveis de Projeto do painel do projeto

A aba Variáveis de Projeto do painel do projeto contém uma lista das variáveis de projeto criadas para um projeto. Inclui controles para criar novas variáveis de projeto e para editar e excluir variáveis de projeto existentes.

Não é necessário abrir um projeto para acessar suas variáveis de projeto. A aba Variáveis de Projeto do painel do projeto é acessível tanto de fora quanto dentro de um projeto a partir destes locais:

• A página Projetos (veja Visualização em bloco ou Visualização em lista em Projetos).
• A barra de ferramentas do projeto (veja Menu de ações do projeto na barra de ferramentas do projeto).

Ao selecionar Variáveis do Projeto, o painel do projeto se abre na parte inferior da tela:

• Guias: Ao acessar logs para operações ou fluxos de trabalho, guias adicionais aparecem na parte superior do painel. Essas guias são rotuladas com Registro seguido pelo nome de uma operação ou fluxo de trabalho. Para reorganizar as guias, arraste e solte uma guia. Para fechar uma guia, clique no ícone de fechar . Fechar a última guia ou usar o ícone de fechar mais à direita fecha o painel.
• Redimensionar: A barra na parte superior do painel pode ser usada para redimensionar o painel. Passe o mouse sobre a barra e arraste o ícone de redimensionar para cima ou para baixo.
• Colapsar: Colapsa o painel. Uma vez colapsado, clique no ícone de retorno para voltar à visualização anterior.
• Expandir: Expande o painel para tela cheia. Uma vez expandido, clique no ícone de retorno para voltar à visualização anterior.
• Fechar: Fecha o painel.

Para editar uma variável de projeto existente, clique dentro dos campos da tabela de variáveis do projeto e edite os valores inline.

Informações adicionais sobre como buscar, excluir e configurar variáveis de projeto a partir desta visualização são fornecidas em Configurar variáveis de projeto na visualização do painel mais adiante nesta página.

Painel do projeto

Uma nova variável de projeto pode ser criada na guia Componentes do painel do projeto usando a opção Criar Novo na categoria Variáveis do Projeto (veja Menu de ações da guia Componentes na Guia Componentes do Painel do Projeto).

Uma variável de projeto existente pode ser editada na guia Componentes do painel do projeto usando a opção Visualizar/Editar em um componente de variável de projeto (veja Menu de ações do componente na Guia Componentes do Painel do Projeto).

Ambas as opções de menu abrem a tela de configuração da variável de projeto individual, conforme abordado em Configurar uma variável de projeto individualmente mais adiante nesta página.

Editor de script

No editor de script, abra a aba Variáveis do painel de componentes e, em seguida, vá para a sub-aba Variáveis do Projeto:

• Adicionar Novo: Clique para criar uma nova variável de projeto.

• Editar: Para editar uma variável de projeto existente, passe o mouse sobre o nome da variável para visualizar informações adicionais e clique em qualquer lugar no nome da variável de projeto ou no popup de informações:

  

Ambas as ações abrem a tela de configuração da variável de projeto individual, conforme abordado em Configurar uma variável de projeto individualmente mais adiante nesta página.

Modo de mapeamento de transformação

No modo de mapeamento de transformação, abra a aba Variáveis à esquerda e expanda a categoria Variáveis do Projeto:

• Criar Nova Variável de Projeto: Clique para criar uma nova variável de projeto.

• Pesquisar: Para pesquisar uma variável específica pelo nome, clique no ícone de busca e insira uma palavra-chave ou várias palavras-chave separadas por vírgulas na caixa de pesquisa. A pesquisa retorna uma lista de variáveis que contêm qualquer uma das palavras-chave.

• Editar: Para editar uma variável de projeto existente, passe o mouse sobre o nome da variável e clique no ícone de edição :

Ambas as ações de criar uma nova variável de projeto e editar uma variável de projeto existente abrem a tela de configuração da variável de projeto individual, conforme abordado em Configurar uma variável de projeto individualmente mais adiante nesta página.

Configurações de endpoint

Ao usar um conector para configurar um endpoint, nos campos que possuem um ícone de variável , clique no ícone para exibir uma lista de variáveis existentes. Para criar uma nova variável de projeto, clique em Adicionar no canto inferior direito:

• Para editar uma variável de projeto existente nesta lista, passe o mouse sobre a linha da variável de projeto e clique no ícone de edição à direita.

• Quando uma variável de projeto existente já tiver sido usada em um campo de configuração, passe o mouse sobre a pílula da variável para visualizar informações sobre a variável, em seguida, clique no ícone de edição ou em Editar no canto inferior esquerdo:

  

Todas essas ações abrem a tela de configuração individual da variável de projeto, conforme abordado em Configurar uma variável de projeto individualmente mais adiante nesta página.

Menu de ações da variável de projeto

Após a criação de uma variável de projeto, as ações do menu para essa variável de projeto estão acessíveis na aba Componentes do painel do projeto (veja Menu de ações do componente na aba Componentes do painel do projeto).

Cada uma dessas ações de menu está disponível:

Item do Menu	Descrição
	Ver/Editar abre a tela de configuração individual da variável de projeto para que você possa configurar a variável de projeto. Para detalhes, veja Configurar uma variável de projeto individualmente mais adiante nesta página.
	Cortar coloca uma cópia da variável de projeto na sua área de transferência e exclui a variável de projeto original do projeto (veja Reutilização de componentes).
	Copiar coloca uma cópia da variável de projeto na sua área de transferência (veja Reutilização de componentes).
	Duplicar cria uma nova variável de projeto não referenciada usando a mesma configuração da variável de projeto original (veja Reutilização de componentes).
	Renomear posiciona o cursor no nome da variável de projeto para que você possa fazer as edições necessárias.
	Ver Dependências altera a visualização no painel do projeto para exibir quaisquer outras partes do projeto das quais a variável de projeto depende (veja Dependências de componentes, exclusão e remoção).
	Adicionar ao Grupo abre uma caixa de diálogo para criar um novo grupo personalizado ou adicionar a variável de projeto a um grupo existente (veja Grupos de componentes).
	Excluir exclui permanentemente a variável de projeto (veja Dependências de componentes, exclusão e remoção).
	Remover não está funcional no momento.

Configurar uma variável de projeto

Uma vez que uma variável de projeto é criada, ela pode ser configurada de duas maneiras:

• Configurar variáveis de projeto na visualização de gaveta: A visualização de gaveta é aberta ao criar ou editar variáveis de projeto fora do projeto na página Projetos ou se você selecionar Variáveis de Projeto no menu de ações do projeto.

• Configurar uma variável de projeto individualmente: A caixa de diálogo para variáveis de projeto individuais é aberta ao editar ou criar uma variável de projeto diretamente do painel do projeto, dentro de um script ou transformação, ou dentro de uma tela de configuração de endpoint (como descrito em Criar e atualizar variáveis de projeto anteriormente nesta página).

Configurar uma variável de projeto na visualização de gaveta

Configurar uma variável de projeto na gaveta do projeto é uma das duas visualizações usadas para configurar variáveis de projeto. (A outra visualização é usada ao configurar uma variável de projeto individual.)

A gaveta de variáveis de projeto é acessível tanto de fora quanto dentro de um projeto. Não é necessário abrir um projeto para acessar a gaveta. A opção Variáveis de Projeto pode ser acessada a partir destes locais:

• A página Projetos (veja Visualização em bloco ou Visualização em lista em Projetos).
• A barra de ferramentas do projeto (veja Menu de ações do projeto na Barra de ferramentas do projeto).

Ao acessar a gaveta de variáveis de projeto, estas ações estão disponíveis:

• Excluir Variável(is): Habilitado apenas quando pelo menos uma variável de projeto está selecionada. Clique para excluir permanentemente a variável de projeto (veja Dependências de componentes, exclusão e remoção).

• Nova Variável: Adiciona uma nova linha de variável de projeto na parte inferior da tabela de variáveis de projeto. Alternativamente, você pode adicionar uma nova linha de variável de projeto colocando o cursor no campo Descrição da última linha e, em seguida, pressionando a tecla Tab. Com qualquer um dos métodos de criação de uma nova variável de projeto, o cursor é colocado no campo Nome para que você renomeie a variável de projeto:

  

  Caution

  Como todos os elementos de dados globais (variáveis globais, variáveis de projeto e variáveis Jitterbit) compartilham o mesmo namespace, seus nomes devem ser exclusivos em comparação com todos os outros elementos de dados globais.

  Assim que você clicar fora dos campos da nova variável de projeto, a variável de projeto é salva. A ordem de classificação pode ser alterada clicando no cabeçalho da coluna para Nome, Valor Padrão, Rótulo ou Descrição.

  As variáveis de projeto podem ser configuradas clicando ou navegando para cada campo dentro da tabela e editando-o inline.

  Para novas variáveis de projeto, a configuração é salva quando você muda o foco para fora da nova linha de variável de projeto. Para variáveis de projeto existentes, a configuração é salva cada vez que você muda o foco para outro campo, mesmo dentro da mesma linha de variável de projeto.

• Pesquisar: Insira uma única palavra-chave ou string de palavras-chave na caixa de pesquisa para buscar uma variável de projeto pelo seu Nome ou Descrição.

Colunas da tabela de variáveis de projeto

Cada coluna da tabela de variáveis de projeto é descrita abaixo:

• Selecionar: A coluna na extrema esquerda pode ser usada para selecionar uma, várias ou todas as variáveis de projeto para exclusão. Após pelo menos uma variável de projeto ser selecionada, o botão Excluir Variável(is) na parte superior da tabela está disponível para você excluir permanentemente a variável de projeto (veja Dependências de componentes, exclusão e remoção).

• Nome: Insira o nome da variável do projeto. O nome da variável do projeto deve ser único dentro do projeto, não deve conter espaços e pode ser composto pelos seguintes caracteres: letras (a-z, A-Z), números (0-9), pontos e sublinhados. Outros caracteres não são recomendados e podem causar problemas. Os nomes das variáveis do projeto não diferenciam maiúsculas de minúsculas; por exemplo, uma variável chamada ProjectVar é tratada da mesma forma que projectvar. Como todos os elementos de dados globais (variáveis globais, variáveis de projeto e variáveis Jitterbit) compartilham o mesmo espaço de nomes, seus nomes devem ser únicos em comparação com todos os outros elementos de dados globais.

  Ao criar novas variáveis de projeto, é uma boa prática prefixar as variáveis do projeto para que sejam fáceis de localizar posteriormente. Por exemplo, uma variável de projeto org.netsuite.auth.username é primeiro prefixada com org, depois netsuite, etc., para organizá-la efetivamente em uma lista entre outras variáveis de projeto. No entanto, se você planeja usar as variáveis do projeto em JavaScript mais tarde, recomendamos usar sublinhados em vez de pontos. Mais informações são fornecidas abaixo em Recuperar variáveis de projeto em scripts ou transformações.

  Uma variável global existente pode ser convertida em uma variável de projeto inserindo seu nome no campo Nome. Veja Converter uma variável global em uma variável de projeto para detalhes.

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

• Valor de Máscara: Use o controle deslizante para ativar a opção Valor de Máscara. Ativar esta opção oculta o valor padrão substituindo-o por pontos pretos em vários lugares da interface do usuário. Você pode querer usar isso se o valor contiver informações sensíveis que você não deseja que sejam visíveis na tela.

  Atenção

  Mascar o valor não impede que o valor seja acessível em um script.

• Rótulo: Insira um rótulo opcional para descrever a variável. Este rótulo aparece quando você passa o mouse sobre a variável em scripts e nas telas de configuração.

• Descrição: Insira uma descrição opcional para fornecer mais detalhes sobre a variável. Esta descrição aparece quando você passa o mouse sobre a variável em scripts e nas telas de configuração.

Configurar uma variável de projeto individualmente

Configurar uma variável de projeto em uma caixa de diálogo é uma das duas visualizações usadas para configurar variáveis de projeto. (A outra visualização é a visualização de gaveta de variável de projeto.)

Esta visualização é usada quando você cria ou edita uma variável de projeto diretamente do painel do projeto, dentro de um script ou transformação, ou dentro de uma tela de configuração de endpoint.

Quando você cria uma nova variável de projeto ou edita uma variável de projeto existente individualmente, a caixa de diálogo Visualizar/Editar Variável de Projeto é exibida:

• Nome da variável de projeto: Insira o nome da variável de projeto que você deseja declarar. O nome da variável de projeto deve ser exclusivo dentro do projeto, não deve conter espaços e pode ser composto 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. Os nomes das variáveis de projeto não diferenciam maiúsculas de minúsculas; por exemplo, uma variável chamada ProjectVar é tratada da mesma forma que projectvar. Como todos os elementos de dados globais (variáveis globais, variáveis de projeto e variáveis Jitterbit) compartilham o mesmo espaço de nomes, seus nomes devem ser exclusivos em comparação com todos os outros elementos de dados globais.

  Ao criar novas variáveis de projeto, é uma boa prática prefixar as variáveis de projeto para que sejam fáceis de localizar mais tarde. Por exemplo, uma variável de projeto org.netsuite.auth.username é primeiro prefixada com org, depois netsuite, etc. para organizá-la efetivamente em uma lista entre outras variáveis de projeto. No entanto, se você planeja usar as variáveis de projeto em JavaScript mais tarde, recomendamos usar sublinhados em vez de pontos. Mais informações são fornecidas abaixo em Recuperar variáveis de projeto em scripts ou transformações.

Uma variável global existente pode ser convertida em uma variável de projeto inserindo seu nome no campo Nome. Veja Converter uma variável global em uma variável de projeto para mais detalhes.

• Valor padrão: Insira um valor padrão opcional a ser usado como o valor inicial para a variável de projeto. Este valor pode ser modificado posteriormente por meio de script. Se você não quiser que a variável de projeto tenha um valor padrão, deixe este campo em branco.

• Ocultar valor na interface: Use o controle deslizante para ativar a opção Mascarar valor. Ativar esta opção oculta o valor padrão substituindo-o por pontos pretos em vários locais da interface do usuário. Você pode querer usar isso se o valor contiver informações sensíveis que não deseja que sejam visíveis na tela. Após ativar esta opção, você será solicitado a confirmar que deseja ocultar o valor:

  Texto do diálogo

  Mascarar valor
  Você tem certeza? Esta ação irá mascarar o valor atual e não pode ser desfeita.

  Caution

  Mascarar o valor não impede que o valor seja acessado em um script.

  Se você desativar esta opção após ativá-la, será solicitado a confirmar que deseja remover o valor atual (já que um valor anteriormente oculto não pode ser revelado):

  Texto do diálogo

  Revelar e atualizar valor
  Você tem certeza? Esta ação irá atualizar o valor atual e não pode ser desfeita.

  Após clicar em Continuar, o cursor será posicionado em um campo Valor Padrão vazio.

• Rótulo: Insira um rótulo opcional para descrever a variável. Este rótulo aparece quando você passa o mouse sobre a variável em scripts e nas telas de configuração.

• Descrição: Insira uma descrição opcional para fornecer mais detalhes sobre a variável. Esta descrição aparece quando você passa o mouse sobre a variável em scripts e nas telas de configuração.

• Salvar: Clique para salvar e fechar a configuração da variável de projeto.

• Excluir: Após abrir uma variável de projeto existente, clique para excluir permanentemente a variável de projeto e fechar a configuração (veja Dependências de componentes, exclusão e remoção).

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

No Integration Studio, o valor de uma variável de projeto pode ser retornado usando Jitterbit Script em scripts ou transformações, ou usando JavaScript apenas em scripts criados como um componente de projeto.

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 de projeto.

• $: Prefixado com um sinal de dólar $, o exemplo de código $org.netsuite.auth.username recupera o valor da variável de projeto chamada "org.netsuite.auth.username".
• Get: Usando a função Get, o exemplo de código Get("org.netsuite.auth.username") retorna o mesmo valor.

Em scripts e transformações, as variáveis de projeto existentes são exibidas na aba Variáveis do painel de componentes do script dentro da sub-aba Variáveis do Projeto. Veja Adicionar uma variável de projeto a um script abaixo.

JavaScript

No JavaScript usado dentro de scripts dentro de 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 prefixando com um sinal de dólar $.

• $: Prefixado com um sinal de dólar $, o exemplo de código $org_netsuite_auth_username recupera o valor da variável de projeto chamada "org_netsuite_auth_username".

• Nome 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 de projeto definidas pelo usuário, consulte a seção sobre variáveis Jitterbit para mais informações.

Em scripts e transformações, as variáveis de projeto existentes são exibidas na aba Variáveis do painel de componentes do script dentro da sub-aba Variáveis do Projeto. Veja Adicionar uma variável de projeto a um script abaixo.

Adicionar uma variável de projeto a um script

Em Jitterbit Script ou JavaScript usado dentro de scripts criados dentro de uma operação, as variáveis de projeto existentes são exibidas na aba Variáveis do painel de componentes dentro da sub-aba Variáveis do Projeto:

Para adicionar a sintaxe de variável a um script (Jitterbit Script ou JavaScript), use um dos seguintes 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 na localização do cursor dentro do script.
• Comece a digitar o nome da variável e, em seguida, pressione Control+Space para exibir uma lista de sugestões de autocompletar. Selecione uma variável para inserir a sintaxe da variável.
• Digite manualmente a sintaxe da variável.

Usar variáveis do projeto em telas de configuração

Durante a configuração de certos componentes do projeto, incluindo a configuração de endpoint usando conectores, você pode usar variáveis do projeto em quaisquer campos que tenham um ícone de variável . As variáveis podem ser usadas em campos junto com outras entradas, incluindo outras variáveis ou palavras-chave.

Selecionar uma variável do projeto

Para acessar variáveis do projeto, você pode clicar no ícone de variável ou inserir 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 ao lado do seu nome:

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

O fundo do ícone é sólido se a variável do projeto tiver um valor padrão especificado na configuração da variável do projeto, ou vazio se não tiver.

Selecione uma variável para adicionar ao campo na localização do seu cursor, em qualquer lugar na string. A variável é exibida em um formato de pílula semelhante ao mostrado abaixo:

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

Controles de visualização

Uma vez que uma variável de projeto tenha sido selecionada, você pode alternar entre formatos ou remover a variável de projeto:

• Colapsar: Para mudar o formato padrão da pílula da variável para o formato de texto, clique no ícone de colapso :

  

  Para mudar de um formato de texto de volta para o formato de pílula, desfoque o campo, como clicando em outro campo configurável. A entrada do campo retorna automaticamente ao formato padrão de pílula.

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

Como trabalhar com variáveis de projeto

Esta seção fornece informações sobre como completar tarefas específicas com variáveis de projeto.

Converter uma variável global em uma variável de projeto

Para converter uma variável global existente em uma variável de projeto, insira o nome da variável global existente no campo Nome da Variável de Projeto. Ao salvar (mudando o foco para fora da linha se estiver na visualização de gaveta ou clicando em Salvar se estiver na visualização individual), você será solicitado a confirmar que deseja converter a variável global em uma variável de projeto:

Ao clicar em Continuar, todas as referências e dependências da variável global são transferidas para a variável do projeto. Isso inclui referências à antiga variável global dentro de scripts, que agora referenciam a variável do projeto. Lembre-se de que um valor para uma variável do projeto definido em um script durante a execução da cadeia de operações substitui o valor padrão especificado na configuração da variável do projeto. Clicar em Cancelar cancela a conversão da variável global.

Transferir variáveis do projeto

Ao Transferir um projeto, você tem a capacidade de selecionar quais variáveis do projeto terão seus valores excluídos no ambiente de destino.

Isso permite que você mantenha os valores das variáveis do projeto segregados em um ambiente. Por exemplo, você pode querer manter valores de variáveis do projeto separados para uma URL de host de endpoint para um ambiente de Produção e uma URL de host de endpoint de sandbox separada para um ambiente de QA.

Você pode querer excluir certos valores de variáveis do projeto da transferência para evitar preencher seus valores na transferência inicial ou para evitar sobrescrever seus valores em transferências subsequentes.

Para excluir variáveis do projeto da transferência, selecione a opção Selecionar Valores de Variáveis para Migrar na tela de transferência do projeto. Quando essa opção é selecionada, nenhum valor de variável do projeto é selecionado para transferência por padrão. Se você quiser incluir algum valor de variável do projeto durante a transferência, pode selecioná-los individualmente. Para mais detalhes, veja Transferência de projeto em Transferir um projeto.