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

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

Где S - путь, по которому установлена серверная часть веб-приложения. Наличие файла PP.xml по указанному расположению обязательно.

Путь для Windows Путь для Linux

ASP.NET (IIS) и Apache:

C:\Program Files\Foresight\Analytics Platform 9.x Web Application\Config

Java (Apache Tomcat):

C:\Tomcat\webapps\pp\config

Java (Apache Tomcat):

/var/lib/tomcat7/webapps/pp/config

Apache:

/opt/Foresight/fp9.x-webserver/config

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

Файл PP.xml должен состоять из раздела <pp>, содержащего дочерние разделы с настройками.

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

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

Параметры подключения к BI-серверу задаются в разделах:

Примечание. Для корректной работы обязательно должен быть задан атрибут url в разделе <service> или в разделе <proxy>. Если данный атрибут задан в обоих разделах, то атрибут url из раздела <service> имеют более высокий приоритет, чем атрибут url из раздела <proxy>.

Описание разделов

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

Раздел может содержать следующие атрибуты:

Атрибуты	Описание
url	Путь к BI-серверу. Примечание. Обязательный атрибут. Путь указывается в формате: http://Server[:Port][/VirtualCatalog]/axis2/services/PP.SOM.Som Где: Server. Наименование или IP-адрес сервера, на котором функционирует BI-сервер; Port. Номер порта, через который будет осуществляться работа; VirtualCatalog. Виртуальный каталог BI-сервера, созданный инсталлятором. Указывается, если BI-сервер установлен на веб-сервер IIS или в ОС Linux.
timeout	Время ожидания выполнения запроса на стороне клиента в миллисекундах. Если значение атрибута не задано или установлено значение 0 или меньше 0, то будет использоваться значение по умолчанию - 90000 мс.
foreExec	Определяет, разрешено ли выполнение макросов, написанных на Fore, с помощью операции ForeExec. Возможные значения: true. Разрешено выполнять макросы с помощью операции ForeExec. false. Значение по умолчанию. Выполнение макросов запрещено. В заголовке запросов будет формироваться специальный параметр. Наличие данного параметра не является надежным способом запрета выполнения макросов с помощью операции ForeExec. Надёжным способом является использование параметра Disallow в настройках реестра или файле Settings.xml.

Пример раздела:

<pp>
    <service url="http://10.30.208.20/fpBI_App_v9.x/axis2/services/PP.SOM.Som" timeout="600000" foreExec="true"/>

…
</pp>

В результате для работы веб-приложения будет использоваться BI-сервер, расположенный по адресу «http://10.30.208.20/fpBI_App_v9.x/axis2/services/PP.SOM.Som». Время ожидания запроса на стороне клиента - 600000 миллисекунд, выполнение макросов с помощью операции ForeExec разрешено. Запросы из браузера будут идти напрямую, в обход серверной части веб-приложения.

Параметры BI-сервера с возможностью выполнения запросов через серверную часть веб-приложения: PPService.axd.

Раздел может содержать следующие атрибуты:

Атрибуты

Описание

url

Путь к BI-серверу. Путь указывается в формате:

http://Server[:Port][/VirtualCatalog]/axis2/services/PP.SOM.Som

Где:

Server. Наименование или IP-адрес сервера, на котором функционирует BI-сервер;
Port. Номер порта, через который будет осуществляться работа;
VirtualCatalog. Виртуальный каталог BI-сервера, созданный инсталлятором.

Атрибут url является обязательным, если используется веб-сервер Internet Information Services на базе ОС Windows. Запросы через PPService.axd будут перенаправляться на указанный BI-сервер.

Если веб-сервер развёрнут на базе ОС Linux, то значение атрибута url не учитывается. Все запросы отправляются на PPService.axd. Далее запросы перенаправляются в соответствии с настройками, которые заданы в файле конфигурации Apache2. Для указания адреса BI-сервера, на который необходимо перенаправить запросы, может быть использована переменная PP_SOM. Данная переменная добавляется в файл envvars при установке серверной части и используется в файле конфигурации Apache2.

Пример раздела:

<pp>
    <proxy url="http://websrv/fpBI_App_v9.x/axis2/services/PP.SOM.Som"/>

…
</pp>

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

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

Настройки веб-приложения задаются в разделах:

Примечание. Для корректной работы обязательно должен быть задан раздел <metabase>.

Описание разделов

Параметры используемого репозитория.

Раздел может содержать следующие атрибуты:

Атрибуты	Описание
id	Идентификатор репозитория. Примечание. Обязательный атрибут. Для указанного репозитория обязательно должны быть заданы настройки подключения с помощью диалога «Настройка подключения к репозиторию». Обратите внимание, что в настройках репозитория в данном диалоге должен быть установлен флажок «Для всех пользователей на компьютере». Примечание. Для репозитория на основе SQLite работа с продуктом «Форсайт. Аналитическая платформа» доступна только в настольном приложении в однопользовательском режиме.
ping	Время, через которое выполняется проверка соединения с BI-сервером в миллисекундах.
recentObjects	Определяет, отображается ли список «Недавние документы» в окне приветствия. Возможные значения: true. Значение по умолчанию. Список отображается; false. Список не отображается.
authentication	Способ авторизации. Возможные значения: Login. Значение по умолчанию. Вход через окно регистрации; Domain. Вход через доменную авторизацию; IntegratedDomain. Вход через интегрированную доменную авторизацию; OAuth. Вход по протоколу OAuth 2.0. Если используется данное значение, то обязательно должен быть задан раздел <oAuthService>: <oAuthService enabled="true"/> Также должны быть выполнены настройки, описанные в статье «Настройка входа через OAuth». Guest. Гостевой вход. Примечание. При авторизации в веб-приложении тип аутентификации определяется настройками BI-сервера. Если в файле PP.xml в разделе <metabase> заданы репозиторий по умолчанию с помощью атрибута id и тип аутентификации с помощью атрибута authentication, то для данного репозитория будет применяться заданный тип аутентификации независимо от настроек BI-сервера. Для получения подробной информации о настройках BI-сервера в ОС Windows и Linux обратитесь к разделам «Настройка списка репозиториев», «Конфигурация и настройка».
async	Определяет, каким образом будет выполняться отправление запросов на сервер. Возможные значения: true. Значение по умолчанию. Запросы отправляются асинхронно; false. Запросы отправляются синхронно. Примечание. При работе с Apache PreFork на Astra Linux для интегрированной доменной авторизации и мандатных меток безопасности в текущей сессии рекомендуется использовать синхронные запросы.
sessionCookie	Возможность переиспользования созданных сессий с репозиторием. Возможные значения: true. Значение по умолчанию. Переиспользовать сессию, если она была создана ранее. Необходимыми условиями для переиспользования являются: корректные логин и пароль; сессия должна существовать на сервере; существующая сессия была создана именно для указанного пользователя; false. Не переиспользовать сессию, всегда создавать новую.

Пример раздела:

<pp>
…
    <metabase id="QA_Reports" ping="110000" recentObjects="false" authentication="Guest" sessionCookie="false"/> 
…
</pp>

В результате будет использоваться репозиторий с идентификатором QA_Reports без переиспользования созданных сессий с репозиторием. Для авторизации будет использоваться гостевой вход. В окне приветствия не будет отображаться список «Недавние документы», а проверка соединения с BI-сервером будет проверяться через 110000 миллисекунд.

Настройки входа по протоколу OAuth 2.0. Для авторизации по протоколу OAuth 2.0 в разделе <metabase> в атрибуте authentication должно быть указано значение «OAuth» и выполнены настройки, описанные в статье «Настройка входа через OAuth».

Раздел может содержать следующие атрибуты:

Атрибуты	Описание
enabled	Определяет, используется ли вход по протоколу OAuth 2.0. Возможные значения: true. Используется вход по протоколу OAuth; false. Не используется вход по протоколу OAuth.
useDefaultUserOauth	Определяет, под каким пользователем происходит аутентификация на сервере базы данных при использовании протокола OAuth 2.0: под пользователем по умолчанию или под конкретным пользователем, соответствующим пользователю, который проходил авторизацию на внешнем сервере. Необязательный атрибут. Если атрибут не указан, используется значение по умолчанию. Возможные значения: true. Используется по умолчанию. Аутентификация на сервере базы данных выполняется под пользователем по умолчанию, учётные данные которого были сохранены с помощью утилиты PP.Util; false. Аутентификация на сервере базы данных выполняется под конкретным пользователем, соответствующим пользователю, который проходил авторизацию на внешнем сервере. Если используется данное значение, то учётные данные каждого пользователя для каждого репозитория должны быть сохранены с помощью утилиты PP.Util. Для подробной информации о сохранении учётных данных пользователя обратитесь к статье «Настройка входа через OAuth». Также необходимо настроить параметры протокола OAuth 2.0.
allowOauthProviders	Перечисление сервисов авторизации, учётные записи которых можно использовать для входа в веб-приложение. Атрибут задаётся только при авторизации пользователей через OAuth. Значения указываются в квадратных скобках через запятую. Например: "allowOauthProviders" : ["FCC","Google"] Допустимые значения определяются тем, какие сервисы заданы при настройке параметров для протокола OAuth. Наименования сервисов при настройке параметров могут быть выбраны произвольно.
autoStartOauthProvider	Сервис авторизации, на который будет осуществлено автоматическое перенаправление при попытке входа в веб-приложение с использованием OAuth-авторизации. Например: "autoStartOauthProvider": "FCC" где: FCC. Наименование внешнего сервиса авторизации, заданного при настройке параметров для протокола OAuth. Используемый в атрибуте сервис должен быть указан в перечислении allowOauthProviders. Если в атрибуте будет указан незарегистрированный сервис, или его не будет в перечислении allowOauthProviders, автоматическая переадресация не произойдёт.

Пример раздела:

<pp>
…
    <metabase authentication="OAuth" id="FPRepository"/>
    <oAuthService enabled="true" useDefaultUserOauth="true" allowOauthProviders="Google, FCC" autoStartOauthProvider="Google"/>
…
</pp>

В результате для репозитория FPRepository будет использоваться вход по протоколу OAuth 2.0. Фактическое подключение к репозиторию будет выполнено под пользователем по умолчанию.

Определяет тип модуля, который будет открываться вместо окна приветствия (стартовой страницы welcome.html).

Раздел может содержать следующий атрибут:

Атрибуты

Описание

startModule

Определяет тип модуля. Возможные значения:

-1. Форма для входа в систему;
0. По умолчанию. Окно приветствия;
7. Навигатор объектов;
8. Менеджер безопасности;
1793. Рабочее пространство;
2561. Аналитические запросы (OLAP);
2562. Отчёты;
2827. Анализ временных рядов;
4097. Задача ETL;
4354. Справочник НСИ;
5123. Моделирование и прогнозирование;
8448. Аналитические панели.

Пример раздела:

<pp>
…
    <miscellaneous startModule="7"></miscellaneous>
…
</pp>

В результате при переходе на стартовую страницу welcome.html будет открываться навигатор объектов.

Определяет, скрывать ли раскрывающееся меню «Поделиться» в главном меню и набор команд, доступных в данном меню.

По умолчанию раскрывающееся меню «Поделиться» отображается и содержит полный набор команд. Используйте раздел <shareSettings> чтобы скрыть раскрывающееся меню «Поделиться» или какую-либо команду из него.

Раздел может содержать следующие атрибуты и подразделы:

Атрибут/раздел

Описание

enabled

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

true. Меню отображается;
false. Меню не отображается.

Раздел определяет доступность команд в меню «Поделиться». Каждая команда соответствует одному веб-сервису. Раздел <shareSettings> может содержать один или несколько разделов <shareItem>.

Раздел <shareItem> должен содержать атрибуты:

name. Наименование веб-сервиса. Возможные значения:

LiveJournal;
GooglePlus;

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

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

Пример раздела:

<pp>
…
     <shareSettings enabled="true">
        <shareItem enabled="true" name="GooglePlus"/>
        <shareItem enabled="false" name="LiveJournal"/>
    </shareSettings>
…
</pp>

В результате в главном меню будет отображаться раскрывающееся меню «Поделиться», содержащее команду «GooglePlus».

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

Раздел может содержать следующие атрибуты:

Раздел

Описание

Определяет, какие языки интерфейса доступны для выбора в окне регистрации. Раздел <cultures> может содержать один или несколько разделов <culture>.

Раздел <culture> должен содержать атрибут cultureName, определяющий язык. Возможные значения:

ar. Арабский;
ar-AE. Арабский (Объединенные Арабские Эмираты);
az. Азербайджанский;
de. Немецкий;
en. Английский;
es. Испанский;
fr. Французский;
it. Итальянский;
kk. Казахский;
pt. Португальский;
ru. Русский;
uk. Украинский;
zh-CN. Китайский.

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

Пример раздела:

<pp>
…
     <cultures>
        <culture cultureName="ru" />
        <culture cultureName="en" />
    </cultures>
…
</pp>

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

Настройки инструментов продукта «Форсайт. Аналитическая платформа», подключение расширений и пользовательских модулей.

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

Раздел <modules> может содержать следующие подразделы для настройки инструментов продукта «Форсайт. Аналитическая платформа»:

Раздел	Описание
<dashboard>	Настройки инструмента «Аналитические панели». Раздел <dashboard> должен содержать один подраздел <reportBox>, описывающий настройки инструмента. Подраздел <reportBox> может содержать атрибуты: ServicesPlugins. Определяет, доступно ли использование плагинов. Возможные значения: true. Плагины доступны; false. Плагины недоступны; AutoLayoutByDefault. Определяет режим компоновки панели по умолчанию. Возможные значения: true. По умолчанию используется автоматическое размещение объектов; false. По умолчанию используется ручное размещение объектов; TimeSeries. Определяет, доступен ли отчёт «Временные ряды». Возможные значения: true. Отчёт доступен; false. Значение по умолчанию. Отчёт недоступен; ExpressReport. Определяет, доступен ли отчёт «Экспресс-отчёт». Возможные значения: true. Отчёт доступен; false. Значение по умолчанию. Отчёт недоступен. ViewModeContextMenuOFF. Определяет, доступно ли контекстное меню визуализаторов при просмотре готовой аналитической панели. Возможные значения: true. Контекстное меню недоступно; false. Контекстное меню доступно; ViewModePreview. Определяет, доступно ли открытие на просмотр готовой аналитической панели без отображения ленты инструментов. Возможные значения: true. Лента инструментов не отображается при открытии на просмотр аналитической панели; false. Значение по умолчанию. Лента инструментов отображается при открытии на просмотр аналитической панели. ClientPDFExport. Определяет принцип экспорта аналитической панели в документ PDF (.pdf). Возможные значения: true. В результирующем файле блоки аналитической панели будут располагаться на одной странице и отображаться так же, как в веб-приложении в момент экспорта; false. Значение по умолчанию. В результирующем файле блоки аналитической панели будут располагаться на отдельных страницах и отображаться в соответствии с параметрами страницы. Совет. Для настройки инструмента «Аналитические панели*» также используйте раздел <collaboration>.
<reporter>	Настройки инструмента «Отчёты». Раздел <reporter> должен содержать один подраздел <reportBox>, описывающий настройки инструмента. Подраздел <reportBox> может содержать дополнительный подраздел <dataView> для настройки области данных отчёта, в котором содержится таблица. Для работы с таблицей используется подраздел <gridView>. Подраздел <gridView> может содержать атрибут: AutoUpdateByHandler. Определяет, будет ли выполняться обработка события ReportEvents.OnCellChange, которое происходит при изменении значения ячейки регламентного отчёта. Возможные значения: true. Событие выполняется при изменении ячейки регламентного отчёта; false. Значение по умолчанию. Событие не выполняется при изменении ячейки регламентного отчёта. Для подключения обработчика событий к отчёту обратитесь к разделу «Обработка событий отчёта». Примечание. В веб-приложении изменение ячеек регламентного отчёта доступно только в пределах таблицы.
<timeSeries>	Настройки инструмента «Анализ временных рядов». Раздел <timeSeries> должен содержать один подраздел <reportBox>, описывающий настройки инструмента. Подраздел <reportBox> может содержать атрибуты: isRExist. Определяет, доступны ли методы R на вкладке «Вычисления» ленты инструментов. Возможные значения: true. Отчёт доступен; false. Значение по умолчанию. Отчёт недоступен.

Пример раздела:

<pp>
…
    <Modules>
        <dashboard>
            <reportBox servicesPlugins="false" biSearchEnabled="true" autoLayoutByDefault="false"
                       timeSeries="true" expressReport="false"/> 
        </dashboard>
        <reporter>
            <reportBox>
                <dataView>
                    <gridView AutoUpdateByHandler="true">
                    </gridView>
                </dataView>
            </reportBox>
        </reporter>
        <timeSeries>
            <reportBox isRExist="true"/>
        </timeSeries>
    </Modules>
…
</pp>

В результате для инструмента «Аналитические панели» будут сделаны следующие настройки: недоступно создание плагинов, для поиска применяется BI-поиск, по умолчанию используется ручной режим размещения объектов, доступно создание отчёта «Временные ряды» и недоступно создание отчёта «Экспресс-отчёт». Для инструмента «Отчёты» доступно выполнение события ReportEvents.OnCellChange. Для инструмента «Анализ временных рядов» доступны для использования методы R.

Подключение расширений

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

Подключение пользовательских модулей

Пользовательский модуль - это часть веб-приложения, написанная прикладным разработчиком. Это может быть как новый инструмент, так и форма обратной связи. Сам модуль должен быть написан в виде html-страницы и скопирован в папку установки серверной части веб-приложения. Также туда должны быть скопированы все файлы, необходимые для работы модуля и созданные прикладным разработчиком.

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

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

Атрибут/раздел	Описание
name	Название модуля, которое будет отображаться в окне приветствия в веб-приложении.
resourceKey	Ключ ресурсов в файле App.resources..js, где - буквенное обозначение языка.
url	Путь к модулю относительно папки «S\App», где S - это путь до места установки серверной части веб-приложения.
Visible	Признак того, что модуль отображается в окне приветствия в веб-приложении. Возможные значения: 0. Модуль отображается; 1. Модуль не отображается.
data	Тип модуля. Принимает значения элементов перечисления PP.App.ModuleType.
classId	Идентификатор пользовательского класса объектов модуля. Указывается в формате: classId="["<класс>"]" Для просмотра идентификатора класса: В настольном приложении в навигаторе объектов выполните команду «Сервис > Параметры» в главном меню. В отобразившемся диалоге «Параметры» перейдите в раздел «Пользовательские метаданные». На вкладе «Классы объектов» выберите расширение. Нажмите кнопку «Редактировать». В отобразившемся диалоге на вкладке «Описание» в поле «Идентификатор» будет указан идентификатор класса объектов расширения. Например: classId="["DATA_ENTRY_FORM_CLASS"]" Вместо идентификатора класса может быть указано одно или несколько значений перечисления MetabaseObjectClass в формате: classId="[<значение1>,<значение2>,…,<значениеN>]" Например: ClassId: [4354, 3076]
actions	Действия, доступные для модуля в окне приветствия в веб-приложении. Доступные действия: 0. Открытие объекта; 1. Создание нового объекта; 2. Импорт данных. Действия указываются в квадратных скобках через запятую. Например: actions="[0, 1]"
<images>	Раздел с настройками пиктограмм для модуля. Содержит следующие подразделы: <WelcomeScreenIcon>. Настройки пиктограммы в окне приветствия. Размер пиктограммы 32x32 пикселя; <AddressBarIcon>. Настройки пиктограммы в адресной строке. Размер пиктограммы 16x16 пикселей; <DocumentsIcon>. Настройки пиктограмм для документов расширения в списке недавних документов в окне приветствия. Размер пиктограммы 16x16 пикселей. Данные разделы содержат одинаковый набор атрибутов: imageListId. Идентификатор спрайта с изображениями; rowIndex. Индекс строки в спрайте, содержащей пиктограмму; columnIndex. Индекс столбца в спрайте, содержащего пиктограмму. Настройки спрайтов задаются в разделе <imageLists>. Индексация изображений в спрайтах начинается с нуля.

Пример раздела:

<pp>
…
     <modules>
         <userRds name="Пользовательский НСИ"
             resourceKey="welcomeScreenRds"
             url="UserRds.html"
             data="4354"
             classId="[4354, 3076]"
             Visible="1"
             actions="[0,1]">
             <images>
                 <WelcomeScreenIcon imageListId="userModules32" rowIndex="0" columnIndex="10"/>
                 <AddressBarIcon imageListId="userModules16" rowIndex="0" columnIndex="13" />
                 <DocumentsIcon imageListId="userModules16" rowIndex="0" columnIndex="13" />
             </images>
         </userRds>
     </modules>
     <imageLists>
         <userModules16 source="../build/img/ribbon16.png" iconHeight="16" iconWidth="16"/>
         <userModules32 source="../build/img/ribbon32.png" iconHeight="32" iconWidth="32"/>
     </imageLists>
…
</pp>

В результате в качестве пользовательского модуля будет подключен файл UserRds.html, расположенный в папке App с установленной серверной частью веб-приложения. Файл реализует пользовательскую версию инструмента для работы с НСИ. Для пиктограмм будут использоваться спрайты ribbon16.png и ribbon32.png из папки build с установленной серверной частью веб-приложения.

Настройки экспорта отчёта, построенного с помощью инструмента «Аналитические запросы (OLAP)», «Аналитические панели», «Отчёты» или «Анализ временных рядов», во внешние форматы.

Примечание. Если раздел не задан, то доступны все форматы экспорта.

Раздел может содержать следующие атрибуты:

Атрибуты	Описание
clientExportPng	Определение доступа к экспорту отчёта в формате .png для инструментов «Аналитические запросы (OLAP)» и «Анализ временных рядов». Возможные значения: true. Экспорт отчёта в формате .png доступен. В результирующем файле содержимое отчёта будет отображаться так же, как в веб-приложении в момент экспорта; false. Значение по умолчанию. Экспорт отчёта в формате *.png недоступен.
hiddenFormats	Форматы экспорта, которые будут скрыты в главном меню инструментов.
disabledFormats	Форматы экспорта, которые будут недоступны в главном меню инструментов.

Форматы экспорта задаются через запятую.

Возможные форматы экспорта в атрибутах:

xls;
xlsx;
pdf;
rtf;
pptx;
html;
mht;
emf;
png. Используется только для инструментов «Аналитические панели», «Аналитические запросы (OLAP)» и «Анализ временных рядов»;

Примечание. Экспорт аналитических панелей в формате *.png доступен независимо от использования атрибута clientExportPng.

ppcube. Используется только для инструмента «Аналитические запросы (OLAP)»;
ppexpress. Используется только для инструмента «Аналитические запросы (OLAP)»;
ppdash. Используется только для инструмента «Аналитические панели».

Пример раздела:

<pp>
…
    <metabase id="FPRepository"/>
    <export hiddenFormats="ppexpress, ppcube" disabledFormats="emf" сlientExportPng="true"/>
…
</pp>

В результате выполнения примера:

в инструменте «Аналитические запросы (OLAP)» будут скрыты форматы экспорта *.ppexpress, *.ppcube, недоступен экспорт в формат *.emf и дополнительно доступен экспорт в формат *.png;
в инструментах «Аналитические панели» и «Отчёты» будет недоступен экспорт в формат *.emf;
в инструменте «Анализ временных рядов» будет недоступен экспорт в формат *.emf и дополнительно доступен экспорт в формат *.png.

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

Раздел <plugins> может содержать один или несколько разделов <plugin>, содержащих настройки подключения плагинов.

Раздел <plugin> может содержать следующие атрибуты и подразделы:

Атрибут/раздел	Описание
name	Наименование плагина.
path	Путь к JS-файлу плагина относительно папки установки веб-приложения.
css	Путь к CSS-файлу со стилями плагина относительно папки установки веб-приложения.
loaded	Способ загрузки плагина: true. Плагин загружается сразу; false. Плагин загружается по требованию. Примечание. Значение false используется только при подключении плагина к аналитической панели.
type	Идентификатор плагина или тип картографического сервиса. При подключении плагина к инструментам идентификатор должен соответствовать типу экземпляра объекта: PP.Ui.Dashboard.<наименование плагина>. При подключении плагина к аналитической панели; PP.Ui.Prx.<наименование плагина>. При подключении плагина к регламентному отчёту и форме ввода. При подключении внешних картографических сервисов к карте должен быть указан тип картографического сервиса: PP.Yandex. Для Яндекс-карты; PP.Bing. Для Bing-карты; PP.ArcGis. Для ArcGis-карты; PP.OpenStreetMap. Для OpenStreetMap-карты; PP.Google. Для Google-карты.
<params>	Раздел должен содержать раздел <param> с атрибутами: при подключении внешнего картографического сервиса к карте: name. Значение «APIKey»; value. Значение ключа API. Примечание. Атрибуты раздела задаются, если для плагинов внешних картографических сервисов требуется использование ключа API. при подключении пользовательских шаблонов диаграмм: name. Значение «ImagePath»; value. Относительный путь до файлов шаблонов *.svg.

Пример раздела:

<pp>
…
<plugins>
    <plugin type="PP.Ui.Dashboard.MyLabel" path="../plugins/MyLabel.js" css="../plugins/MyLabel.css" loaded="false" name="MyLabel"/>
    <plugin name="ExternalMapPlugin" path="../build/ExternalMapPlugin.js" loaded="true"/>
    <plugin name="YandexMapPlugin" path="../build/YandexMapPlugin.js" type="PP.Yandex"/>
    <plugin name="ArcGisMapPlugin" path="../build/ArcGisMapPlugin.js" type="PP.ArcGis"/>
    <plugin name="GoogleMapPlugin" path="../build/GoogleMapPlugin.js" type="PP.Google">
        <params>
            <param name="APIKey" value="AIzaSyCT36DH2CuXQ8GHtNSZASvoxQtbidhuWCU"/>
        </params>
    </plugin>
</plugins>
…
</pp>

В результате будут подключен плагин MyLabel.js к аналитической панели. К карте будут подключены внешние картографические сервисы: Яндекс, Bing, ArcGis, OpenStreetMap, Google. Для карт Google используется ключ API.

Настройки диаграмм.

Раздел может содержать следующие атрибуты:

Атрибуты	Описание
animation	Определяет, будет ли при отрисовке диаграммы использоваться анимация. Возможные значения: true. Анимация используется; false. Значение по умолчанию. Анимация не используется.
enableCanvas	Определяет, будет ли отображаться на боковой панели флажок «Масштабировать ось категорий». Возможные значения: true. Флажок отображается; false. Значение по умолчанию. Флажок не отображается.

Пример раздела:

<pp>
…
    <chart animation="true" enableCanvas="true"/>
…
</pp>

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

Настройки таблиц.

Раздел может содержать следующие атрибуты:

Атрибуты

Описание

enableNativeContextMenu

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

true. Контекстное меню браузера доступно;
false. Значение по умолчанию. Контекстное меню браузера недоступно.

enableSelection

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

true. Значение по умолчанию. Выделение доступно;
false. Выделение недоступно.

Пример раздела:

<pp>
…
    <tabSheet enableNativeContextMenu="true" enableSelection="false"/>
…
</pp>

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

Настройки спрайтов.

Спрайты используются при подключении расширений и пользовательских модулей в разделе <Modules>.

Название раздела с настройками спрайта может быть любым. Данное называние будет являться идентификатором спрайта и должно быть уникальным.

Раздел с настройками спрайта должен содержать следующие атрибуты:

Атрибут	Описание
source	Путь к спрайту относительно папки «S\App», где S - это путь до места установки серверной части веб-приложения.
iconHeight	Высота пиктограмм в спрайте.
iconWidth	Ширина пиктограмм в спрайте.

Пример раздела:

<pp>
…
     <modules>
         <userRds name="Пользовательский НСИ"
             resourceKey="welcomeScreenRds"
             url="UserRds.html"
             data="4354"
             classId="[4354, 3076]"
             Visible="1"
             actions="[0,1]">
             <images>
                 <WelcomeScreenIcon imageListId="userModules32" rowIndex="0" columnIndex="10"/>
                 <AddressBarIcon imageListId="userModules16" rowIndex="0" columnIndex="13" />
                 <DocumentsIcon imageListId="userModules16" rowIndex="0" columnIndex="13" />
             </images>
         </userRds>
     </modules>
     <imageLists>
         <userModules16 source="../build/img/ribbon16.png" iconHeight="16" iconWidth="16"/>
         <userModules32 source="../build/img/ribbon32.png" iconHeight="32" iconWidth="32"/>
     </imageLists>
…
</pp>

Признак доступности получения ссылки на аналитическую панель или на блок из аналитической панели. Если получение ссылки доступно, то в главном меню отображается команда «Поделиться > Ссылка на документ», а в меню блока команда «Ссылка на блок».

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

Раздел может содержать следующие атрибуты:

Атрибуты

Описание

enabled

Признак доступности получения ссылки. Доступные значения:

true. Получение ссылки доступно;
false. Значение по умолчанию. Получение ссылки недоступно.

Пример раздела:

<pp>
…
    <enabled enabled="true" />
…
</pp>

В результате в инструменте «Аналитические панели» будет доступно получение ссылки на аналитическую панель или ссылки на блок аналитической панели.

Настройки сервисных функций.

Раздел может содержать следующие атрибуты:

Атрибуты

Описание

securityManager

Открытие менеджера безопасности из навигатора объектов с помощью команды главного меню «Сервис > Менеджер безопасности».

Возможные значения:

true. По умолчанию. Открытие менеджера безопасности доступно из навигатора объектов с помощью указанной команды;
false. Открытие менеджера безопасности недоступно из навигатора объектов. Указанная команда главного меню не отображается.

Пример раздела:

<pp>
…
    <serviceCM securityManager="false"/>
…
</pp>

В результате в веб-приложении будет недоступно открытие менеджера безопасности из навигатора объектов с помощью команды главного меню «Сервис > Менеджер безопасности».

Раздел <createMenuHierarchy> может содержать следующие подразделы для определения структуры раскрывающегося меню кнопки «Новый объект» в веб-приложении:

Подраздел

Описание

<block>

Блок, разделяющий набор объектов по смыслу. Раздел может содержать атрибут:

index. Определяет индекс блока в структуре меню.

<other>

Группа объектов. Раздел может содержать атрибуты:

index. Определяет индекс группы в структуре меню;
name. Определяет наименование группы.

Примечание. Для подразделов можно задать пользовательские наименования, например, подраздел <block> переименовать на <main>, <other> - на <customObjects>.

Если раздел <createMenuHierarchy> пустой, то используется структура меню по умолчанию.

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

Где:

object. Пользовательское наименование типа объекта;
index. Индекс объекта в блоке или группе;
classID. Тип объекта репозитория. Значения типов указаны в перечислении MetabaseObjectClass.

Объекты, доступные для создания в веб-приложении:

Пример раздела:

<pp>
…
    <createMenuHierarchy>
        <tools index="0" name="Инструменты">
            <olap index="0" classID ="KE_CLASS_EXPRESSREPORT"/>
            <dashboard index="1" classID ="KE_ADHOC_REPORT"/>
            <timeSeries index="2" classID ="KE_CLASS_WORKBOOK"/>
        </tools>
        <model index="1">
            <modeling index="0" classID ="KE_CLASS_MSPROBLEM"/>
        </model>
        <additionally index="2">
            <document index="0" classID="KE_CLASS_DOCUMENT"/>
            <topobase index="1" classID="KE_CLASS_TOPOBASE"/>
        </additionally>
    </createMenuHierarchy>
…
</pp>

После выполнения примера будет изменена структура раскрывающегося меню кнопки «Новый объект»:

Настройки для переопределения пиктограммы, логотипа и наименования вкладки браузера при работе в веб-приложении. Пользовательские изображения должны быть расположены в папке S\build\img\app, где S - путь, по которому установлена серверная часть веб-приложения.

Раздел может содержать следующие атрибуты:

Атрибуты	Описание
favicon	Определяет путь до файла, используемого в качестве пиктограммы веб-страницы. Пиктограмма будет отображена на вкладке браузера рядом с названием страницы. Используется файл с расширением *.ico.
titleRu	Определяет текстовый заголовок вкладки для русской версии страницы веб-приложения.
titleEn	Определяет текстовый заголовок вкладки для английской версии страницы веб-приложения.
logoRu	Определяет путь до графического файла, используемого в качестве логотипа на странице авторизации в русской версии веб-приложения. Рекомендуемое разрешение изображения для корректного отображения логотипа на странице - 723х505 пикселей.
logoEn	Определяет путь до графического файла, используемого в качестве логотипа на странице авторизации в английской версии веб-приложения. Рекомендуемое разрешение изображения для корректного отображения логотипа на странице - 723х505 пикселей.
aboutRu	Определяет путь до файла, используемого в качестве логотипа на странице «О программе» в русской версии веб-приложения.
aboutEn	Определяет путь до файла, используемого в качестве логотипа на странице «О программе» в английской версии веб-приложения.

Пример раздела:

<pp>
…
<customSettingsfavicon ="pkez.ico"
titleRu ="ИАК"
titleEn ="IAK"
logoRu ="pkez_h.svg"
logoEn ="pkord_h.svg"
aboutRu ="pkez_h.svg"
aboutEn ="pkord_h.svg" >
</customSettings>
…
</pp>

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

Настройки шрифтов, применяемые в инструменте «Аналитические панели».

Раздел может содержать следующие атрибуты:

Атрибуты	Описание
CustomFonts	Список шрифтов, которые будут добавлены и доступны для выбора при настройке оформления различных элементов визуализаторов. Указываемые шрифты предварительно должны быть установлены в операционной системе.
DisabledFonts	Список шрифтов, которые будут исключены из списка доступных при настройке оформления различных элементов визуализаторов.

Пример раздела:

<pp>

…

    <Font CustomFonts="Microsoft Sans Serif, Segoe UI" DisabledFonts="Arial, Impact" />

…

</pp>

В результате при работе с инструментом «Аналитические панели» в веб-приложении будут модифицированы списки доступных для использования шрифтов. Будут добавлены шрифты Microsoft Sans Serif, Segoe UI и исключена возможность выбора шрифтов Arial, Impact.

Список шрифтов, доступных по умолчанию:

Список шрифтов после модификации с помощью раздела <Font>:

Пример

Приведён пример минимально необходимых настроек для работы веб-приложения.

Раздел	Краткое описание
<service>	Параметры BI-сервера с возможностью выполнения запросов из браузера напрямую, в обход серверной части веб-приложения.
<proxy>	Параметры BI-сервера с возможностью выполнения запросов через серверную часть веб-приложения.

Раздел	Краткое описание
<metabase>	Параметры используемого репозитория.
<oAuthService>	Настройки входа по протоколу OAuth 2.0.
<miscellaneous>	Определяет тип модуля, который будет открываться вместо окна приветствия (стартовой страницы welcome.html).
<shareSettings>	Определяет, скрывать ли раскрывающееся меню «Поделиться» в главном меню и набор команд, доступных в данном меню.
<cultures>	Определяет языки интерфейса, на которых доступно веб-приложение.
<modules>	Настройки инструментов продукта «Форсайт. Аналитическая платформа», подключение расширений и пользовательских модулей.
<export>	Настройки экспорта отчёта во внешние форматы.
<plugins>	Подключение дополнительных плагинов.
<chart>	Настройки диаграмм.
<tabSheet>	Настройки таблиц.
<imageLists>	Настройки спрайтов.
<embed>	Признак доступности получения ссылки на аналитическую панель или на блок из аналитической панели.
<serviceCM>	Настройки сервисных функций.
<createMenuHierarchy>	Настройки для определения структуры раскрывающегося меню кнопки «Новый объект» в веб-приложении.
<customSettings>	Настройки для переопределения пиктограммы, логотипа и наименования вкладки браузера при работе в веб-приложении. Пользовательские изображения должны быть расположены в папке S\build\img\app, где S - путь, по которому установлена серверная часть веб-приложения.
<font>	Настройки шрифтов, применяемые в инструменте «Аналитические панели».