Предпросмотр документов

Общая информация

  • Для форматов с нативным предпросмотром, например поддерживаемых PDF и изображений, конвертация в thumbnail не запускается. Конкретный набор форматов определяется MIME-описанием платформы и возможностями UI.

  • Для содержимого без нативного предпросмотра возможна автоматическая конвертация при наличии конвертера в целевой формат. По умолчанию используется PDF. Подробнее см. Трансформация содержимого документов.

  • Доступность предпросмотра и конвертеров зависит от состава и условий поставки. Наличие MIME-типа или настройки целевого формата само по себе не гарантирует возможность просмотра или конвертации.

  • Автоматическая генерация обрабатывает основной контент, доступный через системный атрибут _content.

  • Основной контент — контент в атрибуте с id content или другой, но в конфигурации типа он должен быть указан в contentConfig → path. Подробнее см. Конфигурация контента

Условия автоматической генерации превью

  1. Тип документа унаследован от user-base прямо или косвенно; запись имеет тип, отличный от thumbnail.

  2. При создании документа есть _content с непустым SHA-256. При событии изменения контента сведения об источнике проверяются заново при генерации.

  3. MIME-тип исходного содержимого корректен, и для него не предусмотрен нативный предпросмотр на UI.

  4. Зарегистрирован конвертер из исходного MIME-типа в целевой.

Целевой формат задаётся Spring-настройкой микросервиса:

ecos:
  contentPreview:
    defaultTargetMimeType: application/pdf

Настройка определяет целевой MIME, но не добавляет конвертеры.

Ограничение размера

По умолчанию генерация thumbnail допускается для исходного файла размером не более 100 MiB (100 × 1024 × 1024 байт). При превышении размера генерация отклоняется. Ограничение настраивается в ecos-transformations:

ecos:
  thumbnail:
    maxFileSizeMb: 100

Это ограничение генерации thumbnail, а не общий предел загрузки файлов в Citeck или нативного отображения PDF. При изменении значения учитывайте ресурсы сервиса и ограничения конвертера.

Процесс генерации

  1. В системе происходит создание сущности с основным контентом или изменение основного контента.

  2. Микросервис ecos-transformations проверяет условия генерации и создаёт или находит thumbnail для исходной записи, атрибута и целевого MIME.

  3. После коммита транзакции публикуется команда в очередь RabbitMQ transformations.content-preview.gen.

  4. Обработчик команды запускает генерацию асинхронно. Контент источника читается заново, проверяется размер и выполняется конвертация в целевой формат.

  5. Результат записывается в основной контент thumbnail. При успехе устанавливается PROCESSED, обновляется SHA-256 источника и сбрасываются сведения о повторных попытках.

Результат не обязан быть готов сразу после сохранения документа. Если источник пуст или не имеет SHA-256, обработчик завершает генерацию без конвертации и выставляет PROCESSED; этот статус сам по себе не гарантирует наличие непустого PDF.

Thumbnail

Это некоторое представление основного документа в заданном формате. Атрибуты:

content: CONTENT          // основное сгенерированное содержимое
mimeType: TEXT            // MIME-тип содержимого для этого thumbnail
srcSha256: TEXT           // хэш исходного контента
srcAttribute: TEXT        // атрибут с исходным контентом
status: TEXT              // статус обработки: DRAFT, PROCESSING, PROCESSED, FAILED
nextTryTime: DATETIME     // время следующей попытки сгенерировать контент в случае неудачи
failsCount: NUMBER        // текущее количество неудачных попыток сгенерировать контент
failDescription: TEXT     // описание последней ошибки генерации

Thumbnail-сущности создаются как дочерние к исходному документу: _parent указывает на документ, _parentAtt — на thumbnail:thumbnails.

Thumbnail repair job

В микросервисе ecos-transformations работает джоба обработки просроченных повторов и зависшей генерации. Она включается через 10 секунд после готовности приложения и проверяет доступность ecos-model.

В каждом цикле:

  1. Сначала выбирается один thumbnail с nextTryTime раньше текущего времени, с сортировкой по этому полю. Фильтра по статусу FAILED в этом запросе нет. Для выбранного thumbnail выполняется повторная генерация.

  2. Если просроченного повтора нет, выбирается thumbnail в статусе PROCESSING, у которого _modified старше 30 минут. Он переводится в FAILED с описанием timeout и назначением следующей попытки; немедленная конвертация в этой ветке не выполняется.

После обработки записи джоба ожидает 500 мс, при отсутствии работы — 10 секунд. Полное время цикла зависит также от длительности запросов и конвертации.

При обычной ошибке увеличивается failsCount, заполняется failDescription и назначается повтор с задержкой, зависящей от счётчика. Максимальная задержка — 48 часов. Для распознанной ошибки Unknown MimeType очищаются контент и nextTryTime; автоматического повтора по таймеру не будет.

Thumbnail в DRAFT без nextTryTime не попадает в эти запросы. Поэтому repair job не гарантирует восстановление любого незавершённого thumbnail; при диагностике проверяйте статус, время повтора и логи сервиса.