BI-интеграции

Интеграция публикует таблицы и метрики вашей модели в BI-инструмент. Тогда графики в нём строятся по тем же определениям, что и ответы в чате. Интеграции настраиваются на вкладке «Подключения → Интеграции».

BI-инструмент читает данные через ClickHouse-шлюз Дефиники, поэтому шлюзу нужен публичный адрес. Если вы видите «У ClickHouse-шлюза нет публичного URL», интеграции не к чему подключаться: попросите команду Дефиники, обслуживающую вашу установку, задать адрес шлюза.

Добавить интеграцию

1. Нажмите «Добавить интеграцию».

2. Выберите «Тип»: Superset, DataLens или Metabase. Тип интеграции нельзя изменить после создания.

3. Задайте «Название», например «Superset (прод)», и адрес инструмента — тот, по которому сервер Дефиники обращается к нему.

4. Укажите учётные данные. Что нужно для каждого инструмента:

   Инструмент	Учётные данные
   Superset	«Имя пользователя» и «Пароль» пользователя Superset, который может создавать базы данных и наборы данных.
   DataLens	Пользователь DataLens с ролью datalens.editor. «ID воркбука» — из адреса воркбука; если оставить поле пустым, воркбук создаётся при первой синхронизации.
   Metabase	«API-ключ» группы Administrators (Admin settings → Authentication → API keys) и его «Название API-ключа», как его показывает Metabase.

   Логин хранится в зашифрованном виде и больше не показывается.

5. Решите, как интеграция следует за моделью (см. ниже), и сохраните.

6. Нажмите «Проверить», затем «Синхронизировать».

DataLens доступен, если он включён в вашей установке.

Какая версия модели опубликована

• «Следовать за последней развёрнутой моделью» включено — каждое развёртывание модели обновляет инструмент автоматически. В списке такая интеграция подписана «Следует за последним деплоем».
• Выключено — инструмент остаётся на одной версии, например «Закреплена на v12». Так графики не поменяются неожиданно после правки модели. Когда будете готовы, нажмите «Опубликовать текущую версию»: интеграция перейдёт на развёрнутую версию и синхронизируется.

«Синхронизировать» публикует текущую версию интеграции ещё раз — например, если в инструменте что-то удалили вручную. Под интеграцией видно, когда прошла последняя синхронизация и что она сделала: сколько наборов данных создано, обновлено и удалено.

Сервисный аккаунт интеграции

Интеграция сама создаёт сервисный аккаунт для доступа к шлюзу. В списке сервисных аккаунтов он подписан «Управляется интеграцией …»: его роль, статус и токены меняются только через интеграцию. Чтобы ограничить, какие данные видит BI-инструмент, выдайте этому аккаунту доступы: Сервисные аккаунты.

Удалить интеграцию

При удалении Дефиника перестанет публиковать данные в инструмент, а логин интеграции в шлюзе будет отозван, и графики на её базе данных перестанут работать. Созданные в инструменте объекты (база данных и наборы данных в Superset, подключение и датасеты в DataLens, коллекция и карточки в Metabase) останутся — удалите их там, если они больше не нужны.