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

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 podem se referir a vários tipos de dados, tais como informações sobre o próprio pipeline, a execução atual do pipeline, a configuração usada para executar o pipeline e o ambiente no qual o pipeline está sendo executado.

Para referenciar metadados, use a seguinte sintaxe, substituindo os termos entre símbolos de menor e maior que pelo valor desejado:

{{ metadata.<dados> }}

Aqui:

• metadata é uma palavra reservada.

• dados refere-se aos metadados que você deseja referenciar.

Por exemplo, use a seguinte sintaxe para referenciar o nome do pipeline no qual este código está sendo executado:

{{ metadata.pipeline.name }}

Estes são todos os metadados que você pode acessar com Double Braces:

Metadados de pipeline

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

Metadados de implantação

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

Metadados de execução de pipeline

data	Descrição
execution.key	ID da execução do pipeline atual
execution.timeout	Timeout configurado do pipeline
execution.startTimestamp	Timestamp do início da execução pipeline (em milissegundos, no formato UNIX Epoch)
execution.redelivery	Booleano. True se esta execução for uma nova tentativa de execução. False, se não. Aprenda mais sobre reprocessamento em nosso artigo sobre o 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 }}