Voltar para documentação
Manual

Guia de Variáveis para Modelos de Documentos

Este documento descreve o funcionamento do sistema de variáveis usados em Relatórios > Modelos de documentos > Novo ou Editar

Guia de Merge Tags para Modelos de Documentos

Este documento descreve o funcionamento do sistema de variáveis Merge Tags utilizado nos modelos de documentos do Giter. O sistema permite a inserção dinâmica de dados (como nome do residente, CPF, datas, etc.) em campos de texto rico (RichEditor).

1. Como Utilizar na Interface (Filament)

Ao editar um modelo de documento no painel administrativo:

Editor Rich Text para documentos dinâmicos com exemplo de utilização das Merge Tags
  1. No campo Editor de documento, clique no botão "Merge Tags" na barra de ferramentas ou digite {{ para abrir o menu de autocompletar.
  2. Selecione a tag desejada da lista.
  3. O editor inserirá a tag no formato {{ Rótulo da Tag }} (ex: {{ Residente: Nome }}).
  4. Ao gerar o PDF, o sistema substituirá automaticamente essas tags pelos dados reais.
Detalhe do acesso ao menu de variáveis Merge Tags no cabeçalho do editor

2. Tags Disponíveis

As tags estão organizadas por categorias:

Organização (Tenant)

Menu de variáveis da Organização - não precisa de toggle habilitado nos parametros de modelo de documento.
  • {{ Organização: Nome }}
  • {{ Organização: CNPJ }}
  • {{ Organização: Endereço }}
  • {{ Organização: Número }}
  • {{ Organização: Bairro }}
  • {{ Organização: CEP }}
  • {{ Organização: Cidade }}
  • {{ Organização: Estado }}
  • {{ Organização: Representante }}

Unidade (Unit)

Menu de variáveis da Unidade.
Disponíveis ao habilitar o toggle "Solicitar unidade?" nos parâmetros do modelo de documento.
  • {{ Unidade: Nome }}
  • {{ Unidade: CNPJ }}
  • {{ Unidade: Endereço }}
  • {{ Unidade: Número }}
  • {{ Unidade: Bairro }}
  • {{ Unidade: CEP }}
  • {{ Unidade: Cidade }}
  • {{ Unidade: Estado }}
  • {{ Unidade: Representante }}
  • {{ Unidade: Responsável Técnico }}

Funcionário (User)

Menu de variáveis de Funcionário.
Disponíveis ao habilitar o toggle "Solicitar funcionário?" nos parâmetros do modelo de documento.
  • {{ Funcionário: Nome }} (user_name)
  • {{ Funcionário: E-mail }} (user_email)
  • {{ Funcionário: Telefone }} (user_phone)
  • {{ Funcionário: Data Nasc. }} (user_birthday)
  • {{ Funcionário: CNPJ }} (user_cnpj)
  • {{ Funcionário: Endereço }} (user_address)
  • {{ Funcionário: Número }} (user_number)
  • {{ Funcionário: Bairro }} (user_neighborhood)
  • {{ Funcionário: CEP }} (user_cep)
  • {{ Funcionário: Cidade }} (user_city)
  • {{ Funcionário: Estado }} (user_state)
  • {{ Funcionário: CPF }} (user_cpf)
  • {{ Funcionário: Reg. Conselho }} (user_council_registry)

Contrato de Trabalho (UserContract)

Menu de variáveis de Contrato de trabalho.
Disponíveis ao habilitar o toggle "Solicitar contrato de trabalho?" nos parâmetros do modelo de documento.
  • {{ Contrato: Unidade }} (user_contract_unit): Nome da unidade do contrato.
  • {{ Contrato: Cargo }} (user_contract_occupation): Cargo/ocupação formal do colaborador.
  • {{ Contrato: Tipo de Colaborador }} (user_contract_user_type): Regime (CLT, PJ, Estágio, Cooperado, etc.).
  • {{ Contrato: Salário }} (user_contract_wage): Remuneração formatada em reais (ex: R$ 3.500,00).
  • {{ Contrato: Salário Extenso }} (user_contract_wage_full): Remuneração descrita por extenso (ex: três mil e quinhentos reais).
  • {{ Contrato: Valor Hora }} (user_contract_hourly_rate): Valor da hora de trabalho formatada em reais.
  • {{ Contrato: Valor Hora Extenso }} (user_contract_hourly_rate_full): Valor da hora de trabalho por extenso.
  • {{ Contrato: Turno }} (user_contract_work_shift): Nome amigável do turno (ex: Diurno 12x36).
  • {{ Contrato: Horário do Turno }} (user_contract_shift_schedule): Horário de início e fim da jornada (ex: 07:00 às 19:00).
  • {{ Contrato: Data Início }} (user_contract_start_date): Data de início do contrato (dd/mm/aaaa).
  • {{ Contrato: Data Fim }} (user_contract_end_date): Data de distrato/término ou "Em vigor".
  • {{ Contrato: Status }} (user_contract_status): Situação do contrato (Ativo, Encerrado ou Suspenso).
  • {{ Contrato: Horas Semanais }} (user_contract_weekly_hours): Carga horária semanal pactuada (ex: 44).
  • {{ Contrato: Observações }} (user_contract_notes): Texto livre de anotações ou aditivos.

Residente (Resident)

Menu de variáveis de Residente.
Disponíveis ao habilitar o toggle "Solicitar residente?" nos parâmetros do modelo de documento.
  • {{ Residente: Nome }}
  • {{ Residente: Endereço }}
  • {{ Residente: Número }}
  • {{ Residente: Bairro }}
  • {{ Residente: CEP }}
  • {{ Residente: Cidade }}
  • {{ Residente: Estado }}
  • {{ Residente: Nacionalidade }}
  • {{ Residente: Estado Civil }}
  • {{ Residente: CPF }}
  • {{ Residente: Data Nasc. }}
  • {{ Residente: Responsável }}
  • {{ Residente: Idade }}
  • {{ Residente: Data Entrada }}
  • {{ Residente: Hora Entrada }}
  • {{ Residente: Data Saída }}
  • {{ Residente: Hora Saída }}

Responsável pelo Residente

Menu de variáveis de Responsável pelo residente.
Disponíveis ao habilitar o toggle "Solicitar residente?" nos parâmetros do modelo de documento.
  • {{ Responsável: Nome }}
  • {{ Responsável: CPF }}
  • {{ Responsável: Estado Civil }}
  • {{ Responsável: Profissão }}
  • {{ Responsável: CEP }}
  • {{ Responsável: Endereço }}
  • {{ Responsável: Número }}
  • {{ Responsável: Bairro }}
  • {{ Responsável: Cidade }}
  • {{ Responsável: Estado }}
  • {{ Responsável: Parentesco/Vínculo }}
  • {{ Responsável: Telefone }}

Geral e Filtros

Menu de variáveis de Datas dinâmicas
Disponíveis ao habilitar o toggle "Solicitar datas?" nos parâmetros do modelo de documento.
  • {{ Data Inicial (Filtro) }}: Data inicial selecionada no modal de geração.
  • {{ Data Final (Filtro) }}: Data final selecionada no modal de geração.
  • {{ Data Atual (d/m/Y) }}: Data de hoje no formato dd/mm/aaaa.
  • {{ Data Atual Extenso }}: Data de hoje por extenso (ex: 12 de abril de 2026).

3. Retrocompatibilidade

O sistema continua suportando as tags antigas no formato ##NOME_DA_TAG## (ex: ##RESIDENTE_NOME##). No entanto, novas implementações devem preferir o formato de Merge Tags {{ ... }}, pois estas são nativamente integradas ao editor do Filament e evitam erros de digitação.


4. Como solicitar novas Merge Tags?

Para solicitar uma nova Merge Tag nos Modelos de Documentos, entre em contato com o desenvolvedor pelo grupo de suporte GITER da sua organização no Whatsapp.


Documentação desenvolvida com ❤️ por Je4nPw.
Sugestões de alterações? Entre em contato comigo pelo Whatsapp.