Core Services

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

You can access the settings via the administration area under the Core Services.

"module" Group

Setting (Key) Type Description

Setting (Key)	Type	Description
Module_Description (`moduleHeader_description`)	text	Allows you to enter a short description of the module. Can be displayed, for example, in the module header.
Module_ForceLoad (`moduleForceLoad`)	bool	Forces the initial load even with the "onDemand" loading strategy so that loading dependencies can be taken into account.
Module_Header (`moduleHeader_enabled`)	bool	Enables or disables an additional display and function area in the module header.
Module_Icon (`module_iconCls`)	text	Defines the module’s display icon. For example, all Font Awesome icons.
Module_LoadStrategy (`moduleLoadStrategy`)	text	Specifies how the BPC reloads relevant modules. This setting applies 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 reloaded as needed. delayed: All modules not currently in use are loaded later, e.g., when the client/browser is 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

Allows you to enter a short description of the module. Can be displayed, for example, in the module header.

Module_ForceLoad
(moduleForceLoad)

bool

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

Module_Header
(moduleHeader_enabled)

bool

Enables or disables an additional display and function area in the module header.

Module_Icon
(module_iconCls)

text

Defines the module’s display icon. For example, all Font Awesome icons.

Module_LoadStrategy
(moduleLoadStrategy)

text

Specifies how the BPC reloads relevant modules.
This setting applies 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 reloaded as needed.
delayed: All modules not currently in use are loaded later, e.g., when the client/browser is 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.

"plugin" group

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

"identityProvider" group

Setting (Key) Type Description

Setting (Key)	Type	Description
IdentityProvider_BackendConnection (`identityProviderBackendConnection`)	text	Specifies the identity provider to be used.

IdentityProvider_BackendConnection
(identityProviderBackendConnection)

text

Specifies the identity provider to be used.

"login" group

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	Specifies a landing page that is called and displayed first after a successful login. See Customizable landing page for BPC users (Landing Page).
Login_Message (`login_welcomeMsg`)	text	Defines the welcome message displayed after a successful login to the application.
Login_PasswordReset (`login_showReset`)	bool	Defines whether the "Forgot Password" feature is available on the login screen.
Login_Show_Language_Selector (`login_showLanguageSelector`)	bool	Hide language selection in the login screen
Login_TenantDefault (`login_tenantDefaultValue`)	text	Allows you to specify a default tenant for the login. Specify a valid organization name according to the Identity Provider configuration.
Login_TenantSelection (`login_showTenant`)	bool	Defines whether the option to specify a tenant is available on the login screen.
Login_Title (`login_title`)	text	Defines the application title displayed on the login screen.
Logout_ResetUrl (`logout_resetUrl`)	bool	Removes the current deep link from the URL upon logout.

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

Specifies a landing page that is called and displayed first after a successful login. See Customizable landing page for BPC users (Landing Page).

Login_Message
(login_welcomeMsg)

text

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

Login_PasswordReset
(login_showReset)

bool

Defines whether the "Forgot Password" feature is available on the login screen.

Login_Show_Language_Selector
(login_showLanguageSelector)

bool

Hide language selection in the login screen

Login_TenantDefault
(login_tenantDefaultValue)

text

Allows you to specify a default tenant for the login. Specify a valid organization name according to the Identity Provider configuration.

Login_TenantSelection
(login_showTenant)

bool

Defines whether the option to specify a tenant is available on the login screen.

Login_Title
(login_title)

text

Defines the application title displayed on the login screen.

Logout_ResetUrl
(logout_resetUrl)

bool

Removes the current deep link from the URL upon logout.

"core" group

Setting (Key) Type Description

Setting (Key)	Type	Description
Core_BaseURL (`bpcBaseUrl`)	text	Specifies the server URL at which the BPC is accessible.
Core_ClientPath (`clientPath`)	text	The path under which the BPC is made available 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	Allows you to define additional translation texts or override existing texts.
Core_Deployment (`deployment`)	json	Defines module settings for which a warning should appear during Deployment. See Deployment Constraints
Core_FrontendOnlyModules (`guiModules`)	json	Registration of custom frontend modules without a 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. Additionally, the module-specific URL path is appended (see Module_URL).
Core_SessionCheckInterval (`clientSession.checkInterval`)	integer	Defines the interval (in seconds) at which BPC checks the validity of the current sessions against an external IdentityProvider.
Core_SessionInactiveTimeoutMinutes (`clientSession.inactiveSessionTimeoutMinutes`)	integer	If a session exists and has not had an active WebSocket connection for this period of time (e.g., browser window closed), the session is closed.
Core_TranslationsFallbackLanguage (`translationsFallbackLanguage`)	text	Text is returned in this language if it is not available in the requested language. For example, if the interface is to be displayed in Spanish but not all texts have been translated yet, the missing texts will be returned in the fallback language. Example of an entry: `de`

Core_BaseURL
(bpcBaseUrl)

text

Specifies the server URL at which the BPC is accessible.

Core_ClientPath
(clientPath)

text

The path under which the BPC is made available 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

Allows you to define additional translation texts or override existing texts.

Core_Deployment
(deployment)

json

Defines module settings for which a warning should appear during Deployment. See Deployment Constraints

Core_FrontendOnlyModules
(guiModules)

json

Registration of custom frontend modules without a 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. Additionally, the module-specific URL path is appended (see Module_URL).

Core_SessionCheckInterval
(clientSession.checkInterval)

integer

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

Core_SessionInactiveTimeoutMinutes
(clientSession.inactiveSessionTimeoutMinutes)

integer

If a session exists and has not had an active WebSocket connection for this period of time (e.g., browser window closed), the session is closed.

Core_TranslationsFallbackLanguage
(translationsFallbackLanguage)

text

Text is returned in this language if it is not available in the requested language. For example, if the interface is to be displayed in Spanish but not all texts have been translated yet, the missing texts will be 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 the "settings" value when an index is created. See also: Create-Index-relevant BPC settings
Core_IndexDynamicTemplates (`indexDynamicTemplates`)	json	The value is set as "dynamic_templates" in the field mappings ("mappings") of an index. See also: BPC settings relevant to Create-Index
Core_IndexTemplates (`indexTemplates`)	json	These templates are stored directly in OpenSearch and are then automatically applied by OpenSearch based on the pattern when a new index is created. See also: BPC settings relevant to Create-Index

Core_IndexCreationSettings
(indexCreationSettings)

json

The value is set as the "settings" value when an index is created.

Core_IndexDynamicTemplates
(indexDynamicTemplates)

json

The value is set as "dynamic_templates" in the field mappings ("mappings") of an index.

Core_IndexTemplates
(indexTemplates)

json

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

"backup" group

Setting (Key) Type Description

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

Core_BackupRepository
(backupRepository)

json

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

Core_BackupJobs
(backupJobs)

json

Container containing the backup jobs.

Core_ConfigurationBackupOnChange (bpcConfigurationBackup_onChanges)

bool

Enables the automatic creation of a backup of the BPC configuration when settings are changed or deleted.

Core_DefaultLogServiceIndicesBackup (defaultLogServiceIndicesBackup)

json

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

Core_DefaultStorageServiceIndicesBackup (defaultStorageServiceIndicesBackup)

json

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

"frontend" group

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, simply enter the desired text as the configuration, e.g., Business Process Center.

Placeholders: Placeholders are denoted by curly braces. The brackets and their contents are then replaced accordingly.
Example: BPC - {platzhalter}

Possible values for the placeholder:

userSession.data.loginName: Username 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 on the monitor)

Cookie_ShowBanner
(cookie_showBanner)

bool

Allows customization of privacy settings.

CoreUI_AdditionalSourceFiles
(view_additionalFiles)

json

Allows the inclusion of external JS or CSS sources by specifying HTTP URLs.
The URLs for JS and CSS are specified as comma-separated arrays (lists).

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). As a general rule, 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_Breadcrumb
(gui_breadcrumb)

bool

Enables/disables the breadcrumb, which displays the user’s current position within the application.

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

CoreUI_DateFormat
(global_dateFormat)

text

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

CoreUI_DateRangeFavorites
(dateRange_favorites)

json

Configures the quick selection favorites for the date picker.

CoreUI_ModuleNavigator
(moduleNavigator)

bool

Enables/disables navigation to the most recently opened module.

CoreUI_StageColor
(gui_stageColor)

text

Allows you to specify a background color to distinguish between different stages. Color codes: red, #FF0000, rgba(255,0,0,0.5)

CoreUI_ViewConfiguration
(viewConfiguration)

json

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

CoreUI_WelcomeNotification
(welcomeNotification)

text

Specifies the welcome message when logging into BPC.

FunctionToolbar
(appToolbar_enabled)

bool

Enables or disables the BPC toolbar.

FunctionToolbar_GlobalMenuEnabled
(appToolbar_globalMenuEnabled)

bool

Enables or disables the global menu.

FunctionToolbar_GlobalMenuShowLogout
(appToolbar_globalMenuShowLogout)

bool

Hides the "Logout" function in the global menu.
If this function is hidden, logging out should be enabled via an alternative method, 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

Enables or disables the Global Date Filter filter. The filter allows users to specify a global time period, which is then applied in relevant application modules.

ModuleHeader_Content
(moduleHeaderContent)

json

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

NavigationToolbar
(navToolbar_enabled)

bool

Enables or disables 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 application area switcher should be displayed with an icon only.

CoreUI_NavigationItemsIconOnly
(nav_itemsIconOnly)

bool

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

CoreUI_NavigationHideSingleApplicationArea
(nav_hideSingleApplicationArea)

bool

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

"performanceTracing" group

Setting (Key) Type Description

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

PerformanceTracing
(performanceTracing)

bool

Enables the core functions for monitoring application performance.

"frontend logging" group

Setting (Key) Type Description

Setting (Key)	Type	Description
Enable frontend logging (`loggingEnabled`)	bool	Enables the core functions for logging 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"). By default, the value is set to "Warning."

Enable frontend logging
(loggingEnabled)

bool

Enables the core functions for logging 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"). By default, the value is set to "Warning."

"theme" group

Setting (Key) Type Description

Setting (Key)	Type	Description
CoreUI_Theme (`theme_name`)	list	Allows you to select a theme.

CoreUI_Theme
(theme_name)

list

Allows you to select a theme.

"externalLinks" group

Setting (Key) Type Description

Setting (Key)	Type	Description
Documentation_URL (`onlineDocumentationUrl`)	text	Allows you to maintain an external URL for the system documentation. This can be accessed from the main menu.

Documentation_URL
(onlineDocumentationUrl)

text

Allows you to maintain an external URL for the system documentation. This can be accessed from the main menu.

"license" group

Setting (Key) Type Description

Setting (Key)	Type	Description
License_Notification (`licenseNotifications`)	json	Allows you to configure notifications at specified times before the BPC license expires.
License_Overview (`licencedModules`)	json	Provides an overview of the license terms based on the imported BPC license.

License_Notification
(licenseNotifications)

json

Allows you to configure notifications at specified times before the BPC license expires.

License_Overview
(licencedModules)

json

Provides an overview of the license terms based on the imported BPC license.

"apikeys" group

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	This specifies when administrators should be notified about API keys that are about to expire.

API_Keys
(apiKeys)

json

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

API_Keys_Notification
(apiKeysNotifications)

json

This specifies when administrators should be notified about API keys that are about to expire.

View and Navigation Structure

There is a separate configuration for the view and navigation structure with the key viewConfiguration. The configuration of the individual menu entries is injected directly into the ExtJS object. Therefore, all attributes listed under "configs" in the API documentation are supported.

This configuration is used to generate the navigation structure and determine which modules are linked to the navigation elements. The configuration is structured as follows:

Setting Data Type Description

defaultView

Number

View to be displayed initially. References a viewID.

views

Array

A list of view objects.

viewItemId

Number

ID of the view element. Is ignored if it is located under views.

viewItemId must be globally unique.

text

Text

Text of the menu entry

tooltip

Text

Tooltip content

targetModule

Text

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

iconCls

Text

CSS classes for the icon

...

...

Any additional 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 child elements.
The child elements are also structured as described in this table.

right

Text / Array

Name of a user right.
If the element is specified, the system checks whether the user has this right. If not, the element is ignored and considered nonexistent.

role

Text / Array

Name of a user role.
If the element is specified, the system checks whether the user has this role. If not, the element is ignored and considered nonexistent.

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

organization

Text

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

Keywords: