Client-Konfigurationen

Einführung in Client-Konfigurationen in ConSol CM

Mit Client-Konfigurationen kann die Benutzeroberfläche von CM/Track und kundenspezifischen REST-Clients konfiguriert werden. In diesem Handbuch ist die Konfiguration von CM/Track beschrieben.

Konzepte, Begriffe und Definitionen

Konzept

Andere Begriffe

Definition

CM/Track

 

ConSol CM-Add-on; Portal, in dem Kunden ihre Vorgänge erstellen und anschauen können

JSON

JavaScript Object Notation

Format von Client-Konfigurationen in ConSol CM

Aktivitätsformular

ACF

Formular, das angezeigt wird, wenn der Benutzer eine Aktivität ausführt. Die Pflichtfelder des Formulars müssen vor dem Fortfahren ausgefüllt werden.

Standardwerteskript

 

Skript, mit dem Felder bei der Vorgangserstellung mit bestimmten Werten vorbefüllt werden

Zweck und Verwendung

In der Client-Konfiguration können folgende Aspekte von CM/Track definiert werden:

Es können mehrere Client-Konfigurationen für unterschiedliche CM/Track-Instanzen erstellt werden. Die Zuordnung erfolgt über System-Properties, siehe Zuordnen der Client-Konfiguration zur CM/Track-Instanz.

Eine Client-Konfiguration besteht aus einer oder mehreren JSON-Dateien, in denen die Einstellungen vorgenommen werden. Diese Einstellungen überschreiben die Standardkonfiguration von CM/Track. Für alle nicht explizit in den JSON-Dateien konfigurierten Aspekte, wird die Standardkonfiguration verwendet, d. h. die JSON-Dateien müssen nicht vollständig sein. Es reicht aus, die Abweichungen von der Standardkonfiguration festzulegen.

Verfügbare Attribute für Client-Konfigurationen

Die Client-Konfiguration für CM/Track enthält folgende Dateien:

In den folgenden Abschnitten sind die verfügbaren Einstellungen für die einzelnen Dateien beschrieben.

config.json

Diese Datei enthält die Einstellungen für die Anzeige von Vorgängen und die Startseite. Folgende Attribute können in dieser Datei verwendet werden:

localization.json

Die Lokalisierungsdateien, z. B. localization_en.json und localization_de.json, enthalten die GUI-Texte, die in CM/Track in der jeweiligen Sprache angezeigt werden, nachdem sich der Benutzer angemeldet hat.

Zusätzlich können Sie die Trennzeichen für Festkommazahlen ändern, indem Sie die Attribute number_decimal_separator und number_group_separator mit den gewünschten Trennzeichen zur Lokalisierungsdatei jeder Sprache hinzufügen.

Das folgende Beispiel zeigt die Attribute mit den Standardwerden für Deutsch:

public.json

Die Datei public.json enthält die Konfiguration von CM/Track vor der Anmeldung. Dazu gehören die Funktion zum Zurücksetzen des Passworts auf der Anmeldeseite und die Lokalisierungen.

In dieser Datei können folgende Attribute verwendet werden:

Grundlegende Aufgaben

Arbeiten mit Client-Configurationen

Jede Client-Konfiguration hat einen eigenen Tab. Im unteren Bereich der Seite befinden sich die Aktionen, die sich auf die Konfiguration als Ganzes beziehen. Jede Datei innerhalb einer Konfiguration hat ihren eigenen Editor. Die Aktionen unter dem Editor beziehen sich auf die jeweilige Datei.

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

Konfigurieren der Vorgangsseite

Für Vorgangsseiten können folgende Aspekte in der Datei config.json konfiguriert werden:

Die folgenden Aspekte können für Vorgangsseiten in der Datei localization.json konfiguriert werden:

Regeln für die Konfiguration des Feldlayouts

Im folgenden Abschnitt ist beschrieben, wie das Feldlayout definiert wird. Das allgemeine Prinzip gilt für folgende Attribute:

Es gelten folgende Regeln:

Im folgenden Beispiel hat das Vorgangslayout zwei Zeilen und drei Spalten. Die erste Zeile enthält die Felder module und categories. Das Feld categories belegt zwei Spalten. In der zweiten Zeile gibt es eine leere Position neben dem Feld priority.

"layout": {

"helpdesk_standard": [

["module", "categories","categories"],

["reactiontime","priority","EMPTY"]

]

},

Das folgende Beispiel zeigt die Konfiguration für das Aktivitätsformular qualify mit dem Feld categories, das zwei Spalten breit ist:

"acf" : {

"qualify": [

["impact", "severity", "EMPTY"],

["categories", "categories", "EMPTY"],

["product_table", "product_table", "product_table"]

]

}

Wenn die Feldnamen nicht eindeutig sind, weil das Aktivitätsformular Felder aus mehreren Vorgangsfeldgruppen enthält, müssen Sie die Felder mit der Syntax gruppenName.feldName referenzieren.

Nutzen Sie in Ihrem Aktivitätsformular 3 Spalten, wenn das Formular Tabellen enthält, die viel Platz benötigen.

Sie können die Felder mithilfe von Überschriften strukturieren:

Einstellungen für Rich-Text-Editoren

Kommentare und Rich-Text-Felder haben Rich-Text-Editoren. Die Konfiguration erfolgt im Attribut richTextEditorSettings, das mehrere Einstellungen enthält:

Das folgende Beispiel zweigt die Verwendung der Einstellungen:

"richTextEditorSettings": {

"customfieldContentFileMaxSize": 10,

"froalaConfig": {

"mainCommentEditor": {

"heightMin": 200,

"toolbarButtons": [[

"bold", "italic", "underline", "strikeThrough", "|",

"align", "|", "paragraphFormat", "fontFamily", "fontSize", "textColor", "backgroundColor", "-",

"subscript", "superscript", "|",

"formatOL", "formatUL", "indent", "outdent", "|",

"insertTable", "|", "specialCharacters", "insertLink", "insertImage"]]

},

"commonRichTextFieldsEditor": {

"height": "auto",

"toolbarButtons" : [

"bold", "italic", "underline", "fontFamily", "fontSize", "insertImage"

]

}

}

}

Wenn das Rich-Text-Feld die Einstellung Darstellung von Rich-Text im Ansichtsmodus hat, kann der im Link und im Titel des Popup-Fensters verwendete Text in der Datei localization.json konfiguriert werden. Fügen Sie die folgenden Keys hinzu:

'preview_show_link': '[Inhalt anzeigen]',

'preview_dialog_title': 'Inhaltsansicht'

Konfigurieren der Startseite

Die Startseite wird angezeigt, nachdem der Benutzer sich in CM/Track angemeldet hat. Sie enthält folgende Elemente:

Für die Konfiguration der Startseite sind folgende Dateien relevant:

Die folgende Abbildung zeigt die Startseite für einen Benutzer mit Zugriff auf zwei Queues. Beachten Sie, dass alle Queues, auf die der Benutzer Zugriff hat, auf der Startseite angezeigt werden, auch wenn sie nicht explizit konfiguriert wurden. Queues ohne angepasste Konfiguration werden mit den Standardeinstellungen dargestellt.

Konfigurieren der Felder zur Vorgangserstellung

Das folgende Beispiel zeigt eine Konfiguration der Startseite in der Datei config.json:

"welcomePage": {

"queuePanels": [

{

"@name": "HelpDesk_1st_Level",

"description": "custom_HD_description",

"icon": "fa-bug"

},

{

"@name": "ServiceDesk",

"description": "custom_SD_description",

"icon": "fa-question"

}

]

}

Code-Beispiel 33: Beispielkonfiguration der Startseite

Das folgende Beispiel zeigt die für die Startseite erzeugten Schlüssel in der Datei localization.json:

{

"custom_HD_description": "Queue for IT questions",

"custom_SD_description": "Queue for general questions"

}

Code-Beispiel 34: Ausschnitt aus localization_en.json mit den benutzerdefinierten Bezeichnungen für die Queue-Beschreibung

Es sind folgende Parameter verfügbar:

Wenn keine explizite Konfiguration angegeben ist, werden die Standardwerte (Beschreibung der Queue in der Web Admin Suite und ein Ordner-Icon) verwendet. Alle Queue, für die der Benutzer Berechtigungen zum Erstellen von Vorgängen hat, werden angezeigt.

Sind mehrere Queues vorhanden, so werden sie in der Reihenfolge angezeigt, in der sie in der Datei config.json konfiguriert sind. Queues, die nicht explizit konfiguriert wurden, werden zuletzt angezeigt.

Konfigurieren der News

Die Startseite kann um News erweitert werden. Zu diesem Zweck wird ein Skript des Typs News (siehe Skripte des Typs News) auf der Seite Skripte der Web Admin Suite erstellt und die Konfiguration der News-Darstellung zur Datei config.json hinzugefügt. Die vom Skript zurückgegebenen News können aus mehreren Quellen abgerufen werden, zum Beispiel aus Ticketkommentaren oder RSS-Feeds, oder direkt im Skript erstellt werden.

Das folgende Codebeispiel zeigt eine News-Konfiguration in der Datei config.json. Es konfiguriert die Darstellung der vom Skript news.groovy erstellten News-Einträge. Eine Beschreibung der anderen Einstellungen finden Sie in News-Widgets.

"newsConfiguration": {

"scriptName": "news.groovy",

"autoscroll": "smooth",

"title": "News",

"height": 350,

"createDate": true,

"updateDate": true,

"author": true,

"color": "#488ca1"

}

Code-Beispiel 35: Abschnitt newsConfiguration einer config.json-Datei

Der lokalisierte Titel des News-Bereichs wird im Attribut newsTitle der Datei localization_en.json/localization_de.json angegeben. Wenn kein lokalisierter Titel angegeben ist, wird der Standardtitel „News“ verwendet.

Konfigurieren der Password-Funktionalitäten

Die Passwort-Funktionalitäten werden an folgenden Stellen konfiguriert:

In beiden Fällen bedeutet false, dass das entsprechende Element nicht angezeigt wird und der Benutzer sein Passwort nicht ändern / zurücksetzen kann. true bedeutet, dass das Password geändert werden kann. Der Standardwert ist false.

Erweiterte Aufgaben

Verwenden der Funktionen des JSON-Editors

Der JSON-Editor hat folgende Funktionen:

Setzen von System-Properties für CM/Track

Es gibt mehrere System-Properties, die gesetzt werden müssen, um CM/Track zu verwenden.

Zuordnen der Client-Konfiguration zur CM/Track-Instanz

Mit der Property cmas-restapi-core, domain.map.for.client.config.<name> ordnen Sie die Client-Konfiguration einer oder mehrerer CM/Track-Instanzen zu. Der Wert der Property muss die Domäne ohne das Protokoll, der Zielport (falls erforderlich) und der Pfad der entsprechenden CM/Track-Instanz sein. Wenn Sie einer Client-Konfiguration mehrere CM/Track-Instanzen zuordnen möchten, können Sie eine durch Kommas getrennte Liste der Domänen verwenden.

Beispiel:

Diese System-Property muss manuell hinzugefügt werden.

Zulassen der Kommunikation zwischen ConSol CM und CM/Track

Aus Sicherheitsgründen muss die Kommunikation zwischen dem ConSol CM-Server und CM/Track explizit aktiviert werden. Dies erfolgt in folgenden System-Properties:

Verwalten von Client-Konfigurationen nach Updates

Die Vorlage für die Client-Konfiguration wird bei der Installation oder dem Update von ConSol CM hinzugefügt. Wenn Sie ConSol CM auf eine neuere Version aktualisieren, werden die Dateien von vorhandenen Konfigurationen nicht verändert. Das bedeutet, dass neue Konfigurationsoptionen und Lokalisierungen nicht automatisch hinzugefügt werden. Sie können sie nach dem Update anhand der Vorlagendateien hinzufügen.