Сетевые настройки Аналитического портала
4 минутное чтение
В этом разделе отдельно перечислены настройки, используемые для взаимодействия клиента и сервера Аналитического портала.
Сетевые настройки портала устанавливаются в WEB-клиенте аналитического портала или в файле настроек «modusbi.json», находящегося в каталоге исполняемого файла аналитического портала.
Настройки в файле редактируются вручную. Изменения сделанные в WEB-клиенте не изменяют файл настроек.
Часть настроек доступных из WEB-клиента дублируется настройками из файла. Настройки из файла имеют более высокий приоритет, список смежных настроек приведён ниже.
Если есть необходимость настраивать смежные настройки из WEB-клиента, настройку из файла необходимо убрать (как значение, так и само свойство).
Структура URL
После загрузки клиентской части Аналитического портала в память браузера по первоначальной ссылке, клиент отправляет запросы на сервер, генерируя URL на основании настроек:
- «Протокол»:
- «Протокол сервера данных»;
- «Доменная часть»:
- «Адрес сервера данных»;
- «Порт сервера данных»;
- «Путь на сервере»:
- «Корневой каталог приложения на сервере» — имя службы, если доменное имя маскирует несколько служб или «/» если доменное имя представляет только Аналитический портал;
- «Путь к API данных» — путь относительно корневого каталога, где опубликован API сервера портала, по умолчанию «/v1/api/»;
- «Корневой каталог приложения Форм Ввода Данных» — путь к подразделу форм ввода данных относительно пути к API. По умолчанию «/fvd».
Настройки из WEB-клиента
| Пункт настройки | Описание |
|---|---|
| Адрес сервера | Строка, содержащая сетевой адрес, по которому сервер(Backend) будет принимать клиентские подключения. Запись 0.0.0.0 позволяет задействовать все адреса IPv4. По умолчанию равно «localhost» |
| Порт | Строка, содержащая TCP-порт, открываемый сервером(Backend) Аналитического портала. По умолчанию равно «5000». |
| Корневой каталог приложения на сервере | Строка, содержащая путь к публикации Аналитического портала относительно домена компании. По умолчанию равно «/». Пример 1: Доменное имя, используемое для сайтов компании в www.mysite.com. Значение параметра равно «/». Аналитический портал доступен по адресу http://www.mysite.com/. Пример 2: Доменное имя, используемое для сайтов компании в www.mysite.com. Значение параметра равно «/bi-portal». Аналитический портал доступен по адресу http://www.mysite.com/bi-portal/ |
| Протокол сервера данных | Строка, содержащая наименование протокола, который будет использовать Аналитический портал. По умолчанию равно «HTTP». Допустимые значения: «HTTP», «HTTPS». |
| Адрес сервера данных | Строка, содержащая сетевой адрес для обращений клиентского приложения (Frontend) к серверу (Backend) Аналитического портала |
| Порт сервера данных | Строка, содержащая порт, по которому будут выполняться обращения клиентского приложения (Frontend) к серверу (Backend) Аналитического портала. По умолчанию равно «5000». |
| Путь к API данных | Пути в URL, используемое для доступа к API аналитического портала. По умолчанию равно «/v1/api/». |
| Корневой каталог приложения Форм Ввода Данных |
Путь в URL для доступа к ресурсам Форм Ввода Данных аналитического портала. По умолчанию равно «/fvd». |
| Ключ SSL | Настройка позволяющая выбрать файл закрытого ключа для TLS. Используется только при значении настройки «protocol» равной «HTTPS». |
| Сертификат SSL | Настройка позволяющая выбрать файл сертификата для TLS. Используется только при значении настройки «protocol» равной «HTTPS». |
Файл настроек modusbi.json
Файл настроек «modusbi.json» находится в каталоге размещения исполняемого файла аналитического портала.
{
"metadata": {
...
"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"
},
...
}
, где
| Настройка | Тип 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». |
$.backend.base_url |
Строка | Пути в URL, используемое для доступа к API аналитического портала. По умолчанию равно «/v1/api/». |
$.form.base_url |
Строка | Путь в URL для доступа к ресурсам Форм Ввода Данных аналитического портала. По умолчанию равно «/fvd». |
$.frontend.base_url |
Строка | Строка, содержащая путь к публикации Аналитического портала относительно домена компании. По умолчанию равно «/». Пример 1: Доменное имя, используемое для сайтов компании в www.mysite.com. Значение параметра равно «/». Аналитический портал доступен по адресу http://www.mysite.com. Пример 2: Доменное имя, используемое для сайтов компании в www.mysite.com. Значение параметра равно «/bi-portal». Аналитический портал доступен по адресу http://www.mysite.com/bi-portal/ |
Соответствие сетевых настроек 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 |
Примечание: Настройки в файле имеют приоритет перед аналогичными настройками в WEB-клиенте. Если необходимо иметь возможность выполнять некоторые настройки из WEB-клиента, аналогичную настройку из файла необходимо убрать (как значение, так и само свойство).