Core Services

Im Folgenden werden die verschiedenen Konfigurationsmöglichkeiten der Core Services vorgestellt und beschrieben.

Zu den Einstellungsmöglichkeiten gelangen Sie über den Administrationsbereich im Reiter Core Services.

Gruppe "module"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
Module_Description (`moduleHeader_description`)	text	Ermöglicht die Hinterlegung einer kurzen Beschreibung des Moduls. Kann z.B. im Module Header angezeigt werden.
Module_ForceLoad (`moduleForceLoad`)	bool	Erzwingt das initiale Laden auch bei der Ladestrategie "onDemand", damit Ladeabhängigkeiten berücksichtigt werden können.
Module_Header (`moduleHeader_enabled`)	bool	Ermöglicht das De-/Aktivieren eines zusätzlichen Anzeige- und Funktionsbereichs im Header des Moduls.
Module_Icon (`module_iconCls`)	text	Definiert das Anzeige-Icon des Moduls. Bspw. alle Font-Awesome-Icons.
Module_LoadStrategy (`moduleLoadStrategy`)	text	Legt fest, wie das BPC relevante Module nachlädt. Diese Einstellung bezieht sich auf den Client/Browser. 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.
Module_Name (`module_name`)	text	Definiert den Anzeige-Namen des Moduls.
Module_URL (`moduleUrl`)	text	Gibt den modulspezifischen Basis-Pfad des REST-Interfaces des Core-Moduls an.

Module_Description
(moduleHeader_description)

text

Ermöglicht die Hinterlegung einer kurzen Beschreibung des Moduls. Kann z.B. im Module Header angezeigt werden.

Module_ForceLoad
(moduleForceLoad)

bool

Erzwingt das initiale Laden auch bei der Ladestrategie "onDemand", damit Ladeabhängigkeiten berücksichtigt werden können.

Module_Header
(moduleHeader_enabled)

bool

Ermöglicht das De-/Aktivieren eines zusätzlichen Anzeige- und Funktionsbereichs im Header des Moduls.

Module_Icon
(module_iconCls)

text

Definiert das Anzeige-Icon des Moduls. Bspw. alle Font-Awesome-Icons.

Module_LoadStrategy
(moduleLoadStrategy)

text

Legt fest, wie das BPC relevante Module nachlädt.
Diese Einstellung bezieht sich auf den Client/Browser.

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.

Module_Name
(module_name)

text

Definiert den Anzeige-Namen des Moduls.

Module_URL
(moduleUrl)

text

Gibt den modulspezifischen Basis-Pfad des REST-Interfaces des Core-Moduls an.

Gruppe "plugin"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
PluginConfiguration (`plugin_configuration`)	json	Plugin-Konfiguration im JSON-Format

PluginConfiguration
(plugin_configuration)

json

Plugin-Konfiguration im JSON-Format

Gruppe "identityProvider"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
IdentityProvider_BackendConnection (`identityProviderBackendConnection`)	text	Legt den zu verwendenden Identity Provider fest.

IdentityProvider_BackendConnection
(identityProviderBackendConnection)

text

Legt den zu verwendenden Identity Provider fest.

Gruppe "login"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
Login_Default_Language (`login_defaultLanguage`)	text	Ist dies gesetzt, dann überwiegt es die Browser-Sprache, aber nicht einen möglichen URL-Parameter.
Login_LandingPage (`login_landingPages`)	json	Festlegung einer Einstiegs-Seite (Landing Page), welche zuerst nach der erfolgreichen Anmeldung aufgerufen und angezeigt wird. Siehe Steuerbare Einstiegsseite für BPC-Nutzer (Landing Page).
Login_Message (`login_welcomeMsg`)	text	Definiert die Willkommen-Nachricht nach erfolgreichem Login in der Applikation.
Login_PasswordReset (`login_showReset`)	bool	Definiert, ob die Funktion "Passwort vergessen" in der Login-Ansicht verfügbar ist.
Login_Show_Language_Selector (`login_showLanguageSelector`)	bool	Sprachauswahl im Login ausblenden
Login_TenantDefault (`login_tenantDefaultValue`)	text	Ermöglicht die Angabe eines Default-Mandanten für den Login. Angabe eines gültigen Organisationsnamens entsprechend der Identity Provider Konfiguration.
Login_TenantSelection (`login_showTenant`)	bool	Definiert, ob die Angabe eines Mandanten in der Login-Ansicht verfügbar ist.
Login_Title (`login_title`)	text	Definiert den auf der Login-Ansicht angezeigten Anwendungstitel.
Logout_ResetUrl (`logout_resetUrl`)	bool	Entfernt beim Abmelden den aktuellen Deeplink aus der URL.

Login_Default_Language
(login_defaultLanguage)

text

Ist dies gesetzt, dann überwiegt es die Browser-Sprache, aber nicht einen möglichen URL-Parameter.

Login_LandingPage
(login_landingPages)

json

Festlegung einer Einstiegs-Seite (Landing Page), welche zuerst nach der erfolgreichen Anmeldung aufgerufen und angezeigt wird. Siehe Steuerbare Einstiegsseite für BPC-Nutzer (Landing Page).

Login_Message
(login_welcomeMsg)

text

Definiert die Willkommen-Nachricht nach erfolgreichem Login in der Applikation.

Login_PasswordReset
(login_showReset)

bool

Definiert, ob die Funktion "Passwort vergessen" in der Login-Ansicht verfügbar ist.

Login_Show_Language_Selector
(login_showLanguageSelector)

bool

Sprachauswahl im Login ausblenden

Login_TenantDefault
(login_tenantDefaultValue)

text

Ermöglicht die Angabe eines Default-Mandanten für den Login. Angabe eines gültigen Organisationsnamens entsprechend der Identity Provider Konfiguration.

Login_TenantSelection
(login_showTenant)

bool

Definiert, ob die Angabe eines Mandanten in der Login-Ansicht verfügbar ist.

Login_Title
(login_title)

text

Definiert den auf der Login-Ansicht angezeigten Anwendungstitel.

Logout_ResetUrl
(logout_resetUrl)

bool

Entfernt beim Abmelden den aktuellen Deeplink aus der URL.

Gruppe "core"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
Core_BaseURL (`bpcBaseUrl`)	text	Gibt die Server-URL an, unter der das BPC erreichbar ist.
Core_ClientPath (`clientPath`)	text	Pfad, unter dem das BPC auf dem Server den Benutzern angeboten wird. Dies ist nur relevant, falls ein Reverse Proxy genutzt wird und das BPC nicht direkt unter "/" verfügbar ist.
Core_ConfigurationBackup (`bpcConfigurationBackup`)	json	Definition des Standard-Backup-Zyklus' der BPC-Konfiguration.
Core_ConfigurationBackupOnChange (`bpcConfigurationBackup_onChanges`)	bool	Ermöglicht die automatische Erstellung eines Backups der BPC-Konfiguration, wenn Einstellungen geändert bzw. gelöscht wurden.
Core_CustomTranslations (`customTranslations`)	json	Ermöglicht die Festlegung zusätzlicher Übersetzungstexte bzw. können vorhandene Texte überschrieben werden.
Core_Deployment (`deployment`)	json	Festlegung von Modul-Einstellungen bei denen während des Deployment eine Warnung erscheinen soll. Siehe Deployment Constraints
Core_FrontendOnlyModules (`guiModules`)	json	Registrierung von Custom-Frontend-Modulen ohne Backend.
Core_RestURLExtension (`baseUrl`)	text	Gibt die Pfaderweiterung für alle BPC REST-Services an. Zusätzlich erfolgt die Erweiterung um den modulspezifischen URL-Pfad (siehe Module_URL).
Core_SessionCheckInterval (`clientSession.checkInterval`)	integer	Definiert das Interval (Angabe in Sekunden), in dem das BPC die Gültigkeit der aktuellen Sessions gegenüber eines externen IdentityProviders prüft.
Core_SessionInactiveTimeoutMinutes (`clientSession.inactiveSessionTimeoutMinutes`)	integer	Wenn eine Session existiert und diese seit diesem Zeitraum keine aktive Websocket-Verbindung mehr besitzt (z.B. Browser Fenster geschlossen), dann wird die Session geschlossen.
Core_TranslationsFallbackLanguage (`translationsFallbackLanguage`)	text	Texte werden in dieser Sprache zurückgeliefert, wenn diese in der angeforderten Sprache nicht zur Verfügung stehen. Die Oberfläche soll z.B. in Spanisch dargestellt werden und es sind noch nicht alle Texte dafür übersetzt, dann werden die fehlenden in der Fallback-Sprache zurückgeliefert. Beispiel für einen Eintrag: `de`

Core_BaseURL
(bpcBaseUrl)

text

Gibt die Server-URL an, unter der das BPC erreichbar ist.

Core_ClientPath
(clientPath)

text

Pfad, unter dem das BPC auf dem Server den Benutzern angeboten wird. Dies ist nur relevant, falls ein Reverse Proxy genutzt wird und das BPC nicht direkt unter "/" verfügbar ist.

Core_ConfigurationBackup
(bpcConfigurationBackup)

json

Definition des Standard-Backup-Zyklus' der BPC-Konfiguration.

Core_ConfigurationBackupOnChange
(bpcConfigurationBackup_onChanges)

bool

Ermöglicht die automatische Erstellung eines Backups der BPC-Konfiguration, wenn Einstellungen geändert bzw. gelöscht wurden.

Core_CustomTranslations
(customTranslations)

json

Ermöglicht die Festlegung zusätzlicher Übersetzungstexte bzw. können vorhandene Texte überschrieben werden.

Core_Deployment
(deployment)

json

Festlegung von Modul-Einstellungen bei denen während des Deployment eine Warnung erscheinen soll. Siehe Deployment Constraints

Core_FrontendOnlyModules
(guiModules)

json

Registrierung von Custom-Frontend-Modulen ohne Backend.

Core_RestURLExtension
(baseUrl)

text

Gibt die Pfaderweiterung für alle BPC REST-Services an. Zusätzlich erfolgt die Erweiterung um den modulspezifischen URL-Pfad (siehe Module_URL).

Core_SessionCheckInterval
(clientSession.checkInterval)

integer

Definiert das Interval (Angabe in Sekunden), in dem das BPC die Gültigkeit der aktuellen Sessions gegenüber eines externen IdentityProviders prüft.

Core_SessionInactiveTimeoutMinutes
(clientSession.inactiveSessionTimeoutMinutes)

integer

Wenn eine Session existiert und diese seit diesem Zeitraum keine aktive Websocket-Verbindung mehr besitzt (z.B. Browser Fenster geschlossen), dann wird die Session geschlossen.

Core_TranslationsFallbackLanguage
(translationsFallbackLanguage)

text

Texte werden in dieser Sprache zurückgeliefert, wenn diese in der angeforderten Sprache nicht zur Verfügung stehen. Die Oberfläche soll z.B. in Spanisch dargestellt werden und es sind noch nicht alle Texte dafür übersetzt, dann werden die fehlenden in der Fallback-Sprache zurückgeliefert.
Beispiel für einen Eintrag: de

Gruppe "elasticsearch"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
Core_IndexCreationSettings (`indexCreationSettings`)	json	Standard Index Einstellungen, die beim Anlegen eines neuen Index (durch das BPC) verwendet werden.
Core_IndexDynamicTemplates (`indexDynamicTemplates`)	json	Standard Dynamic Templates, die beim Anlegen eines neuen Index (durch das BPC) verwendet werden.
Core_IndexTemplates (`indexTemplates`)	json	Hier können Pattern-Index-Templates für ES definiert werden, die eine spezielle Aufbereitung/Zerlegung von Indexwerten ermöglichen, um nach diesen zu suchen. Bspw. für die Suche nach komma-separierten Werten im Monitor.

Core_IndexCreationSettings
(indexCreationSettings)

json

Standard Index Einstellungen, die beim Anlegen eines neuen Index (durch das BPC) verwendet werden.

Core_IndexDynamicTemplates
(indexDynamicTemplates)

json

Standard Dynamic Templates, die beim Anlegen eines neuen Index (durch das BPC) verwendet werden.

Core_IndexTemplates
(indexTemplates)

json

Hier können Pattern-Index-Templates für ES definiert werden, die eine spezielle Aufbereitung/Zerlegung von Indexwerten ermöglichen, um nach diesen zu suchen. Bspw. für die Suche nach komma-separierten Werten im Monitor.

Gruppe "frontend"

Setting (Key) Typ Beschreibung

Browser Icon
(gui_favIcon)

url

URL zu einem Browser Icon. Dieser Wert sollte nur gesetzt werden, falls das Icon aus dem aktuellen Theme nicht genutzt werden soll.

Browser_Title
(browser_title)

text

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)

Cookie_ShowBanner
(cookie_showBanner)

bool

Ermöglicht die Anpassung der Privatsphäre-Einstellungen.

CoreUI_AdditionalSourceFiles
(view_additionalFiles)

json

Erlaubt die Einbindung externer JS- bzw. CSS-Sourcen durch Angabe von HTTP-Urls.
Die Urls für JS und CSS werden jeweils kommagetrennt als Array(Liste) angegeben.

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"]
}

CoreUI_Breadcrump
(gui_breadcrumb)

bool

De-/Aktiviert den Breadcrumb, der die aktuelle Position des Benutzers in der Anwendung anzeigt.

Dieses Setting ist ab BPC 4.0.11 nicht mehr verfügbar. Stattdessen wird Breadcrumb als Plugin angeboten. Siehe auch: Plugin - Breadcrumb

CoreUI_DateFormat
(global_dateFormat)

text

Formatierung der Anzeige von Datum-Settings. Für mögliche Formatierung siehe: https://docs.sencha.com/extjs/7.5.1/classic/Ext.Date.html#property-defaultFormat. Wird keine Formatierung gesetzt, wird die Default-Formatierung vom Ext-Locale verwendet.

CoreUI_DateRangeFavorites
(dateRange_favorites)

json

Konfiguriert die Schnellauswahl Favoriten der Datumsauswahl.

CoreUI_ModuleNavigator
(moduleNavigator)

bool

De-/Aktiviert die Navigationsmöglichkeit zum zuletzt geöffneten Moduls.

CoreUI_StageColor
(gui_stageColor)

text

Erlaubt die Angabe einer Hintergrundfarbe zur Unterscheidung von unterschiedlichen Stages. Farbcodes: red, #FF0000, rgba(255,0,0,0.5)

CoreUI_ViewConfiguration
(viewConfiguration)

json

Definition der Seitenstruktur sowie der Applikationsbereiche im BPC. Siehe Ansicht und Navigationsstruktur.

CoreUI_WelcomeNotification
(welcomeNotification)

text

Angabe der Begrüßungsnachricht beim Einloggen ins BPC.

FunctionToolbar
(appToolbar_enabled)

bool

Ermöglicht das De-/Aktivieren der BPC-Toolbar.

FunctionToolbar_GlobalMenuEnabled
(appToolbar_globalMenuEnabled)

bool

Ermöglicht das De-/Aktivieren des globalen Menüs.

FunctionToolbar_GlobalMenuShowLogout
(appToolbar_globalMenuShowLogout)

bool

Ermöglicht das Ausblenden der "Abmelden"-Funktion im globalen Menu.
Wird die Funktion ausgeblendet, sollte der Logout über eine Alternative wie z.B. per Account ermöglicht werden.

FunctionToolbar_Height
(appToolbar_height)

integer

Angabe der Höhe der BPC-Toolbar in Pixel.

FunctionToolbar_LeftContent
(appToolbarLeftContent)

json

FunctionToolbar_RightContent
(appToolbarRightContent)

json

GlobalDaterangeEnabled
(globalDateRange_enabled)

bool

Aktivieren oder Deaktivieren des Globaler Datumsfilter-Filters. Der Filter ermöglicht den Anwendern, einen globalen Zeitraum festzulegen, welcher dann in passenden Applikationsmodulen angewendet wird.

ModuleHeader_Content
(moduleHeaderContent)

json

Definiert, welche Funktionen im Modul-Header als Schnellfunktionen zur Verfügung stehen.

NavigationToolbar
(navToolbar_enabled)

bool

Ermöglicht das De-/Aktivieren der BPC-Navigationsleiste.

NavigationToolbar_Expanded
(navToolbar_isExpanded)

bool

Definiert, ob die Navigationsleiste standardmäßig ausgeklappt ist.

NavigationToolbar_Width
(navToolbar_width)

integer

Angabe der Breite der Navigationsleiste im ausgeklappten Zustand in Pixel.

NavigationToolbar_WidthCollapsed
(navToolbar_widthCollapsed)

integer

Angabe der Breite der Navigationsleiste im eingeklappten Zustand in Pixel.

CoreUI_NavigationApplicationSwitcherIconOnly
(nav_appAreaSwitchIconOnly)

bool

Definiert, ob der Switcher der Applikationsbereiche nur mit Icon angezeigt werden soll.

CoreUI_NavigationItemsIconOnly
(nav_itemsIconOnly)

bool

Definiert, ob die Elemente der Navigationsbar nur mit Icon angezeigt werden soll.

CoreUI_NavigationHideSingleApplicationArea
(nav_hideSingleApplicationArea)

bool

Definiert, ob der Switcher der Applikationsbereiche ausgeblendet werden soll, wenn es nur einen einzigen Applikationsbereich gibt.

Gruppe "performanceTracing"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
PerformanceTracing (`performanceTracing`)	bool	Aktiviert die Core-Funktionen zur Überwachung der Applikationsperformance.

PerformanceTracing
(performanceTracing)

bool

Aktiviert die Core-Funktionen zur Überwachung der Applikationsperformance.

Gruppe "theme"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
CoreUI_Theme (`theme_name`)	list	Erlaubt die Auswahl eines Themes.

CoreUI_Theme
(theme_name)

list

Erlaubt die Auswahl eines Themes.

Gruppe "externalLinks"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
Documentation_URL (`onlineDocumentationUrl`)	text	Ermöglicht die Pflege einer externen URL zur Systemdokumentation. Diese kann im Hauptmenü aufgerufen werden.

Documentation_URL
(onlineDocumentationUrl)

text

Ermöglicht die Pflege einer externen URL zur Systemdokumentation. Diese kann im Hauptmenü aufgerufen werden.

Gruppe "license"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
License_Notification (`licenseNotifications`)	json	Ermöglicht die Konfiguration von Benachrichtigungen zu festgelegten Zeitpunkten vor Ablauf der Gültigkeit der BPC-Lizenz.
License_Overview (`licencedModules`)	json	Stellt eine Übersicht der Lizenzbedingungen entsprechend der eingespielten BPC-Lizenz bereit.

License_Notification
(licenseNotifications)

json

Ermöglicht die Konfiguration von Benachrichtigungen zu festgelegten Zeitpunkten vor Ablauf der Gültigkeit der BPC-Lizenz.

License_Overview
(licencedModules)

json

Stellt eine Übersicht der Lizenzbedingungen entsprechend der eingespielten BPC-Lizenz bereit.

Gruppe "apikeys"

Setting (Key) Typ Beschreibung

Setting (Key)	Typ	Beschreibung
API_Keys (`apiKeys`)	json	Hier werden die vom API Keys Editor gepflegten API Keys abgelegt.
API_Keys_Notification (`apiKeysNotifications`)	json	Es wird festgelegt zu welchem Zeitpunkt die Administratoren über bald ablaufende API Keys informiert werden sollen.

API_Keys
(apiKeys)

json

Hier werden die vom API Keys Editor gepflegten API Keys abgelegt.

API_Keys_Notification
(apiKeysNotifications)

json

Es wird festgelegt zu welchem Zeitpunkt die Administratoren über bald ablaufende API Keys informiert werden sollen.

Ansicht und Navigationsstruktur

Für die Ansicht und Navigationsstruktur gibt es eine extra Konfiguration mit dem Key viewConfiguration. Die Konfiguration der einzelnen Menü-Einträge wird direkt in das ExtJS Objekt injiziert. Daher sind alle Attribute möglich, die unter "configs" in der API-Dokumentation angegeben sind.

Aus dieser Konfiguration wird die Navigationsstruktur generiert und welche Module mit den Navigationselementen verknüpft sind. Die Konfiguration ist wie folgt aufgebaut:

Setting Datentyp Beschreibung

defaultView

Zahl

Ansicht, die initial angezeigt werden soll. Referenziert eine viewID.

views

Array

Eine Liste von View-Objekten.

viewItemId

Zahl

ID des View-Elements. Wird nicht berücksichtigt, wenn es sich unterhalb von views befindet.

viewItemId muss global eindeutig sein.

text

Text

Text des Menü-Eintrags

tooltip

Text

Tooltip-Inhalt

targetModule

Text

Name der Modul-Instanz, die nach Klick auf das Navigationselement angezeigt wird.

iconCls

Text

CSS-Klassen für das Icon

...

...

Es können weitere beliebige Attribute ergänzt werden. Diese werden direkt an das ExtJS-Objekt weitergereicht. Daher können alle Menu Item-Attribute (siehe ExtJS API) verwendet werden.

items

Array

Liste von Unterelementen.
Die Unterelemente sind ebenfalls so aufgebaut, wie in dieser Tabelle beschrieben.

right

Text / Array

Bezeichnung eines Benutzerrechtes.
Ist das Element angegeben, wird geprüft, ob der Benutzer dieses hat. Ist das nicht der Fall, wird das Element ignoriert und gilt als nicht existent.

role

Text / Array

Bezeichnung einer Benutzerrolle.
Ist das Element angegeben, wird geprüft, ob der Benutzer diese Rolle hat. Ist das nicht der Fall, wird das Element ignoriert und gilt als nicht existent.

Beispiel:
"role":["rolle1","rolle2"]

organisation

Text

Bezeichnung einer Organisation.
Ist das Element angegeben, wird geprüft, ob der Benutzer dieser Organisation angehört. Ist das nicht der Fall, wird das Element ignoriert und gilt als nicht existent.

Keywords: