Konfigurationen für Widgets zusammenstellen

Mit der Bibliothek agorum.composite.configured-settings stellen Sie Konfigurationen für Widgets zusammen, die eine ACL haben und die Sie über einen Kundenbereich überschreiben können.

Verwendung

---

let settings = require('/agorum/roi/customers/agorum.composite/js/configured-settings').load('name-of-the-widget', user);

• Der Parameter user ist optional.
• Das System verwendet den angemeldeten Benutzer, wenn Sie den Parameter user nicht angeben.

Alternativ verwenden Sie folgenden Aufruf, mit dem der Unterordner settings ebenfalls bestimmbar ist. Den Aufruf verwenden Sie, wenn Sie über ein Widget mehr als eine Einstellung anbieten möchten:

let settings = require('/agorum/roi/customers/agorum.composite/js/configured-settings').loadSettings('name-of-the-widget', user, 'name-of-settings');

Konfigurationen vornehmen

---

In der MetaDB existieren zwei Bereiche:

• Globale Einstellungen (bei den von agorum core gelieferten Komponenten)
• Kundenspezifische Einstellungen

Unterhalb von settings existiert für beide Bereiche folgende Struktur:

• Eindeutiger Name der Einstellung (Name des Property-Bundles)
  • acl
    Definiert den Namen einer ACL.
  • js
    Definiert den Pfad zu einer JavaScript-Datei mit Konfigurationen.
  • beliebige weitere Werte (wenn kein JavaScript angegeben ist)

Die Bibliothek agorum.composite.configured-settings sammelt dann alle vorhandenen Konfigurationen, auf die der Benutzer berechtigt ist, fügt diese zusammen und gibt diese als Array zurück.

Die Konfigurationen können entweder beliebige Property-Entrys enthalten (Name, Werte-Paare) oder auf ein JavaScript verweisen, das die Konfiguration zusammenstellt.

Globale Einstellungen

Die globalen Einstellungen finden Sie in der Administration > MetaDB unter:

MAIN_MODULE_MANAGEMENT/aguila/control/widgets/name-of-the-widget/settings

• Unterhalb der globalen Einstellungen legen Sie Konfigurationen ab, die das Widget standardmäßig mitliefert.
• Ein Update überschreibt diese Änderungen.
• Legen Sie hier keine kundenspezifischen Konfigurationen ab.

Kundenspezifische Einstellungen

Die kundenspezifischen Einstellungen finden Sie in der Administration > MetaDB unter:

MAIN_MODULE_MANAGEMENT/customers/name-of-the-widget/settings

• Unterhalb der kundenspezifischen Einstellungen liegen alle kundenspezifischen Konfigurationen.
• Hier können Sie bei Verwendung des Namens einer globalen Einstellung die globalen Einstellungen überschreiben.

Erläuterung der Settings

---

Setting	Beschreibung
acl	Lädt optional die jeweilige Konfigurationsdatei je nach Rechten des Benutzers.
js	Enthält optional Konfiguration(en) für die Einstellungen. Das Skript muss über die exportierte Funktion settings ein Array zurückgeben.

Beispiel

// Konfiguration exportieren
exports.settings = user => { 
  return [   
    { 
      name: 'value1'   
    },
    { 
      name: 'value2'   
    }
  ];
};

Komplettes Beispiel (für die Suche)

---

Ein komplettes Beispiel finden Sie in der Administration > MetaDB unter:

MAIN_MODULE_MANAGEMENT/customers/agorum.composite.acic/settings/test_acic_config/settings

Setting	Wert
acl	Published
js	/agorum/roi/customers/test_acic/js/test_acic_config

Unterhalb des Verzeichnisses js legen Sie die JavaScript-Datei test_acic_config.js an.