Core Services settings

The various configuration options for the Core Services are presented and described below.

You can access the settings options via the administration area in the tab Core Services tab.

Group "module"

Setting (Key) Type Description

Setting (Key)	Type	Description
Module_Description (`moduleHeader_description`)	text	Enables the storage of a short description of the module. Can be displayed in the module header, for example.
Module_ForceLoad (`moduleForceLoad`)	bool	Forces the initial load even with the Loading strategy "onDemand" so that loading dependencies can be taken into account.
Module_Header (`moduleHeader_enabled`)	bool	Enables the activation/deactivation of an additional display and function area in the header of the module.
Module_Icon (`module_iconCls`)	text	Defines the display icon of the module. E.g. all Font Awesome icons.
Module_LoadStrategy (`moduleLoadStrategy`)	text	Defines how the BPC loads relevant modules. This setting relates to the client/browser. all: All frontend modules are loaded when the interface is loaded. onDemand: Only frontend modules that are currently being displayed or used are loaded. Modules are loaded on demand. delayed: All currently unused modules are loaded with a delay, e.g. if the client/browser is currently idle.
Module_Name (`module_name`)	text	Defines the display name of the module.
Module_URL (`moduleUrl`)	text	Specifies the module-specific base path of the REST interface of the core module.

Module_Description
(moduleHeader_description)

text

Enables the storage of a short description of the module. Can be displayed in the module header, for example.

Module_ForceLoad
(moduleForceLoad)

bool

Forces the initial load even with the Loading strategy "onDemand" so that loading dependencies can be taken into account.

Module_Header
(moduleHeader_enabled)

bool

Enables the activation/deactivation of an additional display and function area in the header of the module.

Module_Icon
(module_iconCls)

text

Defines the display icon of the module. E.g. all Font Awesome icons.

Module_LoadStrategy
(moduleLoadStrategy)

text

Defines how the BPC loads relevant modules.
This setting relates to the client/browser.

all: All frontend modules are loaded when the interface is loaded.
onDemand: Only frontend modules that are currently being displayed or used are loaded. Modules are loaded on demand.
delayed: All currently unused modules are loaded with a delay, e.g. if the client/browser is currently idle.

Module_Name
(module_name)

text

Defines the display name of the module.

Module_URL
(moduleUrl)

text

Specifies the module-specific base path of the REST interface of the core module.

Group "plugin"

Setting (Key) Type Description

Setting (Key)	Type	Description
PluginConfiguration (`plugin_configuration`)	json	Plugin configuration in JSON format

PluginConfiguration
(plugin_configuration)

json

Plugin configuration in JSON format

Group "identityProvider"

Setting (Key) Type Description

Setting (Key)	Type	Description
IdentityProvider_BackendConnection (`identityProviderBackendConnection`)	text	Defines the identity provider to be used Identity Provider

IdentityProvider_BackendConnection
(identityProviderBackendConnection)

text

Defines the identity provider to be used Identity Provider

Group "login"

Setting (Key) Type Description

Setting (Key)	Type	Description
Login_Default_Language (`login_defaultLanguage`)	text	If this is set, it overrides the browser language, but not a possible URL parameter.
Login_LandingPage (`login_landingPages`)	json	Definition of an entry page (landing page), which is first called up and displayed after successful login. See Controllable entry page for BPC users (landing page).
Login_Message (`login_welcomeMsg`)	text	Defines the welcome message after a successful login to the application.
Login_PasswordReset (`login_showReset`)	bool	Defines whether the "Forgot password" function is available in the login view.
Login_Show_Language_Selector (`login_showLanguageSelector`)	bool	Hide language selection in the login
Login_TenantDefault (`login_tenantDefaultValue`)	text	Enables the specification of a default tenant for the login. Specification of a valid organization name according to the identity provider configuration.
Login_TenantSelection (`login_showTenant`)	bool	Defines whether the specification of a tenant is available in the login view.
Login_Title (`login_title`)	text	Defines the application title displayed in the login view.
Logout_ResetUrl (`logout_resetUrl`)	bool	Removes the current deep link from the URL when logging out.

Login_Default_Language
(login_defaultLanguage)

text

If this is set, it overrides the browser language, but not a possible URL parameter.

Login_LandingPage
(login_landingPages)

json

Definition of an entry page (landing page), which is first called up and displayed after successful login. See Controllable entry page for BPC users (landing page).

Login_Message
(login_welcomeMsg)

text

Defines the welcome message after a successful login to the application.

Login_PasswordReset
(login_showReset)

bool

Defines whether the "Forgot password" function is available in the login view.

Login_Show_Language_Selector
(login_showLanguageSelector)

bool

Hide language selection in the login

Login_TenantDefault
(login_tenantDefaultValue)

text

Enables the specification of a default tenant for the login. Specification of a valid organization name according to the identity provider configuration.

Login_TenantSelection
(login_showTenant)

bool

Defines whether the specification of a tenant is available in the login view.

Login_Title
(login_title)

text

Defines the application title displayed in the login view.

Logout_ResetUrl
(logout_resetUrl)

bool

Removes the current deep link from the URL when logging out.

Group "core"

Setting (Key) Type Description

Setting (Key)	Type	Description
Core_BaseURL (`bpcBaseUrl`)	text	Specifies the server URL under which the BPC can be accessed.
Core_ClientPath (`clientPath`)	text	Path under which the BPC is offered to users on the server. This is only relevant if a reverse proxy is used and the BPC is not directly available under "/".
Core_CustomTranslations (`customTranslations`)	json	Enables additional translation texts to be defined or existing texts to be overwritten.
Core_Deployment (`deployment`)	json	Definition of module settings for which a warning should appear during Deployment. See Deployment constraints
Core_FrontendOnlyModules (`guiModules`)	json	Registration of custom frontend modules without backend.
Core_MandatoryRoleToAccessBPC (`mandatoryRoleToAccessBPC`)	text	If set, only users with this role can use the BPC.
Core_RestURLExtension (`baseUrl`)	text	Specifies the path extension for all BPC REST Services. The extension is also extended by the module-specific URL path (see Module_URL).
Core_SessionCheckInterval (`clientSession.checkInterval`)	integer	Defines the interval (specified in seconds) at which the BPC checks the validity of the current sessions against an external IdentityProvider.
Core_SessionInactiveTimeoutMinutes (`clientSession.inactiveSessionTimeoutMinutes`)	integer	If a session exists and it no longer has an active web socket connection since this time (e.g. browser window closed), then the session is closed.
Core_TranslationsFallbackLanguage (`translationsFallbackLanguage`)	text	Texts are returned in this language if they are not available in the requested language. The interface is to be displayed in Spanish, for example, and not all texts have been translated for this yet, then the missing texts are returned in the fallback language. Example of an entry: `de`

Core_BaseURL
(bpcBaseUrl)

text

Specifies the server URL under which the BPC can be accessed.

Core_ClientPath
(clientPath)

text

Path under which the BPC is offered to users on the server. This is only relevant if a reverse proxy is used and the BPC is not directly available under "/".

Core_CustomTranslations
(customTranslations)

json

Enables additional translation texts to be defined or existing texts to be overwritten.

Core_Deployment
(deployment)

json

Definition of module settings for which a warning should appear during Deployment. See Deployment constraints

Core_FrontendOnlyModules
(guiModules)

json

Registration of custom frontend modules without backend.

Core_MandatoryRoleToAccessBPC
(mandatoryRoleToAccessBPC)

text

If set, only users with this role can use the BPC.

Core_RestURLExtension
(baseUrl)

text

Specifies the path extension for all BPC REST Services. The extension is also extended by the module-specific URL path (see Module_URL).

Core_SessionCheckInterval
(clientSession.checkInterval)

integer

Defines the interval (specified in seconds) at which the BPC checks the validity of the current sessions against an external IdentityProvider.

Core_SessionInactiveTimeoutMinutes
(clientSession.inactiveSessionTimeoutMinutes)

integer

If a session exists and it no longer has an active web socket connection since this time (e.g. browser window closed), then the session is closed.

Core_TranslationsFallbackLanguage
(translationsFallbackLanguage)

text

Texts are returned in this language if they are not available in the requested language. The interface is to be displayed in Spanish, for example, and not all texts have been translated for this yet, then the missing texts are returned in the fallback language.
Example of an entry: de

Group "opensearch"

Setting (Key) Type Description

Setting (Key)	Type	Description
Core_IndexCreationSettings (`indexCreationSettings`)	json	The value is set as its "settings" value when creating/creating an index. See also: Create-Index relevant BPC settings
Core_IndexDynamicTemplates (`indexDynamicTemplates`)	json	The value is set as "dynamic_templates" for the field mappings of an index. See also: Create-Index relevant BPC settings
Core_IndexTemplates (`indexTemplates`)	json	These templates are stored directly in OpenSearch and then automatically applied by OpenSearch based on the pattern when a new index is created. See also: Create-Index relevant BPC settings

Core_IndexCreationSettings
(indexCreationSettings)

json

The value is set as its "settings" value when creating/creating an index.

Core_IndexDynamicTemplates
(indexDynamicTemplates)

json

The value is set as "dynamic_templates" for the field mappings of an index.

Core_IndexTemplates
(indexTemplates)

json

These templates are stored directly in OpenSearch and then automatically applied by OpenSearch based on the pattern when a new index is created.

Group "backup"

Setting (Key) Type Description

Setting (Key)	Type	Description
Core_BackupRepository (`backupRepository`)	json	Definition of the backup repository. See OpenSearch Snapshot API documentation.
Core_BackupJobs (`backupJobs`)	json	Container with the backup jobs.
Core_ConfigurationBackupOnChange (`bpcConfigurationBackup_onChanges`)	bool	Enables the automatic creation of a backup of the BPC configuration if settings have been changed or deleted.
Core_DefaultLogServiceIndicesBackup (`defaultLogServiceIndicesBackup`)	json	Default backup settings for the indices, which are automatically created via the Log Service.
Core_DefaultStorageServiceIndicesBackup (`defaultStorageServiceIndicesBackup`)	json	Default backup settings for the indices, which are automatically created via the Storage Service.

Core_BackupRepository
(backupRepository)

json

Definition of the backup repository. See OpenSearch Snapshot API documentation.

Core_BackupJobs
(backupJobs)

json

Container with the backup jobs.

Core_ConfigurationBackupOnChange (bpcConfigurationBackup_onChanges)

bool

Enables the automatic creation of a backup of the BPC configuration if settings have been changed or deleted.

Core_DefaultLogServiceIndicesBackup (defaultLogServiceIndicesBackup)

json

Default backup settings for the indices, which are automatically created via the Log Service.

Core_DefaultStorageServiceIndicesBackup (defaultStorageServiceIndicesBackup)

json

Default backup settings for the indices, which are automatically created via the Storage Service.

Group "frontend"

Setting (Key) Type Description

Browser Icon
(gui_favIcon)

url

URL to a browser icon. This value should only be set if the icon from the current theme is not to be used.

Browser_Title
(browser_title)

text

The browser title can be configured statically or with placeholders using this configuration parameter.

Static title: For a static title, only the respective text must be entered as the configuration, e.g. Business Process Center.

Placeholder: Placeholders are set using curly brackets. The brackets and the content are then replaced accordingly.
Example: BPC - {platzhalter}

Possible values for the placeholder:

userSession.data.loginName: User name of the currently logged in user
activeModule._settings.data.map.module_name.value: Name of the active module
activeModuleInformation.moduleBrowserTitle: Title information from the active module (e.g. current view in the monitor)

Cookie_ShowBanner
(cookie_showBanner)

bool

Enables the privacy settings to be customized.

CoreUI_AdditionalSourceFiles
(view_additionalFiles)

json

Allows the integration of external JS or CSS sources by specifying HTTP urls.
The urls for JS and CSS are each specified comma-separated as an array (list).

If the BPC is accessed via a secure connection (see TLS/HTTPS), the URLs must also use https. Otherwise the browser may refuse to load the files (see Mixed content). In general, loading external JS sources can always pose a security risk.

{
    "css": [
        "http://example.com/style1.css",
        "http://example.com/style2.css"
    ],
    "js": ["http://example.com/script"]
}

CoreUI_Breadcrump
(gui_breadcrumb)

bool

Enables/disables the breadcrumb, which displays the current position of the user in the application.

This setting is no longer available from BPC 4.0.11. Instead, breadcrumb is offered as a plugin. See also: Plugin - Breadcrumb

CoreUI_DateFormat
(global_dateFormat)

text

Formatting of the display of date settings. For possible formatting see: https://docs.sencha.com/extjs/7.5.1/classic/Ext.Date.html#property-defaultFormat. If no formatting is set, the default formatting of the Ext-Locale is used.

CoreUI_DateRangeFavorites
(dateRange_favorites)

json

Configures the quick selection favorites of the date selection.

CoreUI_ModuleNavigator
(moduleNavigator)

bool

Enables/disables the navigation option to the last opened module.

CoreUI_StageColor
(gui_stageColor)

text

Allows the specification of a background color to differentiate between different stages. Color codes: red, #FF0000, rgba(255,0,0,0.5)

CoreUI_ViewConfiguration
(viewConfiguration)

json

Definition of the page structure and the application areas in the BPC. See View and navigation structure.

CoreUI_WelcomeNotification
(welcomeNotification)

text

Specification of the welcome message when logging into the BPC.

FunctionToolbar
(appToolbar_enabled)

bool

Enables the activation/deactivation of the BPC toolbar.

FunctionToolbar_GlobalMenuEnabled
(appToolbar_globalMenuEnabled)

bool

Enables the global menu to be activated/deactivated.

FunctionToolbar_GlobalMenuShowLogout
(appToolbar_globalMenuShowLogout)

bool

Enables the "Logout" function to be hidden in the global menu.
If the function is hidden, the logout should be enabled via an alternative such as User Account Menu.

FunctionToolbar_Height
(appToolbar_height)

integer

Specifies the height of the BPC toolbar in pixels.

FunctionToolbar_LeftContent
(appToolbarLeftContent)

json

FunctionToolbar_RightContent
(appToolbarRightContent)

json

GlobalDaterangeEnabled
(globalDateRange_enabled)

bool

Enable or disable the Global date filter filter. The filter allows users to define a global time period, which is then applied in suitable application modules.

ModuleHeader_Content
(moduleHeaderContent)

json

Defines which functions are available as quick functions in the module header.

NavigationToolbar
(navToolbar_enabled)

bool

Enables the activation/deactivation of the BPC navigation bar.

NavigationToolbar_Expanded
(navToolbar_isExpanded)

bool

Defines whether the navigation bar is expanded by default.

NavigationToolbar_Width
(navToolbar_width)

integer

Specifies the width of the navigation bar in pixels when expanded.

NavigationToolbar_WidthCollapsed
(navToolbar_widthCollapsed)

integer

Specifies the width of the navigation bar in pixels when collapsed.

CoreUI_NavigationApplicationSwitcherIconOnly
(nav_appAreaSwitchIconOnly)

bool

Defines whether the switcher of the application areas should only be displayed with an icon.

CoreUI_NavigationItemsIconOnly
(nav_itemsIconOnly)

bool

Defines whether the elements of the navigation bar should only be displayed with an icon.

CoreUI_NavigationHideSingleApplicationArea
(nav_hideSingleApplicationArea)

bool

Defines whether the application area switcher should be hidden if there is only a single application area.

Group "performanceTracing"

Setting (Key) Type Description

Setting (Key)	Type	Description
PerformanceTracing (`performanceTracing`)	bool	Activates the core functions for monitoring the application performance.

PerformanceTracing
(performanceTracing)

bool

Activates the core functions for monitoring the application performance.

Group "frontend logging"

Setting (Key) Type Description

Setting (Key)	Type	Description
Activate frontend logging (`loggingEnabled`)	bool	Activates the core functions for logging the client-side console output.
Frontend log level (`logLevel`)	text	Controls the log level for the frontend log service (possible values are "Debug", "Log", "Info", "Warning" and "Error"). The value "Warning" is set by default.

Activate frontend logging
(loggingEnabled)

bool

Activates the core functions for logging the client-side console output.

Frontend log level
(logLevel)

text

Controls the log level for the frontend log service (possible values are "Debug", "Log", "Info", "Warning" and "Error"). The value "Warning" is set by default.

Group "theme"

Setting (Key) Type Description

Setting (Key)	Type	Description
CoreUI_Theme (`theme_name`)	list	Allows the selection of a theme.

CoreUI_Theme
(theme_name)

list

Allows the selection of a theme.

Group "externalLinks"

Setting (Key) Type Description

Setting (Key)	Type	Description
Documentation_URL (`onlineDocumentationUrl`)	text	Allows the maintenance of an external URL for system documentation. This can be called up in the main menu.

Documentation_URL
(onlineDocumentationUrl)

text

Allows the maintenance of an external URL for system documentation. This can be called up in the main menu.

Group "license"

Setting (Key) Type Description

Setting (Key)	Type	Description
License_Notification (`licenseNotifications`)	json	Enables the configuration of notifications at specified times before the BPC license expires.
License_Overview (`licencedModules`)	json	Provides an overview of the license conditions according to the installed BPC license.

License_Notification
(licenseNotifications)

json

Enables the configuration of notifications at specified times before the BPC license expires.

License_Overview
(licencedModules)

json

Provides an overview of the license conditions according to the installed BPC license.

Group "apikeys"

Setting (Key) Type Description

Setting (Key)	Type	Description
API_Keys (`apiKeys`)	json	The API keys maintained by the API Keys Editor are stored here.
API_Keys_Notification (`apiKeysNotifications`)	json	The time at which the administrators are to be informed about API keys that are about to expire is defined.

API_Keys
(apiKeys)

json

The API keys maintained by the API Keys Editor are stored here.

API_Keys_Notification
(apiKeysNotifications)

json

The time at which the administrators are to be informed about API keys that are about to expire is defined.

Group "account"

Settings for Account.

Setting (Key) Type Description

Setting (Key)	Type	Description
Actions on user information page (`accountPageActionContent`)	json	The actions and their sequence are defined here, which are displayed on the User information page

Actions on user information page
(accountPageActionContent)

json

The actions and their sequence are defined here, which are displayed on the User information page

View and navigation structure

There is an extra configuration for the view and navigation structure with the key viewConfiguration. The configuration of the individual menu items is injected directly into the ExtJS object. Therefore, all attributes specified under "configs" in the API documentation are possible.

The navigation structure is generated from this configuration and which modules are linked to the navigation elements. The configuration is structured as follows:

Setting Data type Description

defaultView

Number

View that is to be displayed initially. References a viewID.

views

Array

A list of view objects.

viewItemId

Number

ID of the view element. Is not taken into account if it is located below views.

viewItemId must be globally unique.

text

Text

Text of the menu item

tooltip

Text

Tooltip content

targetModule

Text

Name of the module instance that is displayed after clicking on the navigation element.

iconCls

Text

CSS classes for the icon

...

...

Any other attributes can be added. These are passed directly to the ExtJS object. Therefore, all menu item attributes(see ExtJS API) can be used.

items

Array

List of sub-elements.
The sub-elements are also structured as described in this table.

right

Text / Array

Designation of a user right.
If the element is specified, the system checks whether the user has this right. If this is not the case, the element is ignored and is considered non-existent.

role

Text / Array

Designation of a user role.
If the element is specified, the system checks whether the user has this role. If this is not the case, the element is ignored and is not considered to exist.

Example:
"role":["role1", "role2"]

organization

Text

Name of an organization.
If the element is specified, the system checks whether the user belongs to this organization. If this is not the case, the element is ignored and is considered non-existent.

Keywords: