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:

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:

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:

Einstellungen für Portalkonfigurationen

Die Portalkonfiguration hat folgende Attribute:

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:

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:

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:

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.

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:

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:

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:

Die folgenden Einstellungen beziehen sich auf die Struktur:

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:

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:

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:

Widgets auf Startseite

Es gibt drei Arten von Widgets, die auf der Startseite von CM/Track angezeigt werden können:

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:

Allgemeine Einstellungen

Es sind folgende Einstellungen verfügbar. Sie werden in den Dateien config.json und public.json gespeichert:

Authentifizierung

Der Tab Authentifizierung enthält die Einstellungen, die zum Konfigurieren von Benutzerauthentifizierung über OIDC benötigt werden.

Es sind folgende Einstellungen verfügbar:

Grundlegende Aufgaben

Arbeiten mit Portalkonfigurationen

Sie können die folgenden Aktionen für Client-Konfigurationen durchführen:

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:

  1. Öffnen Sie den Tab Dateien.

    Wenn Sie ungespeicherte Änderungen im Tab Grundkonfiguration haben, müssen Sie diese Änderungen zuerst speichern.

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

  3. Bearbeiten Sie die Texte in Anführungszeichen hinter dem Doppelpunkt.

  4. 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:

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:

  1. Erstellen Sie auf der Seite Vorgangsfelder ein Feld und weisen Sie ihm die Einstellung Textdarstellung mit dem Wert Titel zu.

  2. 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:

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:

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

  2. Erstellen Sie eine OIDC-Konfiguration für jede URL. Sie muss mindestens die folgenden Properties enthalten:

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