Назад в DevOps
DevOps / Отчетность

Автоматизированная документация и
Отчеты о соответствии для TIA Portal

Создавайте полные отчеты по проектам, документы приемочных испытаний FAT/SAT и пакеты проектной документации одной командой - без ручного сбора данных и форматирования.

Четыре типа отчетов, одна команда

От краткого технического обзора до подписанного пакета документов о соответствии

Отчет по проекту

Полная техническая документация проекта TIA Portal. Включает конфигурацию оборудования, топологию сети, список вводов-выводов, программные блоки, теги, UDT, экраны HMI, перекрестные ссылки и статус компиляции. Базовый документ для передачи любого проекта.

Отчет FAT

Отчет о заводских приемочных испытаниях (Factory Acceptance Test), сочетающий полный отчет по проекту с результатами автоматизированных тестов, снимком VCS состояния проекта на момент теста и страницей утверждения. Создается в конце заводских испытаний перед отправкой.

Отчет SAT

Отчет о приемочных испытаниях на объекте (Site Acceptance Test) с той же структурой, что и отчет FAT, адаптированный для пусконаладочных работ на месте. Документирует конечное установленное и введенное в эксплуатацию состояние системы.

Проектная документация (Deliverable)

Полный ZIP-архив, объединяющий отчет PDF, экспорт данных XLSX, архив TIA Portal .zap20 и снимок VCS. Все, что нужно клиенту или системе архивации, в одном файле.

Что содержит отчет по проекту

Автоматически извлекается из живого проекта TIA Portal - без ручного ввода данных

  • Конфигурация оборудования: стойки, модули, версии прошивок, назначение слотов
  • Топология сети: кольца PROFINET, подсети, IP-адреса, подключения устройств
  • Полный список вводов-выводов: физические адреса, символьные имена, типы данных, описания
  • Инвентаризация программных блоков: OB, FB, FC, DB с размерами и датами изменения
  • Таблицы тегов: все теги ПЛК с адресами, типами и комментариями
  • Пользовательские типы данных (UDT): определения структур и детали элементов
  • Экраны HMI: список экранов, количество элементов и обзор привязок тегов
  • Анализ перекрестных ссылок: где каждый тег и блок используется в проекте
  • Статус компиляции: результат последней сборки, ошибки, предупреждения по каждому устройству

Форматы вывода

Каждый формат предназначен для своей аудитории и рабочего процесса

Отчет PDF

Удобочитаемый документ для клиентов, аудиторов и архивов проектов. Структурированные разделы, таблицы и титульный лист. Готов к печати или цифровой подписи.

Экспорт данных XLSX

Машиночитаемая таблица для дальнейшего анализа, импорта в системы ERP/MES или пользовательских конвейеров отчетности. Каждый раздел на отдельном листе.

Архив ZIP

Полный пакет проекта: отчет PDF + данные XLSX + архив TIA Portal .zap20 + снимок VCS. Один файл для передачи клиенту или хранения в системе документооборота.

Параметры отчета

Точная настройка состава каждого отчета

Фильтр устройств

Ограничьте отчет конкретным ПЛК или HMI-устройством с помощью опции deviceName. Полезно для многоустройственных проектов, где каждое устройство проходит свои приемочные испытания.

Включение исходного кода

Опция includeSourceCode добавляет полный исходный код SCL для всех программных блоков. Полезно для аудитов, проверок кода или контрактных требований к поставке исходников.

Результаты тестов

includeTestResults прикрепляет результаты автоматизированных тестов ПЛК T-IA Connect, запущенных перед созданием отчета. Доказывает, что система прошла набор тестов на момент подписания.

Снимок VCS

includeVcsSnapshot фиксирует хэш коммита Git и ветку на момент создания отчета. Обеспечивает защищенную от несанкционированного доступа связь между отчетом и точной версией протестированного кода.

Отчеты как часть вашего DevOps-конвейера

Автоматический запуск генерации отчетов в конце этапов CI/CD

T-IA Connect предоставляет как синхронные, так и асинхронные REST-эндпоинты для генерации отчетов. CI-конвейер может запустить отчет FAT в конце успешного прогона тестов в PLCSim, прикрепить PDF как артефакт сборки и уведомить ответственного инженера - и все это без вмешательства человека.

Асинхронный эндпоинт рекомендуется для больших проектов: задание ставится в очередь, конвейер опрашивает статус завершения, и готовый отчет загружается, когда он готов. Для небольших проектов синхронный эндпоинт возвращает файл напрямую.

В сочетании с версионностью Git и автоматизированным тестированием ПЛК автоматическая отчетность замыкает цикл DevOps: каждое слияние в main создает версионный отчет, протестированное состояние системы и полную проектную документацию.

Справочник инструментов MCP

Шесть инструментов, охватывающих все типы отчетов и форматы вывода

generate_project_report

Генерирует полный технический отчет по проекту. Опции: deviceName, includeSourceCode, outputPath. Возвращает файл отчета в формате PDF.

generate_project_deliverable

Создает полный ZIP-пакет: PDF + XLSX + архив .zap20 + снимок VCS. Стандартный пакет для завершения проекта.

fat_generate_report

Генерирует отчет о заводских приемочных испытаниях. Объединяет отчет по проекту с результатами тестов, снимком VCS и страницей утверждения.

sat_generate_report

Генерирует отчет о приемочных испытаниях на объекте. Та же структура, что и у FAT, адаптированная для документации по пусконаладке на месте.

Асинхронный REST-эндпоинт

POST /api/reports/generate - ставит задачу на генерацию отчета в очередь и возвращает ID задачи. Опрашивайте GET /api/reports/job/{id} для получения статуса, затем скачивайте по завершении.

Синхронный REST-эндпоинт

POST /api/reports/generate/sync - генерирует отчет синхронно и возвращает файл напрямую. Подходит для небольших проектов или интерактивного использования.

Автоматизируйте документацию вашего проекта

Перестаньте тратить часы на ручную сборку отчетов по проекту. Одна команда генерирует все - от списка вводов-выводов до подписанного документа FAT.