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

Все настройки 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 - пул соединений выключен;
значение больше ноля - пул соединений включен, задано максимальное количество соединений (по умолчанию установлено ограничение на 50 соединений);

  • 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

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

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

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

  • OAuth 1.1:

    • PPUserNameFormat. Формат имен пользователей, например, «oa-tw-%s»;

    • ConsumerKey. Ключ зарегистрированного приложения;

    • ConsumerSecret. Секретный код зарегистрированного приложения;

  • OAuth 2.0:

    • PPUserNameFormat. Формат имен пользователей, например, «oa-ggl-%s»;

    • ConsumerKey. Ключ зарегистрированного приложения;

    • ConsumerSecret. Секретный код зарегистрированного приложения;

    • AuthUrl. Адрес сервиса авторизации, который будет использоваться в веб-приложении для параметра RequestTokenUrl;

    • RequestTokenUrl. Адрес сервиса авторизации, по которому будет возвращаться токен доступа;

    • RequestCallbackParam. Наименование атрибута, через который будет передаваться адрес для переадресации пользователя после авторизации в веб-приложении, например, «redirect_uri»;

    • UserDataUrl. Адрес сервиса данных, по которому будут возвращаться данные о пользователе после авторизации в веб-приложении;

    • UserIdAttr. Путь до поля в запрашиваемых данных, которое будет использоваться в качестве уникального идентификатора пользователя, например, «/path/to/id»;

    • UserNameAttr. Путь до поля в запрашиваемых данных, которое будет использоваться в качестве отображаемого имени пользователя, например, «/path/to/displayName».

При настройке подключения к репозиторию под конкретным пользователем, который проходил авторизацию на внешнем сервере, значения в параметрах UserIdAttr и UserNameAttr могут совпадать.

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

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

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

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

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

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

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

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

Раздел Service

В данном разделе указываются адреса удаленных BI-серверов для извлечения и кэширования данных из репозитория. BI-сервер с веб-приложением будет обращаться к удаленным BI-серверам и получать поток с необходимыми данными без дополнительного обращения к СУБД.

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

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

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

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

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

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

Раздел 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 Признак использования механизма In-Memory для кэширования данных кубов, в том числе кубов ADOMD и баз данных временных рядов в файловом кэше. По умолчанию параметр принимает значение true, механизм кэширования используется.
CacheDims Признак использования механизма In-Memory для кэширования данных справочников. По умолчанию параметр отсутствует и используется механизм кэширования объектов репозитория. Для кэширования справочников с использованием механизма In-Memory создайте параметр и установите ему значение true.

Примечание. Параметр может принимать значение true, если параметр UseInMem принимает значение true. Если параметр UseInMem принимает значение false, то для параметра CacheDims автоматически устанавливается значение false.

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

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

MemLimitMb Лимит используемой оперативной памяти в мегабайтах. Если параметр не задан, то, в зависимости от разрядности операционной системы, используются следующие ограничения: x86 - 1024 мб; x64 - 5120 мб.

Примечание. Для x86 систем объем 1024 мб является максимально возможным для использования.

CacheLimitMb

Лимит дискового пространства, выделяемого для хранения кэша агрегированных данных. Значение указывается в мегабайтах. По умолчанию параметр не задан. Если параметр задан, то при превышении лимита будут удалены устаревшие/неиспользуемые данные кэша. Минимальный размер дискового пространства, который может быть выделен для хранения кэша агрегированных данных, равен 1024 мб.

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

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

AllowConv

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

MatrixAggr

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

Допустимые значения:

  • false. Матричная агрегация отключена. Режим не предназначен для использования в промышленных условиях;
  • true. Значение по умолчанию. Матричная агрегация применяется для всех видов агрегаций, кроме агрегаций, которые рассчитываются для выхода по умолчанию в стандартных кубах. Для выхода по умолчанию в стандартных кубах агрегированные данные будут кэшироваться и дальнейшая работа будет производиться с кэшированными значениями.
  • force. Не использовать кэшированные агрегированные значения, производить принудительный расчёт всех видов агрегаций в памяти. Режим не предназначен для использования в промышленных условиях;
  • optimal. Поведение как при значени true, но если есть возможность кэшировать расчитанные агрегированные значения, то кэширование будет произведено и в дальнейшая работа производится с данными из кэша. Особенностью режима является агрегация, когда по одному или нескольким измерениям задана пользовательская альтернативная иерархия - в этом случае кэшируется только агрегация по измерениям с собственной иерархией элементов, а агрегация по измерениям с альтернативной иерархией расчитывается поверх результатов кэшированной агрегации в отдельной стадии расчёта.

OptimalThreshold

Порог применения режима матричной агрегации. Параметр актуален, если параметру MatrixAggr установлено значение optimal.

Во время работы вычисляется размер отметки (декартово произведение отмеченных элементов), переданной для произведения агрегации данных. Если полученный размер меньше значения, заданного в OptimalThreshold, то применяется матричная агрегация. Если размер отметки превышает значение OptimalThreshold, то будет производиться расчёт агрегированных значений и их кэширование в файловый кэш.

По-умолчанию порог имеет значение 10000. Если параметру OptimalThreshold установить значение 0, то он учитываться не будет.

PreloadData

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

Если параметру установить значение true, то при первом обращении к любому кэшированному кубу происходит сканирование его кэша для полной загрузки в оперативную память. В результате этого первое использование куба будет медленным, а все последующие - максимально быстрыми. Может использоваться для реализации предзагрузки данных.

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

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

UseMemoryPool

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

По умолчанию параметру установлено значение false, при этом пул страниц кэшированных данных не используется.

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

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

См. также:

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