System-Properties

Einführung in System-Properties in ConSol CM

In System-Properties werden Einstellungen für das ConSol CM-System gespeichert. Diese Einstellungen werden in unterschiedlichen Bereichen verwendet, zum Beispiel, um die E-Mail-Funktion zu konfigurieren, die Authentifizierungsmethode festzulegen oder den Index anzupassen.

In den meisten Fällen werden Änderungen an den System-Properties sofort wirksam. Lesen Sie immer die Property-Dokumentation und prüfen Sie die Auswirkungen des neuen Wertes, bevor Sie eine System-Property ändern.

Konzepte, Begriffe und Definitionen

Konzept	Andere Begriffe	Definition
Standard-Property		In ConSol CM vordefinierte Property
System-Property		Standard-Property, die für den Systembetrieb notwendig ist und daher nicht gelöscht werden kann
eigene Property	benutzerdefinierte System-Property	Vom Administrator während der Konfiguration des ConSol CM-Systems definierte System-Property.

Zweck und Verwendung

System-Properties werden zum Speichern von globalen Einstellungen für ConSol CM und Konfigurieren von ConSol CM-Komponenten, wie beispielsweise dem E-Mail-System und dem Index, verwendet. Zusätzlich können in System-Properties globale Variablen für Skripte gespeichert werden. Sie bilden damit eine bequeme Möglichkeit, um Einstellungen zu verwalten, die in Workflows und Skripten benötigt werden, wie zum Beispiel Reaktionszeiten, im Prozess benötigte E-Mail-Adressen oder die URL, über die ConSol CM erreichbar ist.

Verfügbare Einstellungen für System-Properties

Verschiedene Arten von System-Properties

Es gibt zwei Arten von System-Properties: die in ConSol CM vordefinierten Properties und die vom Administrator während der Konfiguration des ConSol CM-Systems definierten Properties.

• Standard-Properties:
  Vordefinierte Properties mit einer bestimmten Bedeutung/Funktion in ConSol CM. Anhängig von ihrer Nutzung werden sie:

  • automatisch bei der Installation oder Aktualisierung von ConSol CM hinzugefügt. Automatisch hinzugefügte Properties können mit einem Standardwert vorbefüllt sein.
  • automatisch beim Ausführen bestimmter Aktionen in der Web Admin Suite hinzugefügt.
  • manuell vom Administrator hinzugefügt.

  Über das Dokumentations-Icon in den Property-Details können Sie die Dokumentation der einzelnen Properties anzeigen. Eine komplette Liste finden Sie in Liste der System-Properties.

  Die Standard-Properties, die nicht gelöscht werden können, weil sie für den Systembetrieb erforderlich sind, werden „System-Properties” genannt.

• Eigene Properties:
  Vom Kunden definierte Properties. Der Administrator kann bei der Konfiguration des ConSol CM-Systems zusätzliche Properties definieren. Mit diesen Properties können globale Variablen bequem an Skripte übergeben werden, da sie geändert werden können, ohne das Skript selber zu bearbeiten. Häufige Anwendungsfälle für eigene Properties sind das Festlegen von Reaktionszeiten, die Definition von im Prozess benötigten E-Mail-Adressen oder das Speichern der System-URL.

  Best Practice

  Geben Sie beim Erstellen von eigenen Properties immer eine Beschreibung an. Die Beschreibung sollte den Zweck der Property und die möglichen Werte enthalten. Das ist besonders bei Ganzzahl-Properties wichtig, da dort die Maßeinheit entscheidend ist.

Felder

Die folgenden Felder sind für System-Properties verfügbar:

• Modul:
  Pflichtfeld. Der Bereich, zu dem die System-Property gehört.

  Der Modulname von eigenen Properties sollte mit custom- beginnen. Details dazu in Importieren und Exportieren von System-Properties.

  Sie können entweder ein vorhandenes Modul aus der Liste der Autocomplete-Vorschläge auswählen oder ein neues Modul erstellen, indem Sie den gewünschten Modulnamen eingeben und die Option Neuen Wert erstellen: <Modulname> in den Autocomplete-Vorschlägen auswählen.

• Property:
  Pflichtfeld. Der Name der System-Property. Er muss innerhalb des Moduls eindeutig sein.

• Typ:
  Pflichtfeld. Der Datentyp des Property-Wertes. Mögliche Datentypen sind:

  • Text: Textfeld.
  • Passwort: Passwortfeld, statt dem Wert werden Punkte angezeigt.
  • E-Mail: E-Mail-Feld, der Wert muss ein gültiges Format für E-Mail-Adressen haben (<Adresse>@<Domäne>).
  • Boolean: Boolean-Feld, mögliche Werte sind true, false und leer (nur wenn die Property optional ist).
  • Ganzzahl: Zahlenfeld, der Wert muss eine Zahl ohne Nachkommastellen sein.

• Wert
  Der Wert der System-Property. Der Wert ist eine Pflichtangabe, sofern die Property nicht optional ist. Andernfalls kann der Wert leer sein. Er muss zum ausgewählten Typ passen.

• Beschreibung
  Optional. Ein Text mit der Beschreibung der Property.

  Best Practice

  Geben Sie beim Erstellen von eigenen Properties immer eine Beschreibung an. Die Beschreibung sollte den Zweck der Property und die möglichen Werte enthalten. Das ist besonders bei Ganzzahl-Properties wichtig, da dort die Maßeinheit entscheidend ist.

• Über REST verfügbar
  Pflichtfeld. Wenn diese Checkbox ausgewählt ist, kann der Wert der Property über die REST-API abgerufen werden. Details dazu finden Sie in der ConSol CM REST API Dokumentation.

  Ein reguläres ConSol CM-Benutzerkonto reicht aus, um System-Properties über REST abzurufen. Stellen Sie sicher, dass Sie keine sensiblen Daten offenlegen, auf die normale Benutzer keinen Zugriff haben dürfen.

• Im Staging-Export enthalten
  Wenn diese Checkbox ausgewählt ist, wird die Property beim Erzeugen eines Szenarios auf der Seite Staging-Export mit exportiert.

Grundlegende Aufgaben

Suchen nach System-Properties

Die Liste der System-Properties wird direkt nach dem Öffnen der Seite System-Properties der Web Admin Suite angezeigt. Sie können die Liste filtern, um die System-Properties leichter zu finden:

• Textsuche: Führen Sie eine Freitext-Suche durch.

  Geben Sie im Feld Suchen Text ein, um nach Modul, Namen, Wert oder Typ der Property zu filtern.

• Module: Zeigen Sie nur die System-Properties an, die zu einem bestimmten Modul gehören.

  Wählen Sie das Modul in der Drop-down-Liste Alle Module.

• Art der Property: Zeigen Sie nur vordefinierte Properties oder nur eigene Properties an.

  Wählen Sie in der Drop-down-Liste Alle Properties die Option Standard-Properties, System-Properties oder Eigene Properties aus.

Verwalten von System-Properties

Sie können für System-Properties folgende Aktionen ausführen:

• Neue Property erstellen
  Klicken Sie über der Liste der Properties auf den Button Neue Property und geben Sie die erforderlichen Werte ein.

  Wenn die neue Property einer vorhandenen ähnelt, können Sie die Seite Neue Property mit den Daten einer vorhandenen Property vorbefüllen, indem Sie in der Zeile dieser Property auf das Icon Duplizieren klicken.

• Property bearbeiten
  Klicken Sie auf das Icon Bearbeiten oder die Zeile der Property und aktualisieren Sie die gewünschten Daten im Bearbeitungsbereich auf der rechten Seite.

• Property löschen
  Sie können optionale Properties löschen, indem Sie auf das Icon Löschen klicken. Um mehrere Properties gleichzeitig zu löschen, wählen Sie die Properties aus und klicken Sie über der Tabelle auf das Icon Löschen.

• Property-Dokumentation anzeigen
  Sie können die Dokumentation einer System-Property anzeigen, indem Sie in den Property-Details auf das Icon Dokumentation klicken. Die Dokumentation wird in einem Modalfenster angezeigt.

Erweiterte Aufgaben

Verwendung von System-Properties in Skripten

Sie können globale Variablen in System-Properties speichern, um sie später in Skripten zu verwenden. Dies ist praktisch, da die Werte später leicht geändert werden können, ohne die Skripte anpassen zu müssen. Beispiele für globale Variablen können Reaktionszeiten, im Prozess benötigte E-Mail-Adressen oder die System-URL sein.

Mit der folgenden Methode wird der Wert einer System-Property abgerufen:

configurationService.getValue(String pModule, String pProperty)

Importieren und Exportieren von System-Properties

System-Properties werden bei der Verwendung der Funktion zum Import-/Export von Szenarien besonders behandelt. Die vordefinierten System-Properties werden standardmäßig nicht mit dem regulären Szenario exportiert. Eigene Properties werden nur dann exportiert, wenn ihr Modulname mit custom- beginnt. Das liegt daran, dass die Import-/Export-Funktion häufig für die Übertragung von Daten von Entwicklungs- oder Testsystemen auf Produktivsysteme verwendet wird. Auf jedem dieser Systeme werden möglicherweise spezielle Werte benötigt, zum Beispiel für die E-Mail-Einstellungen, sodass es nicht erwünscht ist, diese Werte beim Importieren eines Szenarios zu überschreiben.

Bei den Properties, die exportiert werden sollen, müssen Sie die Checkbox Im Staging-Export enthalten, markieren.

Alternativ können Sie einen benutzerdefinierten Export erzeugen, der gezielt die zu exportierenden von System-Properties enthält.

Details zu dieser Funktion finden Sie in Staging-Export und Benutzerdefinierter Export.