00 Термины

Данная информация приведена для версии веб-клиента начиная с 9.0.0. (Подход сохраняется, различия могут быть лишь в эскпортируемых по умолчанию модулях и компонентах)

Веб-клиент (Front-end, Клиент, шаблон, далее “обвязка, веб-клиент”) – веб-приложение Luxms BI для пользователей и администраторов, реализованное в виде HTML5/Javascript приложения для браузеров (поставщик: проект luxmsbi-web-client).

Коробка (коробочный, “из коробки”) - общая характеристика элементов, поставки, поведения и настройки компонентов, идущих в базовом виде веб-клиента и не требующих дополнительных действий, кроме тех, что указаны в основных руководствах пользователя продукта.

Атлас (Датасет, Набор данных) – логическая единица демонстрации агрегированных данных (метаданных), готовых дэшбордов и их настроек, полностью подготовленных для показа на веб-клиенте.

Имя схемы (“схема_нейм”) - это поле schema_name атласа, которое является строковым идентификатором, используемым в ряде запросов. В рамках инстанса должно быть уникальным. В идеале содержать логику именования ,выбранную вами и привязывающую атлас к инстансу, чтобы в случае переноса атласов не получить конфликт имен. По умолчанию, при создании равен ds_${id атласа}, например ds_51.

Дешборд (Dashboard) – аналитическая панель, на которой отображаются один или несколько дешлетов, объединенных какой-либо логикой.

Дешлет, деш (Dashlet, Dash) – аналитический блок, в первую очередь резервирующий место на дэшборде. По умолчанию соответствующий одному из встроенных типов визуализаций, но может хранить сразу несколько (типы визуализации “доска” и “табы”).

Визель (Vizel) - компонент React, по умолчанию рисующий график на основе входных данных и характеристик и особенностей самого типа графика. В одном деше может быть отрисовано более одного визеля.

Тип дэша, тип визуализации (view_class) - это строка, указывающая один из коробочных визелей, который нужно отобразить в данном дэшлете. Например, визель, позволяющий рендерить кастомный React-компонент, зовется internal

Глобальный - доступный для всех на всех атласах

Локальный - доступный в рамках одного атласа.

Источник данных - любое хранилище данных, в том числе файл Excel или CSV.
Бывает локальным и глобальным.

Куб данных (далее “куб”) - абстракция OLAP-технологии, представляющая структуру данных, состоящую их Размерностей (Dimensions) и Фактов (Measures). Это плоская таблица с предрасчетами аггрегаций.
Бывает глобальным и локальным. Локальный куб может иметь и локальный, и глобальный источник данных, но глобальный куб может иметь только глобальный источник данных.

Идентификатор куба - это ${имя источника}.${имя таблицы}, например "postgres.fortests_fortests_Postgres".

Размерности (Dimensions, Измерения, Разрезы, далее “дименшны”) – характеристики показателей в кубе данных. Обычно имеют иерархическую структуру.

Факты (Measures, далее “межи”) – числовые значения показателей в кубе данных.

Декартово произведение - каждое значение одного дименшна соединяется с каждым значением другого дименшна (кратно количеству выбранных дименшнов), формируя все возможные их комбинации, где для каждого из таких вариантов комбинаций посчитаны значения выбранных меж.
Именно в таком виде вам будут приходить данные от куба (массив объектов, где каждый ключ - значение дименшна, межи или подытога в данной точке)

Подытог (subtotal) - данные, полученные без учета каких либо дименшнов. То есть, если мы укажем дименшнами sex, name, age и межами sum(value), avg(value), то в случае, если нас интересуют подытоги по дименшну sex - мы получим в итоговом ответе сервера декартово произведение без поля sex, но с двумя дополнительными полями, отражающих подытог по каждому из двух существующих меж (т.е. в аггрегации не будет разбивки по указанным в подытогах дименшнам).

Observable service (ОС, далее “сервис”) - инстанс класа, являющегося наследником базового класса BaseService, который реализует паттерн Observer. Наблюдаемым объектом выступает модель такого сервиса, являющаяся аналогом простого js-объекта. Методы базового класса позволяют осуществлять подписку разных React-компонентов на изменения модели сервиса и менять ее встроенными методами (влияя на state React-компонента-подписчика через callback-функцию). Выступает как архитектурное решение, позволяющее синхронизировать множество компонентов, создавать кастомные события, их эммитеры и обработчики, экономить запросы на сервер за данными, хранить фильтры и многое другое.

Ресурс - в общем случае произвольный файл, находящийся в разделе resources атласа (то есть запись в таблицах вида схема_нейм_атласа.resources).
Чаще всего в данном руководстве под этим будем подразумевать компонент React (уже собранный webpack в виде пары .js, .js.map) или модули и стили, которые он импортирует.

bi-magic-resources (luxmsbi-web-resources) (BMR, “веб-ресорсес”) – специализированный публичный проект на Github (https://github.com/luxms/bi-magic-resources), созданный для более комфортной разработки и кастомизации фронтенда Luxms BI командами наших клиентов. Способен управлять ресурсами и конфигурациями всех атласов, дешбордов и дешлетов

Ресурсы - раздел resources текущего атласа(ов) со всеми его файлами. Или даже все ресурсы во всех атласах разом (тогда речь идет о компонентах и файлах, которыми вы управляете в проекте BMR)