Core Services Einstellungen

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.

Modul

Allgemeine Modul Einstellungen

Name (ID) Beschreibung

Name
(module_name)

Name bzw. Titel des Modules/der Komponente.

Icon
(module_iconCls)

Individuell auswählbares Icon, das vor dem Titel angezeigt wird.
Falls kein Symbol angezeigt werden soll, kann z.B. "none" eingetragen werden. Bei leerem Feld wird ein Standard-Icon gewählt.

Beschreibung
(moduleHeader_description)

Kann als zusätzliche Beschreibung genutzt werden, die im Modulheader angezeigt wird.

Modulladestrategie
(moduleLoadStrategy)

Steuert das Ladeverhalten der einzelnen Module im Frontend. Mit "onDemand" werden Module erst geladen, wenn diese auch benötigt werden. Dies kann sich positiv auf den initialen Ladevorgang und die gesamte Performance auswirken.

  • 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.

Basispfad REST-API
(moduleUrl)

Basispfad des Moduls zu seiner angebotenen REST-API.
Sollte nicht geändert werden.

Identity Provider

Einstellungen zur Verwendung externer Identityprovider

Name (ID) Beschreibung

Identity Provider
(identityProviderBackendConnection)

Der vom BPC verwendete Identity Providers.
<b>Achtung!</b> Änderungen auf einen nicht funktionalen Identity Provider führen dazu, dass man sich nicht mehr anmelden kann. Wenn dies eintritt, muss über das Dateisystem des BPC der Fallback auf den lokalen Identity Provider aktiviert werden.

Login

Einstellungen zum Benutzer Login

Name (ID) Beschreibung

Organisationsauswahl
(login_showTenant)

Erlaubt es in der Login-Maske die Organisation(en) zu setzen, die nach dem Login aktiv sein sollen.
Geht nicht bei OIDC basierten Identity Providern.

Standard-Organisation
(login_tenantDefaultValue)

Name der Organisation, die initial in der Login-Maske angegeben sein soll.
Geht nicht bei OIDC basierten Identity Providern.

Login-Titel
(login_title)

Text der in der Login-Maske im Titel angezeigt wird.
Geht nicht bei OIDC basierten Identity Providern.

Login-Begrüßungstext
(login_welcomeMsg)

Text der unterhalb der Login-Maske angezeigt wird.
Geht nicht bei OIDC basierten Identity Providern.

Passwort-Zurücksetzen
(login_showReset)

Zeigt in der Login-Maske die Möglichkeit für das Zurücksetzen des Passwortes an.
Geht nicht bei OIDC basierten Identity Providern.

Logout entfernt Deep-Link
(logout_resetUrl)

Wenn die Option aktiviert ist, wird beim Logout der Deep-Link entfernt. Das bedeutet, dass man nach einem erneuten Login auf der jeweiligen Landingpage des BPC ist und nicht in der vorherigen Ansicht.

Standard-Sprache
(login_defaultLanguage)

Standard-Sprache des BPC. Wird diese gesetzt, dann wird das BPC in dieser Sprache geladen, solange der Anwender diese für sich nicht ändert.
Wird keine Sprache angegeben, so wird die Sprache des Browsers verwendet.
Wert wird nach ISO 639-1 zweistellig angegeben. Z.Bsp. "de" für deutsch.

Sprachauswahl
(login_showLanguageSelector)

Zeigt die Sprachauswahl in der Login-Maske an.
Geht nicht bei OIDC basierten Identity Providern.

Landingpage
(login_landingPages)

Über diese Konfiguration kann man abhängig von Organisationen, Rollen oder Rechten des Benutzers unterschiedliche Landingpages setzen.
Zum Anpassen sollte die Landingpage-Konfiguration-Oberfläche genutzt werden.

Basis Einstellungen

Einstellungen zu Basis Funktionalitäten im BPC

Name (ID) Beschreibung

REST-API-URL-Erweiterung
(baseUrl)

Basispfad für die BPC-REST-API.
Sollte nicht geändert werden.

Pfad der externen URL
(clientPath)

Angabe des Pfades ergänzend zur externen Basis-URL. Ist das BPC z.B. unter <code>https:example.com:8282/bpc/</code> zur erreichen, so muss hier <code>/bpc/</code> konfiguriert werden.

Externe Basis-URL
(bpcBaseUrl)

Die Serveradresse (inkl. Port, aber ohne Pfad) über die das BPC für die Anwender erreichbar ist.
Beispiel: <code>https:example.com:8282</code>
Der Pfad in der URL wird über eine weitere Einstellung angegeben.

Intervall zur Sessionprüfung
(clientSession.checkInterval)

Intervall (in Sekunden), in dem beim Identity Provider geprüft wird, ob die Anmeldung der am BPC angemeldeten Benutzer noch aktiv ist. Der Wert 0 deaktiviert die Prüfung.

Inaktivitätslimit
(clientSession.inactiveSessionTimeoutMinutes)

Inaktivitätslimit in Minuten. Ist ein Benutzer für die konfigurierte Zeitspanne nicht aktiv, so wird er automatisch abgemeldet. Nicht aktiv bedeutet, dass es keine aktive Verbindung aus einem Browser heraus gibt. Der Wert 0 deaktiviert die Prüfung.
Automatische Abmeldungen sind im Audit-Log ersichtlich. Es ist erforderlich, dass die Sitzungsprüfung aktiv ist.

Fallback-Sprache
(translationsFallbackLanguage)

Fallback-Sprache für fehlende Übersetzungen. Falls in der aktuellen Sprache einzelne Übersetzungen fehlen, werden diese durch die der Fallback-Sprache ersetzt.

Benutzerdefinierte Übersetzungen
(customTranslations)

Enthält benutzerdefinierte Übersetzungstexte. Darüber können auch bestehende Texte im BPC überschrieben werden. Für die Konfiguration sollte die entsprechende Sprache-Einstellung genutzt werden.

Deploymenteinstellungen
(deployment)

Definition von Einstellungen für die beim Deployment eine Warnung erscheinen soll.

Benötigte Benutzerrolle
(mandatoryRoleToAccessBPC)

Wenn gesetzt, können nur Benutzer mit dieser Rolle das BPC benutzen.

OpenSearch

Einstellungen zum Zugriff auf das OpenSearch

Name (ID) Beschreibung

Index-Erstellungseinstellungen
(indexCreationSettings)

Der Wert wird beim Anlegen/Erzeugen eines OpenSearch-Indexes als dessen "settings"-Wert gesetzt. Wird auch bei der Reindizierung anwendet, da diese einen neuen Index anlegt.

Index-Erstellungsvorlagen
(indexTemplates)

Diese Templates werden direkt in OpenSearch hinterlegt und dann beim Anlegen eines neuen Index automatisch von OpenSearch anhand des Patterns angewendet. Wird auch bei der Reindizierung anwendet, da diese einen neuen Index anlegt.

Dynamische Feldvorlagen
(indexDynamicTemplates)

Der Wert wird beim Anlegen/Erzeugen eines OpenSearch-Indexes in Felder-Mappings ("mappings") als "dynamic_templates" gesetzt. Wird auch bei der Reindizierung anwendet, da diese einen neuen Index anlegt.

Backup

Einstellungen zum Backup

Name (ID) Beschreibung

Automatische Backups
(bpcConfigurationBackup_onChanges)

Ist diese Option aktiv, dann wird die gesamte Konfiguration vor jeder einzelnen Änderung gesichert.
Sicherungen der Konfiguration können über die Backup-Oberfläche wiederhergestellt werden.

Backupeinstellung für Log Service-Indizes
(defaultLogServiceIndicesBackup)

Standard-Backupeinstellungen für Log Service-Indizes

Backupeinstellung für Storage Service-Indizes
(defaultStorageServiceIndicesBackup)

Standard-Backupeinstellungen für Storage Service-Indizes

Backups
(backupJobs)

Liste von Backup-Jobs. Diese sichern periodisch OpenSearch Indizes.
Diese Einstellung sollte über die Backup-Konfigurationsoberfläche vorgenommen werden.

Speicherort
(backupRepository)

Konfiguration des Speicherortes für OpenSearch Indizes. Diese Konfiguration wird direkt an OpenSearch durchgereicht. Details können der OpenSearch Dokumentation zur Snapshot Repository API entnommen werden.

Frontend

Einstellungen zum Anpassen des BPC Frontends

Name (ID) Beschreibung

Einzelnen Anwendungsbereich ausblenden
(nav_hideSingleApplicationArea)

Wenn aktiv und für den jeweiligen Benutzer nur ein Anwendungsbereich zur Verfügung steht, dann wird die Anzeige des aktuellen Anwendungsbereiches ausgeblendet.

Breite der Navigation
(navToolbar_width)

Die initiale Breite der Navigation im ausgeklappten Zustand.

Breite der eingeklappten Navigation
(navToolbar_widthCollapsed)

Die Breite der Navigation im eingeklappten Zustand.

Navigations aufgeklappt
(navToolbar_isExpanded)

Steuert die initiale Darstellung der Navigation. Diese kann aufgeklappt sein oder minimiert sein. Im minimierten Zustand werden nur Icons angezeigt.

Höhe des globalen Headers
(appToolbar_height)

Höhe des globalen Headers in Pixel.

Menü im globalen Header
(appToolbar_globalMenuEnabled)

Steuert die Anzeige des Menüs in des globalen Headers.

Abmelden im globalen Menü
(appToolbar_globalMenuShowLogout)

Steuert die Anzeige der Abmelde-Funktion innerhalb des Menüs des globalen Headers.

Zusätzliche Dateien
(view_additionalFiles)

Über diese Einstellung können zusätzliche Dateien (unterstützt werden CSS und JS-Dateien) für die Benutzeroberfläche im Browser geladen werden.

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)

Steuert die Anzeige der Navigation auf der linkten Seite.

Globaler Header
(appToolbar_enabled)

Steuert die Anzeige des globalen Headers.
Diese sollte nur in speziellen Fällen ausgeblendet werden, da diese wichtige Funktionselemente des BPC beinhaltet.

Navigationseinstellungen
(viewConfiguration)

Einstellungen für die Navigationselemente im BPC. Veränderungen sollten nur über die Navigationseinstellungen-Seite vorgenommen werden.

Browser Titel
(browser_title)

Titel im 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)

Farbindikator
(gui_stageColor)

Der Hintergrund wird in der angegebenen Farbe markiert. Dies kann genutzt werden, um verschiedene Deployment-Stages zu markieren.
Mögliche Syntax: HTML-Color-Keywords (red,green, …​); Hexadezimal (#11aabb,#a45fc3,…​); RGB (rgb(255 255 128),rgb(117 190 218 / 50%))

Favicon-URL
(gui_favIcon)

URL zu einem alternativen Favicon. Dieses kann z.B. über ein eigenes Theme bereitgestellt werden.

Begrüßungsnachricht
(welcomeNotification)

Text der nach dem initialen Lader der Oberfläche als Benachrichtigung angezeigt.

Datumsbereiche für Schnellauswahl
(dateRange_favorites)

Die hier konfigurierten Datumsbereiche werden über die Schnellauswahl an Felder für die Auswahl von Datumsbereichen angeboten.

Globale Datumskontext
(globalDateRange_enabled)

Zeigt in der globalen Kopfleiste eine Auswahl für einen Datumsbereich an. Wenn dieser aktiviert ist, wirkt dieser sich auf den Inhalt der angezeigten Module aus.
Es kann vorkommen, dass Module oder einzelne Bestandteile diese Funktion nicht unterstützen.

Standard Datumsformat
(global_dateFormat)

Standardformat für Datumsangaben. Wenn kein Format angegeben wird, wird das für die jeweilige aktive Sprache hinterlegte Format genutzt.
Die Syntax ist der Ext.Date-Klasse aus der ExtJS(classic) Dokumentation zu entnehmen.

Cookie-Banner
(cookie_showBanner)

Zeigt initial beim Laden des BPC ein Cookie-Banner an.
Der Text des Cookie-Banners kann über die Sprache-Einstellung des BPC geändert werden.

Toolbar links
(appToolbarLeftContent)

Inhalte links im globalen Header.
Diese werden nur angezeigt, wenn man im Administrationsbereich ist.
Verfügbare Werte: "deployment"

Toolbar rechts
(appToolbarRightContent)

Inhalt rechts im globalen Header.
Diese werden nur angezeigt, wenn man im Administrationsbereich ist.
Verfügbare Werte: "deployment"

Modulheader
(moduleHeaderContent)

Zusätzliche Inhalte im Modulheader.
Diese werden nur angezeigt, wenn man im Administrationsbereich ist.
Verfügbare Werte: "deployment"

Frontend Logging

Über das Frontend Logging werden und können Clientseitige Javascript Konsolenausgaben in das Backend geschrieben

Name (ID) Beschreibung

Frontend Logs an Backend senden
(loggingEnabled)

Wenn diese Option aktiv ist, dann werden Logeinträge aus der Browserkonsole an das Backend geschickt und dort gespeichert.

Log-Level
(logLevel)

Detailgrad der Protokollierung. Je feiner das Log Level konfiguriert wird, desto mehr Daten werden erfasst. Ein hohes Aufkommen an Logeinträgen kann die Performance des Systems negativ beeinflussen.

Leistungsüberwachung

Einstellungen zur Leistungsüberwachung

Name (ID) Beschreibung

Leistungsüberwachung
(performanceTracing)

Aktiviert das Speichern von Browser-Performance Daten im Backend. Diese können im Performance Monitor angezeigt werden. Die Daten enthalten diverse Metriken die bei der Verwendung des BPC anfallen. Die Daten werden anonym erfasst und bei der Verwendung des BPC periodisch an das Backend gesendet.

Theme

Einstellungen zur Anpassung des BPC Themes

Name (ID) Beschreibung

Design
(theme_name)

Initiales Design in dem das BPC geladen wird.
Designs können zusätzlich installiert werden.

Einstellungen zu externen Links

Name (ID) Beschreibung

Online-Dokumentation
(onlineDocumentationUrl)

Wenn eine URL angegeben wird, dann wird im globalen Menü innerhalb des globalen Headers ein Link zu dieser URL angeboten.

Lizenz

Einstellungen zur BPC Lizenz

Name (ID) Beschreibung

Benachrichtigungen zur Lizenz
(licenseNotifications)

Diese Einstellung steuert den Zeitpunkt, an dem Benachrichtigungen zum Ablauf der Lizenz erzeugt werden.

Lizenzierte Module
(licencedModules)

Enthält Informationen aus der aktuell geladenen Lizenz. Diese Einstellung kann nicht überschrieben werden.

Plugin

Einstellungen zur Verwaltung von Plugins im Modul

Name (ID) Beschreibung

Plugin-Konfiguration
(plugin_configuration)

Konfiguration von Plugins, die innerhalb dieses Moduls angezeigt werden sollen. Für die Anpassung sollte die Plugin-Konfigurations-Seite des jeweiligen Moduls genutzt werden.

Siehe Plugins

API Schlüssel

Einstellungen zu API Schlüssel

Siehe API Keys

Name (ID) Beschreibung

Benachrichtigungen zu API-Keys
(apiKeysNotifications)

Benachrichtigungen zu ablaufenden API-Keys. Durch diese Konfiguration kann gesteuert werden, wann durch Benachrichtigungen auf ablaufende API-Schlüssel hingewiesen wird.

API-Key
(apiKeys)

Ein API-Key wird für die Authentifizierung und Authorisierung gegenüber der BPC REST-API verwendet.
Diese Einstellung sollte über die API-Keys-Konfigurationsoberfläche vorgenommen werden.

Account

Einstellungen zum User Account Menu

Name (ID) Beschreibung

Aktionen auf Benutzerinformationsseite
(accountPageActionContent)

Legt fest, welche Aktionen auf der Seite der Benutzerinformationen angeboten werden.
Die Reihenfolge der Werte wird berücksichtigt.
Verfügbare Werte: "logout","accountPage","updateProfile","configureTotp","changePw","link","languageSelector","cookieSettings","deleteLocalStorage", "changeOrganisation"


Keywords: