Пакетные отчёты

Эта страница описывает механизм. Конкретные виды — типы документов, поля, статусы — определяются для вашей организации и могут отличаться. См. систему сущностей.

Отчёт в CityScreen Deals — это массовое слияние документов: система формирует один общий выходной файл из шаблона и набора записей документов.

Метрики и графики описаны в разделе дашборды.

Типы отчётов

Тип отчёта определяет, документы какого вида можно объединять и какой шаблон используется для получения результата. Типы отчётов создаёт администратор и привязывает каждый к типу документа и файлу шаблона.

Источником для типа отчёта могут быть только типы документов.

Формирование отчёта

В списке документов, при желании отфильтрованном по типу и пользовательским полям, выберите Создать отчёт. Выберите тип отчёта, дайте отчёту название и подтвердите.

Система ставит задачу формирования в очередь. Она выполняется в фоне — держать страницу открытой не нужно. Для больших наборов данных формирование может занять значительное время.

Когда задача завершится, отчёт появляется в списке отчётов со статусом Создан и ссылкой для скачивания.

Значения фильтров в шаблоне

Когда отчёт формируется из отфильтрованного списка документов, критерии поиска, которые применил пользователь, сохраняются и передаются в контекст шаблона под ключом filter.

Так созданная книга может показывать, какие фильтры дали этот набор данных, — это полезно для титульных листов, заголовков и журналов проверки.

Доступ к значениям фильтров

На любом листе шаблона используйте {{filter.<key>}}, где <key> совпадает с ключом критерия поиска:

Report filters:
  Document type: {{filter.documentType.id}}
  Region:        {{filter.variableValues.region}}

Объект filter повторяет иерархию критериев поиска. Критерии, разделённые точками, например variableValues.region, становятся вложенными путями:

Ключ критерия поиска Плейсхолдер шаблона

name

{{filter.name}}

documentType.id

{{filter.documentType.id}}

variableValues.region

{{filter.variableValues.region}}

Внутри повторяющегося раздела используйте префикс корневого контекста, чтобы обратиться к значениям фильтров из цикла:

{{#items}}
  Region filter: {{$.filter.variableValues.region}}
  Document name: {{name}}
{{/items}}

Скачивание отчёта

Отчёт можно скачать, только когда его статус — Создан. У отчётов, которые ещё формируются (статус Создаётся), пока нет файла для скачивания.

Если отчёт не сформировался

Если при формировании возникает ошибка, статус отчёта становится Ошибка.

Если отчёт не сформировался:

  • Проверьте, корректен ли исходный шаблон: те же причины пустого результата, что влияют на формирование одного документа (опечатки в плейсхолдерах, устаревший синтаксис, повреждённый шаблон), могут привести к сбою пакетной задачи. Полный список частых причин см. диагностика проблем.

  • Если шаблон корректен, обратитесь к администратору.

Удаление отчётов

Отчёты можно удалять по одному. Для удаления нужно соответствующее право для типа отчёта.

Связанные страницы

  • Экспорт записи — получение одного файла из одной записи

  • Шаблоны — синтаксис плейсхолдеров и форматы шаблонов

  • Лист _data — подключение дополнительных источников данных в книгу

  • Плейсхолдеры — имена полей, пути через точку, доступ к корневому контексту

  • Дашборды — аналитика и метрики