Zum Inhalt

Widget

Allgemein

  • Installation erfolgt pro Datenbank
Lieferumfang des Installationspaketes
Ordner/Datei Beschreibung
documentation Dokumentation der Komponente
l10n Übersetzungsdateien (DE/EN) für die Konfiguration
webcontent/smartdesign.base.%WidgetName%/assets/config Widget-Konfigurationsdateien
webcontent/smartdesign.base.%WidgetName%/assets/images Symboldateien
webcontent/smartdesign.base.%WidgetName%/assets/lang Widget-Übersetzungsdateien
webcontent/smartdesign.base.%WidgetName%/assets/acp-config.json ACP Konfigurationsdatei
widgets Vorkonfiguration des Widgets

Datenbankanpassungen

Mögliche Änderungen an der Datenbank sind in der entsprechenden Komponenten-Dokumentation beschrieben. Diese könnten neue Datensatz-Typen mit entsprechenden Feldern oder zusätzliche Felder für vorhandene Datensatz-Typen umfassen.

Widget installieren

  1. Navigieren Sie zu dem SmartDesign-Apps Ordner auf dem Zielsystem. 
    C:\Program Files (x86)\Common Files\CAS-Software\Server\JavaServices\smartdesign-apps

  2. Navigieren Sie in den entsprechenden Unterordner, welcher im Namen Ihre aktuell in genesisWorld verwendete Datenbank hat.

    INFO

    Datenbankname Falls Sie nicht wissen, welche Datenbank derzeit in Ihrem genesisWorld verwendet wird, können Sie dies im genesisWorld Datenbankassistenten prüfen.
    Es ist wichtig zu beachten, dass wenn kein Ordner mit dem Namen existiert, können Sie diesen auch selbst erstellen. Bitte beachten Sie dabei dieses Benennungsschema:
    „@{DATENBANKNAME}“

  3. Navigieren Sie in die Unterordner „smartdesign.base“ -> „smartdesign“ -> „base“.

    • Wenn diese Ordnerstruktur nicht existiert, müssen Sie sie manuell erstellen.

  4. Kopieren Sie die Ordner „l10n“, „webcontent“ und „widgets“ in diesen Ordner.

    • Die Ordner sind im Installationspaket enthalten.
  5. Alles erledigt! Das Widget ist jetzt im SmartDesign AppDesigner verfügbar.

Widget einbinden

INFO

Um das Widget in SmartDesign einzubinden, sind administrative Berechtigungen erforderlich.
  1. Loggen Sie sich im genesisWorld SmartDesign ein.
  2. Öffnen Sie die Administrations-App.
  3. Klicken Sie auf den Abschnitt "App Designer" im linken Teil der Seite.
  4. Klicken Sie im Kästchen "Session" auf Aktivieren.
  5. Öffnen Sie eine beliebige App und navigieren Sie zu einem beliebigen Datensatz.
  6. Klicken Sie am oberen rechten Rand der Seite auf "Anpassen".
  7. Fügen Sie an einer beliebigen Stelle auf der Maske eine Gruppe ein.
  8. Fügen Sie das Widget in die soeben erstellte Gruppe ein.
  9. Klicken Sie am oberen rechten Rand der Seite auf "Übernehmen" und anschließend auf "Veröffentlichen".
  10. Fertig! Jetzt ist das Widget auf einer Maske platziert.

Widget konfigurieren

Bei der Konfiguration gibt es zwei unterschiedliche Stellen, an denen das Widget angepasst werden kann:

  • Konfiguration im App Designer
    • Die spezifische Anleitung zur Konfiguration finden Sie in der jeweiligen Widget Dokumentation.
  • Konfiguration über die Konfigurationsdatei

Konfigurationsdatei - acp-config.json

In der Konfigurationsdatei des Widgets, werden globale Einstellungen vorgenommen. 

C:\Program Files (x86)\Common Files\CAS-Software\Server\JavaServices\smartdesign-apps\{@DATENBANKNAME}\smartdesign.base\smartdesign\base\webcontent\{WIDGETNAME}\assets\acp-config.json


"logLevel": "ERROR",
"externalApp": false,
"restAPIConfiguration": null,
"defaultLanguage": "de",
"useTranslations": true,
"useTranslationsConfiguration": false
Beschreibung
  • logLevel:
    • Beschreibung: Einstellung des LogLevel.
    • Mögliche Werte: ERROR; WARNING; GENERAL; INFO
  • externalApp:
    • Beschreibung: Gibt an, ob die App außerhalb vom SmartDesign ausgeführt wird.
    • Mögliche Werte: true; false
  • restAPIConfiguration: (optional)
    • Beschreibung: Konfiguration für den externen REST API Zugriff.
    • Mögliche Werte: null; Konfiguration siehe unten
  • defaultLanguage:
    • Beschreibung: Fallback-Sprache für den TranslateService.
    • Mögliche Werte: de; en; etc.
  • useTranslations:
    • Beschreibung: Gibt an, ob der TranslateService verwendet werden soll.
    • Mögliche Werte: true; false
  • useTranslationsConfiguration:
    • Beschreibung: Gibt an, ob die zusätzlichen Konfigurationssprachdateien geladen werden sollen.
    • Mögliche Werte: true; false


IRestAPIConfiguration (optional)

"restAPIConfiguration":{
    "apiKey":    "API-Key",
    "database":  "Database",
    "username":  "Username",
    "password":  "Password",
    "rootURL":   "http://localhost:8080/"
    }
Beschreibung
  • apiKey:
    • Beschreibung: API Key
    • Mögliche Werte: string
  • database:
    • Beschreibung: Name der Datenbank
    • Mögliche Werte: string
  • username: (optional)
    • Beschreibung: Benutzername
    • Mögliche Werte: string
  • password: (optional)
    • Beschreibung: Passwort für den Benutzer
    • Mögliche Werte: string
  • rootURL: (optional)
    • Beschreibung: URL zur REST API
    • Mögliche Werte: string