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"
Parameter (Key) | Typ | Beschreibung |
---|---|---|
Module_Description |
text |
Ermöglicht die Hinterlegung einer kurzen Beschreibung des Moduls. Kann z.B. im Module Header angezeigt werden. |
Module_ForceLoad |
bool |
Erzwingt das initiale Laden auch bei der Ladestrategie "onDemand", damit Ladeabhängigkeiten berücksichtigt werden können. |
Module_Header |
bool |
Ermöglicht das De-/Aktivieren eines zusätzlichen Anzeige- und Funktionsbereichs im Header des Moduls. |
Module_Icon |
text |
Definiert das Anzeige-Icon des Moduls. Bspw. alle Font-Awesome-Icons. |
text |
Legt fest, wie das BPC relevante Module nachlädt.
|
|
Module_Name |
text |
Definiert den Anzeige-Namen des Moduls. |
Module_URL |
text |
Gibt den modulspezifischen Basis-Pfad des REST-Interfaces des Core-Moduls an. |
Gruppe "plugin"
Parameter (Key) | Typ | Beschreibung |
---|---|---|
PluginConfiguration |
json |
Plugin-Konfiguration im JSON-Format |
Gruppe "identityProvider"
Parameter (Key) | Typ | Beschreibung |
---|---|---|
IdentityProvider_BackendConnection |
text |
Legt den zu verwendenden Identity Provider fest. |
Gruppe "login"
Parameter (Key) | Typ | Beschreibung |
---|---|---|
Login_Default_Language |
text |
Ist dies gesetzt, dann überwiegt es die Browser-Sprache, aber nicht einen möglichen URL-Parameter. |
Login_LandingPage |
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 |
text |
Definiert die Willkommen-Nachricht nach erfolgreichem Login in der Applikation. |
Login_PasswordReset |
bool |
Definiert, ob die Funktion "Passwort vergessen" in der Login-Ansicht verfügbar ist. |
Login_Show_Language_Selector |
bool |
Sprachauswahl im Login ausblenden |
Login_TenantDefault |
text |
Ermöglicht die Angabe eines Default-Mandanten für den Login. Angabe eines gültigen Organisationsnamens entsprechend der Identity Provider Konfiguration. |
Login_TenantSelection |
bool |
Definiert, ob die Angabe eines Mandanten in der Login-Ansicht verfügbar ist. |
Login_Title |
text |
Definiert den auf der Login-Ansicht angezeigten Anwendungstitel. |
Logout_ResetUrl |
bool |
Entfernt beim Abmelden den aktuellen Deeplink aus der URL. |
Gruppe "core"
Parameter (Key) | Typ | Beschreibung |
---|---|---|
API_Keys |
json |
|
Core_BaseURL |
text |
Gibt die Server-URL an, unter der das BPC erreichbar ist. |
Core_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 |
json |
Definition des Standard-Backup-Zyklus' der BPC-Konfiguration. |
Core_ConfigurationBackupOnChange |
bool |
Ermöglicht die automatische Erstellung eines Backups der BPC-Konfiguration, wenn Einstellungen geändert bzw. gelöscht wurden. |
Core_Deployment |
json |
Festlegung von Modul-Einstellungen bei denen während des Deployment eine Warnung erscheinen soll. Siehe Deployment Constraints |
Core_FrontendOnlyModules |
json |
Registrierung von Custom-Frontend-Modulen ohne Backend. |
Core_IndexCreationSettings |
json |
Standard Index Einstellungen, die beim Anlegen eines neuen Index (durch das BPC) verwendet werden. |
Core_IndexDynamicTemplates |
json |
Standard Dynamic Templates, die beim Anlegen eines neuen Index (durch das BPC) verwendet werden. |
Core_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_RestURLExtension |
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 |
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 |
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. |
Gruppe "frontend"
Parameter (Key) | Typ | Beschreibung |
---|---|---|
Browser Icon |
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 |
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. Platzhalter: Platzhalter werden durch geschweifte Klammern gesetzt.
Die Klammern und der Inhalt wird dann entsprechend ersetzt. Mögliche Werte für den Platzhalter:
|
CoreUI_AdditionalSourceFiles |
json |
Erlaubt die Einbindung externer JS- bzw. CSS-Sourcen durch Angabe von HTTP-Urls. |
CoreUI_Breadcrump |
bool |
De-/Aktiviert den Breadcrumb, der die aktuelle Position des Benutzers in der Anwendung anzeigt. |
CoreUI_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 |
json |
Konfiguriert die Schnellauswahl Favoriten der Datumsauswahl. |
CoreUI_ModuleNavigator |
bool |
De-/Aktiviert die Navigationsmöglichkeit zum zuletzt geöffneten Moduls. |
CoreUI_StageColor |
text |
Erlaubt die Angabe einer Hintergrundfarbe zur Unterscheidung von unterschiedlichen Stages. Farbcodes: red, #FF0000, rgba(255,0,0,0.5) |
CoreUI_ViewConfiguration |
json |
Definition der Seitenstruktur sowie der Applikationsbereiche im BPC. Siehe Ansicht und Navigationsstruktur. |
CoreUI_WelcomeNotification |
text |
Angabe der Begrüßungsnachricht beim Einloggen ins BPC. |
FunctionToolbar |
bool |
Ermöglicht das De-/Aktivieren der BPC-Toolbar. |
FunctionToolbar_GlobalMenuEnabled |
bool |
Ermöglicht das De-/Aktivieren des globalen Menüs. |
FunctionToolbar_GlobalMenuShowLogout |
bool |
Ermöglicht das Ausblenden der "Abmelden"-Funktion im globalen Menu. |
FunctionToolbar_Height |
integer |
Angabe der Höhe der BPC-Toolbar in Pixel. |
FunctionToolbar_NotificationWidth |
text |
|
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. |
|
Module_HeaderLarge |
bool |
Definiert, ob der ModuleHeader ein- oder zweizeilig angezeigt wird. |
NavigationToolbar |
bool |
Ermöglicht das De-/Aktivieren der BPC-Navigationsleiste. |
NavigationToolbar_Expanded |
bool |
Definiert, ob die Navigationsleiste standardmäßig ausgeklappt ist. |
NavigationToolbar_Width |
integer |
Angabe der Breite der Navigationsleiste im ausgeklappten Zustand in Pixel. |
NavigationToolbar_WidthCollapsed |
integer |
Angabe der Breite der Navigationsleiste im eingeklappten Zustand in Pixel. |
Gruppe "performanceTracing"
Parameter (Key) | Typ | Beschreibung |
---|---|---|
PerformanceTracing |
bool |
Aktiviert die Core-Funktionen zur Überwachung der Applikationsperformance. |
Gruppe "theme"
Parameter (Key) | Typ | Beschreibung |
---|---|---|
CoreUI_Theme |
list |
Erlaubt die Auswahl eines Themes. |
Gruppe "externalLinks"
Parameter (Key) | Typ | Beschreibung |
---|---|---|
Documentation_URL |
text |
Ermöglicht die Pflege einer externen URL zur Systemdokumentation. Diese kann im Hauptmenü aufgerufen werden. |
Gruppe "license"
Parameter (Key) | Typ | Beschreibung |
---|---|---|
License_Notification |
json |
Ermöglicht die Konfiguration von Benachrichtigungen zu festgelegten Zeitpunkten vor Ablauf der Gültigkeit der BPC-Lizenz. |
License_Overview |
json |
Stellt eine Übersicht der Lizenzbedingungen entsprechend der eingespielten BPC-Lizenz bereit. |
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:
Parameter | Datentyp | Beschreibung | ||
---|---|---|---|---|
|
Zahl |
Ansicht, die initial angezeigt werden soll. Referenziert eine viewID. |
||
|
Array |
Eine Liste von View-Objekten. |
||
Zahl |
ID des View-Elements.
Wird nicht berücksichtigt, wenn es sich unterhalb von
|
|||
|
Text |
Text des Menü-Eintrags |
||
|
Text |
Tooltip-Inhalt |
||
|
Text |
Name der Modul-Instanz, die nach Klick auf das Navigationselement angezeigt wird. |
||
|
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. |
||
|
Array |
Liste von Unterelementen. |
||
|
Text / Array |
Bezeichnung eines Benutzerrechtes. |
||
|
Text / Array |
Bezeichnung einer Benutzerrolle. Beispiel: |
||
|
Text |
Bezeichnung einer Organisation. |