Variáveis

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.

Variáveis

No Application Integration, as variáveis são definidas ou inicializadas em vários lugares:

• Variáveis de configuração: definidas no momento do design para armazenar os dados de configuração da integração. Por exemplo, você pode usar isso para definir um endereço de e-mail de destino para notificação, em vez de codificar esse endereço de e-mail na integração.
• Variáveis de sistema: geradas automaticamente pelo sistema para armazenar os dados de configuração da integração. Por exemplo, a variável ExecutionId armazena o ID de execução da integração.
• Variáveis de integração: definidas explicitamente na integração para rastrear dados ao longo de toda a execução de integração. Por exemplo, é possível definir uma variável para armazenar o resultado de uma tarefa e usá-la em uma tarefa subsequente.
• Variáveis de tarefa: definidas implicitamente pela execução de tarefas específicas para armazenar a saída da tarefa. Por exemplo, a tarefa Chamar endpoint REST define a variável responseBody para armazenar o corpo da resposta do endpoint REST. As variáveis de tarefa também são conhecidas como variáveis geradas automaticamente. As variáveis geradas automaticamente têm uma convenção de nomenclatura especial de usar acentos graves em torno do nome da variável.

Variáveis de integração

As variáveis de integração, que incluem variáveis de entrada e saída, 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:

• Tomadas como entradas para a integração, também conhecidas como variáveis de entrada.
• Retornadas como saídas da integração, também conhecidas como variáveis de saída.
• Usadas para reter o estado temporário durante a execução de uma 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.

Ao marcar uma variável como uma variável de entrada, você indica que o valor da variável é esperado para ser fornecido quando a integração é acionada. O valor de uma variável de entrada pode ser modificado durante a execução da integração.

Ao marcar uma variável como uma variável de saída, você indica que o valor final da variável precisa ser retornado como parte da resposta da integração.

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

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. As variáveis de tarefa também são conhecidas como variáveis geradas automaticamente.

O nome exclusivo de uma variável de tarefa segue uma convenção de nomenclatura especial: usa acentos graves em torno do nome da variável e inclui o ID da tarefa. O formato é `<Task ID>_<Variable Name>`.

Por exemplo, a tarefa Chamar endpoint REST tem uma saída para o corpo da resposta. Se essa tarefa tiver um ID de Task_5, o nome exclusivo da variável de tarefa para o corpo da resposta será `Task_5_responseBody`.

No painel Variáveis, as variáveis de tarefa podem ser listadas por um nome de saída comum, por exemplo, responseBody, sem o ID da tarefa ou acentos graves. Para conferir o nome completo e exclusivo da variável necessária para referência, clique na variável no painel e confira os detalhes no painel à direita.

Variáveis de configuração

Visualização : conector do BigQuery

Este recurso está sujeito aos Termos das Soluções Pré-GA na seção Termos Gerais de Serviço dos Termos Específicos de Serviço. Os 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, como controle de qualidade, preparo ou produção. Não é necessário atualizar a integração manualmente antes de fazer o upload dela para um novo ambiente. O Application Integration permite inserir valores para as variáveis de configuração ao publicar a integração.

Para conferir e editar as variáveis de configuração definidas na integração, clique em variable_add Variável de configuração de integração no painel Variáveis. Para saber como criar variáveis de configuração e usá-las, consulte o tutorial Criar CICD para sua integração.

Variáveis de sistema

As variáveis de sistema são geradas automaticamente quando você cria uma integração. É possível usar essas variáveis nas tarefas de integração e para processar erros. A integração contém as seguintes variáveis geradas pelo sistema:

• ErrorInfo: quando a execução falha, é possível acessar os detalhes do erro com a variável ErrorInfo:

  {
    "ErrorInfo": {
    "message": String,
    "code": Number
    }
  }
  

  É possível acessar as mensagens de erro criando uma variável de integração chamada ErrorMessage. No entanto, recomendamos que você use a variável ErrorInfo.message gerada pelo sistema para acessar mensagens de erro.

• ExecutionMode: o modo de execução com base no acionador. Os valores válidos são SYNC e ASYNC.
• ExecutionId: o ID de execução da integração.
• IntegrationName: o nome da integração.
• Region: a região da integração.
• ProjectId: o ID do projeto que contém a 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 Variables também exibe uma contagem do total de referências de variáveis na integração.

Para visualizar o painho Variables, clique em , o painel "Alternar", na barra de navegação do designer.

A imagem a seguir mostra um layout de amostra do painel Variables:

Conferir e editar variáveis de configuração

Visualização : conector do BigQuery

Este recurso está sujeito aos Termos das Soluções Pré-GA na seção Termos Gerais de Serviço dos Termos Específicos de Serviço. Os 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.

Para conferir as variáveis de configuração definidas na integração, clique em variable_add Variável de configuração de integração no painel Variáveis. Isso abre o painel Variáveis de configuração mostrando todas as variáveis de configuração definidas na integração. Basta clicar no campo Valor para editar o valor da variável de configuração.

A imagem a seguir mostra um layout de amostra do painel Variáveis de configuração:

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 , o 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 ao lado do nome dela.

      Tipo de dados	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 as variáveis funcionam em integrações

Durante a integração, os dados do tempo de execução são transmitidos como variáveis que são 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 um 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.

A tabela a seguir resume os diferentes tipos de variáveis e o comportamento delas:

Tipo variável	Descrição	Comportamento	Exemplo
Variável de configuração	Armazena os dados de configuração da integração.	Definida no momento do design e pode ser editada ao publicar a integração.	Um endereço de e-mail de destino para notificação.
Variável de sistema	Gerada automaticamente pelo sistema.	Somente leitura e não pode ser editada.	A variável ExecutionId.
Variável de integração	Rastreia os dados ao longo de toda a execução de integração.	Definida explicitamente na integração e pode ser editada durante a execução da integração.	Uma variável para armazenar o resultado de uma tarefa.
Variável de tarefa	Armazena a saída de uma tarefa específica.	Definida implicitamente pela execução de uma tarefa e não pode ser editada.	A variável responseBody da tarefa Chamar endpoint REST.

Referências de variáveis

As tarefas, os acionadores e os edges em uma integração leem e gravam em variáveis usando referências de variáveis. Uma referência de variável tem o formato $paramKey$, em que paramKey é o nome da variável.

$isNameUnique$ = true AND $numAccounts$ >= 1

Exemplo:

• Uma condicional edge pode ter a seguinte aparência:

  $isNameUnique$ = true AND $numAccounts$ >= 1

  Neste exemplo, isNameUnique é uma variável do tipo de dados booleano e numAccounts é um parâmetro do tipo de dados inteiro.

• É possível criar uma notificação por e-mail para um novo registro de usuário em um fluxo de trabalho do Application Integration. Suponha que você tenha duas variáveis:
  • $userName$: contém o nome do novo usuário (por exemplo, "Alex").
  • $orderID$: contém um identificador de pedido exclusivo (por exemplo, "ORD-12345").

  O modelo para o corpo do e-mail pode ser:

  Hello $userName$, thank you for your order! Your order ID is $orderID$.

  Quando essa mensagem é enviada, o sistema substitui as referências de variáveis pelos valores correspondentes. A mensagem final será:

  Hello Alex, thank you for your order! Your order ID is ORD-12345.

É possível usar referências de variáveis nos seguintes lugares:

• Parâmetros da tarefa
• Parâmetros do acionador
• Condições de borda

Ao se referir a uma variável gerada automaticamente ou de tarefa, é necessário usar o nome completo e exclusivo dela, que inclui acentos graves e o ID da tarefa, dentro dos delimitadores de cifrão. Por exemplo, para se referir à saída responseBody de uma tarefa Chamar endpoint REST com ID Task_5, é necessário usar $`Task_5_responseBody`$.

Cotas e limites

Para informações sobre o assunto, consulte Cotas e limites.

A seguir

• Saiba como criar CI/CD para sua integração.
• Saiba como mascarar dados sensíveis nos registros.
• Adicionar e configurar uma tarefa de mapeamento de dados