Templates de Documentos

Gere documentos automaticamente com dados do sistema

Os Templates de Documentos permitem criar modelos de documentos (contratos, termos, declarações, relatórios) que são preenchidos automaticamente com dados reais dos itens de uma categoria. Você monta o modelo uma vez e o ENSPACE gera o documento final sempre que necessário, substituindo as marcações do template pelos dados do item.

Para acessar, vá até Configurações > Estrutura > Categorias, selecione a categoria e clique em Templates de Documentos.

Visão geral: como funciona

Como os templates se conectam à categoria

O diagrama abaixo mostra como os templates utilizam os campos da categoria para gerar documentos automaticamente dentro dos itens.

Jornada do usuário

O processo completo, do template ao documento final, segue esta jornada:

As seções abaixo detalham cada etapa.

Etapa 1 — Criar o template

Etapa 2 — Inserir variáveis

As variáveis são marcações que representam dados reais dos campos da categoria. Elas aparecem no template como texto entre chaves duplas (ex: {{data.nome_cliente}}), mas são substituídas pelos dados reais somente no momento da geração do documento final — dentro do editor, você verá apenas as marcações.

Para inserir uma variável, clique no botão # (Variáveis) no topo do editor, selecione o campo desejado e cole no documento com CTRL + V.

Para entender o formato das variáveis, a diferença entre campos personalizados e metadados, e como evitar erros, consulte a seção Como usar variáveis no template abaixo.

Etapa 3 — Adicionar lógica

Os blocos lógicos permitem controlar quando um conteúdo aparece e quantas vezes ele se repete no documento. Eles são inseridos pelo botão de Comandos (ícone de chave de fenda) no topo do editor: ao clicar no tipo desejado, o sistema copia a estrutura para a área de transferência. Cole no documento com CTRL + V.

Existem três tipos de blocos:

Para aprender a preencher cada estrutura com seus dados reais, consulte a seção Como usar blocos lógicos no template abaixo.

Etapa 4 — Vincular o template a um formulário

Após montar o template, é necessário vinculá-lo a um campo do tipo Editor de Documento dentro de um formulário da categoria. Esse é o campo onde o usuário final vai gerar o documento.

Etapa 5 — Gerar o documento final

Com o template vinculado ao formulário, o usuário final pode gerar documentos ao criar ou editar itens.

O documento gerado fica salvo no próprio campo do item. Se o resultado não for o esperado, você pode gerar novamente selecionando outro template ou o mesmo.

Onde o documento gerado fica salvo

O documento gerado fica armazenado como dado do item, dentro do campo Editor de Documento. Para visualizá-lo na tela dedicada do item, configure uma Pasta de Visualização do tipo Documento vinculada ao campo.

Para saber como montar a barra de pastas do item, consulte Construtor de Pastas.

Observações importantes

• Se uma variável não tiver valor preenchido no item, o espaço correspondente ficará vazio no documento final.
• Atualizar o template não afeta documentos já gerados — cada documento é uma cópia independente gerada no momento da criação.
• Documentos são gerados um por vez, por item. Não é possível gerar em lote.
• O editor de templates (OnlyOffice) serve apenas para montar o modelo — o documento final é visualizado após a geração no item.

Como usar variáveis no template

Esta seção detalha como as variáveis funcionam dentro do editor de templates.

Inserindo uma variável

Formato das variáveis

As variáveis seguem o padrão {{data.referencia_tecnica_do_campo}}. A referência técnica é o identificador interno do campo, definido na criação do campo — diferente do nome de exibição.

Alguns campos são metadados do item e não usam o prefixo data.:

Para entender o sistema de variáveis em profundidade, consulte Variáveis e Formatação.

Como usar blocos lógicos no template

Esta seção detalha como preencher cada tipo de bloco lógico com seus dados reais.

Bloco condicional de texto (IF)

Exibe um trecho do documento somente se a condição sobre um campo de texto for verdadeira.

Estrutura

Elementos da estrutura:

Operadores disponíveis:

O condicional de texto usa o operador === (igual a) para comparar o valor do campo com um texto esperado. Para verificar o oposto (campo diferente de um valor), use !== (diferente de).

Como preencher:

1. Substitua variavel pelo campo real — ex: data.status
2. Substitua 'valor' pelo texto esperado — ex: 'Aprovado'
3. Substitua conteúdo pelo texto que deve aparecer

Exemplo 1 — Exibir ou omitir um trecho:

{{}}{{IF variavel === 'valor'}} conteúdo {{END-IF}}

{{}}{{IF data.status === 'Aprovado'}} Este documento foi aprovado conforme as condições estabelecidas. {{END-IF}}

Resultado: o texto definido em conteúdo só aparecerá no documento final se o campo "status" do item for exatamente "Aprovado". Se a condição não for cumprida, o trecho será omitido do documento.

Exemplo 2 — Exibir textos diferentes conforme o resultado:

Para mostrar um texto quando a condição for verdadeira e outro quando não for, use dois blocos IF complementares — o primeiro com === e o segundo com !==:

{{}}{{IF variavel === 'valor'}} conteúdo se verdadeiro {{END-IF}}
{{}}{{IF variavel !== 'valor'}} conteúdo se falso {{END-IF}}

{{}}{{IF data.status === 'Aprovado'}} Este documento foi APROVADO e está apto para assinatura. {{END-IF}}
{{}}{{IF data.status !== 'Aprovado'}} Este documento NÃO foi aprovado. Consulte o responsável para mais informações. {{END-IF}}

Resultado: se o status for "Aprovado", o primeiro trecho aparece e o segundo é omitido. Se o status for qualquer outro valor (ex: "Pendente", "Recusado"), o segundo trecho aparece e o primeiro é omitido.

Bloco condicional de valor (IF com números)

Funciona como o condicional de texto explicado acima, mas compara valores numéricos. A diferença principal é que você pode usar operadores de comparação além do ===.

Estrutura

Elementos da estrutura:

Operadores disponíveis:

O condicional de valor permite comparar campos numéricos usando diferentes operadores. Escolha o operador conforme o tipo de comparação que deseja fazer.

Como preencher:

1. Substitua variavel pelo campo real — ex: data.valor
2. Substitua o operador === pelo tipo de comparação desejado — ex: >
3. Substitua 123 pelo valor de referência — ex: 10000
4. Substitua conteúdo pelo texto que deve aparecer

Exemplo 1 — Exibir cláusula para valores altos:

{{}}{{IF variavel === 123}} conteúdo {{END-IF}}

{{}}{{IF data.valor > 10000}} CLÁUSULA ADICIONAL: Para valores acima de R$ 10.000,00, aplica-se a taxa de administração de 2%. {{END-IF}}

Resultado: a cláusula adicional só aparecerá no documento final se o campo "valor" do item for maior que 10.000. Se o valor for 10.000 ou menor, o trecho será omitido.

Exemplo 2 — Textos diferentes conforme a faixa de valor:

{{}}{{IF variavel > 123}} conteúdo para valor alto {{END-IF}}
{{}}{{IF variavel <= 123}} conteúdo para valor baixo {{END-IF}}

{{}}{{IF data.valor > 10000}} Este contrato se enquadra na categoria de ALTO VALOR e requer aprovação da diretoria. {{END-IF}}
{{}}{{IF data.valor <= 10000}} Este contrato se enquadra na categoria PADRÃO e segue o fluxo regular de aprovação. {{END-IF}}

Resultado: se o valor for maior que 10.000, o primeiro trecho aparece e o segundo é omitido. Se o valor for 10.000 ou menor, o segundo trecho aparece e o primeiro é omitido.

Combinando condições (AND e OR)

Dentro de um IF, você pode combinar múltiplas condições:

• AND — todas devem ser verdadeiras para o conteúdo aparecer
• OR — basta uma ser verdadeira

{{}}{{IF data.status === 'Aprovado' AND data.valor > 10000}} Contrato de alto valor aprovado. {{END-IF}}

{{}}{{IF data.prioridade === 'Alta' OR data.valor > 50000}} Este item requer atenção especial. {{END-IF}}

Bloco de repetição (FOR)

Repete um trecho do documento para cada item de uma lista. Uma lista é qualquer campo que armazena múltiplos registros — como uma lista de produtos, parcelas, pessoas ou etapas.

Estrutura

Elementos da estrutura:

O prefixo $ é obrigatório para acessar dados dentro do FOR. Ele indica ao sistema que você está se referindo a um registro individual da lista, não a um campo global do item.

O elemento item é um identificador livre para você nomear seu dado. Como boa prática, é indicado substituí-lo pelo nome do campo que será percorrido.

Como preencher:

1. Escolha um nome identificador para cada registro — pode ser qualquer palavra que faça sentido (ex: produto, parcela, pessoa). Esse nome substitui item na estrutura.
2. Substitua variavel pela variável do campo de lista — ex: data.produtos
3. Dentro do bloco, use $ + nome escolhido + subcampo — ex: $produto.nome, $produto.preco

Exemplo 1 — Lista simples de produtos:

{{}}{{FOR item IN variavel}} conteúdo {{= $item.subcampo}} {{END-FOR item}}

{{}}{{FOR produto IN data.produtos}} Produto: {{= $produto.nome}} - Valor: R$ {{= $produto.preco}} {{END-FOR produto}}

Resultado: se o item tiver 3 produtos na lista, o documento final terá 3 linhas — uma para cada produto, com nome e preço preenchidos automaticamente.

Exemplo 2 — Lista com múltiplos subcampos:

{{}}{{FOR item IN variavel}} {{= $item.subcampo1}} - {{= $item.subcampo2}} - {{= $item.subcampo3}} {{END-FOR item}}

{{}}{{FOR pessoa IN data.participantes}} Nome: {{= $pessoa.nome}} - CPF: {{= $pessoa.cpf}} - Cargo: {{= $pessoa.cargo}} {{END-FOR pessoa}}

Resultado: para cada pessoa na lista de participantes, uma linha será gerada com nome, CPF e cargo preenchidos.

Combinações avançadas

Os blocos podem ser combinados para criar documentos com lógica complexa.

IF dentro de FOR — exibir conteúdo condicional para cada item da lista:

{{}}{{FOR produto IN data.produtos}} Produto: {{= $produto.nome}} {{}}{{IF $produto.valor > 1000}} (Valor elevado) {{END-IF}} {{END-FOR produto}}

{{}}{{FOR pessoa IN data.pessoas_cadastradas}} CPF: {{= $pessoa.cpf}} {{}}{{FOR telefone IN pessoa.telefones}} DDD: {{= $telefone.ddd}} {{END-FOR telefone}} {{END-FOR pessoa}}

Erros comuns