Documentación Automatizada e
Informes de Cumplimiento para TIA Portal
Genere informes de proyecto completos, documentos de pruebas de aceptación FAT/SAT y paquetes de entregables con un solo comando - sin recopilación manual de datos, sin trabajo de formato.
Cuatro Tipos de Informes, Un Solo Comando
Desde una descripción técnica rápida hasta un paquete de cumplimiento firmado
Informe de Proyecto
Documentación técnica completa del proyecto TIA Portal. Cubre configuración de hardware, topología de red, lista de E/S, bloques de programa, variables, UDTs, pantallas HMI, referencias cruzadas y estado de compilación. El documento base para cualquier entrega de proyecto.
Informe FAT
Informe de Factory Acceptance Test que combina el informe de proyecto completo con resultados de pruebas automatizadas, una captura VCS del estado del proyecto al momento de la prueba y una página de firma. Producido al final de las pruebas en fábrica antes del envío.
Informe SAT
Informe de Site Acceptance Test con la misma estructura que el informe FAT, adaptado para la puesta en marcha in situ. Documenta el estado final instalado y comisionado del sistema.
Entregable de Proyecto
Un archivo ZIP completo que combina el informe PDF, la exportación de datos XLSX, un archivo TIA Portal .zap20 y una captura VCS. Todo lo que el cliente o el sistema de archivo necesita en un solo archivo.
Qué contiene un Informe de Proyecto
Extraído automáticamente del proyecto TIA Portal en vivo - sin entrada manual de datos
- Configuración de hardware: racks, módulos, versiones de firmware, asignación de slots
- Topología de red: anillos PROFINET, subredes, direcciones IP, conexiones de dispositivos
- Lista completa de E/S: direcciones físicas, nombres simbólicos, tipos de datos, descripciones
- Inventario de bloques de programa: OBs, FBs, FCs, DBs con tamaños y fechas de modificación
- Tablas de variables: todas las variables del PLC con direcciones, tipos y comentarios
- User-Defined Types (UDTs): definiciones de estructura y detalles de miembros
- Pantallas HMI: lista de pantallas, recuento de elementos y resumen de enlaces de variables
- Análisis de referencias cruzadas: dónde se usa cada variable y bloque en todo el proyecto
- Estado de compilación: último resultado de build, errores, advertencias por dispositivo
Formatos de Salida
Cada formato sirve a una audiencia y un flujo de trabajo diferentes
Informe PDF
Documento legible por humanos para clientes, auditores y archivos de proyectos. Secciones estructuradas, tablas y una página de portada. Listo para imprimir o firma digital.
Exportación de Datos XLSX
Hoja de cálculo legible por máquina para análisis posteriores, importación en sistemas ERP/MES o pipelines de informes personalizados. Cada sección en una hoja dedicada.
Entregable ZIP
Paquete de proyecto completo: informe PDF + datos XLSX + archivo TIA Portal .zap20 + captura VCS. Un solo archivo para entregar al cliente o guardar en el sistema de gestión documental.
Opciones de Informe
Ajuste lo que incluye cada informe
Filtro de Dispositivo
Limite el informe a un PLC o dispositivo HMI específico usando la opción deviceName. Útil para proyectos multi-dispositivo donde cada dispositivo tiene su propia prueba de aceptación.
Inclusión de Código Fuente
La opción includeSourceCode añade el código fuente SCL completo de todos los bloques de programa. Útil para auditorías, revisiones de código o entregas de fuentes por contrato.
Resultados de Pruebas
includeTestResults adjunta la salida de las pruebas automatizadas de PLC de T-IA Connect ejecutadas antes de la generación del informe. Prueba que el sistema pasó su suite de pruebas en el momento de la firma.
Captura VCS
includeVcsSnapshot registra el hash del commit de Git y la rama en el momento de la generación del informe. Proporciona un vínculo a prueba de manipulaciones entre el informe y la versión exacta del código probada.
Informes como parte de su Pipeline DevOps
Active la generación de informes automáticamente al final de las etapas de CI/CD
T-IA Connect expone endpoints REST tanto síncronos como asíncronos para la generación de informes. Un pipeline de CI puede activar un informe FAT al final de una ejecución exitosa de pruebas en PLCSim, adjuntar el PDF como un artefacto de build y notificar al ingeniero responsable - todo sin intervención humana.
El endpoint asíncrono se recomienda para proyectos grandes: el trabajo se pone en cola, el pipeline consulta la finalización y el informe terminado se descarga cuando está listo. Para proyectos más pequeños, el endpoint síncrono devuelve el archivo directamente.
Combinado con el versionado de Git y las pruebas automatizadas de PLC, el reporting automatizado cierra el ciclo DevOps: cada fusión a main produce un informe versionado, un estado del sistema probado y un entregable de proyecto completo.
Referencia de Herramientas MCP
Seis herramientas que cubren todos los tipos de informes y formatos de salida
generate_project_report
Genera el informe técnico completo del proyecto. Opciones: deviceName, includeSourceCode, outputPath. Devuelve el archivo del informe PDF.
generate_project_deliverable
Produce el paquete entregable ZIP completo: PDF + XLSX + archivo .zap20 + captura VCS. El paquete estándar de entrega para la finalización del proyecto.
fat_generate_report
Genera el informe de Factory Acceptance Test. Combina el informe del proyecto con los resultados de las pruebas, la captura VCS y la página de firma.
sat_generate_report
Genera el informe de Site Acceptance Test. Misma estructura que el FAT, adaptado para la documentación de puesta en marcha in situ.
Endpoint REST Asíncrono
POST /api/reports/generate - pone en cola un trabajo de generación de informes y devuelve un ID de trabajo. Consulte GET /api/reports/job/{id} para ver el estado, luego descárguelo cuando esté completo.
Endpoint REST Síncrono
POST /api/reports/generate/sync - genera el informe síncronamente y devuelve el archivo directamente. Adecuado para proyectos más pequeños o uso interactivo.