Como usar variáveis na integração da Apigee

Aviso: o Application Integration já está disponível para seu projeto do Google Cloud. Agora é possível usar a Apigee Integration e o Application Integration no mesmo projeto do Google Cloud. Saiba mais

Uma variável é um elemento de integração que armazena e transporta dados entre as tarefas, os acionadores e as bordas de uma integração.

• As variáveis podem ser definidas estaticamente no momento do design ou transmitidas dinamicamente para a integração durante a execução.
• As variáveis podem se referir a outras variáveis em uma integração.
• As variáveis podem ser globalmente acessíveis para todas as tarefas ou acessíveis localmente a uma tarefa específica.

Três tipos de variáveis estão disponíveis:

• As variáveis de integração rastreiam os dados ao longo de toda a execução de integração.
• Variáveis de tarefa rastreiam dados pela duração de uma única tarefa.
• Variáveis de configuração: armazene os dados de configuração da integração.

Variáveis de integração

As variáveis de integração são semelhantes às usadas em uma linguagem de programação. Os dados nas variáveis podem ser lidos e gravados durante a execução da integração.

As variáveis de integração podem ser usadas das seguintes maneiras:

• Tomado como entradas para a integração (variáveis de entrada).
• Retornado como saídas da integração (variáveis de saída).
• Usado para reter o estado temporário durante a integração.
Observação: os papéis de variável listados acima não são mutuamente exclusivos. Qualquer variável pode ser uma variável de entrada, de saída, ambas ou nenhuma.

O valor de uma variável não precisa ser definido estaticamente na integração. Os valores das variáveis podem ser transmitidos para uma integração usando um acionador. No entanto, se uma variável for definida estaticamente na integração e a mesma variável for fornecida dinamicamente com o acionador, a atribuição do valor dinâmico substituirá a atribuição estática.

Tipos de dados compatíveis para variáveis de integração

Os seguintes tipos de dados são compatíveis com variáveis de integração:

• String e matriz de strings
• Inteiros e matriz de inteiros
• Dupla e matriz de duplas
• Booleano e matriz de booleanos
• JSON

Variáveis de tarefas

As variáveis de tarefas são variáveis predefinidas geradas automaticamente de uma tarefa. Se uma tarefa tiver uma saída, todas essas saídas estarão disponíveis em uma variável de tarefa. Não é possível excluir nem editar uma variável de tarefa. Por exemplo, na tarefa Chamar endpoint REST, o corpo da resposta é armazenado na variável responseBody.

Variáveis de configuração

Visualização

Este produto ou recurso está sujeito aos "Termos das ofertas pré-GA" na seção "Termos de Serviço gerais" dos Termos específicos do serviço. Os produtos e recursos pré-GA estão disponíveis "no estado em que se encontram" e podem ter suporte limitado. Para mais informações, consulte as descrições da fase de lançamento.

As variáveis de configuração permitem externalizar a configuração para integração. Com elas, é possível definir aspectos da integração, como detalhes do conector, detalhes de autenticação ou endpoints de URL baseados no ambiente de desenvolvimento (controle de qualidade, preparo ou produção). Não é preciso atualizar a integração manualmente antes de fazer o upload dela em um novo ambiente. O Application Integration permite inserir valores para as variáveis de configuração ao publicar a integração.

Para saber como criar variáveis de configuração e usá-las, consulte o tutorial Criar CICD para sua integração.

Ver variáveis

É possível usar o painel Variables para criar, editar, conferir, duplicar e excluir variáveis na integração. O painel Variáveis também exibe uma contagem do total de referências de variáveis na integração.

Para visualizar o painel Variáveis, clique em (painel "Alternar") na barra de navegação do designer.

A imagem a seguir mostra um layout de amostra do painel Variáveis:

Crie uma variável

Para criar uma variável, siga estas etapas:

1. Na barra de navegação do editor de integração, clique em (painel "Alternar") para abrir o painel Variáveis.
2. Clique em +Criar.
3. Faça o seguinte no painel Criar variável:
   1. Nome: insira o nome da variável.
   2. Tipo da variável:escolha o tipo da variável.

   Tipo de dados	Descrição
   Nenhuma	Uma variável local em uma integração.
   Variável de configuração para integração	Uma variável de configuração em uma integração.
   Entrada para integração	Durante a execução, a variável será fornecida como uma entrada para o gatilho executado.
   Saída da integração	O valor final da variável ao final da execução precisa ser enviado para o autor da chamada da integração.
   Entrada e saída da integração	Na execução, a variável será fornecida como uma entrada para o gatilho executado, e o valor final dela será enviado para o autor da chamada da integração.

   3. Tipo de dados: escolha o tipo de dados da variável. É possível identificar o tipo de dados de uma variável usando o ícone colorido ao lado do nome dela.

      Data type	Exemplo
      String	Alex
      Inteiro	30
      Duplo	30.5
      Booleano	true
      JSON	{ "employee":{"name":"Alex", "age":30, "city":"Mountain View"} }
      Matriz de strings	Alex, Kai, Raha
      Matriz de números inteiros	30, 25, 22
      Matriz dupla	30.5, 25.34, 22.134
      Matriz booleana	true, false, false

      Para saber mais sobre os tipos de dados compatíveis, consulte Tipos de dados compatíveis.

   4. Valor padrão: insira o valor padrão da variável. Esse campo é opcional.
   5. Esquema: selecione o esquema JSON para a variável.
      • Inferir de um payload JSON de amostra: gere um esquema JSON de um payload JSON de amostra. O payload de amostra é descartado após a geração do esquema. Apenas o esquema gerado será salvo.
      • Inserir um esquema JSON: insira manualmente um esquema JSON inteiro.
      • Inferir do valor padrão: gere um esquema JSON usando o valor padrão fornecido.
      • Nenhum: nenhum esquema JSON.
      Observação: este campo é exibido apenas para as variáveis de tipo de dados JSON.
   6. Mascarar a variável nos registros (visualização): selecione essa opção para ativar o mascaramento da variável nos registros de execução da integração. Para ativar o mascaramento da variável, é necessário ativar o mascaramento de variáveis para sua integração e região. Para informações sobre como ativar o mascaramento para a integração e a região, consulte Editar uma integração e Editar regiões.

      Para saber mais sobre o mascaramento, consulte Mascarar dados sensíveis nos registros.

4. Clique em Criar.

Como usar dados variáveis em integrações

Durante a integração, os dados do tempo de execução são transmitidos como variáveis declaradas para a integração ou tarefa. Quando a execução começa, os dados de entrada são convertidos em um objeto na memória chamado Event.

Depois da criação do objeto Event, um gráfico de tarefas na memória é criado usando a definição de integração. Os valores de variáveis de entrada são passados para as tarefas com base na configuração. Quando a integração é executada, as tarefas leem e gravam dados no objeto Event para serem usados por tarefas subsequentes ou formar os dados de saída da integração.