Все основные настройки BI-сервера сохраняются в разделе [HKEY_LOCAL_MACHINE], в подразделе System:
[HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\PP\BIS\System]
Также в ветке [HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\10.0] могут быть созданы дополнительные подразделы или отдельные ключи, которые используются при работе как BI-сервера, так и настольного приложения «Форсайт. Аналитическая платформа»:
Audit. Учётные данные служебного пользователя подсистемы безопасности;
Service. Точки доступа к различным BI-серверам;
Manager. Настройки, используемые при работе настольного приложения «Форсайт. Аналитическая платформа». В подразделе может создаваться только подраздел Pool, его структура и параметры аналогичны подразделу, создаваемому в System. Данные настройки будут использоваться настольным приложением, если в нём настроено подключение к репозиторию через веб-сервисы;
InMem. Настройки, определяющие режим работы кэширования данных по технологии In-Memory;
Dimensions. Настройки, позволяющие использовать справочник в режиме кросс-сессионного кэша;
SysLogServer. Настройки, определяющие параметры подключения к syslog-серверу для пересылки сообщений о событиях аудита;
Debug. Настройки, используемые для расчёта алгоритма;
Nav. Настройки, используемые навигатором объектов.
Данные разделы включают в себя подразделы, для которых могут быть установлены различные параметры.
Примечание. Все параметры, создаваемые в данных подразделах, имеют строковый тип. Параметры, принимающие только целочисленные значения, создаются с типом REG_DWORD.
Пример файла реестра: settings_reg.zip.
В данном разделе создается параметр, влияющий на работу веб-сервиса:
Параметр | Описание |
GetSystemInfoExtended | Получение расширенной информации о ресурсах, потребляемых BI-сервером, при выполнении операции веб-сервиса GetSystemInfo с заданными полями processInfo и cpuInfo. Допустимые значения:
Для получения расширенной информации без указания моникёра в запросе должно передаваться поле allowMetabaseNotFound со значением true. Примечание. При указании моникёра расширенная информация возвращается вне зависимости от значения параметра GetSystemInfoExtended. |
В подразделе [HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\PP\BIS\System\Session] создаются параметры, влияющие на работу отдельных сессий с репозиториями:
Параметры | Описание |
RWLockSlim | Блокировка доступа к открытым экземплярам объектов. Допустимые значения:
|
LockSession | Блокировка всей сессии при выполнении запросов. При включенной блокировке запросы ко всем объектам в рамках сессии будут выполняться последовательно, иначе параллельно или применяются индивидуальные блокировки (RWLockSlim). Допустимые значения:
|
LockAd | Блокировка доступа к открытым экземплярам аналитических панелей. При включенной блокировке запросы на чтение/запись будут выполняться последовательно, иначе параллельно. Также при этом включается блокировка вложенных объектов, доступ к которым осуществляется с использованием моникера аналитической панели. Допустимые значения:
|
SamplingStr | Включение сбора статистики по времени и памяти для счётчиков производительности. Допустимые значения:
Флаг IsOn указывается всегда, иначе сбор статистики производиться не будет. Через запятую указываются другие флаги, определяющие, какие именно счетчики необходимо задействовать. Указание только флага IsOn эквивалентно включению всех флагов. |
Sampling | Включение сбора статистики по времени и памяти для счётчиков производительности. Допустимые значения:
|
SysLogMb | Идентификатор репозитория, в котором имеются системные таблицы для хранения собранной статистики (создание системных таблиц для сбора статистики осуществляется с использованием утилиты PP.Util). |
TimeoutSec | Время ожидания при отсутствии запросов, по истечении которого сессия с репозиторием будет разорвана. Время указывается в секундах, в диапазоне [60, 127800]. При значении «-1» время ожидания не ограничено. По умолчанию - 1800. |
Statable | Режим сохранения и восстановления состояний объектов на сервере состояний. Используется вместе с группой настроек StateServer. Допустимые значения:
|
KeyIncr | Генерация последовательных моникёров сессий и объектов. Допустимые значения:
|
SecureSession | Дополнительная проверка соответствия клиента, от имени которого была открыта сессия, и идентификатора сессии при каждом запросе к BI-серверу. Обеспечивает предупреждение атаки типа XSS. Допустимые значения:
Для получения подробной информации о работе веб-приложения по протоколу HTTPS обратитесь к разделу «Настройка веб-приложения для работы через HTTPS». |
StoreBins | Ограничение на количество хранимых на сервере с каждым объектом
результатов экспорта (для экспресс-отчетов и регламентных отчетов). |
StoreBinSize | Максимальный суммарный размер загруженных бинарных объектов в рамках сессии. По умолчанию размер указывается в байтах. Если после значения указать символ «B», «K» или «M» (англ.), то значение соответственно будет в байтах, килобайтах или мегабайтах. По умолчанию 0, при этом ограничение на загружаемый объем отсутствует. |
PoolMaxConnections | Ограничение на количество соединений с базой данных репозитория. Допустимые значения:
Примечание. Параметр PoolMaxConnections является устаревшим, оставлен для совместимости с версиями Prognoz Platform. Используйте параметр MaxConnections в подразделе реестра [HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\PP\BIS\System\Pool]. |
GetStatusMode | Режим обработки операции GetStatus, которая используется в веб-приложении для проверки статуса соединения. Допустимые значения:
|
Другие подразделы System для настройки BI-сервера:
Подраздел | Параметры |
[HKLM\SOFTWARE\Foresight\ Foresight Analytics Platform\ 10.0\PP\BIS\System\Pool] |
В данном подразделе создаются параметры, влияющие на работу пула соединений, который будет использовать BI-сервер.
Также, в подразделе Pool могут быть созданы дополнительные подразделы с параметрами для конкретных репозиториев. Создаваемый дополнительный подраздел должен иметь любое уникальное наименование, в нем могут быть созданы следующие параметры:
Примечание. Параметры пула соединений применяются, если значение параметра MaxConnections больше нуля. |
[HKLM\SOFTWARE\Foresight\ Foresight Analytics Platform\ 10.0\PP\BIS\System\StateServer] |
Параметры подключения к серверу состояний.
Для настройки сервера состояний обязательно задайте одно из значений в зависимости от приложения;
Для настройки аутентификации на сервере состояний создайте подраздел Credentials и задайте параметры Crs, Crsa. В параметрах укажите учётные данные пользователя для подключения к серверу состояний в зашифрованном виде. Зашифрованные значения этих параметров можно получить с помощью утилиты PP.Util, используя параметр /encrypt_creds. |
[HKLM\SOFTWARE\Foresight\ Foresight Analytics Platform\ 10.0\PP\BIS\System\Cert] |
В данном подразделе хранится закрытый ключ сертификата безопасности. Параметры этого подраздела реестра создаются при работе программы PP.Util.
Важно. Параметры данного подраздела не должны редактироваться вручную. |
[HKLM\SOFTWARE\Foresight\ Foresight Analytics Platform\ 10.0\PP\BIS\System\Mbs] |
Параметры объектов для сбора статистики. В данном подразделе необходимо создать дополнительные подразделы с именами, равными идентификатору репозиториев. В каждом дополнительном подразделе может быть создан параметр:
|
[HKLM\SOFTWARE\Foresight\ Foresight Analytics Platform\ 10.0\PP\BIS\System\OAuth] |
Параметры работы через протокол OAuth 2.0 или OpenID Connect для аутентификации пользователей на сторонних серверах, поддерживающих данный протокол. При аутентификации через внешние сервисы должно быть настроено соединение между клиентом и BI-сервером по протоколу HTTPS. По умолчанию выполняется проверка параметра state для защиты от потенциальных атак типа CSRF при получении кода авторизации. Если соединение между клиентом и BI-сервером настроено по протоколу HTTP, то создайте параметр StateCheckOff со значением «1» для отключения проверки. Для настройки взаимодействия с внешними сервисами внутри раздела OAuth создаются подразделы с именами серверов аутентификации OAuth/OpenID Connect. В каждом подразделе задаются необходимые специфические параметры. Допустимы следующие параметры серверов аутентификации OAuth/OpenID Connect:
При настройке подключения к репозиторию под конкретным пользователем, который проходил авторизацию на внешнем сервере, значения в параметрах UserIdAttr и UserNameAttr могут совпадать. Уникальный идентификатор и имя пользователя, полученные при работе с внешним сервисом с помощью параметров UserIdAttr и UserNameAttr, записываются:
Значения, указываемые в параметрах ConsumerKey и ConsumerSecret, будут получены после регистрации разрабатываемого приложения на необходимом сервере аутентификации OAuth/OpenID Connect. Данные параметры необходимы, чтобы после авторизации на сервере аутентификации OAuth/OpenID Connect BI-сервер смог проверить и авторизовать соответствующего пользователя в репозитории. Если параметры ConsumerKey и ConsumerSecret не указаны, то используются внутренние настройки BI-сервера, при этом на сервере аутентификации OAuth/OpenID Connect должно быть зарегистрировано приложение на базе веб-приложения «Форсайт. Аналитическая платформа». |
[HKLM\SOFTWARE\Foresight\ Foresight Analytics Platform\ 10.0\PP\BIS\System\MbDefs] |
Параметры работы со списком репозиториев. Допустимый строковый параметр:
|
[HKLM\SOFTWARE\Foresight\ Foresight Analytics Platform\ 10.0\PP\BIS\System\Dal] |
Параметры выполнения SQL-запросов с использованием операций BI-сервера. Данные параметры влияют на работу BI-сервера, если он используется в качестве клиента для доступа к СУБД.
|
[HKLM\SOFTWARE\Foresight\ Foresight Analytics Platform\ 10.0\PP\BIS\System\Fore] |
Параметры работы с объектами среды разработки.
|
[HKLM\SOFTWARE\Foresight\ Foresight Analytics Platform\ 10.0\PP\BIS\System\WebForms] |
Параметры работы веб-форм.
|
В данном разделе сохраняются учётные данные служебного пользователя подсистемы безопасности в зашифрованном виде. Для шифрования учётных данных используется алгоритм ГОСТ 28147-89.
Подраздел | Ключи |
[HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\Audit\Credentials\Item0] | Подраздел, в котором хранятся учётные данные служебного пользователя.
|
Набор подразделов может меняться в зависимости от количества компьютеров, на которых были добавлены учётные данные служебного пользователя.
Примечание. Данные подраздела формируются автоматически и доступны только для чтения.
В данном разделе указываются адреса удаленных BI-серверов для извлечения и кэширования данных из репозитория. BI-сервер с веб-приложением будет обращаться к удаленным BI-серверам и получать поток с необходимыми данными без дополнительного обращения к СУБД.
Подраздел | Ключи |
[HKLM\SOFTWARE\Foresight\ Foresight Analytics Platform\ 10.0\Service\Epts] |
Подраздел, в котором указываются конечные точки к удалённым серверам. Для каждой точки создайте подраздел с уникальным именем, в каждом из которых добавьте параметр:
|
[HKLM\SOFTWARE\Foresight\ |
Подраздел содержит настройки репозиториев. Для настройки внутри Mbs создайте подраздел с уникальным именем – идентификатором репозитория, также внутри созданного подраздела может быть указан параметр:
Внутри каждого подраздела для репозитория также могут быть созданы дополнительные подразделы с настройками:
Например: [HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\Service\Mbs\WAREHOUSE\Cubes\InMemSettings] Где:
Если подраздел UpdCache создан, то BI-сервер, которому соответствует указанная точка доступа, будет использоваться при выполнении задачи обновления кэша в контейнере запланированных задач. |
В разделе [HKEY_CURRENT_USER] создаются параметры, определяющие режим работы кэширования данных по технологии In-Memory. Настройки применяются при работе текущего пользователя. Ветка, в которую сохраняются настройки: [HKCU\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\InMem]. Работа с кэшем доступна только в рамках одного запущенного экземпляра продукта «Форсайт. Аналитическая платформа». Указанные настройки задаются на клиентских компьютерах, если используется настольное приложение, или на BI-сервере, если используется веб-приложение.
Также настройки могут быть заданы в разделе [HKEY_LOCAL_MACHINE], при этом они будут применяться для всех пользователей. Необходимо учитывать приоритет поиска настроек:
Раздел [HKEY_CURRENT_USER].
Раздел [HKEY_LOCAL_MACHINE].
Примечание. Все параметры должны иметь строковый тип, значения указываются строчными буквами.
Параметры | Описание |
CacheType |
Режим работы кэширования данных кубов, в том числе кубов ADOMD и баз данных временных рядов. Допустимые значения:
Если параметр CacheType не содержится в реестре, то выполняется проверка параметра UseInMem:
|
UseInMem | Признак использования механизма In-Memory для кэширования данных кубов, в том числе кубов ADOMD и баз данных временных рядов в файловом кэше. Допустимые значения:
Важно. Параметр UseInMem является устаревшим и используется для совместимости с прошлыми версиями. Для определения режима работы кэширования данных используйте параметр CacheType. Если одновременно заданы параметры UseInMem и CacheType, то значение параметра CacheType будет приоритетнее. |
CacheDims | Признак использования механизма In-Memory для кэширования данных
справочников. По умолчанию параметр отсутствует и используется
механизм кэширования
объектов репозитория. Для кэширования справочников
с использованием механизма In-Memory создайте параметр и установите
ему значение true.
Примечание. Параметр может принимать значение true, если параметр CacheType принимает значение file. Если параметр CacheType принимает значение global, то для параметра CacheDims автоматически устанавливается значение false. |
DataDir | Путь к папке, в которой будут храниться файлы кэша. Если параметр не указан, то по умолчанию файлы сохраняются в папку:
Примечание. У пользователя операционной системы, который будет работать с кэшированными данными, должны быть права на чтение/запись в указанную папку. |
MemoryThreshold | Порог свободной оперативной памяти, при превышении которого будет недоступен «прогрев» кэша, в процентах. Параметр типа REG_DWORD, допустимые значения: 0-100. По умолчанию параметр принимает значение «20», «прогрев» кэша доступен при загруженности оперативной памяти на 80% и ниже. |
MemLimitMb | Лимит используемой оперативной памяти в мегабайтах. Если параметр не задан, то, используются следующее ограничение: x64 - 5120 мб. |
CacheLimitMb |
Лимит дискового пространства, выделяемого для хранения кэша агрегированных данных. Значение указывается в мегабайтах. По умолчанию параметр не задан. Если параметр задан, то при превышении лимита будут удалены устаревшие/неиспользуемые данные кэша. Минимальный размер дискового пространства, который может быть выделен для хранения кэша агрегированных данных, равен 1024 мб. Примечание. Если размер кэша агрегированных данных превысил заданный лимит, но все агрегированные данные используются в текущий момент, то данные кэша будут очищены при следующей генерации кэша агрегированных данных. |
Threads | Количество потоков, в рамках которых будет осуществляться параллельная обработка данных при агрегировании. По умолчанию количество потоков равно количеству логических ядер процессора. |
AllowConv |
Признак хранения в кэше агрегированных данных, которые могут быть получены при агрегации фиксированных измерений. По умолчанию агрегированные данные не сохраняются в кэше. Для включения кэширования агрегированных данных задайте в параметре значение true, это позволит их быстро подгружать и не тратить время на повторные расчёты агрегатов при смене отметки, если исходные данные не менялись. При больших объёмах исходных данных первое кэширование агрегированных данных может занимать значительное время и существенно увеличить размер дискового пространства, которое будет занимать кэш. |
MatrixAggr |
Режим использования матричной агрегации. Матричная агрегация применяется, если при работе с кэшированными данными агрегированные значения не кэшируются в файлах, а каждый раз производится их расчёт в памяти. Допустимые значения:
|
OptimalThreshold |
Порог применения режима матричной агрегации. Параметр актуален, если параметру MatrixAggr установлено значение optimal. Во время работы вычисляется размер отметки (декартово произведение отмеченных элементов), переданной для произведения агрегации данных. Если полученный размер меньше значения, заданного в OptimalThreshold, то применяется матричная агрегация. Если размер отметки превышает значение OptimalThreshold, то будет производиться расчёт агрегированных значений и их кэширование в файловый кэш. По-умолчанию порог имеет значение 10000. Если параметру OptimalThreshold установить значение 0, то он учитываться не будет. |
PreloadData |
Признак предварительной загрузки данных из кэша в память при первом обращении к кубу. Если параметру установить значение true, то при первом обращении к любому кэшированному кубу происходит сканирование его кэша для полной загрузки в оперативную память. В результате этого первое использование куба будет медленным, а все последующие - максимально быстрыми. Может использоваться для реализации предзагрузки данных. По умолчанию параметру установлено значение false. Примечание. Предварительная загрузка производится до тех пор, пока не превышены объем оперативной памяти или значение параметра MemLimitMb. |
UseMemoryPool |
Признак использования пула новых страниц с кэшированными данными в памяти. Для использования пула установите параметру значение true. Использование пула может значительно ускорить работу при повышенной нагрузке, но также приведёт к повышенному расходу оперативной памяти. По умолчанию параметру установлено значение false, при этом пул страниц кэшированных данных не используется. |
В разделе [HKEY_CURRENT_USER] создаётся параметр, определяющий признак использования справочника в режиме кросс-сессионного кэша. Настройки применяются при работе текущего пользователя. Ветка, в которую сохраняются настройки: [HKCU\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\Dimensions]. Указанные настройки задаются на клиентских компьютерах, если используется настольное приложение, или на BI-сервере, если используется веб-приложение.
Также настройки могут быть заданы в разделе [HKEY_LOCAL_MACHINE], при этом они будут применяться для всех пользователей. Необходимо учитывать приоритет поиска настроек:
Раздел [HKEY_CURRENT_USER].
Раздел [HKEY_LOCAL_MACHINE].
Параметры | Описание |
Cache |
Признак использования справочника в режиме кросс-сессионного кэша. Параметр типа REG_DWORD. Допустимые значения:
|
В разделе [HKEY_CURRENT_USER] указываются настройки подключения к syslog-серверу для пересылки сообщений о событиях аудита. Настройки применяются при работе текущего пользователя. Ветка, в которую сохраняются настройки: [HKCU\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\SysLogServer]. Указанные настройки задаются на клиентских компьютерах, если используется настольное приложение, или на BI-сервере, если используется веб-приложение.
Также настройки могут быть заданы в разделе [HKEY_LOCAL_MACHINE], при этом они будут применяться для всех пользователей. Необходимо учитывать приоритет поиска настроек:
Раздел [HKEY_CURRENT_USER].
Раздел [HKEY_LOCAL_MACHINE].
Параметры | Описание |
Active |
Активация подключения к syslog-серверу для пересылки сообщений о событиях безопасности. Параметр типа REG_DWORD. Допустимые значения:
|
Host |
IP-адрес syslog-сервера. Строковый параметр. Доступен только протокол IPv4. Значение по умолчанию: 127.0.0.1. |
Port |
Порт syslog-сервера для входящих соединений. Параметр типа REG_DWORD. Значение по умолчанию: 202. Задаётся в шестнадцатеричной системе счисления. В settings.xml значение задаётся в десятичной системе счисления - 514. |
Protocol |
Протокол, используемый для передачи. Параметр типа REG_DWORD. Допустимые значения:
|
В разделе создаются параметры, используемые для расчёта алгоритма.
Параметры | Описание |
EtalonHashPath | Сохранение результата расчёта контрольной суммы библиотеки lpsolve55.dll для ОС Windows или liblpsolve55.so для ОС Linux. Параметр строкового типа. В качестве значения параметра задаётся полный путь до файла с результатом расчёта контрольной суммы. Параметр должен быть добавлен на локальных компьютерах всех пользователей. Для получения подробной информации об интеграции с LPSolve обратитесь к разделу «Подключение дополнительных модулей к «Форсайт. Аналитическая платформа». |
MsDump | Дополнительная отладочная информация при расчётах. Параметр типа REG_DWORD. Допустимые значения:
При включённой фильтрации по данным к полной информации об отметке будет добавлена информация о режиме расчёта в зависимости от того, есть ли в источниках фильтрации по данным куб-приёмник блока расчёта. Если нет, то будет применён многопоточный расчёт;
Важно. Параметр влияет на скорость расчёта алгоритма при выполнении сбора и вывода дополнительной отладочной информации. Параметр должен быть добавлен на локальных компьютерах всех пользователей. Для получения подробной информации о получении отладочной информации при расчётах обратитесь к разделу «Как просмотреть отладочную информацию при расчётах?». |
MsNumThreads | Изменение максимального числа потоков, по которым будет выполняться параллельный расчёт итераций, при расчёте блоков расчёта и/или контроля. По умолчанию при многопоточном расчёте используется максимум 8 потоков. Параметр типа REG_DWORD. Если заданное значение параметра меньше числа ядер процессора, то будет использоваться число потоков, заданное в параметре. Если заданное значение параметра больше числа ядер процессора, то будет использоваться число потоков, равное числу ядер. Примечание. При указании параметра учитывайте особенность архитектуры процессора Intel от 2019 года выпуска и выше. При расчёте итераций будет использоваться удвоенное число потоков относительно заданного значения параметра. Параметр должен быть добавлен на локальных компьютерах всех пользователей. Для получения подробной информации о многопоточном расчёте обратитесь к разделу «Как выполнять многопоточный расчёт?». |
MsUseRDSVersions | Использование различных версий значений элементов атрибута версионного справочника в формуле расчёта при поточечном расчёте всего алгоритма и/или конкретной формулы. Параметр типа REG_DWORD. Допустимые значения:
Важно. Использование параметра со значением «1» приводит к снижению производительности и продолжительному расчёту алгоритма. Параметр должен быть добавлен на локальных компьютерах всех пользователей. Для получения подробной информации о формулах расчёта обратитесь к разделу «Настройка формул расчёта». Примечание. Параметр доступен для использования только в настольном приложении. |
В разделе создаются параметры, используемые навигатором объектов.
Параметры | Описание |
RecursiveDeps | Признак использования рекурсивных запросов при получении зависимостей объектов репозитория. Актуально, если репозиторий создан на базе СУБД PostgreSQL/Postgres Pro или SQLite. Для других СУБД параметр игнорируется. Допустимые значения:
|
В ветке [HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\10.0] могут быть созданы отдельные параметры.
Параметры | Описание |
PlatformUserType | Ограничение доступа к элементам справочников НСИ с помощью диапазонов ключей, на основании которых пользователям присваиваются роли: вендор, партнёр, заказчик. Роль позволяет добавлять и редактировать элементы в справочнике НСИ в своём диапазоне ключей и в следующих диапазонах ключей, расположенных по возрастанию. Элементы с ключами из диапазона ключей, расположенных по убыванию, будут недоступны для изменений. Для получения подробной информации о правах доступа на элементы справочников НСИ обратитесь к разделу «Права доступа на элементы справочников НСИ». Параметр типа REG_DWORD. Допустимые значения:
Параметр должен быть добавлен на локальных компьютерах всех пользователей. Примечание. Параметр доступен для использования только в настольном приложении. |
VirtualMemoryThreshold | Порог использования виртуальной памяти, при превышении которого будет включен механизм очистки кэша метаданных объектов. Параметр типа REG_DWORD, допустимые значения: 0-100%. |
См. также:
Системные настройки продукта «Форсайт. Аналитическая платформа» | Настройки в settings.xml