> ## Documentation Index
> Fetch the complete documentation index at: https://dmgttrans.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Modelos e documentos de referência

> Gerencie modelos de documentos nativos e HTML, documentos de referência e modelos de notificação de custódia.

Esta seção é destinada exclusivamente ao perfil **Administrador**.

No menu lateral, acesse **Administração** e escolha:

* **Modelos de Documento**: para criar e editar modelos de documentos emitidos pelo sistema.
* **Documentos de Referência**: para disponibilizar leis e regulamentos aos agentes.
* **Configurações** (subtela interna): para ajustar os modelos de notificação de custódia.

***

## Modelos de documento

A tela **Modelos de documento** lista todos os modelos ativos e permite criar novos modelos ou editar os existentes. Cada modelo publicado gera uma nova versão; as versões anteriores ficam preservadas para manter a integridade dos documentos já emitidos.

### Lista de modelos

Após abrir a tela, você vê:

* **Novo modelo**: botão no topo direito para iniciar um modelo do zero.
* Cards dos modelos ativos, com **nome**, **chave técnica**, **tipo** (Nativo ou HTML) e **versão atual**.
* Cada card exibe a quantidade de **variáveis configuradas** e botões para **Editar modelo** e **Arquivar modelo**.
* Abaixo, a seção **Histórico preservado** exibe as versões antigas arquivadas.

> [!NOTE]
>
> Arquivar um modelo não exclui as versões já emitidas. Apenas impede que o modelo seja usado em novos documentos.

### Identidade global do cabeçalho

Antes de criar modelos, configure a identidade institucional que aparecerá em todos os PDFs nativos:

| Campo | Descrição |
| - | - |
| **Prefeitura / órgão** | Nome da prefeitura ou órgão superior (até 160 caracteres). |
| **Departamento** | Nome do departamento (até 220 caracteres). |
| **Imagem do cabeçalho** | Logo em PNG, JPG ou WebP (até 1,5 MB). |

Clique em **Salvar identidade do cabeçalho** para aplicar as alterações em todos os modelos nativos.

### Criar ou editar um modelo

**1. Abrir o editor**

Clique em **Novo modelo** ou **Editar modelo** em um card existente.

**2. Configurar variáveis**

Abra a seção **Variáveis do modelo** para definir os campos que serão preenchidos ao criar um documento deste tipo. Clique em **Adicionar variável** para incluir novos campos.

**3. Preencher os dados básicos**

Informe a **Chave técnica** (letras minúsculas, números e sublinhado; mínimo 3 caracteres) e o **Nome do modelo / tipo**. A chave não pode ser alterada depois da primeira publicação.

**4. Escolher a forma de geração**

Selecione **Editor visual nativo** ou **HTML** no campo **Forma de geração**.

**5. Editar o conteúdo**

* No **editor visual nativo**, monte o layout com texto, tabelas, variáveis e alinhamentos.
* No modo **HTML**, digite o conteúdo completo em HTML e, opcionalmente, informe uma **Fonte de dados adicional** (URL).

**6. Configurar cabeçalho e assinaturas (nativo)**

Ative ou desative:

* **Exibir número do processo**
* **Exibir número do documento**
* **Exibir departamento**
* **Exibir unidade atual**
* **Página de autenticidade e assinaturas**
* **Signatários externos padrão**: liste nomes, e-mails e cargos sugeridos para assinatura remota.

**7. Publicar**

Clique em **Publicar nova versão**. O sistema salva o modelo e gera uma nova versão numerada.

### Edição de variáveis

Cada variável possui:

| Propriedade | Descrição |
| - | - |
| **Rótulo** | Nome exibido no formulário. |
| **Tipo** | Texto curto, texto longo, data, CPF/CNPJ, e-mail, telefone, endereço, DRV, AIT, placa, caixa de seleção, seleção, pessoa/usuário, texto longo estruturado, entre outros. |
| **Obrigatório** | Define se o campo é de preenchimento obrigatório. |
| **Ocultar no formulário** | Mantém a variável no modelo, mas não aparece para o usuário preencher. |

Para campos do tipo **Seleção**, preencha as opções uma por linha e defina se permite **múltipla escolha**.

Para campos do tipo **Endereço**, o sistema cria automaticamente subvariáveis para CEP, logradouro, número, complemento, bairro, cidade e UF.

### Editor visual nativo

O editor visual oferece:

* Formatação: **negrito**, **itálico**, **sublinhado**.
* Títulos: **Título grande** e **Título médio**.
* Listas: **com marcadores** e **numerada**.
* Alinhamento: **à esquerda**, **centralizar**, **à direita**, **justificar**.
* Tabelas com inserção de linhas e colunas.
* Inserção de **variáveis** com transformações:
  * **Exibir mascarada** (oculta partes de CPF, telefone, e-mail, nome).
  * **Data por extenso** (exibe uma data como "18 de agosto de 2026").
  * **Caixa alta** (converte o valor para letras maiúsculas).

> [!WARNING]
>
> Variáveis marcadas como **Preenchido pelo sistema** ou **Data/hora do sistema** ficam desabilitadas na escolha de tipo, pois são preenchidas automaticamente pelo sistema.

***

## Documentos de referência

A tela **Documentos de Referência** permite fazer upload de leis, regulamentos e outros documentos em PDF para consulta dos agentes de trânsito.

### Enviar um documento

**1. Preencher o nome**

No campo **Nome do Documento**, digite um título descritivo. Exemplo: "Código de Trânsito Brasileiro".

**2. Selecionar o arquivo**

Clique em **Arquivo PDF** e escolha um arquivo no seu computador. Apenas PDF são aceitos.

**3. Enviar**

Clique em **Enviar** e aguarde a confirmação.

### Gerenciar documentos cadastrados

A lista **Documentos Cadastrados** exibe:

* **Nome** do documento.
* **Data** de envio.
* Botão para **remover** o documento.

Clique no ícone de remoção e confirme a exclusão. O arquivo é removido permanentemente.

***

## Modelos de notificação de custódia

Dentro da tela **Configurações**, a seção **Modelos das notificações de custódia** permite editar os textos usados nas comunicações sobre veículos recolhidos.

> [!NOTE]
>
> Esta seção usa modelos HTML versionados. Endereço e CPF existem somente na correspondência privada; os editais públicos recebem apenas os dados do veículo.

### Tipos de modelo

| Modelo | Descrição |
| - | - |
| **Correspondência postal simples** | Carta enviada ao proprietário com dados pessoais e endereço. |
| **Edital simultâneo da notificação inicial** | Publicação em edital com dados do veículo (sem CPF ou endereço). |
| **Edital complementar do art. 26** | Publicação complementar para notificações previstas no artigo 26. |

### Editar um modelo

**1. Selecionar o documento**

No campo **Documento**, escolha o modelo que deseja alterar.

**2. Ajustar o nome**

Altere o **Nome do modelo** se necessário.

**3. Editar o HTML**

Utilize o campo **HTML/EJS** para editar o conteúdo. As variáveis disponíveis dependem do tipo:

**Correspondência postal simples:** `recipient.name`, `recipient.document_masked`, `address.cep`, `address.street`, `address.number`, `address.complement`, `address.neighborhood`, `address.city`, `address.state`, `vehicle.plate`, `vehicle.drv_number`, `vehicle.brand_model`, `vehicle.chassis`, `vehicle.renavam`, `vehicle.collection_date` e `generated_date`.

**Editais públicos:** `notice.number`, `generated_date` e o bloco `<% vehicles.forEach(function(v){ %> ... <% }) %>`. Dentro dele: `v.plate`, `v.drv_number`, `v.brand_model`, `v.chassis`, `v.renavam` e `v.collection_date`.

**4. Verificar a prévia**

A **Prévia** mostra como o documento ficará com dados de exemplo.

**5. Salvar**

Clique em **Salvar como nova versão**. A versão anterior é preservada automaticamente.

> [!TIP]
>
> O sistema mostra uma barra de prévia interativa com dados fictícios (placa ABC1D23, DRV 0123/2026, etc.) para que você valide o layout antes de publicar.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.