Файл конфигурации расположен в /etc/polymatica/polymatica.conf.

Значения параметров, указанные на этой странице через знак равенства после наименования каждого параметра, являются значениями по умолчанию, если прямо не прописано иное. Если у параметра нет значения по умолчанию, описание параметра содержит прямое указание на это («значение по умолчанию не задано»). Для параметров типа «Опция» указываются состояния по умолчанию («по умолчанию параметр указан»/«по умолчанию параметр отсутствует»).

Настройки кластера

Подробная информация о работе кластера приводится в разделе «Кластер».

Адрес подключения для Slave к Master; значение по умолчанию не задано:

plm.cluster.master.address

Порт подключения для Slave к Master; значение по умолчанию не задано:

plm.cluster.master.port = 8080

Включить режим работы в одной директории репозитория (для Master и Slave); значение по умолчанию — False:

plm.cluster.one_repo_mode = True

Разрешить Master создавать дочерние серверы*:

plm.cluster.master.enable_servers

*Для режима работы на одном узле является обязательным параметром, установленным по умолчанию. Для кластерного режима при наличии параметра Master используется как расчетный узел, а при отсутствии этого параметра Master не запускает у себя расчетные серверы (Workers), а лишь осуществляет передачу команд к наиболее свободным менеджерам. Также на нем запускается основной процесс импорта данных из источника.

Время ожидания запроса на ping в секундах (для Slave):

plm.cluster.ping_timeout = 20

Настройки логгеров

Подробная информация о логировании приводится в разделе «Логирование».

Настройка полноты логирования запросов; значение по умолчанию не задано:

plm.log.query_filter

Значение	Описание	Заменяет
full	Печатать в лог адреса и тела для входящих запросов и ответов на них	Отсутствие «plm.log.filter_out_queries» в файле конфигурации
url	Печатать в лог только адреса для входящих запросов и ответов на них	-
nothing	Не печатать в лог ничего для входящих запросов и ответов на них	plm.log.filter_out_queries

Старый параметр, отвечавший за полноту логирования запросов; по умолчанию параметр отсутствует:

plm.log.filter_out_queries

Поддержка старого параметра «plm.log.filter_out_queries», ограничивающего логирование запросов, осуществляется для обеспечения обратной совместимости. Рекомендуется использовать новый параметр «plm.log.query_filter». Если задан параметр «plm.log.filter_out_queries», то поведение параметра «plm.log.query_filter» соответствует значению nothing. Если не задан ни один из двух указанных параметров, логирование будет выполняться в соответствии со значением full.

Лог системных событий

Включить логирование; по умолчанию параметр отсутствует:

plm.log.main.enabled

Уровень логирования:

plm.log.main.loglvl = 3

Разбивать содержимое файла логгера main на отдельные файлы по модулям; по умолчанию параметр отсутствует:

plm.log.main.split

Файлы записываются в директорию, указанную параметром plm.log.main.file.path.

Выводить лог в stdout. Игнорируется, если выставлен параметр plm.daemon_mode. По умолчанию параметр отсутствует:

plm.log.main.log_to_stdout

Сохранять лог в файл; по умолчанию параметр отсутствует:

plm.log.main.log_to_file

Путь до директории, куда должны писаться логи (путь относительно корня репозитория):

plm.log.main.file.path = logs/main

Ротация файлов основного лога:

plm.log.max_files = 30

Формат записи лога; значение по умолчанию не задано:

plm.log.main.custom_file_formatting

Лог действий пользователя

plm.log.user_actions.enabled
plm.log.user_actions.loglvl = 3
plm.log.user_actions.log_to_stdout
plm.log.user_actions.log_to_file
plm.log.user_actions.file.path
plm.log.user_actions.custom_file_formatting

Параметры «plm.log.user_actions.enabled», «plm.log.user_actions.log_to_stdout» и «plm.log.user_actions.log_to_file» по умолчанию отсутствуют, значения для «plm.log.user_actions.file.path» и «plm.log.user_actions.custom_file_formatting» по умолчанию не заданы.

Лог экспорта

plm.log.export.enabled
plm.log.export.loglvl = 3
plm.log.export.log_to_stdout
plm.log.export.log_to_file
plm.log.export.file.path
plm.log.export.custom_file_formatting

Параметры «plm.log.export.enabled», «plm.log.export.log_to_stdout» и «plm.log.export.log_to_file» по умолчанию отсутствуют, значения для «plm.log.export.file.path» и «plm.log.export.custom_file_formatting» по умолчанию не заданы.

Лог событий мультисфер

plm.log.Import.enabled
plm.log.Import.loglvl = 3
plm.log.Import.log_to_stdout
plm.log.Import.log_to_file
plm.log.Import.custom_file_formatting

Параметры «plm.log.Import.enabled», «plm.log.Import.log_to_stdout» и «plm.log.Import.log_to_file» по умолчанию отсутствуют, значение для «plm.log.Import.custom_file_formatting» по умолчанию не задано.

HTTP-сервер

Порт для подключения к HTTP-серверу (порт, по которому доступен веб-интерфейс):

plm.http_server.port = 8080

Адрес HTTP-сервера:

plm.http_server.address = 0.0.0.0

Путь до файлов веб-интерфейса:

plm.http_server.resources_path = /usr/share/polymatica/web

Префикс в адресе HTTP-сервера для доступа к файлам и API:

plm.http_server.root_context_prefix = <your_prefix>

Включить в ответы HTTP-сервера заголовки, отключающие кэширование этих ответов; по умолчанию параметр отсутствует:

plm.http_server.enable_cache_headers

Состояние подпараметров при включенном параметре:

Cache-Control: no-store, no-cache, private
Pragma: no-cache

Если параметр «plm.http_server.enable_cache_headers» выключен, подпараметры не задаются.

Использовать защищенное соединение; по умолчанию параметр отсутствует:

plm.http_server.use_https

Полный путь до приватного ключа сертификата (ключ в формате PEM); значение по умолчанию не задано:

plm.http_server.ssl_key

Полный путь до сертификата; значение по умолчанию не задано:

plm.http_server.ssl_cert

Максимальное количество одновременно обрабатываемых входящих HTTP-запросов:

plm.http_server.max_requests = 128

Значение опции SameSite в заголовке ответа Set-Cookie:

plm.http_server.same_site = Lax

Интервал, с которым серверный сокет проверяет данные:

plm.http_server.idle_interval = 60

Тайм-аут на чтение входящих HTTP-запросов:

plm.http_server.read_timeout =  60

Тайм-аут на запись исходящих HTTP-ответов:

plm.http_server.write_timeout = 60

Тайм-аут для Keep-Alive TCP-соединения для входящих запросов HTTP-сервера:

plm.http_server.keep_alive_timeout = 60

Максимальное количество неудачных попыток при отправке Keep-Alive для TCP-соединения HTTP-сервера:

plm.http_server.keep_alive_max_count = 60

Менеджер ресурсов

Тайм-аут фактической очистки дискового хранилища от удаленных в интерфейсе пользовательских ресурсов (в секундах):

plm.manager.clear_tmp_dir_timeout = 43200

Разрешить учетной записи пользователя работать в одной авторизованной сессии одновременно из нескольких браузеров и в окнах инкогнито (множественная сессия); по умолчанию параметр отсутствует:

plm.allow_multiple_sessions

Когда параметр отсутствует, новая авторизация продолжает работу из предыдущей сессии, а предыдущая сессия автоматически закрывается.
Выход из множественной сессии автоматически закроет ее во всех браузерах и окнах инкогнито.
Параметр игнорируется в присутствии параметра plm.multiple_sessions_mode, см. ниже.

Расширенное управление сессией; значение по умолчанию не задано:

plm.multiple_sessions_mode

Принимает значения:

off – поведение параметра с таким значением аналогично отсутствию параметра plm.allow_multiple_sessions (см. выше), при этом состояние самого параметра plm.allow_multiple_sessions игнорируется;
resume – поведение параметра с таким значением аналогично наличию параметра plm.allow_multiple_sessions (см. выше), при этом состояние самого параметра plm.allow_multiple_sessions игнорируется;
renew – разрешить учетной записи пользователя начинать новую сессию из нескольких браузеров и в окнах инкогнито с сохранением существующей сессии.

В режиме renew завершение одной из сессий НЕ затрагивает другие открытые сессии.

Если не задан ни один из двух указанных параметров, система будет работать в соответствии со значением off.

Номер порта, на котором Менеджер ожидает подключений по внутреннему протоколу, опция командной строки --port или -P:

plm.manager.port = 50000

Идентификатор вышестоящего Менеджера:

plm.manager.id = 00000000-0000-0000-0000-000000000000

IP-адрес Менеджера, опция командной строки --manager-address или -A; значение по умолчанию не задано:

plm.manager.address

Временной интервал сохранения ресурса на диске после удаления, в секундах:

plm.manager.max_allowed_age_us = 86400

Запрет автоматического обновления кубов; по умолчанию параметр отсутствует:

plm.manager.prohibit_auto_update_for_cubes

Сканирование репозитория (разрешить полную перезагрузку репозитория во время обработки обновлений по расписанию); по умолчанию параметр отсутствует:

plm.manager.enable_scan_repo

Временной интервал, отображающий периодичность сканирования репозитория, в секундах:

plm.manager.scan_repo_timeout = 120

Тайм-аут ожидания инициализации нового домена, в секундах:

plm.manager.domain_connect_timeout = 10

Путь до репозитория:

plm.manager.repo_directory = /var/plmrepo/

Временной интервал, по истечении которого и при отсутствии активности пользовательская сессия будет закрыта, в секундах:

plm.manager.user_session_timeout = 1800

Выполнять очистку удаленных (временных) файлов (кубов, пользователей, профилей, сценариев и т. д.) при запуске приложения при условии, что с момента удаления файла прошло больше, чем plm.manager.clear_tmp_dir_timeout секунд; значение по умолчанию — False:

plm.manager.clear_tmp_on_start = True

Добавление пользователей, использующих Simple API, в единую группу:

plm.manager.simple_api_group_name = shared_resources

Скрыть кнопку «Отказаться», служащую для отказа от мультисферы, в контекстном меню мультисферы; по умолчанию параметр отсутствует:

plm.manager.user_can_not_reject_cubes

Запретить сохранять слои в сценарии и профили учетным записям без роли «Администратор системы»; по умолчанию параметр отсутствует:

plm.manager.user_can_not_save

Путь до утилиты проверки лицензии:

plm.manager.license_util = polymatica-license

Путь до файла лицензии:

plm.manager.license_file = /etc/polymatica/license.key

Список мультисфер для автоматического предоставления доступа всем пользователям системы; значение по умолчанию не задано:

plm.manager.auto_enable_cubes.<CUBEID>

Модуль импорта

Подробная информация о настройках импорта приводится в разделе «Импорт данных».

Максимальное количество используемых потоков для модуля импорта; если значение в конфигурационном файле равно нулю, то количество выбирается автоматически:

plm.import.thread_number = 0

Используется в случае нескольких источников, максимальное число потоков, занятых одновременно загрузкой, должно быть в диапазоне от 1 до plm.import.thread_number, если не указано или указано вне диапазона, используется plm.import.thread_number – 1, если plm.import.thread_number не указано, то количество ядер – 3:

plm.import.max_read_datasource_number

Используемая версия протокола драйвера:

plm.import.driver_protocol_version = 7.2

Тайм-аут логина при подключении через ODBC, в секундах:

plm.import.odbc_login_timeout = 20

Тайм-аут соединения при подключении через ODBC, в секундах; 0 – без ограничений:

plm.import.odbc_connection_timeout = 300

Тайм-аут запроса при подключении через ODBC, в секундах; 0 – без ограничений:

plm.import.odbc_query_timeout = 300

Тайм-аут соединения с источником JDBC, в секундах; 0 – без ограничений:

plm.import.jdbc_network_timeout = 900

Количество выделяемых блоков (буферов) при загрузке данных:

plm.import.datasources_blocks = 2

Количество строк в блоке (буфере), выбираемых из БД за одну итерацию цикла (fetch_row_count * 4 и fetch_row_count * 8 должно быть кратно размеру страницы):

plm.import.fetch_row_count = 20480

Номер версии протокола TDS для драйвера ODBC freeTDS. Если параметр не задан, то будет использована встроенная в freeTDS функция автоматического определения версии протокола. По умолчанию значение не задано:

plm.import.tds_version

Максимальный размер записи с типом «строка», в байтах:

plm.import.max_string_size = 4096

Тайм-аут выполнения вызова к драйверу Oracle во время импорта:

plm.import.oracle_call_timeout = 120000

Тайм-аут отправки запроса драйвером Oracle к серверу во время импорта:

plm.import.oracle_send_timeout = 120000

Время ожидания ответа драйвером Oracle от сервера во время импорта:

plm.import.oracle_receive_timeout = 120000

Модуль кластеризации

Лимит объектов кластеризации для иерархического алгоритма:

plm.clusterization.hierarchical_object_limit = 5000

Максимальное количество запускаемых потоков для модуля кластеризации:

plm.clusterization.default_thread_number = 4

Максимальное количество итераций алгоритма K-means:

plm.clusterization.kmeans_max_iteration = 50

Модуль карт

Для работы функционала модуля карт требуется подключение к геокодеру и тайловому серверу. В качестве геокодера поддерживаются PostgreSQL/PostGIS и Nominatim. В конфигурации требуется указать параметры для подключения только к одному геокодеру.

Имя базы данных в PostgreSQL/PostGIS; значение по умолчанию не задано:

plm.geo.postgres_postgis_database_name

Имя пользователя в базе данных PostgreSQL/PostGIS; значение по умолчанию не задано:

plm.geo.postgres_postgis_login

Пароль для доступа к базе данных PostgreSQL/PostGIS; значение по умолчанию не задано:

plm.geo.postgres_postgis_passwd

Адрес базы данных PostgreSQL/PostGIS; значение по умолчанию не задано:

plm.geo.postgres_postgis_host

Порт для обращения к базе данных PostgreSQL/PostGIS; значение по умолчанию не задано:

plm.geo.postgres_postgis_port

Адрес и порт геокодера Nominatim; значения по умолчанию не заданы:

plm.geo.nominatim_host
plm.geo.nominatim_port

В качестве значений для адреса и порта геокодера* можно использовать http://nominatim.polymatica.ru и 80 соответственно.

Префикс запроса к Nominatim; значение по умолчанию не задано:

plm.geo.url_prefix

В качестве тайлового сервера можно использовать сервис* maps.polymatica.ru/tile , либо собственный или общедоступный тайловый сервер.

Адрес тайлового сервера; значение по умолчанию не задано:

plm.geo.tiles_uri

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

plm.geo.thread_number = 4

По умолчанию отсутствие параметра – это формат Д-Ш (как в GeoJson). При указании True будет производиться своп координат на Ш-Д для всех внутренних видов координат.

plm.geo.geocoder_raw_swap_coords = true

* Сервисы http://nominatim.polymatica.ru и maps.polymatica.ru/tile не предполагают большого количества запросов. Для обеспечения отказоустойчивости данных сервисов в условиях большого количества запросов следует разворачивать сервисы в своем контуре.

Конфигурация интерфейса

Включить функциональность перехода между сценариями; по умолчанию параметр отсутствует:

plm.user_interface.scenario_hyperlink_enabled

В мультисфере для вынесенных вверх размерностей колонку «Всего» отображать слева перед размерностями; по умолчанию параметр отсутствует:

plm.user_interface.top_total_transfer

В мультисфере для вынесенных влево размерностей строку «Всего» отображать сверху над размерностями; по умолчанию параметр отсутствует:

plm.user_interface.left_total_transfer

В мультисфере количество столбцов для загрузки в буфер. Минимальная – максимальная границы: 60 – 90. При нулевом значении параметр выключен.

plm.user_interface.view_fetch_cols = 0

В мультисфере количество строк для загрузки в буфер. Минимальная – максимальная границы: 40 – 90. При нулевом значении параметр выключен.

plm.user_interface.view_fetch_rows = 0

В мультисфере для вынесенных размерностей учитывать установленные фильтры, применяя правила:

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

По умолчанию параметр отсутствует.

plm.user_interface.indirect_filters

Запоминать состояние элементов для первых N строк в таблице до ее перестроения по следующим правилам:

Параметр не задан: сохраняется и восстанавливается состояние всей таблицы целиком, которое было до перестроения.
Параметр равен 0: ничего не сохраняется и не восстанавливается.
Параметр равен N, где N – положительное число: сохраняются и восстанавливаются первые от начала таблицы N строк (отсчет строк ведется по элементам последней размерности слева и сверху соответственно).

plm.user_interface.olap.marks.restore_rows = 0

Не отображать меню пользователя на главной панели для всех пользователей, за исключением пользователей с ролями «Администратор системы» или «Создание сфер». Значение по умолчанию — True.

plm.user_interface.enabled_logout = False

Разрешить всем пользователям делиться сценариями и профилями:

plm.user_interface.enabled_sharing = True

Если для параметра задано значение False, пользователи не могут делиться сценариями и профилями, вне зависимости от роли.

Не отображать кнопку предоставления доступа к сценариям/профилям для всех пользователей за исключением пользователей с ролью «Администратор системы»; по умолчанию параметр отсутствует:

plm.user_interface.users_cant_share

Добавить кнопку удаленного экспорта; по умолчанию параметр отсутствует:

plm.user_interface.enable_remote_export_button

Разделитель целой и дробной части числа:

plm.user_interface.decimal_separator = .

Параметры перехода из Polymatica Analytics по ссылке

URL; значение по умолчанию не задано:

plm.user_interface.link_outside.url

Режим открытия URL:

plm.user_interface.link_outside.in_current_tab = False

Принимает следующие значения:

True — открывать URL на текущей вкладке;
False — открывать URL на новой вкладке.

Подсказка для URL; значение по умолчанию не задано:

plm.user_interface.link_outside.url_tip

Настройки экспорта

Подробная информация о настройках экспорта приводится в разделе «Экспорт данных».

Разрешить «временным» (is_guest=true) пользователям экспорт данных; по умолчанию параметр отсутствует:

plm.user.guest_can_export

Настройка количества строк в одном листе Excel (0 – отсутствует ограничение на количество строк):

plm.export.xlsx.sheet_max_rows=0

Отображение заголовка таблицы на каждом листе экспортируемого документа:

plm.export.xlsx.sheets_header=true

Название листа экспортируемого документа XLSX в локали EN:

plm.export.xlsx.sheet_name_en = Sheet

Название листа экспортируемого документа XLSX в локали RU:

plm.export.xlsx.sheet_name_ru = Лист

Настройка разделителей и кодировок CSV

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

Разделитель столбцов в экспортируемом документе CSV:

plm.export.csv.separator = ;

Квалификатор текста (символ кавычки) в экспортируемом документе CSV:

plm.export.csv.quote_char = "

Кодировка экспортируемого документа CSV:

plm.export.csv.encoding = UTF-8

Разделитель целой и дробной части чисел в экспортируемом документе CSV:

plm.export.csv.decimal_separator = .

В случае совпадения квалификатора текста (plm.export.csv.quote_char) с любым из разделителей (plm.export.csv.decimal_separator, plm.export.csv.separator) экспорт прерывается ошибкой.

Для настройки удаленного экспорта из закрытого контура см. параметр «plm.user_interface.enable_remote_export_button» в разделе «Конфигурация интерфейса» выше на этой странице.

Директория, в которую производится удаленный экспорт; значение по умолчанию не задано:

plm.export_path

Параметр, отвечающий за состояние чекбокса «Выбрать формат перед экспортом»:

plm.export.use_formatted_export_by_default = False

Принимает значения:

false – чекбокс не отмечен. Это значение параметра установлено по умолчанию.
true – чекбокс отмечен.

Авторизация через внешние сервисы

Подробные инструкции по настройке параметров для аутентификации и авторизации через внешние сервисы приводятся в разделе Аутентификация и авторизация через внешние сервисы.

URI для подтверждения автоматической аутентификации пользователей; значение по умолчанию не задано:

plm.manager.auto_authentication_uri = https://polymatica.ru/

Тип автоматической аутентификации (зависит от клиента), возможные варианты: DEFAULT, ECASA, ASNA, SIMPLE, SIMPLE_API, OAUTH2, LDAP:

plm.manager.auto_authentication_type = DEFAULT

Использовать стороннюю БД с пользователями и группами; по умолчанию параметр отсутствует:

plm.manager.use_external_users_groups_bd

Параметры синхронизации с LDAP-сервером, DN в LDAP; значение по умолчанию не задано:

plm.manager.auto_authentication_ldap_dn

Базовый DN; значение по умолчанию не задано:

plm.manager.auto_authentication_ldap_base_dn

Использовать LDAPS; по умолчанию параметр отсутствует:

plm.manager.auto_authentication_ldap_secured

Пароль; значение по умолчанию не задано:

plm.manager.auto_authentication_password

Запрос к LDAP-серверу для фильтрации учетных записей пользователей:

plm.manager.auto_authentication_ldap_filter = (&(ObjectClass=user))

Атрибут, значение которого будет являться логином в Polymatica; значение по умолчанию не задано:

plm.manager.auto_authentication_ldap_login_attribute

Старый OAuth2, URL для получения кода аутентификации; значение по умолчанию не задано:

plm.manager.auto_authentication_code_uri

Старый OAuth2, URL для редиректа пользователя обратно в Polymatica Analytics; значение по умолчанию не задано:

plm.manager.auto_authentication_redirect_uri

Старый OAuth2, идентификатор приложения; значение по умолчанию не задано:

plm.manager.auto_authentication_clientid

Параметры для аутентификации через провайдера OAuth2

Включить поддержку аутентификации через провайдеров OAuth2/OpenID Connect; по умолчанию параметр отсутствует:

plm.login.oauth2.enabled

Абсолютное базовое имя хоста для обратного перенаправления из провайдера. Имя должно указывать на текущий сервер Polymatica Analytics. Может содержать порт. Не должен содержать что-либо после authority-части URI:

plm.login.oauth2.redirect_hostname = http://localhost

Выполнять проверку SSL-сертификата; по умолчанию параметр отсутствует:

plm.login.oauth2.verify_ssl

Время жизни идентификаторов состояний «state» для аутентификации по протоколу OAuth2:

plm.login.oauth2.state_lifetime = 600

Записывать в лог персональные данные пользователей, получаемые от провайдеров, в случае возникновения ошибок; по умолчанию параметр отсутствует:

plm.login.oauth2.debug_print_sensitive_content

Включить i-го провайдера; значение по умолчанию Fasle:

plm.login.oauth2.providers[i].enabled = True

Внутренний текстовый идентификатор провайдера; значение по умолчанию не задано. Используется в процессе перенаправлений пользователя между провайдером и веб-интерфейсом Polymatica Analytics:

plm.login.oauth2.providers[i].name

Локализованное название провайдера для веб-интерфейса:

plm.login.oauth2.providers[i].localized_name = значение параметра plm.login.oauth2.providers[i].name

Путь к иконке провайдера относительно корневой директории веб-интерфейса; значение по умолчанию не задано:

plm.login.oauth2.providers[i].icon_uri

Идентификатор приложения-клиента, зарегистрированный у провайдера; значение по умолчанию не задано:

plm.login.oauth2.providers[i].client_id

Секретный ключ, привязанный к приложению-клиенту, зарегистрированному у провайдера; значение по умолчанию не задано:

plm.login.oauth2.providers[i].client_secret

Список scopes, запрос на доступ к которым отправляется провайдеру; значение по умолчанию не задано:

plm.login.oauth2.providers[i].scope

Название группы Polymatica Analytics, в которую добавить пользователя после успешной аутентификации; значение по умолчанию не задано:

plm.login.oauth2.providers[i].group_for_users

Способ аутентификации OAuth2/OIDC:

plm.login.oauth2.providers[i].flow = pkce

Принимает значения:

pkce – (Authorization code with Proof Key for Code Exchange) код авторизации с доказательством обмена ключами, наиболее безопасный вариант аутентификации;
code – (Authorization code flow) только код авторизации, базовый безопасный способ аутентификации;
egisz – аналог PKCE, но с измененной схемой для аутентификации в ЕГИСЗ, в частности, отличаются параметры для запроса id token по refresh token.

Добавить в запрос клиента на аутентификацию (этап перенаправления клиента с Polymatica Analytics к провайдеру) параметр «redirect_uri» с адресом обратного перенаправления клиента в случае успешной аутентификации; по умолчанию параметр отсутствует:

plm.login.oauth2.providers[i].authorization_add_redirect_parameter

Добавить в запрос идентификационного токена параметр «client_secret» со значением секретного ключа приложения; по умолчанию параметр отсутствует:

plm.login.oauth2.providers[i].token_add_client_secret

Передавать параметры запроса идентификационного токена через тело запроса. В противном случае параметры будут передаваться через сам URI-запрос (после символа «?»). По умолчанию параметр отсутствует:

plm.login.oauth2.providers[i].token_pass_parameters_through_body

При входе пользователя проверять список его доступных групп на соответствие «белому списку» заранее заданных имен групп (см. параметр «groups_whitelist»). Если пользователь имеет хотя бы одну группу из списка, он будет допущен в систему. По умолчанию параметр отсутствует:

plm.login.oauth2.providers[i].use_groups_whitelist

При наличии параметра «plm.login.oauth2.providers[i].skip_token_groups», параметр «plm.login.oauth2.providers[i].use_groups_whitelist» игнорируется.

Задать массив групп пользователей, которым разрешено входить в систему; значение по умолчанию не задано:

plm.login.oauth2.providers[i].groups_whitelist[j]

Группа параметров для сопоставления полей идентификационного токена со смысловым значением (mapping)

Название поля в идентификационном токене, содержащее логин пользователя; значение по умолчанию не задано:

plm.login.oauth2.providers[i].claims.login

Название поля в идентификационном токене, содержащее адрес электронной почты пользователя; значение по умолчанию не задано:

plm.login.oauth2.providers[i].claims.email

Название поля в идентификационном токене, содержащее полное ФИО пользователя; значение по умолчанию не задано:

plm.login.oauth2.providers[i].claims.fullname

Название поля в идентификационном токене, содержащее список объектов, описывающих роли пользователя в системе Avanpost FAM; значение по умолчанию не задано:

plm.login.oauth2.providers[i].claims.permissions

Наименование утверждения, содержащего список устаревших прав доступа; значение по умолчанию не задано:

plm.login.oauth2.providers[i].claims.legacy_permissions

Название поля в идентификационном токене, которое должно содержать список групп Polymatica Analytics, в которые требуется включить пользователя; значение по умолчанию не задано:

 plm.login.oauth2.providers[i].claims.groups

Название поля в идентификационном токене, которое должно содержать список групп Polymatica Analytics, по которым определяются доступные мультисферы для выдачи прав доступа пользователю; значение по умолчанию не задано:

plm.login.oauth2.providers[i].claims.roles

Размерность, которую нужно найти в доступных мультисферах, получаемых через параметр «roles». Каждый j-ый индекс должен определять одну размерность. По умолчанию значение не задано:

plm.login.oauth2.providers[i].claims.elements_access[j].dims_regex

Элементы размерности «elements_access.dims_regex», на которые следует выдать права доступа. Одному j-му параметру «elements_access[j].dims_regex» должен соответствовать один j-ый параметр «elements_access[j].claim». По умолчанию значение не задано:

plm.login.oauth2.providers[i].claims.elements_access[j].claim

Параметры Metadata

Адрес провайдера OAuth2/OpenID Connect; значение по умолчанию не задано:

plm.login.oauth2.providers[i].metadata.url

Обновлять параметры провайдера через протокол OIDC Discovery. Если провайдер не поддерживает этот протокол, то невозможность получить параметры приведет к ошибке. По умолчанию параметр отсутствует:

plm.login.oauth2.providers[i].metadata.use_oidc_discovery

Пропускать валидацию данных провайдера, полученных по протоколу OIDC Discovery. Может быть полезно в ситуациях, когда, к примеру, issuer, получаемый по протоколу OIDC Discovery, не совпадает с адресом провайдера. По умолчанию параметр отсутствует:

plm.login.oauth2.providers[i].metadata.skip_validation

Время в секундах, в течение которого Polymatica Analytics считает данные провайдера, полученные по протоколу OIDC Discovery, актуальными. По истечении данного периода времени происходит обновление данных провайдера:

 plm.login.oauth2.providers[i].metadata.expiration_time = 600

Адрес провайдера для перенаправления пользователя на этапе запроса аутентификации через провайдера; значение по умолчанию не задано:

plm.login.oauth2.providers[i].metadata.authorization_endpoint

Адрес провайдера для получения сервером Polymatica Analytics идентификационного токена пользователя, токена обновления, а также ключа для доступа к API провайдера; значение по умолчанию не задано:

plm.login.oauth2.providers[i].metadata.token_endpoint

Адрес провайдера для получения дополнительных данных о пользователе. В некоторых случаях, при запросе данных пользователя по этому адресу, провайдер сообщает больше данных. Значение по умолчанию не задано:

plm.login.oauth2.providers[i].metadata.userinfo_endpoint

При добавлении параметра у учетной записи пользователя после успешной аутентификации не будут сбрасываться настроенные права доступа и не будут применяться описанные в токенах права доступа; по умолчанию параметр отсутствует:

plm.login.oauth2.providers[i].skip_token_permissions

После успешной аутентификации не назначать описанные в токене группы пользователю и не исключать пользователя из уже назначенных групп. Переданные в токене группы не будут созданы. При наличии этого параметра параметр «plm.login.oauth2.providers[i].use_groups_whitelist» игнорируется. По умолчанию параметр отсутствует:

plm.login.oauth2.providers[i].skip_token_groups

После успешной аутентификации не применять описанные в токене роли и не сбрасывать уже назначенные; по умолчанию параметр отсутствует:

plm.login.oauth2.providers[i].skip_token_roles

Пропускать и не создавать группы, отсутствующие в системе; по умолчанию параметр отсутствует:

plm.login.oauth2.providers[i].skip_missing_groups

Пропустить верификацию токена OAuth2, полученного от провайдера; по умолчанию параметр отсутствует:

plm.login.oauth2.skip_token_verification

Имя группы пользователя с правами администратора; значение по умолчанию не задано:

plm.login.oauth2.providers[i].admin_group_name

Отвечает за назначение роли «Администратор» всем пользователям той группы, название которой прислал Avanpost в claims; значение по умолчанию не задано:

 plm.login.oauth2.avanpost.admin_group_name

Идентификатор ресурса, содержащего описание ролей пользователей Polymatica Analytics для системы Avanpost FAM. Если не указать, то Polymatica Analytics не сможет правильно прочитать права доступа пользователя, а Avanpost FAM может возвращать права доступа произвольных приложений. Значение должно соответствовать идентификатору объекта доступа, указанному в настройках приложения в Avanpost FAM.

plm.login.oauth2.avanpost_permissions_resource_id = polymatica_roles

Параметры для аутентификации через ЕСИА

Путь к сертификату информационной системы, зарегистрированному в ЕСИА; значение по умолчанию не задано:

plm.login.oauth2.flow.esia.cert_path

Путь к закрытому ключу сертификата информационной системы, зарегистрированному в ЕСИА; значение по умолчанию не задано:

plm.login.oauth2.flow.esia.cert_private_key_path

Пароль к закрытому ключу сертификата информационной системы, зарегистрированного в ЕСИА. Может быть пуст. Значение по умолчанию не задано.

plm.login.oauth2.flow.esia.cert_private_key_password

Включение авторизации через IAM ЕЦП «Гостех»

Включить поддержку входа в систему через IAM ЕЦП «Гостех» можно с помощью указанных ниже параметров.

Включить вход по предъявлению JWT; по умолчанию параметр не отсутствует:

plm.login.bearer.jwt.enabled

Клэйм для выдачи прав админа в предъявленном JWT; значение по умолчанию не задано:

plm.login.bearer.jwt.permission_admin_claim

После включения становится доступна авторизация по предъявлению JWT-токена через заголовок Authorization запроса на эндпойнт /api/v2/login/bearer/jwt.

В токене должна содержаться следующая информация:

Логин
ФИО
Почта
Код ОКАТО
Код МО

Если вход выполнен успешно, то создается новая или обновляется существующая учетная запись с указанным логином и открывается новая локальная сессия.

Печать подробных данных предъявляемых JWT; по умолчанию параметр не задан:

plm.login.bearer.jwt.debug_print_sensitive_content

Выход из системы и IAM ЕЦП «Гостех»

Для закрытия сессии IAM ЕЦП «Гостех» необходимо указать в параметре конфигурации адрес для редиректа пользователя, вошедшего по предъявлению JWT, после завершения локальной сессии. Если параметр не указан, пользователь будет перенаправлен на root_content_prefix. Значение по умолчанию не задано.

plm.login.bearer.jwt.logout_endpoint

Другие настройки

Путь до временной директории; значение по умолчанию не задано:

plm.tmp_directory

Если параметр не задан, то используется значение plm.manager.repo_directory / tmp.
Если для параметра задать значение plm.tmp_directory = /srv, то для временных файлов, создаваемых при сериализации мультисферы в JSON и экспорте мультисферы в различных форматах при получении соответствующих команд от фронтенда, будет использоваться plm.tmp_directory / tmp. В остальных случаях, например, для передачи файлов между бэкендом и фронтендом (CSV, XLS, логи, python-скрипты), импорта данных (источники данных хранятся во временных файлах), хранение файлов справочников (filter list), для временных файлов будет использоваться plm.manager.repo_directory / tmp.

Путь до рабочей директории:

plm.work_dir = /usr/share/polymatica/

Режим демона; по умолчанию отсутствует:

plm.daemon_mode

Отладочная задержка при сохранении ресурсов:

plm.debug.resource_save_delay = 0

Отладочная задержка при перемещении размерности:

plm.debug.dimension_move_delay = 0

Уникальный идентификатор текущего приложения в системе; по умолчанию выбирается случайное значение типа string:

plm.uuid

Путь до директории с плагинами:

plm.extensions_dir = /usr/lib/polymatica/extensions

Флаг запуска приложения как расчетного сервера; по умолчанию параметр отсутствует:

plm.run_as_server

Флаг запуска приложения как импортера; по умолчанию параметр отсутствует:

plm.run_as_importer

Идентификатор движка для загрузки других движков OpenSSL:

plm.crypto.openssl.dynamic_engine_id = dynamic

Загружать движок с номером i или нет:

plm.crypto.openssl.engines[i].load = False

Идентификатор движка с номером i; значение по умолчанию не задано:

plm.crypto.openssl.engines[i].id

Путь до движка с номером i на диске; значение по умолчанию не задано:

plm.crypto.openssl.engines[i].path

Путь до конфига JVM:

plm.jvm.config_path = /etc/polymatica/polymatica_jvm.conf

Путь до загружаемых JAR; значение по умолчанию не задано:

plm.jvm.class_path

Пути до загружаемых JAR; значение по умолчанию не задано:

plm.jvm.class_paths[i]

Включить плагин ЕСТО; по умолчанию параметр отсутствует:

plm.extension.esto_dictionary.enabled

Запрос к источнику кодов ЕСТО; значение по умолчанию не задано:

plm.extension.esto_dictionary.request

Использовать устаревший способ фильтрации элементов при записи сценариев*:

plm.scenarios.performance_boost = True

Устаревший способ фильтрации может вызывать ошибки, но работает быстрее. Значение параметра по умолчанию — False.

Путь до интерпретатора Python 3:

plm.pyscripts.python_exe = /usr/bin/python3

Переменные окружения, устанавливаемые при старте программы

Набор названий устанавливаемых в рантайме переменных среды; значения по умолчанию не заданы:

plm.environment.<VAR>.name

Набор значений устанавливаемых в рантайме переменных среды; значения по умолчанию не заданы:

plm.environment.<VAR>.value

Путь до каталога, содержащего файл odbcinst.ini:

plm.environment.var1.name = ODBCSYSINI
plm.environment.var1.value = ./

Параметры локали для Oracle:

plm.environment.var2.name = NLS_LANG
plm.environment.var2.value = RUSSIAN_RUSSIA.AL32UTF8

Путь до каталога с настройками для SQL*Net (файл sqlnet.ora):

plm.environment.var3.name = TNS_ADMIN
plm.environment.var3.value = ./

Значения переменных с путями задаются относительно пути до рабочей директории.

Формат даты и времени

Выставляется формат представления времени, где H – час, M – минуты, S – секунды:

plm.time_template = HH:MM:SS

Выставляется формат представления даты, где D – день, M – месяц, Y – год:

plm.date_template = YYYY-MM-DD

В качестве разделителей можно использовать следующие символы: !"#$&'()*+,-./:;<=>?@[\]^_`{|}~

Для времени используется 24-часовой формат с ведущим нулем.

Режим построения сортировочных индексов

Параметр, отвечающий за выбор режима построения сортировочных индексов элементов размерностей при создании/обновлении мультисферы:

plm.import.sort_type

Принимает значения:

default – стандартная сортировка, работает стабильнее ускоренных режимов, но может занимать больше времени.
radix – однопоточная ускоренная сортировка, на больших объемах работающая быстрее, чем стандартная.
indirect – параллельная сортировка, полностью утилизирующая процессор и обеспечивающая высокую скорость.

Потоки

Максимальное количество запускаемых потоков для модуля «Прогнозирование»; если значение в конфигурационном файле равно нулю, то количество выбирается автоматически::

plm.forecast.thread_number = 0

Максимальное количество запускаемых потоков для модуля «Графика»:

plm.graph.thread_number = 4

Отчеты о падениях

Включить поддержку системы подготовки отчетов о падениях Google Crashpad. По умолчанию параметр отсутствует.

plm.crashpad_enabled

Путь до вспомогательной утилиты Crashpad, которая отвечает за формирование отчетов о падениях в случае их возникновения.

plm.crashpad_handler = /usr/sbin/plm_crashpad_handler