Documentação Automatizada e
Relatórios de Conformidade para TIA Portal
Gere relatórios de projeto completos, documentos de teste de aceitação FAT/SAT e pacotes de entrega de projeto em um único comando - sem coleta manual de dados, sem trabalho de formatação.
Quatro Tipos de Relatórios, Um Comando
De uma visão geral técnica rápida a um pacote de conformidade assinado
Relatório de Projeto
Documentação técnica completa do projeto TIA Portal. Abrange configuração de hardware, topologia de rede, lista de E/S, blocos de programa, tags, UDTs, telas de HMI, referências cruzadas e status de compilação. O documento base para qualquer entrega de projeto.
Relatório FAT
Relatório de Factory Acceptance Test combinando o relatório completo do projeto com resultados de testes automatizados, um snapshot VCS do estado do projeto no momento do teste e uma página de aprovação. Produzido ao final dos testes de fábrica antes do envio.
Relatório SAT
Relatório de Site Acceptance Test com a mesma estrutura do relatório FAT, adaptado para comissionamento no local. Documenta o estado final instalado e comissionado do sistema.
Entrega de Projeto
Um arquivo ZIP completo combinando o relatório PDF, exportação de dados XLSX, um arquivo TIA Portal .zap20 e um snapshot VCS. Tudo o que o cliente ou o sistema de arquivamento precisa em um único arquivo.
O que um Relatório de Projeto Contém
Extraído automaticamente do projeto TIA Portal ativo - sem entrada manual de dados
- Configuração de hardware: racks, módulos, versões de firmware, atribuições de slots
- Topologia de rede: anéis PROFINET, sub-redes, endereços IP, conexões de dispositivos
- Lista completa de E/S: endereços físicos, nomes simbólicos, tipos de dados, descrições
- Inventário de blocos de programa: OBs, FBs, FCs, DBs com tamanhos e datas de modificação
- Tabelas de tags: todas as tags do PLC com endereços, tipos e comentários
- User-Defined Types (UDTs): definições de estrutura e detalhes de membros
- Telas de HMI: lista de telas, contagem de elementos e visão geral das vinculações de tags
- Análise de referência cruzada: onde cada tag e bloco é usado em todo o projeto
- Status da compilação: último resultado do build, erros, avisos por dispositivo
Formatos de Saída
Cada formato atende a um público e fluxo de trabalho diferente
Relatório PDF
Documento legível por humanos para clientes, auditores e arquivos de projetos. Seções estruturadas, tabelas e uma página de capa. Pronto para impressão ou assinatura digital.
Exportação de Dados XLSX
Planilha legível por máquina para análises adicionais, importação em sistemas ERP/MES ou pipelines de relatórios personalizados. Cada seção em uma aba dedicada.
Entrega ZIP
Pacote de projeto completo: relatório PDF + dados XLSX + arquivo TIA Portal .zap20 + snapshot VCS. Um arquivo para entregar ao cliente ou armazenar no sistema de gerenciamento de documentos.
Opções de Relatório
Ajuste o que cada relatório inclui
Filtro de Dispositivo
Limite o relatório a um PLC ou dispositivo HMI específico usando a opção deviceName. Útil para projetos com vários dispositivos, onde cada dispositivo tem seu próprio teste de aceitação.
Inclusão de Código Fonte
A opção includeSourceCode anexa o código fonte SCL completo de todos os blocos de programa. Útil para auditorias, revisões de código ou requisitos contratuais de entrega de fontes.
Resultados de Testes
includeTestResults anexa a saída dos testes de PLC automatizados do T-IA Connect executados antes da geração do relatório. Prova que o sistema passou em seu conjunto de testes no momento da aprovação.
Snapshot VCS
includeVcsSnapshot registra o hash do commit do Git e a branch no momento da geração do relatório. Fornece um link inviolável entre o relatório e a versão exata do código testada.
Relatórios como parte do seu Pipeline DevOps
Acione a geração de relatórios automaticamente ao final das etapas de CI/CD
O T-IA Connect expõe endpoints REST síncronos e assíncronos para geração de relatórios. Um pipeline de CI pode acionar um relatório FAT ao final de uma execução de teste PLCSim bem-sucedida, anexar o PDF como um artefato de build e notificar o engenheiro responsável - tudo sem intervenção humana.
O endpoint assíncrono é recomendado para grandes projetos: o trabalho é enfileirado, o pipeline consulta a conclusão e o relatório final é baixado quando estiver pronto. Para projetos menores, o endpoint síncrono retorna o arquivo diretamente.
Combinado com o versionamento Git e testes de PLC automatizados, os relatórios automatizados fecham o ciclo DevOps: cada merge na main produz um relatório versionado, um estado de sistema testado e uma entrega de projeto completa.
Referência de Ferramentas MCP
Seis ferramentas cobrindo todos os tipos de relatórios e formatos de saída
generate_project_report
Gera o relatório técnico completo do projeto. Opções: deviceName, includeSourceCode, outputPath. Retorna o arquivo de relatório PDF.
generate_project_deliverable
Produz o pacote de entrega ZIP completo: PDF + XLSX + arquivo .zap20 + snapshot VCS. O pacote padrão de entrega para a conclusão do projeto.
fat_generate_report
Gera o relatório de Factory Acceptance Test. Combina o relatório do projeto com resultados de testes, snapshot VCS e página de aprovação.
sat_generate_report
Gera o relatório de Site Acceptance Test. Mesma estrutura que o FAT, adaptado para documentação de comissionamento no local.
Endpoint REST Assíncrono
POST /api/reports/generate - enfileira um trabalho de geração de relatório e retorna um ID de trabalho. Consulte GET /api/reports/job/{id} para status, depois baixe quando concluído.
Endpoint REST Síncrono
POST /api/reports/generate/sync - gera o relatório de forma síncrona e retorna o arquivo diretamente. Adequado para projetos menores ou uso interativo.