Portalkonfigurationen
Einführung in Portalkonfigurationen in ConSol CM
Mit Portalkonfigurationen wird die Benutzeroberfläche von CM/Track konfiguriert. Sie können mehrere Portalkonfigurationen für verschiedene CM/Track-Instanzen erstellen.
Konzepte, Begriffe und Definitionen
Konzept |
Andere Begriffe |
Definition |
---|---|---|
CM/Track |
|
ConSol CM-Add-on, mit dem Kunden ihre Vorgänge erstellen und anzeigen können |
JSON |
JavaScript Object Notation |
Format für Dateien mit Portalkonfigurationen |
Aktivitätsformular |
ACF |
Formular, das angezeigt wird, wenn der Benutzer eine Aktivität ausführt. Die erforderlichen Formularfelder müssen vor dem Fortfahren ausgefüllt werden. |
Standardwerteskript |
Prefill-Skript |
Skript zum Vorbefüllen von Feldern mit bestimmten Werten bei der Vorgangserstellung |
Zweck und Verwendung
Die Portalkonfiguration ermöglicht es, folgende Aspekte von CM/Track zu definieren:
- Bilder und Farben
- Angezeigte Komponenten
- Layout der Vorgangsseite
- Lokalisierungen für verschiedene Sprachen
Eine Portalkonfiguration umfasst mehrere JSON- und CSS-Dateien, in denen Einstellungen gemacht werden. Zusätzlich werden einige Bilder in der ConSol CM-Datenbank abgelegt und die Authentifizierungseinstellungen in System-Properties gespeichert. Die Portalkonfiguration basiert auf einem Template mit den Standardeinstellungen.
Portalkonfigurationen werden in drei Tabs verwaltet:
-
Grundkonfiguration: Graphische Benutzeroberfläche, mit der alles außer die Authentifizierung, die Übersetzungen und das erweiterte Styling konfiguriert werden können
-
Authentifizierung: System-Properties für die Konfiguration der Authentifizierung
-
Dateien: JSON- und CSS-Dateien, die die Grundkonfiguration enthalten und erweiterte Anpassungen ermöglichen
Die Einstellungen auf der Seite Portalkonfigurationen gelten nur für eine oder mehrere spezifische Instanzen von CM/Track. Zusätzlich zu dieser Konfiguration sind einige globale Einstellungen, die für alle CM/Track-Instanzen gelten, erforderliche. Diese werden auf der Seite Globale Portaleinstellungen vorgenommen.
Dateien in Portalkonfigurationen
Die Portalkonfiguration für CM/Track umfasst folgende Dateien:
-
components_localization.json
Enthält die Lokalisierungen der GUI-Texte von PrimeReact-Komponenten. Standardmäßig ist die Datei auf Englisch (components_localization_en.json) und Deutsch (components_localization_de.json) verfügbar. Andere Sprachvarianten können hinzugefügt werden, um die Komponenten in diese Sprachen zu lokalisieren. -
config.json
Enthält die Konfiguration von CM/Track nach der Anmeldung. Dies umfasst die Startseite, die Vorgangsseite und die Funktion zum Ändern des Passwortes. -
custom.css
Ermöglicht es, die Standardstile von CM/Track zu überschreiben. Nutzen Sie dies nur für Style, die nicht in der theme.css enthalten sind. -
localization.json
Enthält die Lokalisierungen der GUI-Texte, die nach dem Anmelden in CM/Track angezeigt werden. Standardmäßig ist die Datei auf Englisch (localization_en.json) und Deutsch (localization_de.json) verfügbar. Andere Sprachvarianten können hinzugefügt werden, um CM/Track in diese Sprachen zu lokalisieren. -
public.json
Enthält die Konfiguration von CM/Track vor der Anmeldung. Dies umfasst die Funktion zum Zurücksetzen des Passworts und die Lokalisierungen. -
theme.css
Enthält die Einstellungen aus dem Abschnitt Visuelle Darstellung. Sollte nicht manuell editiert werden. -
welcome.json
Enthält die Konfiguration für die Kacheln zur Vorgangserstellung auf der Startseite.
Einstellungen für Portalkonfigurationen
Die Portalkonfiguration hat folgende Attribute:
-
Name: Interner Name der Konfiguration.
-
URL der CM/Track-Instanz: URL, einschließlich Protokoll, Ziel-Port und Pfad zur CM/Track-Instanz, die die Konfiguration nutzen soll. Wenn Ihre Konfiguration trackV3 heißt, wird sie automatisch von allen ihren CM/Track-Instanzen genutzt.
Wenn Sie einer Portalkonfiguration mehrere CM/Track-Instanzen zuordnen möchten, müssen Sie die System-Properties für die URL-Zuordnung und die OIDC-Konfiguration manuell editieren, siehe Verwenden einer Portalkonfiguration für mehrere URLs.
Visuelle Darstellung
CM/Track hat einen hellen und einen dunklen Modus. Sie können für jeden Modus Bilder und Farben wählen. Es können folgende Farben definiert werden:
-
Primärfarbe: Die Primärfarbe des Themes. Die hier ausgewählte Farbe wird in Buttons, Rändern, den wichtigsten Links der Anwendung und zur Hervorhebung der Auswahl verwendet.
-
Obere Leiste: Die Farbe des oberen Randes der oberen Navigationsleiste. Normalerweise die gleiche Farbe wie die Primärfarbe oder eine Komplementärfarbe dieser.
-
Text von ausgewähltem Element: Die Textfarbe für aktiv ausgewählte Elemente, zum Beispiel in einer hierarchischen Liste, einem Datum, Autocomplete, Selektor oder Dropdown. Diese Farbe dient als Hintergrundfarbe wenn ein Button fokussiert ist.
-
Schatten von fokussiertem Element: Wenn ein Element, wie ein Button oder ein Eingabefeld fokussiert ist (über Tab oder Mausklick), wird es mit einem Ring hervorgehoben. Die hier ausgewählte Farbe definiert die Farbe dieses Rings, normalerweise eine Variante der Primärfarbe.
-
Hintergrund von Kopfzeilen: Die hier ausgewählte Farbe dient als Hintergrundfarbe für Kopfzeilen, z. B. in Tabellen.
-
Hintergrund von ausgewähltem Element: Die Farbe zur Hervorhebung des aktiv ausgewählten Elements, zum Beispiel in einer hierarchischen Liste, einem Datum, Autocomplete, Selektor oder Dropdown.
-
Hintergrund von gehovertem Element: Die Farbe zur Hervorhebung des gehoverten Elements, zum Beispiel in einer hierarchischen Liste, einem Datum, Autocomplete, Selektor oder Dropdown.
-
Ränder: Die Farbe der Rahmen in der ganzen Anwendung, zum Beispiel von Formularfeldern oder Tabellen; in den meisten Fällen grau.
-
Text: Die primäre Textfarbe. Der meiste sichtbare Text erscheint in der ausgewählten Farbe.
-
Überschriftstext: Farbe für Überschriftstexte, zum Beispiel Vorgangsthema, Navigationsmenü, Kopfzeilen von Tabellen und Seiten.
-
Label-Text: Textfarbe für sekundäre oder ausgegraute Texte, hauptsächlich in Labeln.
-
Text auf Hintergrund in Primärfarbe: Farbe, wenn der Text in der Primärfarbe geschrieben ist, wie bei Buttons. Sollte bei einer dunklen Primärfarbe weiß sein und andernfalls schwarz.
Die Einstellungen werden in der Datei theme.css gespeichert und die hochgeladenen Bilder werden in der Datenbank gespeichert.
Vorgangsfelder
Konfigurieren Sie das Layout der Vorgänge für die beiden Modi:
Ansicht: Der Kunde zeigt einen vorhandenen Vorgang an. Das Layout wird in den Attributen editLayout und editLayoutOptions der Datei config.json gespeichert.
Erstellung: Der Kunde erzeugt einen neuen Vorgang. Das Layout wird in den Attributen createLayout und viewLayoutOptions der Datei config.json gespeichert.
Für jeden Modus sind folgende Einstellungen verfügbar:
-
Standardanzahl an Spalten: Definiert, in wie vielen Spalten die Felder ohne explizites Layout angezeigt werden.
-
Angezeigte Felder: Definiert, welche Felder angezeigt werden. Mögliche Werte:
-
Alle über REST verfügbaren Felder: Alle Vorgangsfelder, die so eingestellt sind, dass sie mit vollständigem Zugriff oder schreibgeschützt über REST verfügbar sind, werden angezeigt.
-
Nur explizit hinzugefügte Felder: Es werden nur explizit konfigurierte Felder angezeigt. Dies bedeutet, dass Sie die entsprechende Feldgruppe auswählen und die Felder zum Gruppenlayout hinzufügen müssen.
Ein detaillierte Beschreibung der über REST verfügbaren Felder finden Sie in Globale Portaleinstellungen.
-
-
Feldgruppen: Wählen Sie die Feldgruppen, die in CM/Track angezeigt werden sollen und sortieren Sie sie mit den Pfeiltasten. Für jede Gruppen müssen Sie auf den Button Feldlayout hinzufügen klicken, um die Felder auszuwählen, sie angezeigt werden sollen und sie nach Wunsch zu positionieren. Felder können mehrere Spalten belegen, was für große Tabellen nützlich ist.
Leere Positionen können nur am Ende einer Zeile hinzugefügt werden. Leere Positionen am Anfang oder in der Mitte werden automatisch beim Speichern der Konfiguration gelöscht.
Aktivitätsformulare
Konfigurieren Sie das Layout der Aktivitätsformulare, die in Aktivitäten verwendet werden, die für die Kunden verfügbar sind. Dies ist nur erforderlich, wenn Sie das auf der Seite Aktivitätsformulare definierte Layout überschreiben möchten.
Wählen Sie das Aktivitätsformular, dessen Layout Sie ändern möchten. Sie können die Anzahl an Spalten wählen und die Felder nach Wunsch positionieren. Felder können mehrere Spalten belegen, was für große Tabellen nützlich ist.
Felder, de nicht explizit konfiguriert sind, werden unter den konfigurierten Feldern angezeigt, d. h. Sie können keine Formularfelder entfernen, indem Sie sie aus dem Layout löschen. Stattdessen müssen Sie die Felder so einstellen, dass sie nicht mehr über REST verfügbar sind.
Leere Positionen nur am Ende einer Zeile hinzugefügt werden. Leere Positionen am Anfang oder in der Mitte werden automatisch beim Speichern der Konfiguration gelöscht.
Rich-Text-Editor
Rich-Text-Editoren werden im Kommentarfeld und in Rich-Text-Feldern verwenden. Sie haben eine gemeinsame Einstellung:
-
Maximale Dateigröße (MB): Legt die maximale Größe eines Bildes im Editor in Megabytes fest. Dies gilt sowohl für Rich-Text-Felder als auch für das Kommentarfeld.
Die folgenden Einstellungen werden für jeden Editor einzeln festgelegt. Zuerst wählen Sie die Art der Konfiguration: Kommentar oder Rich-Text-Feld. Für Rich-Text-Felder können Sie das Verhalten für alle Felde definieren, oder ein bestimmtes Feld auswählen, um die Editoreigenschaften nur für dieses Feld zu definieren.
-
Mindesthöhe des Editors (px): Nur für den Kommentareditor. Legt die Höhe des Editors in Pixeln fest.
-
Höhe des Editors (px): Nur für Rich-Text-Felder. Legt die Höhe des Editors in Pixeln fest.
-
Editor-Toolbar: Definiert die verfügbaren Toolbar-Buttons in einer JSON-Struktur. Siehe https://froala.com/wysiwyg-editor/docs/options für die verfügbaren Optionen.
Die Einstellungen werden in der Datei config.json gespeichert.
In den Dateien localization.json können Sie den Text ändern, der für Rich-Text-Felder angezeigt wird, die in der Einstellung Darstellung von Rich-Text im Ansichtsmodus für die Anzeige über einen Link konfiguriert sind:
-
preview_show_link: Text für den Link zum Öffnen des Dialogs mit dem Feldinhalt
-
preview_dialog_title: Titel des Dialogs mit dem Feldinhalt
Vorgangsliste
Sie können Standardwerte für die Filter definieren, die über der Liste der Vorgänge angezeigt werden. Es sind folgende Einstellungen verfügbar:
-
Standardwert für Vorgangsfilter: Definiert den Standardwert für den Filter Anzeigen. Wenn der Benutzer keine Berechtigungen zum Anzeigen von Vorgängen seiner Firma hat, ist der Filter unabhängig vom definierten Standardwert immer auf Meine Tickets gesetzt.
-
Standardwert für Statusfilter: Definiert den Standardwert für den Statusfilter unter Filtern nach.
-
Standardwert für Queue-Filter: Definiert den Standardwert für den Statusfilter unter Filtern nach. Wenn der Benutzer keinen Zugang zur ausgewählten Queue hat, ist der Filter auf Alle Queues gesetzt.
-
Anzeige von und Sortierung nach letztem Änderungsdatum aktivieren: Definiert, ob das letzte Änderungsdatum in der Vorgangsliste angezeigt wird und ob es als Sortierkriterium verfügbar ist. Beachten Sie, dass es sich um das technische Änderungsdatum handelt, das alle am Vorgang vorgenommenen Änderungen berücksichtigt - unabhängig davon, ob sie für den Kunden sichtbar sind oder nicht.
-
Standardwert für Sortierkriterium: Definiert den Standardwert für die Sortierung unter Sortiert nach.
-
Standardwert für Sortierreihenfolge: Definiert den Standardwert für den Button zur Sortierreihenfolge.
Kacheln zur Vorgangserstellung
Die Startseite enthält Kacheln, die als Schnellzugriff für die Vorgangserstellung dienen. Standardmäßig werden alle Queues, auf die der Benutzer Zugriff hat, auf der Startseite mit ihren Standardeinstellungen angezeigt, d. h. mit dem Queue-Namen, der Beschreibung und dem Icon von der Seite Queues.
Alternativ können Sie die Kacheln individuell definieren. Die Einstellungen werden in der Datei welcome.json gespeichert. Wenn der Benutzer Zugriff auf eine Queue hat, für die es keine Kachel gibt, wird die Queue im Button Mehr angezeigt.
Sie können Tabs und Listen frei kombinieren, um Ihre Kacheln zu gruppieren und eine hierarchische Struktur zu erzeugen. Es gibt mehrere Konfigurationsmöglichkeiten:
-
Nur Kacheln: Fügen Sie die Kacheln direkt auf der Startseite ein. So eine Konfiguration sieht ähnlich aus wie die Standarddarstellung mit dem Unterschied, dass alle definierten Kacheln direkt angezeigt werden, d. h. es kann mehrere Reihen an Kacheln geben.
-
Liste: Erstellen Sie Listenelemente und fügen Sie zu jedem Listenelement die gewünschten Kacheln hinzu. Sie können zwischen einer Darstellung als Bereich oder als Liste wählen, abhängig davon, ob alle Kacheln gleichzeitig sichtbar sein sollen oder nicht.
-
Tabs: Erstellen Sie Tabs und entscheiden Sie für jeden Tab, ob er eine Liste oder nur Kacheln enthalten soll.
Die folgenden Einstellungen beziehen sich auf die Struktur:
-
Suche nach Elementen aktiviert: Entscheiden Sie, ob über den Kacheln ein Suchfeld zum Filtern der Kacheln angezeigt werden soll. Dies kann hilfreich sein, wenn Sie viele Kacheln haben. Dies ist eine globale Einstellung.
-
Elemente pro Zeile: Wählen Sie, wie viele Kacheln auf großen Bildschirmen in jeder Zeile angezeigt werden sollen. Diese Einstellung ist global, wenn keine Tabs verwendet werden. Wenn es Tabs gibt, kann sie für jeden Tab definiert werden.
- Darstellung der Listenelemente: Nur relevant, wenn Listen verwendet werden. Wählen Sie die Darstellung der Listenelemente und Kacheln. Diese Einstellung ist global, wenn keine Tabs verwendet werden. Wenn es Tabs gibt, kann sie für jeden Tab definiert werden.
Untereinander auf der linken Seite: Links wird eine Liste angezeigt. Die Kacheln, die zu einem Listenelement gehören, werden rechts angezeigt, wenn das jeweilige Listenelement ausgewählt ist.
Ein Bereich für jedes Listenelement: Die Kacheln sind in Bereichen gruppiert, wobei jeder Bereich ein Listenelement ist. Alle Kacheln sind gleichzeitig sichtbar.
Hinzufügen von Kacheln
Klicken Sie zum Hinzufügen einer Kachel auf das Plus-Symbol im Hauptbereich. Für jede Kachel können folgende Einstellungen vorgenommen werden:
-
Name für Links: Pflichtangabe. Geben Sie der Kachel einen Namen. Dieser Name wird in der URL des Fensters zur Vorgangserstellung für diese Kachel verwendet, sodass ein Bookmark für einen direkten Zugang gesetzt werden kann.
-
Ziel-Queue: Pflichtangabe. Wählen Sie die Queue, in der der Vorgang erstellt wird.
-
Lokalisierter Name: Optional. Geben Sie den lokalisierten Namen für die Kachel ein.
-
Lokalisierte URL: Optional. Geben Sie eine gültige URL ein, um ein Link-Icon, das auf diese URL zeigt, in der Kachel anzuzeigen. Optional können Sie nach einem Leerzeichen eine Beschreibung für die URL hinzufügen.
-
Lokalisierte Beschreibung: Optional. Geben Sie die lokalisierte Beschreibung ein, die unter dem Namen der Kachel angezeigt wird.
-
Standardwerte: Optional. Wählen Sie Standardwerte, um Datenfelder der Typen Sortierte Liste oder Hierarchische Liste im Fenster zur Vorgangserstellung vorzubefüllen.
-
Icon: Pflichtangabe. Wählen Sie ein Icon für die Kachel oder laden Sie ein neues Icon hoch. Standardmäßig wird das Icon der Queue verwendet.
-
Farbe: Pflichtangabe. Wählen Sie eine Farbe für das Icon. Standardmäßig wird die Farbe der Queue verwendet.
- Kommentarfeld verbergen: Pflichtangabe. Entscheiden Sie, ob das Kommentarfeld angezeigt werden soll (Wert False) oder ausgeblendet sein soll (Wert True).
-
Art des initialen Inhalts: Pflichtangabe. Entscheiden Sie, wie sich der initiale Inhalt verhalten soll:
-
Platzhalter: Der Text wird als Watermark angezeigt und verschwindet beim Klicken in das Kommentarfeld. Geeignet für einen kurzen Hinweis.
-
Vorbelegter Text: Der Text verbleibt im Editor, damit ihn der Benutzer ergänzen kann. Typischerweise ist dies ein Entwurf oder eine Gliederung der erwarteten Eingabe.
-
-
Initialer Inhalt: Optional. Geben Sie den Text ein, der im Kommentarfeld angezeigt werden soll. Der Text kann mit HTML-Tags formatiert werden.
Verwenden von Listen
Klicken Sie zum Hinzufügen des ersten Listenelements auf den Button Neues Listenelement. Weitere Listenelemente können durch Klicken auf das Plus-Symbol unter dem ersten Listenelement hinzugefügt werden. Für jedes Listenelement können folgende Einstellungen vorgenommen werden:
-
Name: Pflichtangabe. Geben Sie einen internen Namen für das Listenelement ein.
-
Lokalisierter Name: Optional. Geben Sie den lokalisierten Namen für das Listenelement ein.
Verwenden von Tabs
Klicken Sie zum Hinzufügen des ersten Tabs auf den Button Neuer Tab. Weitere Tabs können durch Klicken auf das Plus-Symbol neben dem ersten Tab hinzugefügt werden. Für jeden Tab können folgende Einstellungen vorgenommen werden:
-
Name: Pflichtangabe. Geben Sie einen internen Namen für den Tab ein.
-
Lokalisierter Name: Optional. Geben Sie den lokalisierten Namen für den Tab ein.
-
Icon: Optional. Wählen Sie ein Icon, das vor dem Namen des Tabs angezeigt wird.
-
Farbe: Optional. Wählen Sie eine Farbe für das Icon.
Widgets auf Startseite
Es gibt drei Arten von Widgets, die auf der Startseite von CM/Track angezeigt werden können:
-
Vorgangsliste: Zeigt die neusten Vorgänge des Benutzers an.
-
Generisch: Zeigt skriptbasierten Inhalt an.
-
News: Zeigt News an.
Standardmäßig ist nur die Vorgangsliste vorhanden. Sie können zusätzliche Widgets hinzufügen, indem Sie auf den Button Widget hinzufügen klicken. Sie müssen einen internen Namen eingeben und den Widget-Typ auswählen. Die verfügbaren Einstellungen hängen vom Widget-Typ ab. Danach können Sie das Widget an die gewünschte Stelle im Grid ziehen und mithilfe der Pfeilsymbole seine Größe ändern.
Vorgangsliste
Keine weiteren Einstellungen
Generisch
Sie müssen im Feld Skript (Typ ‚Widget-Visualisierung‘) ein Widget-Visualisierungsskript auswählen (siehe Skripte des Typs Widget-Visualisierung). Das Skript muss den Inhalt des Widgets zurückgeben.
News
Sie müssen folgende Einstellungen vornehmen:
-
Skript (Typ ‚News‘): Wählen Sie ein News-Skript (siehe Skripte des Typs News), das die neuen Einträge erzeugt. Diese können von aus verschiedenen Quellen abgerufen werden, zum Beispiel Vorgangskommentare oder RSS-Feeds, oder direkt im Skript erstellt werden.
-
Überschrift: Geben Sie die Überschrift des News-Widgets in den konfigurierten Sprachen ein. Wenn keine lokalisierte Überschrift angegeben wird, wird die Standardüberschrift „News“ angezeigt.
-
Höhe (px): Geben Sie die Höhe des Widgets in Pixel an.
-
Erstellungsdatum anzeigen: Legen Sie fest, ob das Datum, an dem der News-Eintrag erzeugt wurde, angezeigt werden soll (true) oder nicht (false).
-
Aktualisierungsdatum anzeigen: Legen Sie fest, ob das Datum, an dem der News-Eintrag aktualisiert wurde, angezeigt werden soll (true) oder nicht (false).
-
Verfasser anzeigen: Legen Sie fest, ob der Verfasser des News-Eintrags, angezeigt werden soll (true) oder nicht (false).
-
Farbselektor: Wählen Sie eine Farbe für das News-Symbol und die Überschrift.
Allgemeine Einstellungen
Es sind folgende Einstellungen verfügbar. Sie werden in den Dateien config.json und public.json gespeichert:
-
Kommentar für Vorgangserstellung erforderlich: Legt fest, ob der Benutzer bei der Erstellung eines neuen Vorgangs ein Passwort eingeben muss (true) oder nicht (false).
-
Anzeigereihenfolge der Einträge der Vorgangshistorie: Legt die Reihenfolge der Einträge in der Vorgangshistorie fest; kann Neuste Einträge zuerst (Standardwert) oder Älteste Einträge zuerst sein.
-
Benutzer können ihre Passwörter nicht auf der Anmeldeseite zurücksetzen
Legt fest, ob die Benutzer ihre Passwörter auf der Anmeldeseite von CM/Track ändern kann (false, Standardwert) oder nicht (true). Wenn dieses Attribut auf true gesetzt ist, wird der Link Passwort vergessen? nicht angezeigt. -
Benutzer können ihre Passwörter nicht ändern: Legt fest, ob die Benutzer ihre Passwörter ändern können, wenn sie in CM/Track angemeldet sind (false, Standardwert) oder nicht (true). Wenn das Attribut auf true gesetzt ist, wird das Menüelement Passwort ändern nicht angezeigt.
-
Standardwerteskript anwenden
Legt fest, ob das Standardwerteskript der Queue ausgeführt wird, wenn der Benutzer einen neuen Vorgang erstellt (true) oder nicht (false), siehe Skripte des Typs Standardwerte.
Authentifizierung
Der Tab Authentifizierung enthält die Einstellungen, die zum Konfigurieren von Benutzerauthentifizierung über OIDC benötigt werden.
Es sind folgende Einstellungen verfügbar:
-
Provider-Typ: Wählen Sie „Intern“, um die ConSol CM-Authentifizierungsanwendung als OIDC-Provider zu nutzen. Wählen Sie „Extern“, wenn eine Anwendung von einem Drittanbieter, wie Azure AD oder ADFS verwendet werden soll. In der System-Property cmas-core-security, oidc.track3.providerType.<Konfigurationsname> gespeichert.
-
Globale Abmeldung: Legt fest, ob der Benutzer auch vom OIDC-Provider abgemeldet werden soll, wenn er sich aus CM/Track abmeldet. Bei einem internen Provider sollte der Wert „True“ ausgewählt werden. Bei einem externen Provider ist der Wert normalerweise „False“, sodass Sessions in anderen Anwendungen, die vom gleichen Provider bereitgestellt werden, nicht geschlossen werden. In der System-Property cmas-core-security, oidc.track3.globalLogout.<Konfigurationsname> gespeichert.
-
Authentifizierungsmethode: Schreibgeschützt. Die Authentifizierungsmethode für CM/Track, wenn der interne OIDC-Provider, d. h. ConSol CM selbst, verwendet wird.
Das ist eine globale Einstellung, die für alle Portalkonfigurationen gilt. Sie kann nur auf der Seite Globale Portaleinstellungen geändert werden.
-
URL der CM/Track-Instanz für OIDC: Schreibgeschützt. Die URL der CM/Track-Instanz zu der die OIDC-Konfiguration gehört.
Der Wert wird von der URL der CM/Track-Instanz abgeleitet. Wenn ein anderer Wert benötigt wird, können Sie ihn in der System-Property cmas-core-security, domain.map.for.oidc.config.<Konfigurationsname> auf der Seite System-Properties ändern.
-
Redirect-URI: Geben Sie die Weiterleitungs-URI an, an der Authentifizierungsantworten empfangen werden können. Dies ist entweder der OIDC-Endpunkt auf dem ConSol CM-Server, auf dem CM/Track läuft, oder auf dem Load-Balancer.
Der Wert wird von der URL der CM/Track-Instanz abgeleitet. Wenn ein anderer Wert benötigt wird, können Sie ihn in der System-Property cmas-core-security, oidc.track3.redirectUri.<Konfigurationsname> auf der Seite System-Properties ändern.
-
URL der Authentifizierungsautorität: Geben Sie die URL der Authentifizierungsautorität ein. In der System-Property cmas-core-security, oidc.track3.authority.<Konfigurationsname> gespeichert.
Der Standardwert wird von der URL, auf der die Web Admin Suite läuft, abgeleitet.
-
Client-ID: Geben Sie die Client-ID (Application-ID) der Anwendung an, so wie sie beim OIDC-Provider registriert ist. In der System-Property cmas-core-security, oidc.track3.clientId.<Konfigurationsname> gespeichert.
-
Client-Secret: Geben Sie das Secret des Client ein, das vom OIDC-Provider erzeugt wurde. In der System-Property cmas-core-security, oidc.track3.clientSecret.<Konfigurationsname> gespeichert.
-
Name des Claims: Geben Sie den Claim-Namen in ID-Token an, mit dem der Benutzer dem Kontakt in ConSol CM zugeordnet wird. Der Wert hängt von den Einstellungen des OIDC-Providers ab; die Standardwerte sind „upn“ und „unique_name“. In der System-Property cmas-core-security, oidc.track3.usernameClaim.<Konfigurationsname> gespeichert.
-
Regex zur Zuordnung von Benutzernamen: Geben Sie den regulären Ausdruck ein, mit dem die Claim-Namen des Benutzernamens den ConSol CM-Benutzernamen zugeordnet werden. In der System-Property cmas-core-security, oidc.track3.usernameRegexp.<Konfigurationsname> gespeichert.
-
“upn” als Claim: (.*)@.* verwandelt den Claim-Wert „user1@sso.yourdomain.com“ in „user1“ und sucht in der ConSol CM-Datenbank nach „user1“.
-
“unique_name” als Claim: .*\\(.*) verwandelt den Claim-Wert „SSO\user1“ in „user1“ und sucht in der ConSol CM-Datenbank nach „user1“.
-
Grundlegende Aufgaben
Arbeiten mit Portalkonfigurationen
Sie können die folgenden Aktionen für Client-Konfigurationen durchführen:
- Neue Portalkonfiguration erstellen
Klicken Sie auf den Button Neue Konfiguration und geben Sie einen Namen für die Konfiguration ein. Sie können entweder eine vorhandene CM/Track V2-Konfiguration auswählen, um sie nach CM/Track V3 zu migrieren, oder das Feld leer lassen, um auf Basis des Standard-Templates TrackV3 eine neue Konfiguration zu erzeugen. - Portalkonfiguration bearbeiten
Öffnen Sie die Details einer Konfiguration und wechseln Sie in den Tab Grundkonfiguration. Nehmen Sie die gewünschten Änderungen vor, siehe Einstellungen für Portalkonfigurationen und klicken Sie auf Konfiguration aktualisieren. - Dateien einer Portalkonfiguration bearbeiten
Öffnen Sie die Details einer Konfiguration und wechseln Sie in den Tab Dateien. Sie können den Namen einer Datei bearbeiten, indem Sie neben dem Dateinamen auf das Icon Bearbeiten klicken. Klicken Sie auf den Button Datei hinzufügen, um der Konfiguration eine neue Datei hinzuzufügen. Das kann entweder eine Datei aus dem Vorlagenselektor des Templates TrackV3 oder eine leere Datei sein. Klicken Sie unter dem Editor der Datei auf den Button Datei löschen, um diese Datei aus der Konfiguration zu entfernen. Sie können den Inhalt der Datei im Editor unter dem Dateinamen bearbeiten. Klicken Sie auf den Button Änderungen speichern, um Ihre Änderungen zu speichern. Wenn Sie mehrere Dateien ändern, können Sie auch den Button Alle Dateien speichern unten auf der Seite nutzen. Klicken Sie auf den Button Änderungen verwerfen, um Ihre Änderungen an der entsprechenden Datei rückgängig zu machen. - Portalkonfiguration löschen
Klicken Sie auf das Icon Löschen. Die Konfiguration wird nach dem Bestätigen der Warnmeldung gelöscht.
Erweiterte Aufgaben
Bearbeiten von GUI-Texten
Die GUI-Texte können in den Dateien components_localization.json, localization.json und public.json geändert werden:
-
Öffnen Sie den Tab Dateien.
Wenn Sie ungespeicherte Änderungen im Tab Grundkonfiguration haben, müssen Sie diese Änderungen zuerst speichern.
-
Klicken Sie auf den Button mit der gewünschten Datei, um zum Anfang der Datei zu scrollen.
-
components_localization.json: Enthält Texte aus Komponenten, die der Benutzer nach dem Anmelden in CM/Track sieht.
-
localization.json: Enthält Texte, die der Benutzer nach dem Anmelden in CM/Track sieht.
-
public.json: Enthält Texte auf der Anmeldeseite von CM/Track.
-
-
Bearbeiten Sie die Texte in Anführungszeichen hinter dem Doppelpunkt.
-
Speichern Sie Ihre Änderungen, indem Sie unter der Datei auf den Button Änderungen speichern klicken oder auf den globalen Button Alle Dateien speichern klicken.
Ändern der Zahlen- und Datumsformate
Die Datei localization.json enthält Attribute zum Ändern der Formate für Zahlen und Daten:
-
globalDateViewFormat: Datumsformat im Ansichtsmodus, Standardwert is dd.MMM yyyy
-
globalDateEditFormat: Datumsformat im Bearbeitungsmodus, Standardwert ist dd.MMM yyyy für Deutsch und M/d/yy für Englisch
-
number_decimal_separator: Dezimaltrennzeichen, Standardwert ist , für Deutsch
-
number_group_separator: Tausender-Trennzeichen, Standardwert ist . für Deutsch
Hinzufügen von Überschriften zum Layout von Vorgängen oder Aktivitätsformularen
Sie können die Felder von Vorgängen oder Aktivitätsformularen mithilfe von Überschriften strukturieren:
-
Erstellen Sie auf der Seite Vorgangsfelder ein Feld und weisen Sie ihm die Einstellung Textdarstellung mit dem Wert Titel zu.
-
Fügen Sie das Feld zum Layout hinzu:
-
Vorgangsfelder: Klicken Sie auf den Button Feldlayout hinzufügen der entsprechenden Feldgruppe, wählen Sie das Feld aus und positionieren Sie es nach Wunsch.
-
Aktivitätsformular: Fügen Sie das Feld auf der Seite Aktivitätsformulare zum Aktivitätsformular hinzu und positionieren Sie es nach Wunsch.
-
Stellen Sie sicher, dass die Gruppe, zu der das Feld gehört, mindestens ein Feld mit einem Wert enthält. Ansonsten wird die ganze Gruppe beim Anzeigen des Vorgangs ausgelassen.
Verwenden einer Portalkonfiguration für mehrere URLs
Die Standard-OIDC-Konfiguration deckt die Situation ab, dass die Standard-Portalkonfiguration „trackV3“ von einer Instanz von CM/Track verwendet wird, die über eine URL verfügbar ist. Wenn die Portalkonfiguration einen anderen Namen hat, wird automatisch eine OIDC-Konfiguration mit diesem Namen erstellt, wenn die URL der CM/Track-Instanz angegeben wird.
Manuelle OIDC-Konfigurationen sind erforderlich, wenn mehrere URLs verwendet werden, zum Beispiel in folgenden Situationen:
-
Zwei verschiedene Instanzen von CM/Track nutzen dieselbe Portalkonfiguration.
-
Auf eine Instanz von CM/Track kann über verschiedene URLs zugegriffen werden, z. B. eine interne URL und eine externe URL.
Für jede URL, über die auf CM/Track zugegriffen wird, ist eine OIDC-Konfiguration nötig. Diese muss manuell auf der Seite System-Properties angelegt werden. Es sind folgende Änderungen erforderlich:
-
Fügen Sie alle URLs, die die Portalkonfiguration nutzen sollen, durch Kommas getrennt zur System-Property cmas-restapi-core, domain.map.for.client.config.<Portalkonfiguration> hinzu, z. B. domain.map.for.client.config.MYPORTAL=http://cm.consol.pl:8999/cm-track, http://cm.consol.pl/cm-track.
-
Erstellen Sie eine OIDC-Konfiguration für jede URL. Sie muss mindestens die folgenden Properties enthalten:
-
Erstellen Sie cmas-core-security, domain.map.for.oidc.config.<OIDC-Konfiguration> und setzen Sie die URL, über die CM/Track erreichbar ist als Wert, z. B. domain.map.for.oidc.config.MYTRACK1=http://cm.consol.pl:8999/cm-track.
-
Erstellen Sie cmas-core-security, oidc.track3.redirectUri.<OIDC-Konfiguration> und setzen Sie den Endpunkt /oidc der CM/Track-Instanz als Wert, z. B. oidc.track3.redirectUri.MYTRACK1=http://cm.consol.pl:8999/cm-track/oidc/.
-
Erstellen Sie cmas-core-security, oidc.track3.authority.<OIDC-Konfiguration> und setzen Sie den Endpunkt /cmas-auth-portal-user der Authentifizierungs-Applikation als Wert, z. B. oidc.track3.authority.MYTRACK1=http://cm.consol.pl:8999/cmas-auth-portal-user.
-
-
Prüfen Sie die Standard-OIDC-Konfiguration, siehe Authentifizierung. Wenn andere Werte benötigt werden, erstellen Sie konfigurationsspezifische Properties, um die Standardwerte zu überschreiben, z. B. oidc.track3.authority.MYTRACK1.