PP.Util

PP.Util - это консольное приложение в составе «Форсайт. Аналитическая платформа», выполняющее различные вспомогательные действия при настройке BI-сервера. Приложение входит в состав продукта «Форсайт. Аналитическая платформа» и расположено:

Для запуска приложения в ОС Linux используйте скрипт PP.Util_start.sh. Один запуск приложения может выполнять только одно из выбранных действий. Необходимое действие выбирается путём указания соответствующего набора параметров.

./PP.Util_start.sh <набор параметров>

PP.Util.exe <набор параметров>

Запуск приложения PP.Util должен осуществляться под тем же пользователем, под которым будет выполняться работа BI-сервера.

Примечание. При установке BI-сервера на веб-сервер IIS по умолчанию пул приложения будет запускаться под учетной записью Network Service; при установке на веб-сервер Apache - сам веб-сервер Apache по умолчанию работает под учетной записью Local System. Для запуска приложения PP.Util из-под соответствующей учетной записи можно воспользоваться приложением PsExec, которое входит в пакет системных программ Windows Sysinternals. Для запуска выполните команду «psexec -i -u "nt authority\network service" cmd.exe», при этом будет запущена командная строка Windows под указанной учетной записью. Далее в командной строке выполните PP.Util с необходимым набором параметров.

Описание набора параметров

Для просмотра консольной справки по доступным наборам параметров в ОС Linux запустите приложение PP.Util без параметров. Необязательные параметры будут указаны в квадратных скобках. При указании набора параметров в синтаксисе приложения квадратные скобки не используются.

Набор параметров Описание Примеры
/save_cert cert_file metabase_id login [password]

Сохранение в системной таблице репозитория сертификата безопасности для аутентификации пользователей по сертификату.

  • cert_file. Абсолютный или относительный путь к файлу с сертификатом безопасности. Обязательный параметр;

  • metabase_id. Идентификатор репозитория. Обязательный параметр;

  • login. Имя пользователя для подключения к репозиторию. Обязательный параметр;

  • password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Примечание. Параметр /save_cert можно использовать в сокращенном виде - /ce.

/save_cert /tmp/server.cer REPOSITORY_ID USER_NAME USER_PASSWORD
/save_private_key key_file cert_id [enc_alg]

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

  • key_file. Абсолютный или относительный путь к файлу с закрытым ключом. Обязательный параметр;

  • cert_id. Идентификатор сертификата безопасности в репозитории. Обязательный параметр. Данный идентификатор будет получен после выполнения команды «/save_cert»;

  • enc_alg. Алгоритм шифрования, который будет применяться при шифровании файла с закрытым ключом перед сохранением в реестре:

    • gos. По умолчанию. Используется шифрование алгоритмом GOST R 34.11-2012;

    • pro. Используется шифрование с помощью Data Protection API (DPAPI) в ОС Windows. Данный алгоритм шифрования недоступен для ОС Linux;

    • sim. Данные закрытого ключа сохраняются в открытом виде без шифрования.

Важно. Для обеспечения безопасности в промышленной эксплуатации продукта «Форсайт. Аналитическая платформа» используйте значение gos или pro.

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

/save_private_key /tmp/server.key SERVER gos
/save_creds [/ALG enc_alg] metabase_id [/DC|/GC] login [password]

Сохранение учётных данных в настройках подключения к репозиторию. Учётные данные сохраняются в зашифрованном виде в подразделе реестра, где хранятся настройки подключения к репозиторию.

  • enc_alg. Алгоритм шифрования, который будет применяться при шифровании учётных данных:

    • gos. По умолчанию. Используется шифрование алгоритмом GOST R 34.11-2012;

    • pro. Используется шифрование с помощью Data Protection API (DPAPI) в ОС Windows. Данный алгоритм шифрования недоступен для ОС Linux;

    • sim. Учётные данные сохраняются в открытом виде.

Важно. Для обеспечения безопасности в промышленной эксплуатации продукта «Форсайт. Аналитическая платформа» используйте значение gos или pro.

Необязательный параметр. Если параметр не задан, то используется значение по умолчанию;

  • metabase_id. Идентификатор репозитория. Обязательный параметр;

  • /DC|/GC. Назначение учётных данных. Выберите один из способов:

    • /DC. Учётные данные для подключения к репозиторию по умолчанию;

    • /GC. Учётные данные для гостевого подключения к репозиторию.

Необязательный параметр. Если параметр не задан, то используются учётные данные пользователя, заданные в параметрах login и password;

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

  • login. Имя пользователя для подключения к репозиторию. Обязательный параметр;

  • password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Примечание. Параметр /save_creds можно использовать в сокращенном виде - /sc.

/save_creds REPOSITORY_ID /DC USER_NAME USER_PASSWORD
/iisdiag [/C] metabase_id login [password]

Проверка типовых проблем установки BI-сервера на IIS.

  • /C. Не проверять настройки, задаваемые в IIS, проверять только те настройки, которые производит инсталлятор при установке BI-сервера.

Необязательный параметр. Если параметр не задан, то выполняется проверка настроек, заданных в IIS, и настроек BI-сервера;

  • metabase_id. Идентификатор репозитория. Обязательный параметр;

  • login. Имя пользователя для подключения к репозиторию. Обязательный параметр;

  • password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

/iisdiag /C REPOSITORY_ID USER_NAME USER_PASSWORD
/create_svclog_tables database_id metabase_id login [password [db_login [db_password]]]

Создание системных таблиц репозитория для хранения лога выполнения операций. Таблицы создаются как на физическом уровне (на сервере СУБД), так и на уровне репозитория (объекты репозитория - Таблица).

  • database_id. Идентификатор объекта «База данных», на который будут настроены создаваемые в репозитории таблицы. Обязательный параметр;

  • metabase_id. Идентификатор репозитория, в котором будут созданы таблицы. Обязательный параметр;

  • login. Имя пользователя для подключения к репозиторию. Обязательный параметр;

  • password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме;

  • db_login. Имя пользователя для авторизации при подключении к базе данных, указанной в параметре database_id. Необязательный параметр. Если имя пользователя не указано, то он будет запрошен в интерактивном режиме;

  • db_password. Пароль пользователя для авторизации при подключении к базе данных, указанной в параметре database_id. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Примечание. Учётные данные db_login, db_password указываются, если это обусловлено настройками соответствующей базы данных в репозитории.

/create_svclog_tables OBJ_DB REPOSITORY_ID USER_NAME USER_PASSWORD DB_USER_NAME DB_USER_PASSWORD
/clear_svclog_tables metabase_id login [password [db_login [db_password]]]

Очистка системных таблиц репозитория с логами выполнения операций.

  • metabase_id. Идентификатор репозитория. Обязательный параметр;

  • login. Имя пользователя для подключения к репозиторию. Обязательный параметр;

  • password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме;

  • db_login. Имя пользователя для авторизации при подключении к базе данных, указанной в параметре database_id. Необязательный параметр. Если имя пользователя не указано, то он будет запрошен в интерактивном режиме;

  • db_password. Пароль пользователя для авторизации при подключении к базе данных, указанной в параметре database_id. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Примечание. Учётные данные db_login, db_password указываются, если это обусловлено настройками соответствующей базы данных в репозитории.

/clear_svclog_tables REPOSITORY_ID USER_NAME USER_PASSWORD DB_USER_NAME DB_USER_PASSWORD
/save_audit_creds [/ALG enc_alg] [/SCOPE scope] [realm|/DC] login [password]

 

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

  • enc_alg. Алгоритм шифрования, который будет применяться при шифровании учётных данных:

    • gos. По умолчанию. Используется шифрование алгоритмом GOST R 34.11-2012;

    • pro. Используется шифрование с помощью Data Protection API (DPAPI) в ОС Windows. Данный алгоритм шифрования недоступен для ОС Linux;

    • sim. Учётные данные сохраняются в открытом виде.

Важно. Для обеспечения безопасности в промышленной эксплуатации продукта «Форсайт. Аналитическая платформа» используйте значение gos или pro.

Необязательный параметр. Если параметр не задан, то используется значение по умолчанию;

  • scope. Способ сохранения учётных данных:

    • hkcu. Только для текущего пользователя.

В ОС Windows учётные данные будут храниться в ветке реестра текущего пользователя [HKEY_CURRENT_USER\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\Audit\Credentials\Item0] и доступны для использования только текущему пользователю на компьютере.

В ОС Linux учётные данные будут храниться в файле registry.reg, расположенном в каталоге по умолчанию. Каталог по умолчанию зависит от указания переменой окружения HOME в файле /etc/opt/Foresight/fp9.x-biserver/envvars:

      • если переменная задана, то файл будет расположен в каталоге $HOME/.config/Foresight/Foresight Analytics Platform/registry;

      • если переменная не задана, то файл будет расположен в каталоге /root/.config/Foresight/Foresight Analytics Platform/registry для Debian-подобных дистрибутивов или /usr/share/httpd/.config/foresight/Foresight Analytics Platform/registry для RedHat-подобных дистрибутивов;

    • hklm. Для всех пользователей.

В ОС Windows учётные данные будут храниться в ветке реестра локальной машины [HKEY_LOCAL_MACHINE\SOFTWARE\Foresight\Foresight Analytics Platform\9.0\Audit\Credentials\Item0] и доступны для использования всем пользователям на компьютере.

В ОС Linux учётные данные будут храниться в файле registry.reg, расположенном в каталоге /opt/Foresight/fp9.x-biserver/bin;

В ОС Windows учётные данные будут храниться в файле settings.xml, расположенном по пути %PROGRAMDATA%\Foresight\Foresight Analytics Platform.

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

В ОС Linux учётные данные будут храниться в файле settings.xml, расположенном в созданном каталоге. Каталог зависит от указания переменой окружения HOME в файле /etc/opt/Foresight/fp9.x-biserver/envvars:

      • если переменная задана, то файл будет расположен в каталоге $HOME/.config/Foresight/Foresight Analytics Platform;

      • если переменная не задана, то файл будет расположен в каталоге /var/www/.config/Foresight/Foresight Analytics Platform для Debian-подобных дистрибутивов или /usr/share/httpd/.config/foresight/Foresight Analytics Platform для RedHat-подобных дистрибутивов.

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

Важно. При сохранении учётных данных служебного пользователя в файл settings.xml в ОС Linux выполните предварительные действия, указанные ниже, для раздачи прав доступа к файлу.

Необязательный параметр. Если параметр не задан, то используется значение по умолчанию;

  • realm|/DC. Область действия учётных данных служебного пользователя. Выберите один из способов:

Примечание. При настройке подключения к репозиторию на каждом клиентском компьютере или на компьютере с установленным BI-сервером IP-адрес или псевдоним сервера должен совпадать с сервером, указанным в параметре SERVER_DATABASE.

      • TYPE. Тип используемого драйвера. Допустимы следующие значения: «POSTGRES», «MSSQL», «ORCL»;

Например: "127.0.0.1|POSTGRES".

Примечание. Для избежания синтаксических ошибок значение задаётся в верхних двойных кавычках.

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

Обязательный параметр;

  • login. Имя существующего служебного пользователя. Обязательный параметр;

  • password. Пароль существующего служебного пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

При сохранении созданных учётных данных служебного пользователя в файл settings.xml в ОС Linux выполните предварительные действия для раздачи прав доступа к файлу:

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

    • если переменная HOME задана:

sudo mkdir -p "$HOME/.config/Foresight/Foresight Analytics Platform"

    • если переменная HOME не задана:

sudo mkdir –p "/var/www/.config/Foresight/Foresight Analytics Platform"

  1. Назначьте владельцем каталога пользователя www-data с помощью команды:

    • если переменная HOME задана:

sudo chown -R www-data:www-data "$HOME/.config/Foresight/Foresight Analytics Platform"

    • если переменная HOME не задана:

sudo chown -R www-data:www-data "/var/www/.config/Foresight/Foresight Analytics Platform"

Указанный пример применим для раздачи прав в Ubuntu. При работе в других дистрибутивах ОС Linux замените «www-data:www-data» на значение из таблицы:

Имя пользователя:Группа Дистрибутив ОС Linux
www-data:www-data Ubuntu, Astra Linux SE 1.7
apache:apache RedHat-подобные дистрибутивы, ALT Linux

  1. Запустите утилиту PP.Util от имени пользователя www-data, daemon или apache, и сохраните учётные данные служебного пользователя. Пример команды:

sudo -u <имя пользователя> PP_NODISPLAY=1 /opt/Foresight/fp9.x-biserver/bin/PP.Util /sac /SCOPE file "SERVER_DATABASE|POSTGRES" SERVICE_USER_NAME SERVICE_USER_PASSWORD

Где:

    • SERVER_DATABASE. IP-адрес или псевдоним, под которым зарегистрирован сервер базы данных;

    • SERVICE_USER_NAME. Имя служебного пользователя;

    • SERVICE_USER_PASSWORD. Пароль служебного пользователя.

  1. Перезапустите сервер Apache в зависимости от операционной системы:

    • для RedHat-подобных дистрибутивов:

sudo systemctl restart httpd-fp9.x

    • для Ubuntu, Astra Linux SE 1.7:

sudo systemctl restart apache2-fp9.x

    • для ALT Linux:

sudo systemctl restart httpd2-fp9.x

После выполнения действий учётные данные служебного пользователя будут сохранены в файл settings.xml.

Примечание. Параметр /save_audit_creds можно использовать в сокращенном виде - /sac.

Для получения подробной информации обратитесь к разделу «Создание служебного пользователя».

В ОС Windows:

/save_audit_creds /SCOPE hkcu "10.30.210.10|POSTGRES" SERVICE_USER_NAME SERVICE_USER_PASSWORD

В ОС Linux:

/save_audit_creds /DC SERVICE_USER_NAME SERVICE_USER_PASSWORD
/create_audit_user metabase_id login password audit_login audit_password [db_login [db_password]]

Создание учётных данных служебного пользователя подсистемы безопасности на сервере базы данных.

/create_audit_user REPOSITORY_ID USER_NAME USER_PASSWORD SERVICE_USER_NAME SERVICE_USER_PASSWORD
/encrypt_creds login [password]

Шифрование имени пользователя и пароля с использованием алгоритма GOST R 34.11-2012 и вывод полученных значений в консоль. Результатом работы команды будет пара атрибутов: Crs и Crsa. Данные атрибуты с зашифрованными учётными данными могут использоваться в файле Settings.xml при настройке подключения к службе каталогов LDAP-сервера.

  • login. Имя пользователя. Обязательный параметр;

  • password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Примечание. Параметр /encrypt_creds можно использовать в сокращенном виде - /ec.

/encrypt_creds User NewPassword

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

См. также:

Приложения в составе продукта «Форсайт. Аналитическая платформа»