Настройки конфигурации Аналитического портала - Продукт Modus BI
- Изменение базовых настроек портала выполняются из WEB-клиента аналитического портала и в файле настроек «modusbi.json», расположенного в каталоге исполняемого файла аналитического портала.
- Настройки Аналитического портала, редактируемые из WEB-клиента сохраняются и считываются в базе метаданных.
- Настройки в файле редактируются вручную, изменения в WEB-клиенте не изменяют файл настроек.
- Часть настроек доступных из WEB-клиента дублируется настройками из файла. Настройки из файла имеют более высокий приоритет. Список смежных настроек приведён ниже.
- Если есть необходимость настраивать смежные настройки из WEB-клиента, настройку из файла необходимо убрать (как значение, так и само свойство).
Настройки из WEB-клиента
Используя WEB-клиент, перейдите в меню «Администрирование» и выберите раздел «Настройки портала»:
Откроется окно с настройками. Описание настройки представлено в таблице.
Доступные из WEB-клиента настройки:
— позволяет загрузить файл обновления Frontend. Нужно выбрать файл в диалоге и указать под каким именем будет загружен дистрибутив. Под указанным именем в дальнейшем дистрибутив будет доступен для выбора в выпадающем списке настроек «Версия Frontend портала».
— позволяет загрузить файл обновления. Нужно выбрать файл в диалоге.
— позволяет загрузить лицензии для обновления лицензии портала. Файл лицензии содержит настройки и лицензионные ограничения для конкретной реализации портала по количеству пользователей, сроку работы, доступности функционала отдельных модулей (формы ввода данных, RLS, коррекции данных и т.д.).
— кнопка смены мастер-паролей позволяет заменить пароли к встроенным учетным записям. Новые пароли будут записаны в файлы developer.secret и system.secret в каталоге где размещён исполняемый файл портала.
Пункт настройки | Описание |
---|---|
Адрес сервера | Строка, содержащая сетевой адрес, по которому сервер (Backend) будет принимать клиентские подключения. Запись 0.0.0.0 позволяет задействовать все адреса IPv4. По умолчанию равно «localhost» |
Порт | Строка, содержащая TCP-порт, открываемый сервером (Backend) Аналитического портала. По умолчанию равно «5000» |
Корневой каталог приложения на сервере |
Строка, содержащая путь к публикации Аналитического портала относительно домена компании. |
Наименование (заголовок окна) | Заголовок окна для пользователя |
Версия Frontend портала | Версия Frontend портала. В списке отображаются доступные для настройки версии. По умолчанию устанавливается максимально доступная версия FE-портала |
Источник дат обновления | Настройка / подключение информации по датам обновления источников данных, отображаемая в описании отчета. Для настройки источника необходимо подключить источник с необходимой информацией (например, таблица). Связать поля фильтр и значения, где фильтр — поле с наименованием источника данных, значение — дата последнего обновления данных в источнике. По умолчанию источник не указан |
Протокол сервера данных | Строка, содержащая наименование протокола, который будет использовать Аналитический портал. По умолчанию равно «HTTP». Допустимые значения: «HTTP», «HTTPS» |
Адрес сервера данных | Строка, содержащая сетевой адрес для обращений клиентского приложения (Frontend) к серверу (Backend) Аналитического портала |
Порт сервера данных | Строка, содержащая порт, по которому будут выполняться обращения клиентского приложения (Frontend) к серверу (Backend) Аналитического портала. По умолчанию равно «5000» |
Путь к API данных | Путь в URL, используемый для доступа к API аналитического портала. По умолчанию равно «/v1/api/» |
Ключ SSL | Настройка, позволяющая выбрать файл закрытого ключа для TLS. Используется только при значении настройки «protocol» равной «HTTPS» |
Сертификат SSL | Настройка, позволяющая выбрать файл сертификата для TLS. Используется только при значении настройки «protocol» равной «HTTPS» |
Заголовок сервисного режима | Строка заголовка для информационного сообщения портала во время сервисного режима. По умолчанию «Сервис временно недоступен» |
Сообщение сервисного режима | Строка для информационного сообщения пользователям портала во время сервисного режима. По умолчанию «Портал находится на сервисном обслуживании. Попробуйте обновить страницу через некоторое время» |
Заголовок при недоступности сервиса | Строка заголовка для информационного сообщения портала во время сервисного режима. По умолчанию «Сервис недоступен» |
Сообщение при недоступности сервиса | Строка для информационного сообщения пользователям портала во время сервисного режима. По умолчанию «Портал недоступен. Попробуйте зайти позже» |
Максимальное число получаемых записей данных | Число, использующееся по умолчанию для ограничения количества строк набора данных при отображении в отчете. Ограничение количества строк устанавливается для сокращения времени отображения отчетов на портале. При необходимости это число можно увеличить или уменьшить. По умолчанию 5000 |
Шаблон Excel по умолчанию | Настраиваемый общий шаблон для выгрузки данных с портала в Excel |
Максимальный размер загружаемого файла Excel | Число в мегабайтах — максимальный размер для загружаемых на портал файлов с данными |
Корневой каталог приложения Форм Ввода Данных |
Путь в URL для доступа к ресурсам Форм Ввода Данных аналитического портала. По умолчанию равно «/fvd» |
Фасеты Источник таблиц Источник полей Источник значений |
«Фасеты» содержат статистику по полям таблиц хранилища данных. Возможно указать имена таблиц, полей и значений, по которым будет работать интерфейс «Администрирование» / «Фасеты». Обычно таблицы фасетов создаются, заполняются и обновляются при использовании соответствующего функционала Modus ETL |
Мультиязычность | Настройка, позволяющая включить или выключить режим «Мультиязычность». По умолчанию «Выкл.» |
Пользователь для автоматической аутентификации | Настройка позволяет выбрать профиль пользователя для входа при автоматической аутентификации |
Токен Yandex TilesApi | Строка для ввода API-токена для получения изображений подложки Яндекс Карт |
Токен 2Gis TilesApi | Строка для ввода API-токена для получения изображений подложки карт 2Gis |
Управление геоданными | Настройка, которая позволяет добавить новый тип геоданных или редактировать существующие типы. Для настройки геоданных необходимо загрузить файл с геоданными |
Файл настроек modusbi.json
Файл настроек «modusbi.json» находится в каталоге размещения исполняемого файла аналитического портала.
{
"metadata": {
"driver": "postgres",
"datasource": "postgres://pg_user:pg_passw@pg_server:5432/BASE_NAME?application_name=modusbi&sslmode=disable",
"maxopenconns": 100,
"maxidleconns" : 20,
"maxlifetime": 3600
},
"server": {
"host": "192.168.0.1",
"port": 3000,
"debug": "enabled"
},
"backend": {
"protocol": "http",
"host": "192.168.0.1",
"port": 3000,
"base_url": "/v1/api/"
},
"frontend": {
"base_url": "/"
},
"form": {
"base_url": "/fvd"
},
"update": {
"path": "update"
},
"backup": {
"path": "backup"
},
"Databases": {
"Vertica" : {
"InMemoryResultRowLimit": 1000
}
},
"CollLogger": "enabled",
"auth": {
"log": {
"to_file": true,
"to_metadata": false
}
}
}
где:
Настройка | Тип json | Описание |
---|---|---|
$.server.host |
Строка | Сетевой адрес, по которому сервер (Backend) будет принимать клиентские подключения. Запись 0.0.0.0 позволяет задействовать все адреса IPv4. По умолчанию равно «localhost». |
$.server.port |
Число | TCP-порт, открываемый сервером (Backend) Аналитического портала. По умолчанию равно «5000». |
$.backend.host |
Строка | Сетевой адрес для обращений клиентского приложения (Frontend) к серверу (Backend) Аналитического портала. |
$.backend.port |
Число | Порт, по которому будут выполняться обращения клиентского приложения (Frontend) к серверу (Backend) Аналитического портала. По умолчанию равно «5000». |
$.backend.protocol |
Строка | Наименование протокола, который будет использовать Аналитический портал. По умолчанию равно «http». Допустимые значения: «http», «https». |
$.metadata.driver |
Строка | Имя драйвера СУБД , где размещена база данных аналитического портала. Всегда «postgres». |
$.metadata.datasource |
Строка | Параметры подключения к базе данных СУБД, где размещена база данных аналитического портала. За подробностями обратитесь к разделу База данных. |
$.metadata.maxidleconns |
Число | Максимальное количество открытых (ожидающих) соединений (в пуле) к базе данных СУБД, где размещена база данных аналитического портала. |
$.metadata.maxlifetime |
Число | Максимальное время жизни соединения (в пуле), к базе данных СУБД, где размещена база данных аналитического портала. Указывается в секундах. |
$.metadata.maxopenconns |
Число | Максимальное количество одновременно открытых соединений к базе данных СУБД, где размещена база данных аналитического портала. Не должно быть больше значения max_connections в настройках СУБД PostgreSQL. |
$.backend.base_url |
Строка | Пути в URL, используемое для доступа к API аналитического портала. По умолчанию равно «/v1/api/». |
$.form.base_url |
Строка | Путь в URL для доступа к ресурсам Форм Ввода Данных аналитического портала. По умолчанию равно «/fvd». |
$.frontend.base_url |
Строка | Строка, содержащая путь к публикации Аналитического портала относительно домена компании. По умолчанию равно «/». Пример 1: Доменное имя, используемое для сайтов компании в www.mysite.com. Значение параметра равно «/». Аналитический портал доступен по адресу www.mysite.com. Пример 2: Доменное имя, используемое для сайтов компании в www.mysite.com. Значение параметра равно «/bi-portal». Аналитический портал доступен по адресу http://www.mysite.com/bi-portal/. |
$.server.debug |
Строка | Строка, содержащая указания к включению или выключению режима отладки. |
$.update.path |
Строка | Строка, содержащая путь к файлам обновления. |
$.backup.path |
Строка | Строка, содержащая путь к файлам резервных копий. |
$.auth.log.to_file |
Булево | Флаг используемый для указания, нужно ли писать в файл лог аутентификации, отдельно от основного лога. |
$.auth.log.to_metadata |
Булево | Флаг используемый для указания, нужно ли писать в базу данных Аналитического портала лог аутентификации, отдельно от основного лога. |
$.Databases.Vertica.InMemoryResultRowLimit |
Число | Параметр ограничивающий количество строк под которое отводится память на серверах источников данных вида СУБД Vertica, при обращении к ним со стороны Аналитического портала. |
Шифрование файла modusbi.json
Для шифрования определенных значений в конфигурационных файлах используется специальная утилита encryption-settings.
Шифровать имеет смысл файлы с доступными для редактирования вручную настройками. Например, файл конфигурации Аналитического портала — “modusbi.json”.
- Для определения необходимых полей файла конфигурации создайте файл с расширением
*.jsonpath
и укажите поля для шифрования.{ "secrets": [ "$.metadata.datasource" ] }
- Генерация ключей.
Запустите утилиту с параметром для генерации ключей, выполнив команду:
<утилита> -g
После выполнения ключи создаются в текущем каталоге:
public_key.pem
— публичный ключ;private_key.pem
— приватный ключ.
- Шифрование настроек.
После того, как ключи сгенерированы, можно перейти к процессу шифрования конфигурационных файлов. Для этого выполните команду:
<утилита> -e -settings <путь к файлу конфигурации> -key <путь к файлу с публичным ключом> -fields <путь к файлу со списком полей для шифрования>
При этом:
<путь к файлу конфигурации>
– укажите путь к файлу, который нужно зашифровать (например,settings.json
);<путь к файлу с публичным ключом>
– укажите путь к файлу с публичным ключом, который был сгенерирован;<путь к файлу со списком полей для шифрования>
– укажите путь к вашему файлу*.jsonpath
.
После шифрования указанные поля будут иметь вид:
"metadata": { "datasource": { "encrypted": true, "value": "XUN8ygFGdRl4FtWiVDhD+ZELfPkHY+EjpDkWEDtjItzTOdGqpCFP36irQiHCDPy2a/a4MdzN9yTlDBBRntRmQG3Pg6P3y5wJMGarQC9pfu8LALp8x+HQgh5ggAffZZNKfRofoqYES9YnFuiB9kPk31BkMAAU4WLNV+NZYpFx8ZYbuaYF0AAOvf/FYOHzr/Qh4109xITCEAODS5ph0cRWQRoQI/jScGn/TrM6XfzjTw+joC38uKG/zQMwAfZBQ/qSz8Aa5ybEIlNcSOuKf6AdoivaTtPepkweF2F/8csgXdAjC1iNySsDMeOyKg7OlackN0kXQGDKXW/3VNA8iKf7ufSBB/eD" }
После выполнения в файле конфигурации зашифровываются указанные поля.
- При шифровании оригинальный файл будет изменен, поэтому рекомендуется создать его незашифрованную копию перед началом процесса.
- Убедитесь, что приватный ключ и файл с зашифрованными настройками находятся рядом с исполняемым файлом Аналитического портала или Агента ETL.
Соответствие настроек WEB-клиента и файла настроек
Некоторые настройки можно редактировать как в интерфейсе WEB-клиента так и в файле настроек «modusbi.json»:
WEB-клиент | Файл настроек |
---|---|
Адрес сервера | $.server.host |
Порт | $.server.port |
Адрес сервера данных | $.backend.host |
Порт сервера данных | $.backend.port |
Протокол сервера данных | $.backend.protocol |
Корневой каталог приложения Форм Ввода Данных | $.form.base_url |
Корневой каталог приложения на сервере | $.frontend.base_url |
Путь к API данных | $.backend.base_url |