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

Чтобы выбрать раздел, нажмите на кнопку 1.
Для выхода из профиля нажмите на кнопку 2.

Раздел предназначен для централизованного управления учетными записями пользователей и их правами доступа в системе.

На странице отображается список пользователей (1) и их роли (2).

Чтобы добавить пользователя, нажмите на кнопку 3.
Для удаления пользователя нажмите на иконку корзины рядом с ним (4).

После нажатия на иконку корзины появится окно подтверждения или отмены действия удаления.

Нажав на кнопку «Добавить пользователя», появится окно регистрации.

Для создания новой учетной записи пользователя введите в поле 1 имя пользователя, в поле 2 введите пароль и нажмите на кнопку «Добавить пользователя» (3).
Чтобы добавить учетную запись Active Directory, введите логин аккаунта Active Directory в поле 4 и нажмите на кнопку «Добавить УЗ из Active Directory» (5).
Для выхода из окна регистрации нажмите на крестик (6).

Предусмотрено 2 роли: «Администратор» и «Пользователь».
Пользователю с ролью «Администратор» доступны разделы: «Администрирование», «Источники», «Контент».
Пользователю с ролью «Пользователь» доступен только раздел «Контент».

Чтобы изменить роль пользователя, нажмите на кнопку его роли (1).

Появится выбор ролей:

Выберите нужную роль и снова нажмите на общую кнопку роли (1) для сохранения выбора.

Раздел предназначен для управления источниками данных.

Инструмент поддерживает функционал генерации документации для баз данных (DWH) и BI-систем (BI).

«DWH» – автоматизация создания документации базы данных. Поддерживаются следующие СУБД: MSSQL, PostgreSQL, ClickHouse, GreenPlum.
«BI» – документирование отчетов и дашбордов. Доступны следующие BI-платформы: AW BI, Apache Superset, Power BI.

На странице отображается два блока: список источников данных – слева (1), настройки подключения выбранного источника – справа (2).

Для добавления источника данных нажмите на кнопку «Добавить источник» (1).

Внизу списка источников появится новая строка (2).

Чтобы настроить новый источник данных, выберите его (3), а затем нажмите на кнопку «Изменить» в правом верхнем углу блока настройки подключения выбранного источника (4).

Заполните все необходимые поля (5), выберите Тип СУБД (6) и сохраните, нажав на кнопку «Применить» (7).

Таким же способом вы можете изменять настройки уже существующих источников данных в вашем списке источников.

Чтобы удалить источник данных, выберите его в списке источников (1) и нажмите на кнопку «Удалить источник» (2).

Появится окно подтверждения или отмены действия удаления.

Раздел обеспечивает легкую навигацию по описанным базам данных и BI-системам, что позволяет пользователям быстро находить необходимую информацию, изучать назначения объектов, общаться с умным ассистентом с целью углубленного анализа и поиска информации.

В левой части раздела расположена панель навигации

Вверху панели находится «Поиск» (1) – он ускоряет процесс нахождения нужной информации (таблицы, функции, отчета, показателя, описания и т.д.).

По умолчанию выбрана документация баз данных «DWH», с возможностью перейти в раздел «BI» (2).

После выбора источника данных (1), раскрывается детальная панель навигации по выбранной базе (2).

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

Для работы с описанием есть следующие инструменты: «Обновить описание» (3), «Изменить» (4), «Экспорт» (5), «Принять» (6).

Кнопка «Обновить описание» позволяет обновить описание конкретного объекта, если в базе данных в нем были какие-либо изменения.
Кнопка «Изменить» позволяет изменить описание вручную, если ИИ неправильно распознал бизнес-контекст.
Кнопка «Экспорт» позволяет экспортировать документацию в формате PDF.
Кнопка «Принять» – это статусная кнопка, нажатие которой даст понять ИИ, что описание объекта прочитано и корректно на взгляд пользователя. А после изменений вручную она даст ИИ дополнительный контекст для последующего описания. Обязательно ее используйте, чтобы ИИ обучался и совершенствовался, и улучшалось качество описаний.

Описание каждой таблицы включает в себя информацию: описание таблицы (1) и описание полей в виде таблицы(2).

Описание каждой процедуры включает в себя информацию: общее назначение процедуры (3), автор процедуры (4), дата создания процедуры (5), целевая таблица, в которой процедура выполняет изменение данных (6), входные параметры (7), логика по шагам (8), пример вызова процедуры (9), SQL-вид процедуры (10).

Описание каждой функции включает в себя информацию: общее назначение функции (11), автор функции (12), дата создания функции (13), целевая таблица, в которой функция выполняет изменение данных (14), входные параметры (15), пример запроса к функции (16), SQL-вид функции (17).

Описание каждого представления включает в себя информацию: описание представления (18), автор представления (19), дата создания представления (20), SQL-вид представления (21), исходные таблицы представления (22), полученные поля и их описание (23), пример запроса к представлению (24).

Если в базу данных были добавлены новые метаданные (например, таблица) нажмите на кнопку «Обновить метаданные» (1), чтобы она отобразилась в детальной панели навигации.

Найдите и выберите ее в списке таблиц (2). В правой части раздела откроется окно с пустым описанием (3).

Чтобы ИИ сгенерировал описание для новой таблицы, нажмите на кнопку «Обновить описание» (4).

Описание готово!

После выбора источника данных (1), раскрывается детальная панель навигации по выбранной BI-системе. Она состоит из корневой папки, которая имеет древовидную структуру в том виде, в котором она представлена в вашей BI-системе (2), и из реестра показателей, который сгенерирован и классифицирован по группам с помощью ИИ (3).

При выборе конкретного отчета из корневой папки, в правой части раздела открывается его описание, сгенерированное ИИ.

Для работы с описанием есть следующие инструменты: «Изменить» (1), «Экспорт» (2), «Принять» (3).

Кнопка «Изменить» позволяет изменить описание вручную, если ИИ неправильно распознал бизнес-контекст.
Кнопка «Экспорт» позволяет экспортировать документацию в формате PDF.
Кнопка «Принять» – это статусная кнопка, нажатие которой даст понять ИИ, что описание объекта прочитано и корректно на взгляд пользователя. А после изменений вручную она даст ИИ дополнительный контекст для последующего описания. Обязательно ее используйте, чтобы ИИ обучался и совершенствовался, и улучшалось качество описаний.

Названия отчетов кликабельны. При нажатии откроется исходный отчет в новой вкладке.

Описание каждого отчета включает в себя информацию: описание назначения отчета, рекомендации по его интерпретации, основные инсайты (4), источники отчета (5), вкладки из отчета (6).

Каждая вкладка из отчета включает в себя: графическую часть отчета (7), описание назначения вкладки, рекомендации по интерпретации, основные инсайты (8), использующиеся фильтры (9), карточки с описанием диаграмм (10).

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

При выборе конкретной группы показателей, в правой части раздела открывается окно с информацией: в каких отчетах используется эта группа (1) и список показателей, объединенных в эту группу (2).

В каких отчетах используется конкретный показатель из списка можно увидеть, нажав на него (3).

Названия отчетов кликабельны. Можно быстро перейти в необходимый отчет как внутри инструмента автоматической генерации документации (4), так и в исходный отчет на внешних платформах (5).

В правом нижнем углу расположен Ассистент AI – это чат с ИИ, в котором можно узнать информацию об источнике: о чем источник, где хранятся продажи, как правильно написать запрос для получения средней выручки за прошлый год и т.д.

Ассистент AI генерирует свой ответ либо по указанному источнику данных (если источник выбран), либо по всем источникам (если источник не выбран).

Пример запроса и ответа без выбора источника данных:

Ассистент AI запоминает контекст диалога и учитывает при следующем ответе. История чата хранится до тех пор, пока пользователь не выйдет из своей учетной записи.