Настройки в системном реестре

Все настройки BI-сервера в реестре сохраняются в разделе HKEY_LOCAL_MACHINE, в следующем подразделе:

Также в ветке HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0 могут быть созданы дополнительные подразделы или отдельные ключи, которые используются при работе как BI-сервера, так и настольного приложения «Форсайт. Аналитическая платформа»:

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

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

Пример файла реестра: settings_reg.zip.

Раздел System

В подразделе HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\PP\BIS\System\Session создаются параметры, влияющие на работу отдельных сессий с репозиториями:

Параметры

Описание

RWLockSlim

Блокировка доступа к открытым экземплярам объектов.
Допустимые значения:
0 (по умолчанию) - объект блокируется на запись;
1 - объект отдельно блокируется на чтение и запись, при этом возможно одновременное чтение из объекта несколькими потоками.

LockSession

Блокировка всей сессии при выполнении запросов. При включенной блокировке запросы ко всем объектам в рамках сессии будут выполняться последовательно, иначе параллельно или применяются индивидуальные блокировки (RWLockSlim).
Допустимые значения:
0 (по умолчанию)
- блокировка выключена;
1 - блокировка включена.

LockAd

Блокировка доступа к открытым экземплярам аналитических панелей. При включенной блокировке запросы на чтение/запись будут выполняться последовательно, иначе параллельно. Также при этом включается блокировка вложенных объектов, доступ к которым осуществляется с использованием моникера аналитической панели.
Доступные значения:
0 (по умолчанию) - блокировка выключена;
1 - блокировка включена.

SamplingStr

Включение сбора статистики по времени и памяти для счётчиков производительности.
Допустимые значения:
IsOn - включение сбора статистики;
Memory - измерять память, затрачиваемую на какие-либо действия;
Time - измерять время выполнения каких-либо действий;
Sql - сбор статистики по выполнению SQL-запросов к БД репозитория;
Cube - сбор статистики по выполнению кубов (построение матрицы куба в соответствии с переданной отметкой);
Pivot - сбор статистики по работе с основами для построения таблиц экспресс-отчетов;
Sheet - сбор статистики по работе таблиц с данными экспресс-отчетов;
Dim - сбор статистики по построению измерений, используемых в различных объектах репозитория;
Rub - сбор статистики по построению базы данных временных рядов (получение данных рядов в соответствии с заданным периодом);
Laner - сбор статистики по работе таблицы с данными рабочих книг;
Report - сбор статистики по вычислениям регламентных отчетов;
RepSheet - сбор статистики по вычислениям листов регламентных отчетов;
RepDataIsl - сбор статистики по вычислениям областей данных;
RepTabIsl - сбор статистики по вычислениям реляционных областей данных;
Fore - сбор статистики по работе макросов и обработчиков событий в регламентных отчетах.
Флаг IsOn указывается всегда, иначе сбор статистики производиться не будет. Через запятую указываются другие флаги, определяющие, какие именно счетчики необходимо задействовать. Указание только флага IsOn эквивалентно включению всех флагов.

Sampling

Включение сбора статистики по времени и памяти для счётчиков производительности.
Допустимые значения:
1 - Собирать статистику только по операциям (количество выполнений, время и т.д.);
On - Собирать всю статистику (по запросам, по операциям, по времени/по памяти). Данный параметр является устаревшим, используйте вместо него параметр SamplingStr.

SysLogMb

Идентификатор репозитория, в котором имеются системные таблицы для хранения собранной статистики (Создание системных таблиц для сбора статистики осуществляется с использованием утилиты PP.Util.exe).

TimeoutSec

Время ожидания при отсутствии запросов, по истечении которого сессия будет разорвана. Время указывается в секундах, в диапазоне [60, 127800]. При значении «-1» время ожидания не ограничено. По умолчанию - 1800.

Statable

Режим сохранения и восстановления состояний объектов на сервере состояний. Используется вместе с группой настроек StateServer.
Допустимые значения:
Never или 0 (по умолчанию) - не сохранять и не загружать состояния объектов;
Yes или 1 - сохранять при изменении, загружать при отсутствии в сессии;
Ever - сохранять при изменении, загружать всегда.

KeyIncr

Генерация последовательных моникеров сессий и объектов.
Допустимые значения:
0 (по умолчанию) - генерация моникеров через GUID;
Yes или 1 - генерация последовательных моникеров (например, S1!M).

StoreBins

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

StoreBinSize

Максимальный суммарный размер загруженных бинарных объектов в рамках сессии. По умолчанию размер указывается в байтах. Если после значения указать символ «B», «K» или «M» (англ.), то значение соответственно будет в байтах, килобайтах или мегабайтах. По умолчанию 0, при этом ограничение на загружаемый объем отсутствует.

PoolMaxConnections

 

Ограничение на количество соединений с базой данных репозитория.
Допустимые значения:
0 (по умолчанию) - не переиспользовать соединения, всегда создавать новое;
<0 -  переиспользовать без ограничения на количество (добавлять новое соединение, если нет свободных соединений);
>0 - переиспользовать с указанным в параметре ограничением на количество соединений.

Примечание. Параметр PoolMaxConnections является устаревшим, оставлен для совместимости с предыдущими версиями Prognoz Platform. Используйте параметр MaxConnections в подразделе реестра HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\PP\BIS\System\Pool.

Другие подразделы System для настройки BI-сервера:

Подраздел Параметры
HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\PP\BIS\System\Pool

В данном подразделе создаются параметры, влияющие на работу пула соединений, который будет использовать BI-сервер.

  • MaxConnections. Максимальное количество соединений в пуле. Возможные значения:
    • -1. По умолчанию. Без ограничения на количество соединений;
    • 0. Пул соединений выключен;
    • значение больше ноля. Задаёт максимальное количество соединений;
  • Strategy. Алгоритм вытеснения соединений из пула при необходимости освободить место для нового соединения.
    Допустимые значения:
    LRU - алгоритм вытеснения давно не используемых по времени соединений (LRU-алгоритм);
    Balance или Default - вытеснение по соотношению количество открытых репозиториев/количество открытых соединений с БД;
  • UserMaxConnections. Максимальное количество соединений, созданных с одинаковыми учетными данными. По умолчанию 0, при этом ограничение на количество соединений отсутствует.
  • RetryCount. Число попыток проверки занятости соединения. Допустимое значение - [1; 1600], по умолчанию - 160 попыток.
  • RetryInterval. Интервал между попытками проверки в миллисекундах. Допустимое значение - [10; 4000], по умолчанию - 400 миллисекунд.

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

  • Db. Параметры соединения для пользователя в следующем формате: {имя_пользователя}:{идентификатор_метабазы}@{сервер_бд};
  • UserMaxConnections. Максимальное количество соединений с указанным репозиторием под указанным пользователем.

Примечание. Параметры пула соединений применяются, если значение параметра MaxConnections больше нуля.

HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\PP\BIS\System\StateServer

Параметры подключения к серверу состояний.

  • Type. Тип сервера состояний. В зависимости от используемого программного обеспечения доступны следующие значения:
    MemCached (по умолчанию).
    Redis.
  • Host. Наименование или IP-адрес сервера состояний (по умолчанию - Localhost).
  • Port. Номер порта, через который будет осуществляться подключение (при значении «-1» используется порт по умолчанию: 11211 для MemCached и 6379 для Redis).
HKLM\Foresight\Foresight Analytics Platform\9.0\PP\BIS\System\Cert

В данном подразделе хранится закрытый ключ сертификата безопасности. Параметры этого подраздела реестра создаются при работе программы PP.Util.exe.

  • Alg. Алгоритм шифрования.
  • Data. Зашифрованный закрытый ключ сертификата безопасности.
  • Id. Идентификатор сертификата безопаности.
  • Key. GUID сертификата безопасности.

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

HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\PP\BIS\System\Mbs
SOFTWARE\Foresight\Foresight Analytics Platform\9.0

Параметры объектов для сбора статистики. В данном подразделе необходимо создать дополнительные подразделы с именами, равными идентификатору репозиториев. В каждом дополнительном подразделе может быть создан параметр:

  • StatKeys. Ключи отдельных объектов репозитория, указанные через запятую, при работе с которыми будут собираться счётчики производительности.
HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\PP\BIS\System\OAuth
SOFTWARE\Foresight\Foresight Analytics Platform\9.0

Параметры работы через протокол OAuth для аутентификации пользователей на сторонних серверах, поддерживающих данный протокол. Для настройки внутри OAuth создаются подразделы с именами OAuth-серверов. В каждом подразделе задаются необходимые специфические параметры. В текущей реализации доступны следующие параметры OAuth-серверов:

  • PPUserNameFormat. Формат имен пользователей (Пример: "oa-tw-%s");
  • consumerKey. Ключ зарегистрированного приложения;
  • consumerSecret. Секретный код зарегистрированного приложения.

Значения, указываемые в параметрах consumerKey и consumerSecret, могут будут получены после регистрации разрабатываемого приложения на необходимом OAuth-сервере. Данные параметры необходимы, чтобы после авторизации на OAuth сервере, BI-сервер смог проверить и авторизовать соответствующего пользователя в репозитории.

Если параметры consumerKey и consumerSecret не указываются, то используются внутренние настройки BI-сервера, при этом на OAuth-сервере должно быть зарегистрировано приложение на базе веб-приложения «Форсайт. Аналитическая платформа».

HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\PP\BIS\System\Dal
SOFTWARE\Foresight\Foresight Analytics Platform\9.0

Параметры выполнения SQL-запросов с использованием операций BI-сервера. Данные параметры влияют на работу BI-сервера, если он используется в качестве клиента для доступа к СУБД.

В текущей реализации доступен следующий флаг:

  • Allow. Разрешение выполнения SQL-запросов через BI-сервера. Допустимые значения:
    0 (по умолчанию) - выполнение SQL-запросов запрещено;
    1 - выполнение SQL-запросов разрешено.
HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\PP\BIS\System\Fore
SOFTWARE\Foresight\Foresight Analytics Platform\9.0

Параметры работы с объектами среды разработки.

  • Disallow. Признак запрета выполнения макросов, написанных на Fore/Fore.NET, с помощью операции ForeExec. При значении «1» выполнение макросов запрещено, проверка выполнения операции ForeExec осуществляется на стороне BI-сервера. Если установлено значение «0» или параметр отсутствует, то проверка осуществляется веб-приложением в соответствии со значением параметра foreExec в файле PP.xml.

Раздел Service

Подраздел Ключи
HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\Service\Epts

Подраздел, в котором указываются конечные точки к удаленным серверам. Для каждой точки создается подраздел с уникальным именем, в каждой из которых задается параметр:

  • address. Фактический адрес удаленного BI-сервера.

HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\Service\Mbs

Подраздел содержит настройки для репозиториев. Для настройки внутри Mbs создается подраздел с уникальным именем – идентификатором описания репозитория. В каждом подразделе создаются подразделы Cubes, а также параметр:

  • endpoint. Уникальное имя точки доступа из Epts. Указанная конечная точка будет использоваться для обращения за кэшированными данными при построении кубов репозитория. Если в качестве наименования указана пустая строка, то обращение будет производиться к текущему BI-серверу.

Подраздел Cubes

Подраздел содержит настройки для кубов репозитория, при работе с которыми будет осуществляться обращение за данными к удаленным BI-серверам. Для настройки создается подраздел с уникальным именем, в котором задаются следующие параметры:

  • Keys. Ключи кубов через запятую без пробелов.
  • endpoint. Уникальное имя точки доступа из раздела Epts.

Раздел InMem

В разделе HKEY_CURRENT_USER создаются параметры, определяющие режим работы кэширования данных кубов в файловом кэше. Настройки применяются при работе текущего пользователя. Ветка, в которую сохраняются настройки: HKCU\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\InMem. Работа с кэшем доступна только в рамках одного запущенного экземпляра продукта «Форсайт. Аналитическая платформа». Указанные настройки задаются на клиентских компьютерах, если используется настольное приложение, или на BI-сервере, если работа осуществляется в веб-приложении.

Также настройки могут быть заданы в разделе HKEY_LOCAL_MACHINE, при этом они будут применяться для всех пользователей. Необходимо учитывать приоритет поиска настроек:

  1. Settings.xml.

  2. Раздел HKEY_CURRENT_USER.

  3. Раздел HKEY_LOCAL_MACHINE.

Примечание. Все параметры должны иметь строковый тип.

Параметры

Описание

UseInMem Признак использования механизма кэширования данных кубов в файловом кэше. По умолчанию параметру установлено значение true, при этом механизм кэширования используется.
Если в параметре UseInMem задать значение false, то будет использоваться старый механизм кэширования. Принципы его работы описаны в статье «Кэширование > Старый механизм кэширования».
DataDir Путь к папке, в которой будут храниться файлы кэша. Если параметр не указан, то по умолчанию файлы сохраняются в папку:
  • Windows. «C:\ProgramData\Foresight\Foresight Analytics Platform\inmem_data\».
  • Linux. «/var/tmp/inmem_data».

Примечание. У пользователя операционной системы, который будет работать с кэшированными данными, должны быть права на чтение/запись в указанную папку.

MemLimitMb Лимит используемой оперативной памяти в мегабайтах. Если параметр не задан, то используется ограничение в 5120 мб.
Threads Количество потоков, в рамках которых будет осуществляться параллельная обработка данных при агрегировании. По умолчанию берётся количество ядер процессора, возвращаемое операционной системой.

AllowConv

Признак хранения в кэше агрегированных данных, которые могут быть получены при агрегации фиксированных измерений. По умолчанию агрегированные данные не сохраняются в кэше. Для включения кэширования агрегированных данных задайте в параметре значение true, это позволит их быстро подгружать и не тратить время на повторные расчёты агрегатов при смене отметки, если исходные данные не менялись. При больших объёмах исходных данных первое кэширование агрегированных данных может занимать значительное время и существенно увеличить размер дискового пространства, которое будет занимать кэш.

CacheLimitMb

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

Дополнительные ключи

Подраздел Ключ
HKLM\SOFTWARE\Foresight\Foresight Analytics Platform\9.0 VirtualMemoryThreshold. Порог использования виртуальной памяти, при превышении которого будет включен механизм очистки кэша метаданных объектов. DWORD-параметр, допустимые значения: 0-100%.

См. также:

Системные настройки продукта «Форсайт. Аналитическая платформа» | Settings.xml