Настройка конфигурации конструктора бизнес-приложений
Для корректной работы конструктора бизнес-приложений в папке установки серверной части конструктора бизнес-приложений должен содержаться файл конфигурации config.json.
По умолчанию в папке установки серверной части конструктора бизнес-приложений содержатся преднастроенные файлы конфигурации config.json, config-sample.json. Файл config-sample.json используется в качестве шаблона и не влияет на работу конструктора бизнес-приложений. Содержимое файлов config.json и config-sample.json совпадает.
Примечание. При обновлении конструктора бизнес-приложений содержимое файла config-sample.json может измениться. Для сохранения настроенной конфигурации используется файл config.json.
Для применения изменения конфигурации конструктора бизнес-приложений в файле config.json перезапустите серверную часть конструктора бизнес-приложений.
config.json
Пути расположения файла config.json по умолчанию:
/opt/foresight/fp10.x-dba/config в ОС Linux;
C:\Program Files (x86)\Foresight\DBA_10.x\config в ОС Windows. Папка DBA_10.x создаётся вручную и может отличаться.
Преднастроенные файлы конфигурации config.json, config-sample.json содержат поля: targetRepo, targetApp, serviceUrl, locale, locales, title, themes.
Файл config.json состоит из основных и дополнительных полей.
Пример файла config.json с минимально необходимыми настройками:
{
"targetRepo": "WAREHOUSE",
"targetApp": "BUSINESS_APPLICATION",
"serviceUrl": "http://10.7.0.100:8210/dba/PPService.axd",
"locale": "ru",
"locales": ["ru"],
"title": "DBA",
"themes": ["dba10"]
}
Основные поля
Для работы конструктора бизнес-приложений с минимально необходимыми настройками задайте основные поля:
targetRepoИдентификатор репозитория по умолчанию.
В ОС Linux идентификатор репозитория задаётся в файле Metabases.xml. В ОС Windows с помощью диалога «Настройка подключения к репозиторию». Также в данном диалоге должен быть установлен флажок «Для всех пользователей на компьютере».
Для подключения нескольких репозиториев заполните поле repositories.
Идентификатор бизнес-приложения, которое будет открыто по умолчанию.
Для подключения нескольких бизнес-приложений заполните поле repositories.
Адрес веб-сервиса PP.SOM при взаимодействии браузера с BI-сервером напрямую, в обход серверной части конструктора бизнес-приложений:
http://<BI-сервер>:<номер порта>/FPBI_App_v10.x/axis2/services/PP.SOM.Som
Где:
<BI-сервер>. IP-адрес или DNS-имя сервера, на котором установлен BI-сервер;
<номер порта>. Номер порта, по которому доступен BI-сервер. По умолчанию используется порт 8810 для ОС Linux, 80 для ОС Windows.
Адрес обработчика запросов PPService.axd при взаимодействии браузера с BI-сервером через серверную часть конструктора бизнес-приложений:
http://<веб-сервер>:<номер порта>/dba/PPService.axd
Где:
<веб-сервер>. IP-адрес или DNS-имя сервера, на котором установлена серверная часть конструктора бизнес-приложений;
<номер порта>. Номер порта, по которому доступна серверная часть конструктора бизнес-приложений. По умолчанию используется порт 8210 для ОС Linux, 80 для ОС Windows.
Для получения подробной информации обратитесь к разделу «Настройка взаимодействия браузера с BI-сервером».
Дополнительные поля
Для расширения функциональности конструктора бизнес-приложений задайте дополнительные поля:
Двухбуквенный код языка, который будет использоваться по умолчанию, если указан массив для переключения языка интерфейса в поле locales.
Массив, содержащий двухбуквенные коды языков, на которые может быть переключён интерфейс:
ru. Русский язык;
en. Английский язык.
По умолчанию в массив включён только один элемент, соответствующий русскому языку. Если в массив добавить английский язык, то в окне регистрации будут доступны гиперссылки для переключения языка интерфейса.
Заголовок конструктора бизнес-приложений, отображаемый на вкладке браузера. По умолчанию поле принимает значение «DBA».
Примечание. Дочернее поле title, заданное в контейнере конкретного кода языка интерфейса, приоритетнее поля title, заданного в корне структуры конфигурации.
Пользовательские настройки оформления конструктора бизнес-приложений при переключении языка интерфейса.
Поле является контейнером и может содержать поля:
ru. Русский язык;
en. Английский язык.
Каждый код языка также является контейнером и может содержать поля:
title. Заголовок конструктора бизнес-приложений, отображаемый на вкладке браузера;
Примечание. Дочернее поле title, заданное в контейнере конкретного кода языка интерфейса, приоритетнее поля title, заданного в корне структуры конфигурации.
favicon. Относительный путь до изображения с логотипом конструктора бизнес-приложений, который отображается на вкладке браузера;
logo. Относительный путь до изображения с логотипом конструктора бизнес-приложений, который отображается в окне регистрации;
sidebarLogo. Относительный путь до изображения с логотипом конструктора бизнес-приложений, который отображается на панели навигации;
sidebarLogoCollapsed. Относительный путь до изображения с логотипом конструктора бизнес-приложений, который отображается на свёрнутой панели навигации;
aboutLogo. Относительный путь до изображения с логотипом конструктора бизнес-приложений, который отображается в окне «О программе».
Допустимые форматы изображений: *.ico, *.svg, *.png, *.bmp.
Пример поля:
"customization":{
"ru": {
"title": "Бизнес-приложение",
"favicon": "assets/images/favicon_ru.ico",
"logo": "assets/images/logo_ru.svg",
"sidebarLogo": "assets/images/logoSidebar_ru.svg",
"sidebarLogoCollapsed": "assets/images/logoSidebarCollapsed_ru.svg",
"aboutLogo": "assets/images/about_ru.svg"
},
"en": {
"title": "Business Application",
"favicon": "assets/images/favicon_en.ico",
"logo": "assets/images/logo_en.svg",
"sidebarLogo": "assets/images/logoSidebar_en.svg",
"sidebarLogoCollapsed": "assets/images/logoSidebarCollapsed_en.svg",
"aboutLogo": "assets/images/about_en.svg"
}
}
Параметры используемого репозитория. По умолчанию поле отсутствует.
Поле является контейнером и может содержать следующие поля:
hideClasses. Массив, содержащий типы объектов, которые могут быть скрыты в конструкторе бизнес-приложений и недоступны для использования. Допустимые значения определяются перечислением MetabaseObjectClass.
По умолчанию поле не задано и скрыты следующие типы объектов:
MetabaseObjectClass.RUBRICATOR. База данных временных рядов;
MetabaseObjectClass.WORKBOOK. Рабочая книга.
Если поле содержит пустое значение, то объекты доступны для создания и работы с ними.
ping. Время, через которое выполняется проверка соединения с BI-сервером в миллисекундах. По умолчанию используется 120000 миллисекунд.
Пример поля:
"metabase":{
"hideClasses": [],
"ping": 20000
}
В результате будет доступна работа с базой данных временных рядов и рабочей книгой, а также изменено время, через которое выполняется проверка соединения с BI-сервером.
Репозитории, к которым доступно подключение. По умолчанию выполняется подключение к репозиторию, заданному в поле targetRepo, и бизнес-приложению, заданному в поле targetApp.
Поле является контейнером и содержит список идентификаторов репозиториев, которые будут доступны при открытии бизнес-приложения.
Для каждого репозитория доступны следующие настройки бизнес-приложений:
| Поля | Описание |
| apps | Список бизнес-приложений. |
<идентификатор бизнес-приложения> |
Идентификатор бизнес-приложения. |
customization |
Пользовательские настройки оформления бизнес-приложения при переключении языка интерфейса. Поле аналогично полю customization в корне файла конфигурации. |
externalJs |
Массив URL-адресов или относительных путей до внешних JS-файлов, которые будут загружаться перед запуском бизнес-приложения. По умолчанию поле отсутствует и никакие внешние JS-файлы не загружаются. |
externalCss |
Массив URL-адресов или относительных путей до внешних CSS-файлов, которые будут загружаться перед запуском бизнес-приложения. По умолчанию поле отсутствует и никакие внешние CSS-файлы не загружаются. |
Настройки, заданные в поле customization для конкретного бизнес-приложения, приоритетнее настроек, заданных в корне файла конфигурации.
Приоритет применения внешних JS и CSS-файлов:
Файлы, указанные в поле externalJs/externalCSS для конкретного бизнес-приложения.
Файлы, указанные в поле externalJs в корне файла config.json. Файл custom.css, созданный при настройке пользовательской темы конструктора бизнес-приложений.
Файлы, расположенные в папке «Внутренняя структура БП > Файлы для веб-версии» в навигаторе объектов.
Пример поля:
"repositories": {
"REPOSITORY_ID": {
"apps": {
"BUSINESS_APP_1":
{
"customization":
{
...
},
"externalJs":
[{
"src":
"./Scripts/Funct.js",
...
}],
"externalCss":
[{
"src":
"./Css/Style.css",
...
}]
},
"BUSINESS_APP_2":
{
...
}
}
},
"WAREHOUSE": {
...
}
}
Ключ темы конструктора бизнес-приложений. По умолчанию поле принимает значение «dba10».
Для создания пользовательской темы обратитесь к разделу «Создание пользовательской темы конструктора бизнес-приложений».
При указании массива ключей первая тема будет использоваться по умолчанию:
"themes": ["custom_theme", "dba10"]
Относительный путь до папки с пользовательскими темами конструктора бизнес-приложений задаётся в поле customThemesPath.
Относительный путь до папки с пользовательскими темами конструктора бизнес-приложений. По умолчанию поле отсутствует, набор тем содержится в папке:
/opt/foresight/fp10.x-dba/themes в ОС Linux;
C:\Program Files (x86)\Foresight\DBA_10.x\themes в ОС Windows.
Пример поля:
"customThemesPath":"customThemes/dark"
Ключ темы конструктора бизнес-приложений задаётся в поле themes.
Массив URL-адресов или относительных путей до внешних JS-файлов, функции которых могут использоваться:
для выполнения команды «Вызов функции JS» с помощью элемента управления «Кнопка» в аналитической панели;
для настройки действия гиперссылки в регламентном отчёте и форме ввода;
для настройки действия, предобработчика, постобработчика пользовательской кнопки, добавленной на панели инструментов в регламентном отчёте и форме ввода;
для подписки на события конструктора бизнес-приложений:
при отрисовке типа страницы: login, navigator или object;
при открытии объекта;
при открытии папки в навигаторе объектов.
Заданные JS-файлы загружаются перед запуском бизнес-приложения. По умолчанию поле отсутствует и никакие внешние JS-файлы не загружаются.
Пример поля:
"externalJs": [{
"src": "./Plugins/Funct.js"
}]
Для получения подробной информации о сигнатуре и подключении JS-функции обратитесь к разделу «Подключение пользовательской JS-функции».
Адрес справочной системы. По умолчанию поле отсутствует и используется адрес: https://help.fsight.ru/{0}/. В этом случае язык справочной системы зависит от языка интерфейса, выбранного в окне регистрации. Массив двухбуквенных кодов языков, на которые может быть переключён интерфейс, определяется в поле locales.
Для использования справочной системы на одном из языков задайте адрес с указанием локали, например: https://help.fsight.ru/ru/. В этом случае язык справочной системы не зависит от языка интерфейса.
Признак отображения версии веб-приложения:
в окне «О программе».
По умолчанию поле отсутствует и версия не отображается.
Для отображения версии веб-приложения задайте поле со значением true:
"showVersion": true
Если поле отсутствует или содержит значение, отличное от true, то версия веб-приложения не отображается.
Параметры открытия объектов в веб-версии бизнес-приложения.
Поле является контейнером, в котором могут быть созданы несколько подразделов c объектами заданного класса. Наименование подраздела должно соответствовать числовому значению класса объекта, которое можно получить в перечислении MetabaseObjectClass.
Настройки для регламентного отчёта:
| Поля | Описание |
2562 |
Регламентный отчёт. |
customization |
Пользовательские настройки оформления регламентного отчёта. |
tabSheetCustomization |
Пользовательские настройки оформления ячеек. |
isCellPaddingLikeExcel |
Признак автоматического добавления отступа размером 0.75 мм от границы ячейки до её содержимого. Применяется, если содержимое ячейки выровнено по левому/правому краю и задан соответствующий отступ размером 0 мм. Допустимые значения:
Примечание. При экспорте отчёта отображение отступов содержимого ячеек в другом офисном приложении может отличаться от отображения в «Форсайт. Аналитическая платформа». |
chart |
Пользовательские настройки оформления диаграмм. |
isAnimationDisable |
Признак использования анимации при отрисовке диаграммы. Допустимые значения:
|
Настройки для справочника НСИ:
| Поля | Описание |
3076 |
Справочник НСИ. Дополнительные настройки для работы со справочником НСИ в старом интерфейсе. По умолчанию справочник НСИ отображается в новом интерфейсе. |
url |
Путь к странице справочника НСИ в формате: http://<текущий IP-адрес>:8110/FP_App_v10.x/app/rds.html |
urlSettings |
Настройки параметров адресной строки, которые используются для открытия справочника НСИ. |
isClass |
Указание параметра class со значением типа объекта. Допустимые значения:
|
isConnectionId |
Указание параметра connectionId с моникёром открытой сессии. Допустимые значения:
|
isRepo |
Указание параметра repo с наименованием текущего открытого репозитория. Допустимые значения:
|
actions |
Действия, доступные для открытия справочника НСИ:
Например, если в поле задано только значение «view», то справочник НСИ будет открываться на просмотр в старом интерфейсе, а на редактирование - в новом. |
Настройки для экспресс-отчёта/аналитической панели:
| Поля | Описание |
2561/8448 |
Экспресс-отчёт/аналитическая панель. |
customization |
Пользовательские настройки оформления аналитической панели/экспресс-отчёта. |
chart |
Пользовательские настройки оформления диаграмм. |
isAnimationDisable |
Признак использования анимации при отрисовке диаграммы. Допустимые значения:
|
ribbonAutoHiding |
Признак автоматического скрытия ленты инструментов при работе с инструментами в бизнес-приложении. Допустимые значения:
|
clientPDFExport |
Признак определения принципа экспорта аналитической панели в документ PDF (*.pdf). Допустимые значения:
|
customFonts |
Список пользовательских шрифтов, которые будут добавлены и доступны для выбора при настройке оформления различных элементов визуализаторов аналитической панели. Заданные шрифты должны быть установлены на каждом компьютере пользователя. По умолчанию доступны шрифты, установленные на BI-сервере. При указании списка пользовательских шрифтов, установленных на компьютере пользователя, будут недоступны шрифты, установленные на BI-сервере. |
plugins |
Подключение дополнительных плагинов. Для получения подробной информации о создании плагина обратитесь к разделу «Создание плагина». Поле содержит настройки подключения плагинов:
При подключении плагина к инструментам идентификатор должен соответствовать типу экземпляра объекта. При подключении плагина к аналитической панели - PP.Ui.Dashboard.<наименование плагина>. При подключении внешних картографических сервисов к карте должен быть указан тип картографического сервиса:
Примечание. Атрибуты раздела задаются, если для плагинов внешних картографических сервисов требуется использование ключа API.
|
chartLoadConfirm |
Признак отображения предупреждения о возможной продолжительной загрузке, если диаграмма содержит больше 10000 точек рядов данных. Допустимые значения:
|
embedModeEnabled |
Доступно для объекта «Аналитическая панель» со значением класса «8448». Признак доступности получения ссылки на аналитическую панель или на блок из аналитической панели. Если получение ссылки доступно, то в главном меню отображается команда «Поделиться > Ссылка на документ», а в меню блока команда «Ссылка на блок». Допустимые значения:
Рекомендуется настроить гостевой вход для отображения встроенной аналитической панели или блока из неё без запроса логина и пароля. |
viewModePreview |
Доступно для объекта «Аналитическая панель» со значением класса «8448». Признак доступности открытия на просмотр готовой аналитической панели без отображения ленты инструментов. Допустимые значения:
|
Пример поля:
"modules": {
"8448": {
"customization":{
"ribbonAutoHiding": true,
"clientPDFExport": true,
"plugins": [
{
"name": "Test",
"path": "./Plugins/test.js",
"css": "./Plugins/CSS/test.css",
"id": "PP.Ui.Dashboard.Test",
"params": [
{
"name": "APIKey",
"value": "AIzaSyCT36DH2CuXQ8GHtNSZASvoxQtbidhuWCU"
}
]
}
]
}
},
"2561": {
"customization":{
...
}
}
}
Поле определяет место хранения моникёров соединений с репозиториями.
Допустимые значения:
true. Данные сессии хранятся в локальном хранилище браузера (LocalStorage). Моникёр соединения с репозиторием доступен на разных вкладках браузера. Не поддерживается вход в один репозиторий под разными пользователями одновременно в разных вкладках;
false. Значение по умолчанию. Данные сессии хранятся в хранилище сеансов браузера (SessionStorage). На каждой вкладке открывается новое соединение. Ранее открытое соединение из другой вкладки недоступно. Поддерживается вход в один репозиторий под разными пользователями одновременно в разных вкладках.
Пример поля:
"globalSession": false