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.

Module

General module settings

Name (ID) Description

Name
(module_name)

Name or title of the module/component.

Icon
(module_iconCls)

Individually selectable icon that is displayed before the title.
If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Description
(moduleHeader_description)

Can be used as an additional description that is displayed in the module header.

Module Load Strategy
(moduleLoadStrategy)

Controls the loading behavior of the individual modules in the frontend. With "onDemand", modules are only loaded when they are actually needed. This can have a positive effect on the initial loading process and overall performance.

  • all: Alle Frontend Module werden beim Laden der Oberfläche mit geladen.

  • onDemand: Es werden nur Frontend-Module geladen, die auch gerade angezeigt bzw. genutzt werden. Module werden bei Bedarf nachgeladen.

  • delayed: Alle aktuell nicht genutzten Module werden verspätet geladen, z.B. wenn der Client/Browser gerade untätig ist.

Base Path REST API
(moduleUrl)

Base path of the module to its offered REST API.
Should not be changed.

Identity Provider

Settings for using external identity providers

Name (ID) Description

Identity Provider
(identityProviderBackendConnection)

The identity provider used by the BPC.
<b>Attention!</b> Changes to a non-functional identity provider mean that you can no longer log in. If this occurs, the fallback to the local identity provider must be activated via the BPC file system.

Login

Settings for User login

Name (ID) Description

Show Organization Selection
(login_showTenant)

Allows you to set the organization(s) in the login mask that should be active after login.
Does not work with OIDC-based identity providers.

Default Organization
(login_tenantDefaultValue)

Name of the organization that should initially be specified in the login mask.
Does not work with OIDC-based identity providers.

Login Title
(login_title)

Text that is displayed in the login mask in the title.
Does not work with OIDC-based identity providers.

Login Welcome Message
(login_welcomeMsg)

Text that is displayed below the login mask.
Does not work with OIDC-based identity providers.

Show Password Reset
(login_showReset)

Shows the option to reset the password in the login mask.
Does not work with OIDC-based identity providers.

Remove Deep Link on Logout
(logout_resetUrl)

If the option is activated, the deep link is removed on logout. This means that after logging in again, you will be on the respective landing page of the BPC and not in the previous view.

Default Language
(login_defaultLanguage)

Default language of the BPC. If this is set, the BPC is loaded in this language as long as the user does not change it for themselves.
If no language is specified, the browser language is used.
The value is specified in two digits in accordance with ISO 639-1. E.g. "de" for German.

Language Selector
(login_showLanguageSelector)

Displays the language selection in the login mask.
Does not work with OIDC-based identity providers.

Landingpage
(login_landingPages)

This configuration can be used to set different landing pages depending on organizations, roles or user rights.
The landing page configuration interface should be used for customization.

See Controllable entry page for BPC users (landing page)

Core Settings

Settings for core functionalities in the BPC

Name (ID) Description

REST API URL Extension
(baseUrl)

Base path for the BPC REST API.
Should not be changed.

External URL Path
(clientPath)

Specification of the path in addition to the external base URL. If the BPC can be reached at <code>https:example.com:8282/bpc/</code>, for example, <code>/bpc/</code> must be configured here.

External Base URL
(bpcBaseUrl)

The server address (incl. port, but without path) via which the BPC can be accessed by users.
Example: <code>https:example.com:8282</code>
The path in the URL is specified via another setting.

Session Check Interval
(clientSession.checkInterval)

Interval (in seconds) at which the identity provider checks whether the login of users logged in to the BPC is still active. The value 0 deactivates the check.

Idle Limit
(clientSession.inactiveSessionTimeoutMinutes)

Inactivity limit in minutes. If a user is not active for the configured period of time, they are automatically logged out. Not active means that there is no active connection from a browser. The value 0 deactivates the check.
Automatic logouts can be seen in the audit log. It is necessary that the session check is active.

Fallback Language
(translationsFallbackLanguage)

Fallback language for missing translations. If individual translations are missing in the current language, these are replaced by those in the fallback language.

Custom Translations
(customTranslations)

Contains user-defined translation texts. It can also be used to overwrite existing texts in the BPC. The corresponding language setting should be used for the configuration.

Deployment Configuration
(deployment)

Definition of settings for which a warning should appear during deployment.

See Deployment and Deployment constraints

Mandatory User Role
(mandatoryRoleToAccessBPC)

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

OpenSearch

Settings for accessing OpenSearch

Name (ID) Description

Index Creation Settings
(indexCreationSettings)

The value is set as its "settings" value when creating/generating an OpenSearch index. Is also used during reindexing, as this creates a new index.

See Create-Index relevante BPC Einstellungen

Index Creation Templates
(indexTemplates)

These templates are stored directly in OpenSearch and then automatically applied by OpenSearch using the pattern when a new index is created. This is also applied during reindexing, as this creates a new index.

See Create-Index relevante BPC Einstellungen

Dynamic Field Templates
(indexDynamicTemplates)

The value is set as "dynamic_templates" when creating/generating an OpenSearch index in field mappings ("mappings"). Is also used during reindexing, as this creates a new index.

See Create-Index relevante BPC Einstellungen

Backup

Backup settings

Name (ID) Description

Automatically Backups
(bpcConfigurationBackup_onChanges)

If this option is active, the entire configuration is backed up before each individual change is made.
Backups of the configuration can be restored via the backup interface.

Backup Configuration for Log Service Indices
(defaultLogServiceIndicesBackup)

Default Backup Configuration for Log Service Indices.

Backup Configuration for Storage Service Indices
(defaultStorageServiceIndicesBackup)

Backup Configuration for Storage Service Indices.

Backups
(backupJobs)

List of backup jobs. These periodically back up OpenSearch indices.
This setting should be made via the backup configuration interface.

Repository
(backupRepository)

Configuration of the storage location for OpenSearch indices. This configuration is passed directly to OpenSearch. Details can be found in the OpenSearch documentation for the Snapshot Repository API.

Frontend

Settings for customizing the BPC frontend

Name (ID) Description

Hide Single Application Area
(nav_hideSingleApplicationArea)

If only one application area is active and available for the respective user, the display of the current application area is hidden.

Navigation Width
(navToolbar_width)

The initial width of the navigation when unfolded.

Navigation Toolbar Collapsed Width
(navToolbar_widthCollapsed)

The width of the navigation when folded.

Navigation Expanded
(navToolbar_isExpanded)

Controls the initial display of the navigation. This can be expanded or minimized. When minimized, only icons are displayed.

Header Height
(appToolbar_height)

Header height in pixel

Menu in Global Header
(appToolbar_globalMenuEnabled)

Controls the display of the menu in the global header.

Show Logout in Global Menu
(appToolbar_globalMenuShowLogout)

Controls the display of the logout in the global header.

Additional Files
(view_additionalFiles)

This setting can be used to load additional files (CSS and JS files are supported) for the user interface in the browser.

Wird das BPC über eine sichere Verbindung (siehe TLS/HTTPS) aufgerufen, so müssen die URLs ebenfalls https nutzen. Ansonsten verweigert der Browser unter Umständen das Laden der Dateien(siehe Mixed content). Allgemein gilt, dass das Laden externer JS-Sourcen immer ein Sicherheitsrisiko darstellen kann.

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

Navigation
(navToolbar_enabled)

Controls the display of the navigation on the left-hand side.

Global Header
(appToolbar_enabled)

Controls the display of the global header.
This should only be hidden in special cases, as it contains important functional elements of the BPC.

Navigation Configuration
(viewConfiguration)

Settings for the navigation elements in the BPC. Changes should only be made via the navigation settings page.

See Navigation settings

Browser Title
(browser_title)

Title in Browser Tab

Der Browser Titel kann über diesen Konfigurationsparameter statisch oder mit Platzhaltern konfiguriert werden.

Statischer Titel: Für einen statischen Titel ist nur der jeweilige Text als Konfiguration einzutragen, z.B. Business Process Center.

Platzhalter: Platzhalter werden durch geschweifte Klammern gesetzt. Die Klammern und der Inhalt wird dann entsprechend ersetzt.
Beispiel: BPC - {platzhalter}

Mögliche Werte für den Platzhalter:

  • userSession.data.loginName: Benutzername des aktuell angemeldeten Benutzers

  • activeModule._settings.data.map.module_name.value: Name des aktiven Moduls

  • activeModuleInformation.moduleBrowserTitle: Titelinformationen aus dem aktiven Modul (z.B. aktuelle Ansicht im Monitor)

Color Indicator
(gui_stageColor)

The background is marked in the specified color. This can be used to mark different deployment stages.
Possible syntax: HTML-Color-Keywords (red,green, …​); Hexadecimal (#11aabb,#a45fc3,…​); RGB (rgb(255 255 128),rgb(117 190 218 / 50%))

Favicon URL
(gui_favIcon)

URL to an alternative favicon. This can be provided via your own theme, for example.

Welcome Notification
(welcomeNotification)

Text that is displayed as a notification after the initial loading of the interface.

Date Range Favorites
(dateRange_favorites)

The date ranges configured here are offered via the quick selection of fields for the selection of date ranges.

Global Date Context
(globalDateRange_enabled)

Displays a selection for a date range in the global header bar. If this is activated, it affects the content of the displayed modules.
It is possible that modules or individual components do not support this function.

See Global date filter

Default Date Format
(global_dateFormat)

Standard format for dates. If no format is specified, the format stored for the respective active language is used.
The syntax can be found in the Ext.Date class from the ExtJS(classic) documentation.

See https://docs.sencha.com/extjs/7.9.0/classic/Ext.Date.html#property-defaultFormat

Cookie Banner
(cookie_showBanner)

Initially displays a cookie banner when loading the BPC.
The text of the cookie banner can be changed via the language setting of the BPC.

Left Global Header Content
(appToolbarLeftContent)

Contents on the left in the global header.
These are only displayed if you are in the administration area.
Available values: "deployment"

Right Global Header Content
(appToolbarRightContent)

Contents on the right in the global header.
These are only displayed if you are in the administration area.
Available values: "deployment"

Module Header Content
(moduleHeaderContent)

Additional content in the module header.
These are only displayed if you are in the administration area.
Available values: "deployment"

Frontend Logging

Frontend logging allows client-side JavaScript console outputs to be written into the backend

Name (ID) Description

Send Frontend Logs to Backend
(loggingEnabled)

If this option is active, log entries are sent from the browser console to the backend and saved there.

Log Level
(logLevel)

Level of detail of the logging. The finer the log level is configured, the more data is recorded. A high volume of log entries can have a negative impact on the performance of the system.

Performance Monitoring

Settings for performance monitoring

Name (ID) Description

Performance Tracing
(performanceTracing)

Activates the saving of browser performance data in the backend. This can be displayed in the Performance Monitor. The data contains various metrics that are generated when using the BPC. The data is recorded anonymously and sent periodically to the backend when the BPC is used.

Theme

Settings for customizing the BPC theme

Name (ID) Description

Theme
(theme_name)

Initial design in which the BPC is loaded.
Themes can also be installed.

Settings for external links

Name (ID) Description

Online Documentation
(onlineDocumentationUrl)

If a URL is specified, a link to this URL is offered in the global menu within the global header.

License

Settings for the BPC license

Name (ID) Description

License Notifications
(licenseNotifications)

This setting controls the time at which license expiry notifications are generated.

Licensed Modules
(licencedModules)

Contains information from the currently loaded license. This setting cannot be overwritten.

Plugin

Settings for managing plugins in the module

Name (ID) Description

Plugin Configuration
(plugin_configuration)

Configuration of plugins that are to be displayed within this module. The plugin configuration page of the respective module should be used for customization.

See Plugins

API Keys

Settings for API keys

See API keys

Name (ID) Description

API Key Notifications
(apiKeysNotifications)

Notifications for expiring API keys. This configuration can be used to control when notifications are sent for expiring API keys.

API Keys
(apiKeys)

API Keys

Account

Settings for the user account menu

Name (ID) Description

User Account Page Actions
(accountPageActionContent)

Specifies which actions are offered on the user information page.
The order of the values is taken into account.
Available values: "logout","accountPage","updateProfile","configureTotp","changePw","link","languageSelector","cookieSettings","deleteLocalStorage", "changeOrganisation"

See Benutzerinformationsseite
Keywords:
Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen