Gerar documentos em PDF é uma das funcionalidades mais requisitadas em aplicações empresariais. Seja para relatórios de pedidos, contratos, faturas ou comprovantes, o PDF é um formato universal, fácil de compartilhar e com alta confiabilidade visual.
No Mendix, é possível criar PDFs a partir de páginas ou relatórios customizados, utilizando módulos disponíveis no Mendix Marketplace e configurando microflows que automatizam a geração e o download dos arquivos.
Neste guia completo da TWRT, você vai aprender:
- Por que usar PDFs no Mendix
- Como instalar e configurar o módulo PDF Document Generation
- Como preparar entidades e microflows para suportar PDFs
- Passo a passo para criar um relatório em PDF
- Boas práticas de segurança e permissões
- Exemplos práticos de estilização e customização do PDF
📌 Por que Gerar PDFs no Mendix?
O Mendix já possui poderosas ferramentas para exibir dados em tela (grids, dashboards, gráficos), mas em muitos casos é necessário exportar essas informações para um formato externo.
Vantagens de usar PDF no Mendix:
- Universalidade: qualquer usuário pode abrir em qualquer dispositivo.
- Impressão facilitada: PDFs mantêm layout e formatação.
- Validade documental: relatórios, contratos e comprovantes oficiais.
- Automação: o Mendix pode gerar relatórios sob demanda ou agendados.
🛠️ Preparando o Ambiente
Antes de começar, verifique os requisitos:
| Requisito | Descrição |
|---|---|
| Mendix Studio Pro | Versão atualizada, exemplo usado: Mendix 10.20 |
| Aplicação base | Exemplo: sistema de pedidos com clientes, produtos e status |
| Módulo PDF Document Generation | Disponível no Marketplace do Mendix |
| Módulo Community Commons | Necessário para commits e transações em microflows |
| Permissões configuradas | Usuários devem ter roles corretos para gerar e baixar PDFs |
📥 Instalando o Módulo PDF Document Generation
O Mendix não possui nativamente um gerador de PDFs. Para isso, usamos o módulo PDF Document Generation.
Passo a Passo:
- Abra o Mendix Studio Pro.
- Vá até o Marketplace.
- Pesquise por PDF Document Generation.
- Clique em Download e adicione ao seu projeto.
- Após instalar, vá em:
- Settings > Runtime > After Startup
- Configure o microflow
Documentation.Initialize.
💡 Esse passo é essencial para inicializar o módulo corretamente toda vez que o app rodar.
⚙️ Configurando as Permissões de Usuário
Um erro comum é esquecer das permissões.
Exemplo de configuração:
- Vá até Security > User Roles.
- Configure o Administrador para ter acesso também como User.
- Isso garante que, ao gerar PDFs, não ocorram erros de permissão.
🔐 Dica: sempre verifique se o usuário que gera o PDF tem permissão para acessar as entidades que alimentam o relatório.
📑 Criando a Página de Relatório
Nosso exemplo será um dashboard de pedidos, mostrando:
- Total de pedidos
- Pedidos pendentes
- Pedidos enviados
- Pedidos cancelados
- Percentual de pendentes (gráfico simples)
Estrutura recomendada:
- Crie uma entidade
Dashboard(armazenará dados do relatório).- TotalPedidos
- Pendentes
- Enviados
- Cancelados
- PercentualPendentes
- Crie uma entidade
OrderReportFile(generalização deFileDocument).- Usada para armazenar o PDF gerado no banco.
- Crie a página DashboardView.
- Insira KPIs (cards numéricos).
- Insira gráfico (ex.: donut chart para percentual).
Essa página servirá como base para o PDF.
🔄 Criando o Microflow de Geração do Dashboard
Antes de gerar o PDF, precisamos popular o Dashboard.
- Crie um submicroflow chamado
GenerateDashboardData. - Nele, faça consultas ao banco:
- Conte total de pedidos.
- Filtre por status (pendentes, enviados, cancelados).
- Calcule percentual de pendentes.
- Armazene os valores na entidade
Dashboard. - Faça commit do objeto.
💡 Importante: PDFs só podem ser gerados a partir de objetos commitados.
🔄 Microflow Principal para Geração do PDF
Agora vamos ao fluxo que realmente cria o arquivo.
Estrutura do Microflow ACT_Order_GeneratePDF:
- Chame o submicroflow
GenerateDashboardData. - Use Community Commons > EndTransaction (finaliza transação do commit).
- Adicione a ação
Generate PDF from Page.
Configurações da ação:
- Page:
DashboardView - Object:
Dashboard - Output:
OrderReportFile(nosso arquivo PDF) - File Name:
"OrderReport.pdf" - Orientation: Landscape ou Portrait (dependendo do layout)
- Page Size: A4
- Por fim, adicione a ação Download File para que o usuário baixe o PDF.
🖥️ Botão de Geração no Front-End
- Vá até a página OrderOverview.
- Adicione um botão:
- Label: Gerar PDF
- OnClick → Call Microflow →
ACT_Order_GeneratePDF
Agora o usuário poderá clicar no botão e gerar relatórios em PDF a qualquer momento.
📊 Exemplo de PDF Gerado
Um relatório simples de pedidos pode gerar algo assim:
Relatório de Pedidos – PDF
| Métrica | Valor |
|---|---|
| Total de Pedidos | 7 |
| Pendentes | 4 |
| Enviados | 1 |
| Cancelados | 2 |
| % Pendentes | 57% |
📌 Esse layout pode incluir gráficos, logos da empresa, cores institucionais e até tabelas complexas.
🎨 Customizando o Layout do PDF
O Mendix permite ajustar a formatação do PDF diretamente na página de origem.
Configurações úteis:
- Page Properties > Export to PDF: habilite a exportação.
- Orientation: Portrait ou Landscape.
- Page Size: A4, Letter, etc.
Além disso, é possível aplicar CSS para melhorar o visual:
.dashboard-title {
font-size: 24px;
font-weight: bold;
color: #D32F2F; /* Vermelho corporativo */
}
.table-report {
border: 1px solid #000;
width: 100%;
text-align: center;
}
🚨 Erros Comuns e Como Evitar
| Erro | Causa | Solução |
|---|---|---|
| PDF vazio | Objeto não commitado | Sempre use commit + EndTransaction |
| Erro de permissão | User Role incorreto | Configure Admin com acesso de User |
| Layout desconfigurado | Página não otimizada para PDF | Ajuste propriedades e CSS |
| Nome de arquivo incorreto | Output não definido | Configure o campo File Name corretamente |
✅ Boas Práticas ao Gerar PDFs no Mendix
- Use entidades dedicadas para armazenar dados do relatório.
- Centralize a lógica em microflows reutilizáveis.
- Sempre finalize transações antes de chamar
Generate PDF. - Teste diferentes layouts (Portrait x Landscape).
- Personalize com CSS para manter identidade visual.
- Valide permissões antes de liberar o botão para usuários comuns.
📌 Conclusão
Gerar PDFs no Mendix pode parecer complexo no início, mas seguindo este passo a passo você consegue criar relatórios profissionais, com dados dinâmicos e visual customizado.
Com o módulo PDF Document Generation, microflows bem estruturados e atenção às permissões, é possível:
- Criar relatórios gerenciais
- Emitir contratos e comprovantes
- Automatizar exportações de dados
👉 Agora é sua vez!
Implemente este fluxo no seu app Mendix, ajuste para o seu caso de uso e entregue relatórios em PDF com a qualidade que seu cliente precisa.
