Materiais de Apoio

Notação de Acesso

Aprenda como acessar dados dos campos do ENSPACE em expressões, templates e condicionais.
atualizado

Aprenda a acessar dados dos campos do ENSPACE

Sempre que você precisa referenciar o valor de um campo — seja em uma expressão, template de documento, condicional ou evento em campo — você usa uma notação de acesso. Essa notação é o caminho que indica ao sistema exatamente qual dado você quer.

Esta página explica os três padrões de acesso disponíveis no ENSPACE e como combiná-los para alcançar qualquer informação armazenada nos seus campos.

Para consultar a estrutura de dados interna de cada tipo de campo, veja a página Dados dos Campos.

O ponto de partida: data

Todo acesso a dados de um item começa pelo prefixo data. Ele representa o conjunto de campos do item atual. A partir dele, você navega até o campo desejado usando a referência que foi definida na configuração do tipo.

Por exemplo, se o tipo possui um campo de texto curto com a referência nome, o caminho completo para acessar seu valor é:

data.nome

Dentro de templates e expressões, esse caminho é envolvido por chaves duplas para que o sistema interprete e substitua pelo valor real:

{{data.nome}}

O resultado seria o conteúdo do campo — por exemplo, "João Silva".


Notação de ponto

A notação de ponto permite acessar propriedades dentro de campos que armazenam objetos (campos complexos como valor monetário, endereço, pessoa/empresa, documento, etc.). Cada ponto representa um nível de profundidade dentro do objeto.

Sintaxe: data.campo.propriedade

Exemplo prático — um campo de valor monetário com referência valor:

CaminhoO que acessaResultado
{{data.valor}}O objeto inteiro{ "currency": "BRL", "value": 1500.00 }
{{data.valor.value}}O valor numérico1500.00
{{data.valor.currency}}O código da moeda"BRL"

Quando o objeto tem múltiplos níveis de profundidade, basta encadear os pontos. Por exemplo, para acessar o código do índice de correção monetária dentro de um campo valor:

{{data.valor.config.correction.periods[0].indexCode}}

Nesse caminho, cada segmento separado por ponto entra um nível mais fundo no objeto: datavalorconfigcorrectionperiods → primeiro item → indexCode.

Outros exemplos:

CampoCaminhoO que acessa
Endereço (endereco){{data.endereco.city}}Cidade
Endereço (endereco){{data.endereco.cep}}CEP
Pessoa/Empresa (cliente){{data.cliente.type}}Tipo de pessoa
Pessoa/Empresa (cliente){{data.cliente.natural_person.cpf}}CPF da pessoa física
Relacionamento (contrato){{data.contrato.display}}Texto de exibição do item vinculado
Relacionamento (contrato){{data.contrato.reference}}Código de referência do item vinculado
Documento (doc){{data.doc.document.name}}Nome do arquivo original
Documento (doc){{data.doc.signed.created_at}}Data da assinatura
Se uma propriedade intermediária não existir (por exemplo, acessar data.doc.signed.pdf.name quando o documento não foi assinado), o resultado será vazio. Nenhum erro é gerado.

Notação de colchete

A notação de colchete permite acessar itens específicos dentro de campos que armazenam listas (campos como seleção múltipla, relacionamento múltiplo, arquivos, repetidor, anotações, chat, etc.). O número entre colchetes indica a posição do item na lista, começando do zero.

Sintaxe: data.campo[posição]

Exemplo prático — um campo de seleção múltipla com referência departamentos contendo ["Financeiro", "Jurídico", "Compliance"]:

CaminhoO que acessaResultado
{{data.departamentos[0]}}Primeiro item"Financeiro"
{{data.departamentos[1]}}Segundo item"Jurídico"
{{data.departamentos[2]}}Terceiro item"Compliance"
A contagem começa do zero, não do um. O primeiro item é sempre [0], o segundo é [1], e assim por diante.

Para listas que contêm objetos (como arquivos, relacionamentos ou anotações), combine a notação de colchete com a notação de ponto para acessar propriedades específicas de cada item:

Exemplo — um campo de arquivos com referência anexos:

CaminhoO que acessaResultado
{{data.anexos[0]}}Primeiro arquivo (objeto inteiro){ "name": "contrato.pdf", ... }
{{data.anexos[0].name}}Nome do primeiro arquivo"contrato.pdf"
{{data.anexos[0].url}}URL do primeiro arquivo"https://storage..."
{{data.anexos[1].name}}Nome do segundo arquivo"relatorio.pdf"

Outros exemplos:

CampoCaminhoO que acessa
Relacionamento múltiplo (contratos){{data.contratos[0].display}}Texto de exibição do primeiro contrato
Relacionamento múltiplo (contratos){{data.contratos[1].reference}}Referência do segundo contrato
Imagens (fotos){{data.fotos[0].width}}Largura da primeira imagem
Anotações (notas){{data.notas[0].content}}Conteúdo da primeira anotação
Anotações (notas){{data.notas[0].sender.name}}Autor da primeira anotação
Repetidor (parcelas){{data.parcelas[0].valor.value}}Valor monetário da primeira parcela
Chat (mensagens){{data.mensagens[0].sender.email}}E-mail do autor da primeira mensagem
Mesmo que o campo contenha apenas um item, ele ainda estará dentro de uma lista. O acesso ao primeiro (e único) item é sempre feito com [0].

Contagem de itens

Para saber quantos itens existem dentro de uma lista, use .length ao final do caminho do campo.

Sintaxe: data.campo.length

CampoCaminhoO que retorna
Seleção múltipla (departamentos){{data.departamentos.length}}Total de opções selecionadas
Arquivos (anexos){{data.anexos.length}}Total de arquivos anexados
Repetidor (parcelas){{data.parcelas.length}}Total de registros no repetidor
Anotações (notas){{data.notas.length}}Total de anotações
Relacionamento múltiplo (contratos){{data.contratos.length}}Total de itens vinculados

Combinando as notações

Na prática, os três padrões se combinam livremente para acessar qualquer dado, por mais aninhado que seja. Leia o caminho da esquerda para a direita como uma sequência de instruções:

{{data.valor.config.correction.periods[0].indexCode}}

Passo a passo:

  1. data — parta do item atual.
  2. .valor — entre no campo valor (um objeto de valor monetário).
  3. .config — acesse a propriedade config dentro dele.
  4. .correction — entre no subobjeto correction.
  5. .periods — acesse a lista de períodos de correção.
  6. [0] — selecione o primeiro período da lista.
  7. .indexCode — acesse o código do índice desse período.

Mais exemplos de caminhos combinados:

CaminhoLeitura
{{data.parcelas[2].valor.currency}}Moeda da terceira parcela do repetidor
{{data.notas[0].sender.email}}E-mail do autor da primeira anotação
{{data.doc.signed.pdf.name}}Nome do PDF assinado do documento
{{data.cliente.legal_person.razao_social}}Razão social da pessoa jurídica
{{data.contratos[1].display}}Texto de exibição do segundo contrato vinculado

Resumo rápido

NotaçãoQuando usarExemplo
Ponto (.)Acessar propriedade de um objeto{{data.valor.currency}}
Colchete ([n])Acessar item de uma lista por posição{{data.anexos[0]}}
Length (.length)Contar itens de uma lista{{data.anexos.length}}
CombinadaNavegar em estruturas aninhadas{{data.parcelas[0].valor.value}}