Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core für Entwickler > agorum core template manager > Aktionen des agorum core template managers im Kontextmenü

JS-DataHandler-Datei anlegen

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des agorum core template managers. Aktualisieren Sie ggf. das hier beschriebene Plugin, um die Dokumentation verwenden zu können.

Mit dieser Aktion erstellen Sie in einem Konfigurationsprojekt ein neues Skript basierend auf einer Vorlage, um diese als JS-DataHandler und im DataHandler-Manager zu verwenden.

Anwendungsfall

Die Aktion JS-DataHandler-Datei anlegen verwenden Sie, wenn Sie einen JS-DataHandler im DataHandler-Manager einsetzen möchten, aber nicht wissen, wie der Skript-Aufbau aussehen könnte. Mithilfe der Aktion legen Sie ein beispielhaftes Skript in Ihrem Konfigurationsprojekt an. Dieses Skript verwenden Sie anschließend im DataHandler-Manager.

Beispiel

JavaScript im DataHandler einbinden
 

Die Aktion anwenden

  1. Öffnen Sie die Ordnerstruktur Ihres Konfigurationsprojekts.
  2. Klicken Sie mit der rechten Maustaste den Ordner js an und wählen Sie im Kontextmenü die Aktion agorum core template manager > JS-DataHandler-Datei anlegen.

    Ergebnis: Ein Dialog öffnet sich.
  3. Füllen Sie die Felder im Dialog.

    Name des neuen JavaScripts
    Definiert den Namen des neuen Skripts ohne Dateiendung.

    Vorlage auswählen
    Definiert eine Vorlage.

    Tipp: agorum core liefert bereits das Skript sample-query-handler.js mit.

    Speicherort auswählen
    Definiert den Ablageort des neuen Skripts.

    Tipps:
    • Legen Sie das Skript im Ordner js/handlers des Konfigurationsprojekts an.
    • Sie müssen den Ordner handlers ggf. manuell anlegen.

  4. Bestätigen Sie Ihre Angaben.

    Ergebnis: Das System erstellt die JavaScript-Datei im gewählten Speicherort. Die Datei kann von dort aus bearbeitet und in den DataHandler-Manager hinterlegt werden.

Einsatz mit MetaDbDefaults / Data.defaults

Wenn Sie das erzeugte Skript später im DataHandler-Manager verwenden, spielt das Keyword MetaDbDefaults aus der export.yml eine wichtige Rolle, sobald Sie zwischen Systemen (z. B. Entwicklung/Test/Produktion) unterscheiden möchten:

Tipp: Wenn Sie mit Mockup-Daten entwickeln, legen Sie den JS-DataHandler typischerweise so an, dass er als Default-Variante genutzt werden kann (und der „echte“ DataHandler auf dem Zielsystem in Data liegt). Details dazu finden Sie in der Dokumentation zur export.yml beim Keyword MetaDbDefaults.

Mitgelieferte Vorlage

Die im Standard mitgelieferte Skriptvorlage finden Sie unter:

/agorum/roi/customers/actempman/defaults/handlers/sample-query-handler.js

Achtung: Datenverlust durch Änderung der mitgelieferten Vorlage und Aktualisierung des agorum core template managers. Ändern Sie die mitgelieferten Vorlagen nicht, da das System diese bei einer Aktualisierung des Plug-ins wieder überschreibt. Legen Sie eigene Vorlagen unter /agorum/roi/customers/actempman/defaults/handlers/ an.

Eine eigene Vorlage anlegen

Wenn Sie eigene Vorlagen anlegen möchten, legen Sie diese unter folgendem Pfad an:

/agorum/roi/customers/actempman/defaults/handlers/

Die eigenen Vorlagen müssen der Namensvergabe entsprechen (<Name des Skripts.js>) und werden in der Vorlagenauswahl angezeigt.