Variáveis

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

• As variáveis podem ser definidas estaticamente no momento da conceção ou transmitidas dinamicamente para a integração no momento da execução.
• As variáveis podem fazer referência a outras variáveis numa integração.
• As variáveis podem ser acessíveis globalmente a todas as tarefas ou acessíveis localmente a uma tarefa específica.

Variáveis

Na integração de aplicações, as variáveis são definidas ou inicializadas em vários locais:

• Variáveis de configuração: definidas no momento da conceção para armazenar os dados de configuração da integração. Por exemplo, pode usar esta opção para definir um endereço de email de destino para a notificação, em vez de codificar esse endereço de email na integração.
• Variáveis do 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 acompanhar os dados ao longo de toda a execução da integração. Por exemplo, pode definir uma variável para armazenar o resultado de uma tarefa e usá-la numa tarefa subsequente.
• Variáveis de tarefas: definidas implicitamente através da execução de tarefas específicas para armazenar o resultado da tarefa. Por exemplo, a tarefa Call REST Endpoint define a variável responseBody para armazenar o corpo da resposta do ponto final REST. As variáveis de tarefas também são conhecidas como variáveis geradas automaticamente. As variáveis geradas automaticamente têm uma convenção de nomenclatura especial que usa 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 variáveis usadas numa linguagem de programação. Os dados nas variáveis podem ser lidos e escritos durante a execução da integração.

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

• Recebidos como entradas na integração, também conhecidos como variáveis de entrada.
• Devolvidas como saídas da integração, também conhecidas como variáveis de saída.
• Usado para manter o estado temporário durante a execução de uma integração.

Nota: as funções de variáveis indicadas acima não são mutuamente exclusivas. Qualquer variável pode ser uma variável de entrada, uma variável de saída, ambas ou nenhuma.

Quando marca uma variável como uma variável de entrada, indica que o valor da variável deve 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.

Quando marca uma variável como variável de saída, indica que o valor final da variável deve ser devolvido como parte da resposta da integração.

O valor de uma variável não tem de ser definido estaticamente na integração. Os valores das variáveis podem ser transmitidos para uma integração através da utilização de 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 de valor dinâmico substitui a atribuição estática.

Tipos de dados suportados

Os seguintes tipos de dados são suportados para variáveis de integração:

• String e matriz de strings
• Número inteiro e matriz de números inteiros
• Duplo e matriz dupla
• Booleano e matriz booleana
• 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 estão disponíveis numa variável de tarefa. Não pode eliminar nem editar uma variável de tarefa. As variáveis de tarefas 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 Call REST Endpoint tem uma saída para o corpo da resposta. Se esta tarefa tiver um ID de Task_5, o nome da variável de tarefa exclusivo para o corpo da resposta é `Task_5_responseBody`.

No painel Variáveis, as variáveis de tarefas podem ser apresentadas por um nome de saída comum, por exemplo, responseBody, sem o ID da tarefa nem acentos graves. Para ver o nome completo e único da variável necessário para referência, clique na variável no painel e veja os respetivos detalhes no painel do lado direito.

Variáveis de configuração

Pré-visualização

Este produto ou funcionalidade está sujeito aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais do Serviço dos Termos Específicos do Serviço. Os produtos e as funcionalidades pré-GA estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

As variáveis de configuração permitem-lhe externalizar a configuração para a integração. Com as variáveis de configuração, pode configurar aspetos da sua integração, como detalhes do conetor, detalhes de autenticação ou pontos finais de URL com base no ambiente de desenvolvimento, como controlo de qualidade, preparação ou produção. Não tem de atualizar a integração manualmente antes de a carregar para um novo ambiente. A integração de aplicações permite-lhe introduzir valores para as variáveis de configuração quando publica a integração.

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

Variáveis do sistema

As variáveis do sistema são geradas automaticamente quando cria uma integração. Pode usar estas variáveis nas tarefas de integração e para resolver erros. A integração contém as seguintes variáveis geradas pelo sistema:

• ErrorInfo: quando a execução falha, pode aceder aos detalhes do erro com a variável ErrorInfo:

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

  Pode aceder às mensagens de erro criando uma variável de integração denominada ErrorMessage. No entanto, recomendamos que use a variável ErrorInfo.message gerada pelo sistema para aceder às 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

Pode usar o painel Variáveis para criar, editar, ver, duplicar e eliminar variáveis na sua integração. O painel Variáveis também apresenta uma contagem do total de referências de variáveis na integração.

Para ver o painel Variáveis, clique em , o painel de ativação/desativação, na barra de navegação do criador.

A imagem seguinte mostra um esquema de exemplo do painel Variáveis:

Veja e edite variáveis de configuração

Pré-visualização

Este produto ou funcionalidade está sujeito aos "Termos das Ofertas de Pré-DG" na secção Termos Gerais do Serviço dos Termos Específicos do Serviço. Os produtos e as funcionalidades pré-GA estão disponíveis "tal como estão" e podem ter apoio técnico limitado. Para mais informações, consulte as descrições das fases de lançamento.

Para ver as variáveis de configuração definidas na sua integração, clique na variável variable_add Variável de configuração da integração no painel Variáveis. Isto abre o painel Variáveis de configuração, que apresenta todas as variáveis de configuração definidas na sua integração. Basta clicar no campo Valor para editar o valor da variável de configuração.

A imagem seguinte mostra um esquema de exemplo do painel Variáveis de configuração:

Crie uma variável

Para criar uma variável, siga estes passos:

1. Na barra de navegação do editor de integração, clique em , o painel de ativação/desativação, para apresentar o painel Variáveis.
2. Clique em +Criar.
3. Faça o seguinte no painel Criar variável:
   1. Nome: introduza o nome da variável.
   2. Tipo de variável: escolha o tipo de variável.

   Tipo de dados	Descrição
   Nenhum	Uma variável local numa integração.
   Variável de configuração para integração	Uma variável de configuração numa integração.
   Entrada para integração	Durante a execução, a variável é fornecida como uma entrada para o acionador executado.
   Saída da integração	O valor final da variável no final da execução deve ser enviado para o autor da chamada da integração.
   Entrada e saída da integração	Na execução, a variável é fornecida como uma entrada para o acionador executado e o respetivo valor final é enviado para o autor da chamada da integração.

   3. Tipo de dados: escolha o tipo de dados da variável. Pode identificar o tipo de dados de uma variável através do ícone junto ao nome da variável.

      Tipo de dados	Exemplo
      String	Alex
      Número 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 ver informações sobre os tipos de dados suportados, consulte o artigo Tipos de dados suportados.

   4. Valor predefinido: introduza o valor predefinido da variável. Este é um campo opcional.
   5. Esquema: selecione o esquema JSON para a variável.
      • Inferir a partir de um payload JSON de exemplo: gera um esquema JSON a partir de um payload JSON de exemplo. O payload de exemplo é rejeitado após a geração do esquema. Apenas o esquema gerado é guardado.
      • Introduza um esquema JSON: introduza manualmente um esquema JSON completo.
      • Inferir a partir do valor predefinido: gera um esquema JSON com o valor predefinido fornecido.
      • Nenhum: nenhum esquema JSON.
      Nota: este campo é apresentado apenas para variáveis do tipo de dados JSON.
   6. Máscara a variável nos registos (pré-visualização): selecione esta opção para ativar a ocultação da variável nos registos de execução da integração. Para ativar a ocultação da variável, tem de ativar as variáveis de ocultação para a sua integração e região. Para obter informações sobre como ativar a ocultação para a integração e a região, consulte os artigos Edite uma integração e Edite regiões.

      Para obter informações sobre a ocultação, consulte o artigo Oculte dados confidenciais nos registos.

4. Clique em Criar.

Como funcionam as variáveis nas integrações

Durante a execução de uma integração, os dados de tempo de execução são transmitidos como variáveis que são declaradas para a integração ou a tarefa. Assim que a execução começa, os dados de entrada são convertidos num objeto na memória denominado Evento.

Após a criação do objeto Event, é criado um gráfico de tarefas na memória através da definição de integração. Os valores das variáveis recebidas são transmitidos às tarefas com base na sua configuração. À medida que a integração é executada, as tarefas leem e escrevem dados novamente no objeto Evento,para serem usados por tarefas subsequentes ou para formar os dados de saída da integração.

A tabela seguinte resume os diferentes tipos de variáveis e o respetivo comportamento:

Tipo de variável	Descrição	Comportamento	Exemplo
Variável de configuração	Armazena os dados de configuração da integração.	Definido no momento da conceção e pode ser editado quando publica a integração.	Um endereço de email de destino para notificação.
Variável do sistema	Gerado automaticamente pelo sistema.	Só de leitura e não pode ser editado.	A variável ExecutionId.
Variável de integração	Monitoriza os dados ao longo de toda a execução de uma integração.	Definido explicitamente na sua integração e pode ser editado durante a execução da integração.	Uma variável para armazenar o resultado de uma tarefa.
Variável de tarefa	Armazena o resultado de uma tarefa específica.	Definido implicitamente através da execução de uma tarefa e não pode ser editado.	A variável responseBody da tarefa Chamar ponto final REST.

Referências de variáveis

As tarefas, os acionadores e as arestas numa integração leem e escrevem em variáveis através de 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

Por exemplo:

• Uma condição limite pode ter o seguinte aspeto:

  $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.

• Pode criar uma notificação por email para um novo registo de utilizador num fluxo de trabalho de integração de aplicações. Suponhamos que tem duas variáveis:
  • $userName$: contém o nome do novo utilizador (por exemplo, "Alex").
  • $orderID$: contém um identificador exclusivo da encomenda (por exemplo, "ORD-12345").

  O modelo para o corpo do email pode ser:

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

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

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

Pode usar referências de variáveis nos seguintes locais:

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

Quando se refere a uma variável gerada automaticamente ou de tarefa, tem de usar o respetivo nome completo e exclusivo, que inclui acentos graves e o ID da tarefa, dentro dos delimitadores de cifrão. Por exemplo, para fazer referência à saída responseBody de uma tarefa Call REST Endpoint com o ID Task_5, tem de usar $`Task_5_responseBody`$.

Quotas e limites

Para informações sobre quotas e limites, consulte o artigo Quotas e limites.

O que se segue?

• Saiba como criar CI/CD para a sua integração.
• Saiba como ocultar dados sensíveis nos registos.
• Adicione e configure uma tarefa de mapeamento de dados