Setting Up Configuration of Designer of Business Applications
To provide correct work of the designer of business applications, make sure that the folder with installed designer of business applications back end contains the config.json configuration file.
The folder with installed designer of business applications back end by default contains preset configuration files: config.json, config-sample.json. The config-sample.json file is used as a template and does not affect the work of the designer of business applications. Contents of the config.json and config-sample.json files matches.
NOTE. When updating the designer of business applications, contents of the config-sample.json file may change. The config.json file is used to save the created configuration.
To apply changes in the configuration of the designer of business applications in the config.json file, restart designer of business applications back end.
config.json
Default paths of the config.json file:
/opt/foresight/fp10.x-dba/config in Linux OS.
C:\Program Files (x86)\Foresight\DBA_10.x\config in Windows OS. The DBA_10.x folder is used manually and may be different.
The preset configuration files config.json and config-sample.json contain the fields: targetRepo, targetApp, serviceUrl, locale, locales, title, themes.
The config.json file contains main and additional fields.
The example of the config.json file with minimum required settings:
{
"targetRepo": "WAREHOUSE",
"targetApp": "BUSINESS_APPLICATION",
"serviceUrl": "http://10.7.0.100:8210/dba/PPService.axd",
"locale": "ru",
"locales": ["ru"],
"title": "DBA",
"themes": ["dba10"]
}
Main Fields
To provide designer of business applications work with minimum required settings, set the main fields:
targetRepoDefault repository identifier.
In Linux OS, repository identifier is set in the Metabases.xml file. In Windows OS, repository identifier is set in the Set Up Repository Connection dialog box. The Anyone Who Uses This Computer checkbox should also be selected in this dialog box.
To connect several repositories, fill in the repositories field.
Identifier of the business application that will be opened by default.
To connect several business applications, fill in the repositories field.
Address of the PP.SOM web service during the direct interaction between the browser and the BI server, bypassing designer of business applications back end:
http://<BI server>:<port number>/FPBI_App_v10.x/axis2/services/PP.SOM.Som
Where:
<BI server>. IP address or name of the DNS server, on which BI server is installed.
<port number>. Number of the port, at which BI server is available. The default port is 8810 for Linux OS and 80 for Windows OS.
Address of the PPService.axd request handler during the interaction between the browser and the BI server via designer of business applications back end:
http://<web server>:<port number>/dba/PPService.axd
Where:
<web server>. IP address or name of the DNS server, on which designer of business applications back end is installed.
<port number>. Number of the port, at which designer of business applications back end is available. The 8210 port is used by default for Linux OS and 80 for Windows OS.
For details see the Setting Up Interaction between Browser and BI Server section.
Additional Fields
To extend designer of business applications functionality, set additional fields:
Two-letter language code that will be used by default if the array for interface language switching is specified in the locales field.
The array containing two-letter language codes, to which the interface can be switched:
ru. Russian.
en. English.
By default, only one element corresponding to Russian is included into array. If English is added to the array, then the login dialog box will display hyperlinks to toggle interface language.
The title of designer of business applications displayed in a browser tab. By default, the field is set to DBA.
NOTE. The title child field set in the container of a specific interface language code has a higher priority than the title field set in the configuration structure root.
Custom formatting settings of designer of business applications on toggling interface language.
The field is a container and can contain the fields:
ru. Russian.
en. English.
Each language code is also a container and can contain the fields:
title. The title of designer of business applications displayed in a browser tab.
NOTE. The title child field specified in the container of a specific interface language code has a higher priority than the title field set in the configuration structure root.
favicon. The relative path to the designer of business applications logo image displayed in a browser tab.
logo. The relative path to the designer of business applications logo image displayed in the login dialog box.
sidebarLogo. The relative path to the designer of business applications logo image displayed on the navigation bar.
sidebarLogoCollapsed. The relative path to the designer of business applications logo image displayed on the collapsed navigation bar.
aboutLogo. The relative path to the designer of business applications logo image displayed in the About window.
Allowed image formats: *.ico, *.svg, *.png, *.bmp.
The example of the field:
"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"
}
}
Parameters of the repository in use. The field is absent by default.
The field is a container and can contain the following fields:
hideClasses. The array containing types of objects that can be hidden in the designer of business applications and are unavailable to use. Available values are determined by the MetabaseObjectClass is created.
The field is not set by default, and the following types of objects are hidden:
MetabaseObjectClass.RUBRICATOR. Time series database.
MetabaseObjectClass.WORKBOOK. Workbook.
If the field contains an empty value, objects can be created and worked with.
ping. The time spent on BI server connection check in milliseconds. The default value is 120000 milliseconds.
The example of the field:
"metabase":{
"hideClasses": [],
"ping": 20000
}
As a result, one can wok with time series databases and workbooks, and BI server connection check time is changed.
Repositories available for connection. By default, connection is established to the repository that is set in the targetRepo field and to the business application that is set in the targetApp field.
The field is a container and contains a list of repository identifiers that will be available after opening business application.
The following business application settings are available for each repository:
| Fields | Description |
| apps | List of business applications. |
<business application identifier> |
Business application identifier. |
customization |
Custom business application formatting settings on toggling interface language. The field is identical to the customization field in the configuration file root. |
externalJs |
The array of URL addresses or relative paths to external JS files that will be loaded before business application startup. The field is absent by default and no external JS files are loaded. |
externalCss |
The array of URL addresses-or relative paths to external CSS files that will be loaded before business application startup. The field is absent by default and no external CSS files are loaded. |
The settings determined in the customization field for specific business application have a higher priority than the settings determined in the configuration file root.
Priority of application of external JS and CSS files:
The files specified in the externalJs/externalCSS field for a specific business application.
The files specified in the externalJs field in the config.json file root. The custom.css file created during the setup of custom theme of the designer of business applications.
The files located in the Internal Structure of Business Process > Files for Web Version folder in the object navigator.
The example of the field:
"repositories": {
"REPOSITORY_ID": {
"apps": {
"BUSINESS_APP_1": {
"customization": {
...
},
"externalJs": [{
"src": "./Scripts/Funct.js",
...
}],
"externalCss": [{
"src": "./Css/Style.css",
...
}]
},
"BUSINESS_APP_2": {
...
}
}
},
"WAREHOUSE": {
...
}
}
Key of the theme for designer of business applications. By default, the field is set to dba10.
To create a custom theme, see the Creating a Custom Theme for Designer of Business Applications section.
When the array of keys is specified, the first theme will be used as a default one:
"themes": ["custom_theme", "dba10"]
The relative path to the folder with custom themes for designer of business applications is set in the customThemesPath field.
The relative path to the folder with custom themes for designer of business applications. The field is absent by default, and the set of themes is contained in the folder:
/opt/foresight/fp10.x-dba/themes in Linux OS.
C:\Program Files (x86)\Foresight\DBA_10.x\themes in Windows OS.
The example of the field:
"customThemesPath":"customThemes/dark"
The key of the theme of the designer of business applications is set in the themes field.
The array of URL addresses or relative paths to external JS files, which functions can be used:
To execute the JS Function Call command using the Buttoncontrol in dashboards.
To set up hyperlinks in regular reports and data entry forms action.
To set up action, prehandler, posthandler of the custom button added on the toolbar in regular reports and data entry forms.
To subscribe to events of designer of business applications:
On rendering page type: login, navigator or object.
On opening object.
On opening a folder in the object navigator.
The specified JS-files are loaded before starting the business application. The field is absent by default and no external JS files are loaded.
The example of field:
"externalJs": [{
"src": "./Plugins/Funct.js"
}]
For details about signature and JS-function connection see the Connecting Custom JS-Function section.
URL of help system. The field is absent by default, ad the URL is used: https://help.fsight.ru/{0}/. In this case help language depends on the interface language selected in the login dialog box. The array of two-letter language codes that can be used in the interface is determined in the locales field.
To use the help in one of the languages, set the URL including the locale, for example, https://help.fsight.ru/en/. In this case help language does not depend on the interface language.
Indicates whether web application version is displayed:
In the login dialog box.
In the About section.
The field is absent by default, and version is not displayed.
To hide web application version, set the field to true:
"showVersion": true
If the field is absent or contains the value that is different from true, web application version is not displayed.
Parameters for opening objects in the web interface of business application.
The field is a container, in which one can create several subsections with objects of the specified class. Subsection name should correspond with the numeric value of the object class, which can be obtained in the MetabaseObjectClass enumeration.
Regular report settings:
| Fields | Description |
2562 |
Regular report. |
customization |
Custom regular report formatting settings. |
tabSheetCustomization |
Cell formatting custom settings. |
isCellPaddingLikeExcel |
Indicates whether automatic indent 0.75 mm from cell border to its contents is added. It is applied if cell contents is aligned left/right and the corresponding indent 0 mm is set. Available values:
NOTE. During report export cell contents indents in other text editor may be displayed differently comparing to Foresight Analytics Platform. |
chart |
Chart formatting custom settings. |
isAnimationDisable |
Indicates whether animation is used on chart rendering. Available values:
|
MDM dictionary settings:
| Fields | Description |
3076 |
MDM dictionary. Advanced settings for working with MDM dictionary in the old interface. MDM dictionary is displayed in the new interface by default. |
url |
The path to MDM dictionary page: http://<current IP address>:8110/FP_App_v10.x/app/rds.html |
urlSettings |
Address field parameter settings that are used to open MDM dictionary. |
isClass |
Specify the class parameter with object type value. Available values:
|
isConnectionId |
Specify the connectionId parameter with opened session moniker. Available values:
|
isRepo |
Specify the repo parameter with the name of the current opened repository. Available values:
|
actions |
Operations available for opening MDM dictionary:
For example, if the field is set only to view, MDM dictionary will open for view in the old interface and for edit in the new interface. |
Express report/dashboard settings:
| Fields | Description |
2561/8448 |
Express report/dashboard. |
customization |
Dashboard/express report custom formatting settings. |
chart |
Chart formatting custom settings. |
isAnimationDisable |
Indicates whether animation is used on chart rendering. Available values:
|
ribbonAutoHiding |
Indicates whether the ribbon is hidden automatically on working with business application tools. Available values:
|
clientPDFExport |
Indicates whether the principle of export of dashboard to PDF (*.pdf) is determined. Available values:
|
customFonts |
Custom fonts that will be added and can be selected on setting up formatting of various dashboard visualizer elements. The specified fonts should be installed on each user computer. The fonts installed on the BI server are available by default. If custom fonts installed on the user computer are selected, the fonts installed on the BI server will be unavailable. |
plugins |
It connects additional plugins. For details about creating a plugin, see the Creating a Plugin section. The field contains plugin connection settings:
When connecting a plugin to platform tools, make sure that its identifier corresponds with the object instance type. When connecting a plugin to a dashboard - PP.Ui.Dashboard.<plugin name>. When connecting external map services to a map one should specify map service type:
NOTE. Section attributes are set if an API key should be used for plugins of external map services.
|
chartLoadConfirm |
Indicates whether the warning about possible delay in chart loading is displayed is the chart contains over 10000 data series points. Available values:
|
embedModeEnabled |
It is available for the Dashboard object with the 8448 class value. Indicates whether it is possible to get a link to dashboard or dashboard block. If it is possible to get a link, the main menu displays the Share > Document Link item, and the block menu displays the Block Link item. Available values:
It is recommended to set up guest login to display an embedded dashboard or dashboard block without entering login and password. |
viewModePreview |
It is available for the Dashboard object with the 8448 class value. Indicates whether a ready dashboard can be opened for view without displaying ribbon. Available values:
|
The example of field:
"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":{
...
}
}
}
The field determines location of repository connection monikers.
Available values:
true. Session data is stored in the browser local storage (LocalStorage). The repository connection moniker is available in different browser tabs. It does not support login to the same repository using different users at the same time in different tabs.
false. Default value. Session data is stored in the browser session storage (SessionStorage). A new connection opens in a new tab. The previously opened connection in the other tab is unavailable. It supports login to the same repository using different users at the same time in different tabs.
The example of field:
"globalSession": false