Базовые настройки

Компоненты Аналитического портала

Modus Аналитический портал (АП) является веб-приложением и состоит из трёх частей (см. Рисунок 1):

• Сервера (Backend) – основное приложение, выполняющее роль веб-сервера, взаимодействующего с источниками данных и выполняющего пользовательские команды;
• Клиента (Frontend) – средство отображения интерфейсов приложения в браузере;
• Данные и метаданные – расположенные в БД Аналитического портала необходимые для работы данные, содержащие настройки, команды, списки сущностей для работы приложения.

Рисунок 1. Схема компонентов аналитического портала

Схема взаимодействия портала с хранилищем данных и компонентов аналитического портала для отображения аналитических панелей (дашбордов) в веб интерфейсе – см. Рисунок 2.

Рисунок 2. Схема взаимодействия аналитического портала с внешними источниками данных и компонентов портала между собой

Хранилище – база данных, в которой хранятся подготовленные для анализа и визуализации данные.

Набор данных – SQL-запрос к таблицам БД хранилища и описание полей набора данных - наименований, псевдонимов/алиасов, типов данных, иерархий и других свойств.

Конструктор аналитических панелей – предназначен для настройки аналитических панелей (дашбордов).

Дашборды отображаются в веб-браузере и визуализируют данные в форме, удобной для восприятия и анализа.

База данных Аналитического портала

База данных Аналитического портала содержит данные для работы программного продукта – настройки, команды, описание API, а также данные о пользователях, дашбордах и т.д.

До версии Аналитического портала 3.0 использовалась встраиваемая СУБД – SQLite.

Начиная с версии 3.0 база данных портала работает под управлением СУБД PostgreSQL (версии не ниже 10) и требует предварительной установки и настройки администратором.

Для установки и настройки СУБД PostgreSQL обратитесь к официальному руководству:

• https://www.postgresql.org/download/
• https://www.postgresql.org/docs/10/runtime-config.html

Если СУБД PostgreSQL устанавливается впервые и будет использоваться без дополнительного ПО – пуллеров соединений (PgBouncer, Pgpool-II и т.д.), то для корректной работы с Аналитическим порталом в файле конфигурации PostgreSQL необходимо правильно сконфигурировать следующий параметр:

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

Действия по подключению Аналитического портала к Базе данных портала описаны далее.

Настройка системы «Modus Аналитический портал»

Предварительная настройка портала

Файл modusbi.json позволяет запустить портал с предварительными настройками. При этом настройки из файла никуда не сохраняются и не записываются, то есть он нужен только для запуска.

Для подключения к базе данных портала необходимо в файле modusbi.json настроить параметры подключения к СУБД PostgreSQL. Для этого в разделе «metadata» следует указать следующие настройки:

{
  ...
  "metadata": {
    "driver": "postgres",
    "datasource": "postgres://\<ПОЛЬЗОВАТЕЛЬ\_БД\>:\<ПАРОЛЬ\_БД\>@\<IP-АДРЕС\_PG\>:\<ПОРТ\_PG\>/\<ИМЯ\_БД\>?application\_name=modusbi&sslmode=disable",
    "maxopenconns": \<максимальное количество одновременно открытых соединений, не больше значения max\_connections в PostgreSQL\>,
    "maxidleconns" : \<максимальное количество открытых (ожидающих) соединений в пуле\>,
    "maxlifetime": \<максимальное время жизни соединения в пуле, секунды\>
  }
  ...
}

Пример. Аналитический портал и СУБД PostgreSQL установлены на одном сервере, PostgreSQL слушает стандартный порт 5432, при этом для подключения используется логин admin, пароль pass, а имя базы данных для портала – modusbi. Тогда раздел «metadata» файла настроек может быть следующим:

{
  ...
  "metadata": {
    "driver": "postgres",
    "datasource": "postgres://admin:pass@localhost:5432/modusbi?application\_name=modusbi&sslmode=disable",
    "maxopenconns": 100,
    "maxidleconns" : 20,
    "maxlifetime": 3600
    }
  ...
}

После запуска портала, в случае необходимости, дальнейшие настройки необходимо осуществлять на странице настроек портала.

Пример. Аналитический портал установлен на сервер-1. Пользователь хочет зайти на портал c сервера-2.

Для этого необходимо:

• Настроить Аналитический портал

  Адрес сервера: 0.0.0.0

  Порт: 5000

  Протокол сервера данных: HTTP

  Адрес сервера данных: IP адрес сервера-1

  Порт сервера данных: 5000

• Открыть на сервере-2 браузер и перейти по адресу:

  IP адрес сервера-1:5000

Для быстрой настройки надо изменить файл modusbi.json, как показано ниже, и запустить портал на сервер-1. Затем на сервер-2 в браузере открыть требуемую ссылку.

Содержимое файла (подробнее о настройках):

{
  "server": {
    "host": "0.0.0.0",
    "port": 5000
  },
  "backend": {
    "protocol": "http",
    "host": "IP адрессервера-1",
    "port": 5000,
    "base\_url": "/v1/api/"
  },
  "frontend": {
    "base\_url": "/"
  },
  "form": {
    "base\_url": "/fvd"
  }
}

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

В СУБД PostgreSQL должна быть создана пустая база данных с любой основной схемой (по умолчанию – это public).

Для инициализации базы метаданных Аналитического портала необходимо сконфигурировать файл modusbi.json. Затем запустить исполняемый файл modusbi с флагом командной строки “-init”. Если всё настроено верно, в файле лога modusbi.log появится соответствующее сообщение: созданы метаданные в ‘<БД PostgreSQL>’, необходимо перезапустить сервер.

Запуск исполняемого файла

Далее нужно запустить исполняемый файл modusbi.

Для корректной работы Аналитического портала необходимо, чтобы у пользователя, который выполняет запуск исполняемого файла, были права на чтение, изменение, удаление папок и файлов в папке, содержащей файл «modusbi».

Во время выполнения файла откроется консоль сервера. До окончания установки консоль сервера закрывать нельзя.

После изменения настроек исполняемый файл нужно перезапускать. Для этого нужно закрыть консоль modusbi и запустить файл заново.

Технические настройки для работы «Modus Аналитический портал»

Адрес «http://localhost:5000/». Логин admin, пароль admin.

В режиме Администрирования перейдите к разделу «Настройки портала» (Рисунок 3, 1 ).

Описание группы настроек портала - см. Рисунок 3 , 2 и Таблицу 1 - ниже.

Рисунок 3. Настройки портала

Таблица 1. Описание настроек портала

Внесите изменения в настройки и сохраните их по кнопке [Сохранить настройки] - см. Рисунок 3, 3.

Для применения настроек воспользуйтесь кнопкой [Перезагрузка] в правом верхнем углу окна настроек - см. Рисунок 3, 4.