Como referenciar dados usando Double Braces

Saiba mais sobre as funções Double Braces e como usá-las na Digibee Integration Platform.

Você pode usar Double Braces de várias maneiras: para acessar os dados recebidos pelo componente no formato JSON, para fazer referência a Globals, contas ou metadados.

Veja como você pode fazer isso:

Referenciando dados JSON

Suponha que um componente receba os seguintes dados JSON sobre um funcionário chamado João Silva:

{
"primeiroNome": "João",
"sobrenome": "Silva",
"endereco": {
"rua": "Rua 123",
"cidade": "São Paulo",
"estado": "SP",
"CEP": "11111-111"
},
"telefone": "[phone]",
"email": "[e-mail]",
"idade": 30,
"genero": "masculino",
"ocupacao": "Engenheiro de Software"
}

Referenciando todos os dados

Para fazer referência a todos os dados JSON recebidos pelo componente, use a seguinte sintaxe:

{{ message.$ }}

Aqui:

• message é uma palavra reservada que se refere aos dados que foram recebidos pelo componente em questão, conhecido como payload.

• $ indica que você está se referindo a todo o payload.

Referenciando propriedades específicas

Use a seguinte sintaxe para fazer referência a propriedades específicas de um JSON, substituindo os termos entre símbolos de menor e maior que pelo valor desejado:

{{ message.<nome-da-propriedade> }}

Aqui:

• message é uma palavra reservada que se refere aos dados que foram recebidos pelo componente em questão, também chamado de payload.

• nome-da-propriedade refere-se ao nome da propriedade desejada.

Por exemplo, se você quiser referenciar o endereço de e-mail de João Silva, use a seguinte notação:

{{ message.email }}

Para acessar propriedades contidas em outras propriedades, use a notação de maneira recursiva. Por exemplo, para referenciar o CEP de João Silva, use a seguinte notação:

{{ message.endereco.CEP }}

Referenciando etapas anteriores usando o Previous Steps Access

Você pode usar o Previous Steps Access para referenciar dados de etapas anteriores de um pipeline usando um alias customizado, facilitando e agilizando o gerenciamento de dados.

Se você ainda não configurou um Alias, consulte as instruções na documentação.

Se já configurou um Alias no seu fluxo, utilize a seguinte sintaxe para referenciar os dados desejados:

{{ step.step-alias }}

Onde:

• step é uma palavra reservada que se refere a uma etapa anterior do fluxo.

• step-alias é o nome personalizado definido no campo Alias do conector ou cápsula. Ele permite que você referencie essa etapa em partes posteriores do fluxo usando Double Braces.

Exemplo: {{ step.csv-to-json-v1-3 }} .

Referenciando triggers

Você pode usar Double Braces para referenciar diretamente os dados de entrada do trigger. Para referenciar um trigger com Double Braces, utilize a seguinte sintaxe:

{{ trigger.input }}

Por exemplo:

{{ trigger.order.id }}

Aqui:

• trigger é uma palavra reservada que se refere ao trigger no workflow.

• order é um objeto que corresponde a uma chave nos dados enviados ao trigger.

• id é um campo dentro do objeto order, apontando para um valor específico dentro da estrutura.

Referenciando Globals

Globals são variáveis ​​criadas pelo usuário que podem ser referenciadas em vários pipelines. Para aprender mais sobre Globals, leia esta documentação.

Para fazer referência a um Global usando Double Braces, use a seguinte sintaxe, substituindo os termos entre símbolos de menor e maior que pelo valor desejado:

{{global.<nome-do-global>}}

Aqui:

• global é uma palavra reservada.

• nome-do-global é o nome do Global desejado.

Embora seja possível fazer referência a Globals sem o prefixo global, é altamente recomendável usar o prefixo, uma vez que as expressões sem ele não serão mais suportadas no futuro.

Suponha que você queira referenciar um Global chamado “meu-global”. Use a notação:

{{global.meu-global}}

Referenciando Contas

As contas são credenciais definidas pelo usuário que podem ser referenciadas em vários pipelines.Para saber mais, leia nossa documentação sobre contas.

Para fazer referência a uma conta, use a seguinte sintaxe, substituindo os termos entre símbolos de menor e maior que pelo valor desejado:

{{ account.<rotulo-da-conta>.<campo> }}

Aqui:

• account é uma palavra reservada que se refere às contas salvas na Digibee Integration Platform.

• rotulo-da-conta refere-se ao rótulo da conta exibido na página de contas.

• campo refere-se ao nome do campo da conta na página de contas, como, por exemplo, username,password, token, header-value, entre outros.

Suponha que você queira fazer referência ao username de uma conta salva chamada conta-da-emily. Para fazer isso, use a seguinte sintaxe:

{{ conta.conta-da-emily.username }}

Referenciando metadados

Metadados referem-se a diferentes tipos de dados disponíveis durante a execução do pipeline: informações sobre o próprio pipeline, a execução atual, a configuração de implantação e o ambiente de execução.

Para acessar metadados, use a seguinte sintaxe, substituindo o termo entre colchetes angulares pelo valor desejado:

{{ metadata.<data> }}

Aqui:

• metadata é uma palavra reservada.

• data é o metadado que você deseja acessar, por exemplo pipeline.name.

Por exemplo, use a seguinte sintaxe para acessar o nome do pipeline em execução:

{{ metadata.pipeline.name }}

As tabelas a seguir listam todos os metadados que podem ser acessados com Double Braces.

Metadados do pipeline

data	Descrição
metadata.pipeline.name	Nome do pipeline.
metadata.pipeline.versionMajor	Versão major do pipeline.
metadata.pipeline.versionMinor	Versão minor do pipeline.
metadata.pipeline.realm	Realm do pipeline.
metadata.pipeline.description	Descrição do pipeline.
metadata.pipeline.id	ID do pipeline.
metadata.pipeline.project	Nome do projeto do pipeline que está sendo implantado. Durante o modo de teste, será retornado como null.

Metadados de implantação

data	Descrição
metadata.runtime.consumers	Número máximo de consumidores, de acordo com o tamanho da implantação do pipeline.
metadata.runtime.actualConsumers	Número de consumidores, definido pelo usuário.
metadata.runtime.environment	Ambiente em que o pipeline está sendo executado.

Metadados de execução do pipeline

data	Descrição
metadata.execution.key	ID da execução atual do pipeline.
metadata.execution.timeout	Tempo limite configurado do pipeline.
metadata.execution.startTimestamp	Timestamp de início do pipeline (em milissegundos, no formato UNIX Epoch).
metadata.execution.redelivery	Valor booleano. Verdadeiro se esta execução for uma nova tentativa, falso caso contrário. Saiba mais sobre novas tentativas no artigo Pipeline Engine.

Referenciando propriedades de Cápsula

Na configuração da Cápsula, você pode definir propriedades para parâmetros e utilizá-los na configuração de componentes dentro do fluxo da Cápsula.

Use a seguinte sintaxe para fazer referência a uma propriedade da Cápsula:

{{ capsule.<property> }}

• capsule é uma palavra reservada que se refere às propriedades da Cápsula.

• property é a propriedade definida no parâmetro no formulário de configuração da Cápsula.

Por exemplo, se você criou uma propriedade chamada mensagemErro no formulário de configuração da Cápsula e quiser referenciá-la em um componente dentro da Cápsula, use a seguinte notação:

{{ capsule.mensagemErro }}