Подключение данных¶

Чтобы Орбита отвечала по данным организации, ей нужно описание этих данных. Описание готовится один раз при внедрении и дополняется по мере появления новых показателей.

Домен данных¶

Домен это описание набора связанных таблиц. В нём указывается:

Что описывается	Зачем
Состав таблиц	Система понимает, где искать данные
Смысл каждого поля	Формулировка вопроса связывается с нужной колонкой
Связи между таблицами	Правильно строятся объединения
Особенности расчёта	Например, что показатель нельзя суммировать по датам

Домены хранятся отдельно от системы и подключаются без пересборки. После изменения описания перезапустите сервер Орбиты.

Что даёт качественное описание¶

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

Русские названия таблиц. Пользователь должен видеть «Животноводство, сводный отчёт», а не техническое имя витрины.
Короткие подписи полей. Помимо подробного описания для системы, у поля должна быть короткая человеческая подпись. Она показывается в прослеживании и в описании структуры данных.
Правила агрегации. Если показатель моментальный, то есть его нельзя складывать по датам, это нужно указать явно. Иначе система просуммирует остатки за месяц и получит бессмысленное число.

Витрины вместо исходных таблиц¶

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

Рекомендация при внедрении: начинать с витрин по ключевым показателям, а не открывать всё хранилище целиком.

Отчёты¶

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

Отчёты создаются двумя способами:

Способ	Кому подходит
Конструктор отчётов в веб-интерфейсе администратора	Точечное создание и правка
Ведение файлов отчётов в системе контроля версий	Командная работа, перенос между стендами

Ведение отчётов в системе контроля версий¶

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

Выгрузить текущие отчёты в папку:

orbita reports pull ./reports

Посмотреть, что изменится, ничего не применяя:

orbita reports diff ./reports

Применить папку к системе:

orbita reports sync ./reports

Полезно знать:

Отчёт опознаётся по краткому имени, а не по имени файла. Правка файла с тем же именем обновляет отчёт на месте, сохраняя его у пользователей в избранном.
Смена краткого имени это не переименование, а создание нового отчёта.
Отчёты, которых нет в папке, по умолчанию не удаляются.
Для применения нужны права на управление отчётами.

Порядок подключения нового набора данных¶

Убедитесь, что данные загружены в аналитическое хранилище и обновляются.
Подготовьте описание домена: таблицы, поля, названия, правила расчёта.
Разместите описание в каталоге доменов и перезапустите сервер Орбиты.
Проверьте вопросом, что система видит данные: «какие данные есть по …».
Задайте несколько типовых вопросов и сверьте ответы с известными цифрами.
Настройте политики доступа, если данные видны не всем. См. Пользователи и права.
Оформите регулярные запросы отчётами.

Проверка после подключения¶

Система перечисляет новый домен в ответе на вопрос о доступных данных.
Типовой вопрос возвращает цифры, совпадающие с эталоном.
В прослеживании видны русские названия таблиц и понятные подписи полей.
Показатели, которые нельзя суммировать, не суммируются.