Базовые настройки веб-приложения

Для задания базовых настроек веб-приложения используется файл PP.xml. Данный файл может быть расположен в двух местах:

Примечание. Если файл PP.xml расположен и в папке веб-приложения и на BI-сервере, то настройки из файла BI-сервера имеют больший приоритет, чем такие же настройки в файле веб-приложения.

Задание настроек в веб-приложении

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

Где S - путь, по которому установлено веб-приложение.

Например, для Windows:

Java (Apache Tomcat): C:\Tomcat\webapps\pp\config\PP.xml

ASP.NET (IIS/Apache): C:\Program Files\JSC Prognoz\Prognoz Platform 8 Web Application\Config\PP.xml

Для Linux:

Java (Apache Tomcat): /var/lib/tomcat7/webapps/pp/config

Apache: /opt/prognoz/pp8.2-dhtml/config

Совет. Если настройки веб-приложения будут задаваться на BI-сервере, в файле PP.xml веб-приложения достаточно задать путь к BI-серверу.

Задание настроек на BI-сервере

Для задания базовых настроек веб-приложения на BI-сервере создайте файл PP.xml в папке «S\Services\PP.SOM.Som\», где S - путь, по которому установлен BI-сервер.

Базовые настройки

Настройки, указываемые в PP.xml, также могут быть заданы через поля статического класса PP.AppConfig. Файл PP.xml должен состоять из раздела <pp>, содержащего дочерние элементы, приведенные в таблице.

Раздел Описание Атрибуты
<service> Параметры BI-сервера. url. Путь к BI-серверу.
По умолчанию путь к серверу прописывается инсталлятором веб-приложения:
http://<Server>[:<Port>][/<VirtualCatalog>]/axis2/services/PP.SOM.Som
Где:

  • <Server> - наименование или IP-адрес сервера, на котором функционирует BI-сервер;

  • <Port> - номер порта, через который будет осуществляться работа;

  • <VirtualCatalog> - виртуальный каталог BI-сервера, созданный инсталлятором.

Примечание. На x64 компьютерах наименование виртуального каталога может содержать постфикс - x64.

timeout. Время ожидания выполнения запроса на стороне клиента (в миллисекундах). Если значение атрибута не задано или установлено значение 0 или меньше 0, будет использоваться значение по умолчанию - 90000 мс.
foreExec. Признак возможности выполнения макросов, написанных на Fore/Fore.NET, с помощью операции ForeExec.
Возможные значения:

  • true. Имеется возможность выполнять макросы с помощью операции ForeExec.

  • false. Значение по умолчанию. Выполнение макросов запрещено.

Примечание. При установке параметру foreExec значения true для запрета выполнения операции ForeExec будет формироваться специальный параметр в заголовке запросов. Наличие данного параметра не является надежным способом запрета выполнения операции. Рекомендуется использовать параметр Disallow в настройках реестра или файла Settings.xml.

ppServiceUrl. Путь к BI-серверу в случае использования веб-приложения без его серверной части. При использовании этого атрибута все запросы от браузера с открытым веб-приложением будут выполняться напрямую к BI-серверу.
Для работы атрибута возможно потребуется обнуление кэша, используя команду PP.App.deleteStorage("config").
<metabase> Параметры используемого репозитория. Id. Идентификатор репозитория, из списка установленных репозиториев на BI-сервере, к которому будет выполняться подключение.
ping. Время, через которое выполняется проверка соединения с BI-сервером (в миллисекундах).
recentObjects. Настройка отображения последних открытых объектов в окне приветствия. Возможные значения:

  • true. Значение по умолчанию. Объекты отображаются;

  • false. Объекты не отображаются.

authentication. Способ авторизации:

  • Login. Значение по умолчанию. Вход через окно регистрации;

  • Domain. Вход через доменную авторизацию;

  • IntegratedDomain. Вход через интегрированную доменную авторизацию;

  • OAuth. Вход по протоколу OAuth (Twitter);

  • SAML2. Вход по протоколу SAML2;

  • Guest. Гостевой вход.

sessionCookie. Возможность переиспользования созданных сессий с репозиторием. Возможные значения:

  • true. Значение по умолчанию. Переиспользовать сессию, если она была создана ранее. Необходимыми условиями для переиспользования являются: корректные логин и пароль; сессия должна существовать на сервере; существующая сессия была создана именно для указанного пользователя;

  • false. Не переиспользовать сессию, всегда создавать новую.
<shareSettings> Параметры публикации данных из веб-приложения в различных веб-сервисах.
Раздел может содержать один или несколько вложенных элементов <shareItem>.		 enabled. Признак доступности публикации данных из веб-приложения. Возможные значения:

  • true. Публикация доступна;

  • false. Публикация недоступна.
<shareItem> Доступность публикации данных в различных сервисах.

name. Наименование сервиса;

enabled. Признак доступности публикации данных из веб-приложения. Возможные значения:

  • true. Публикация доступна;

  • false. Публикация недоступна.
<cultures> Языки, на которых доступно веб-приложение. Раздел может содержать один или несколько вложенных элементов <culture>. Выбор языка интерфейса осуществляется в окне регистрации.

Каждый подраздел <culture> имеет следующие атрибуты:

cultureName. Сокращенное наименование языка. Возможные значения:

  • ar. Арабский;

  • ar-AE. Арабский (Объединенные Арабские Эмираты);

  • az. Азербайджанский;

  • de. Немецкий;

  • en. Английский;

  • es. Испанский;

  • fr. Французский;

  • it. Итальянский;

  • kk. Казахский;

  • pt. Португальский;

  • ru. Русский;

  • uk. Украинский;

  • zh-CN. Китайский.

Примечание. Перевод приложения на казахский и азербайджанский языки может быть неполным.
<сhart> Параметр, определяющий общие настройки диаграмм. animation. Определяет, будет ли при отрисовке диаграммы использоваться анимация. Возможные значения:

  • true. Анимация используется;

  • false. Значение по умолчанию. Анимация не используется.

enableCanvas. Определяет, будет ли отображаться на боковой панели флажок «Масштабирование оси категорий». Возможные значения:

  • true. Флажок отображается;

  • false. Значение по умолчанию. Флажок не отображается.
<discussConfig> Настройки раскрывающегося меню «Поделиться».

enableResize. Определяет, можно ли изменять размер раскрывающегося меню. Возможные значения:

  • true. Размер можно изменять;

  • false. Размер нельзя изменять.

facebookItem. Настройки пункта меню «Facebook». Возможные атрибуты:

  • columnIndex/rowIndex. Индекс столбца/строки, в котором расположена картинка для пункта меню в спрайте;

  • data. Наименование пункта меню;

  • resourceKey. Ключ ресурса;

  • visible. Определяет видимость пункта меню (true - отображается, false - не отображается);

  • focusOnOpen. Определяет, будет ли установлен фокус на пункте меню при открытии (true - отображается, false - не отображается);

googlePlusItem. Настройки пункта меню «GooglePlus». Аналогичны настройкам facebookItem (см. выше);

items. Массив пунктов меню;

linkedInItem. Настройки пункта меню «LinkedIn». Аналогичны настройкам facebookItem (см. выше);

liveJournalItem. Настройки пункта меню «LiveJournal». Аналогичны настройкам facebookItem (см. выше);

twitterItem. Настройки пункта меню «LiveJournal». Аналогичны настройкам facebookItem (см. выше).
<modules> Настройки модулей веб-приложения. Может содержать подраздел с настройками инструмента «Аналитические панели» - <dashboard>. Подраздел <dashboard> имеет следующие атрибуты:
reportBox. Описание настроек инструмента. Возможные атрибуты:

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

    • true. Плагины доступны;

    • false. Плагины недоступны;

  • autoLayoutByDefault. Признак использования автоматического размещения объектов по умолчанию. Возможные значения:

    • true. По умолчанию используется автоматическое размещение объектов;

    • false. По умолчанию используется ручное размещение объектов;

  • biSearchEnabled. Признак доступности BI-поиска. Возможные значения:

    • true. BI-поиск доступен;

    • false. BI-поиск недоступен.
<oauthService> URL-адрес OAuth-сервиса, через который производится авторизация (в случае авторизации через Twitter).

enabled. Признак авторизации через OAuth-сервер:

  • true. Авторизация включена;

  • false. Авторизация выключена.
<plugins> Раздел с определением дополнительных скриптов, подключаемых в виде плагинов. Содержит один или несколько подразделов <plugin>. Каждый подраздел <plugin> имеет следующие атрибуты:

  • name. Имя плагина;

  • path. Путь, по которому расположен скрипт плагина.

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

<plugin name="ChartTemplates" path="../build/ChartTemplates.js"></plugin>

2. Плагин с настройками внешних картографических сервисов. Настройки каждого сервиса содержатся в отдельном элементе, имеющем следующие атрибуты:

name. Наименование сервиса. Доступные значения:

  • Yandex;

  • Bing;

  • ArcGis;

  • OpenStreetMap;

  • Google.

path. Путь до файла MapPlugins.js. Рекомендуется поместить файл в папку «build» установленного веб-приложения.
<samlUrl> URL-адрес провайдера идентификации по протоколу SAML 2.0.  
<sourceTypes> Типы источников данных, доступных в веб-приложении. items. Массив источников данных, которые могут использоваться в веб-приложении.
<tabSheet> Настройки таблиц в веб-приложении. enableNativeContextMenu. Определяет, будет ли доступно для таблицы контекстное меню браузера. Возможные значения:

  • true. Контекстное меню браузера доступно;

  • false. Контекстное меню браузера недоступно (по умолчанию).

enableSelection. Определяет, будет ли доступно выделение ячеек таблицы вручную. Возможные значения:

  • true. Выделение доступно (по умолчанию);

  • false. Выделение недоступно.

Примечание. Для того чтобы внесенные изменения вступили в силу требуется перезапустить BI-сервер и веб-сервер, используемый веб-приложением.

Пример файла PP.xml:

<?xml version="1.0" encoding="utf-8" ?>

<pp>

      <service url="http://localhost:8080/PPBI_App_v8/axis2/services/PP.SOM.Som" timeout="120000" foreExec="true"/>

      <metabase id="PPRepository" ping="120000" recentObjects="false" />

      <shareSettings enabled="true">

            <shareItem name="GooglePlus" enabled="false" />

      </shareSettings>

      <cultures>

            <culture cultureName="ru" />

            <culture cultureName="en" />

      </cultures>

      <publishMobile enabled="true" url="http://mobileserv.prognoz.ru/ppmobile_app_v8" />

<chart animation="true"/>

     <modules>
          <dashboard>

               <reportBox servicesPlugins="true"/>

          </dashboard>
          <timeSeries enabled="true"/>
     </modules>

<plugins>

      <plugin name="Yandex" path="../build/MapPlugins.js" />

      <plugin name="Bing" path="../build/MapPlugins.js" />

      <plugin name="ArcGis" path="../build/MapPlugins.js" />

      <plugin name="OpenStreetMap" path="../build/MapPlugins.js" />

      <plugin name="Google" path="../build/MapPlugins.js" />

      <plugin name="ChartTemplates" path="../build/ChartTemplates.js"/>

</plugins>

</pp>

См. также:

Установка и настройка BI-сервера | Открытие веб-приложения