Einstieg in den agorum core template manager

Diese Dokumentation beschreibt Grundlegendes zum agorum core template manager.

Voraussetzungen

---

Der agorum core template manager kann nur für ein Konfigurationsprojekt / Projekt verwendet werden, das unter folgendem Pfad liegt:

/agorum/roi/customers

Außerdem muss dieses Konfigurationsprojekt folgende zwei Metadaten besitzen:

• area: ag_package
• identifier: ag_package

Diese Metadaten werden ab agorum core 9.0 automatisch auf Projekte gesetzt, bei älteren Projekten prüfen Sie über Details > Objekt-Info > Metadaten, ob diese vorhanden sind. Fehlen die Metadaten, können Fehler auftreten oder die Aktionen werden nicht angezeigt.

Metadaten nachträglich setzen

---

1. Klicken Sie ein zu bearbeitendes Konfigurationsprojekt mit der rechten Maustaste an.
2. Wählen Sie im Kontextmenü agorum core template manager - Edit > Administration > Ordner > area und identifier ändern.
3. Geben Sie ag_package ein. Ist Area schon vorbelegt, ändern Sie dies in ag_package um.
4. Klicken Sie auf OK.
   
   Ergebnis: identifier wird automatisch mit demselben Wert belegt.

Als letzte Voraussetzung muss unterhalb des Konfigurationsprojekts im Ordner yml die Datei project.yml stehen. Wenn diese nicht vorhanden ist, legen Sie diese an.

Struktur des agorum core template managers

---

Der agorum core template manager (fett markiert) wird mit folgender Struktur angelegt: 

• agorum
  • roi
    • customers 
      • <Projekt, etwa actempman>
        • defaults
          • package
            • messages
              • Messages_de.properties (Default-Datei für Deutsch – wird kopiert bei CreatePackages)
              • Messages_en.properties (Default-Datei für Englisch – wird kopiert bei CreatePackages)
            • fs
        • deploy
        • doc
          • project-description.html (Default-Beschreibung für den agorum core plugin manager)
        • js
        • Start Project Templates (hier können Templates als Vorlagen abgelegt werden)
        • yml
    • workspace 
      • <Projekt, etwa actempman>​​​​​ (Ablage von etwa temporären Dateien oder solchen, die von der Konfiguration benötigt werden, aber nicht von Benutzern gefunden werden sollen)
• Eigene Daten (vom Super-Administrator roi)
  • Administration
    • customers (Link, siehe oben)
    • scripting
    • workspace (Link, siehe oben)

Nachdem Sie weitere Vorlagen im Ordner Start Project Templates angelegt haben, können Sie den agorum core template manager wieder exportieren und etwa auf einem anderen System wieder einspielen. Der Export wird über die Datei export.yml durchgeführt.

Anmerkung zur Datei „project-description.html

Diese Datei wird vom agorum core plugin manager geladen, um für das jeweilige Paket eine Beschreibung auszugeben. Diese Datei kann auch sprachabhängig sein. So können mehrere Dateien mit dem jeweiligen Sprachkürzel hinten definiert werden.

Englisch

project-description_en.html

• Das System sucht zuerst für die Sprache des Benutzers die zugehörige Datei.
• Wird diese nicht gefunden, wird als Fallback Englisch genommen.
• Wird Englisch nicht gefunden, wird als letzter Fallback die Datei project-description.html (ohne Sprache) geladen.

Mitgelieferte Projekt-Templates

---

Damit die Arbeit mit dem agorum core template manager besonders einfach ist, werden beispielhafte ZIP-Dateien mitgeliefert, die einen empfohlenen Aufbau eines Projekts enthalten. Sie können auch eine eigene Konfiguration anlegen. Die enthaltenen Dateien liegen unter folgendem Pfad:

Eigene Dateien/Administration/customers/actemp/Start Project Templates

Folgende Projekt-Templates existieren:

Projekt-Vorlage	Beschreibung
agorum core Start Project DropArea Template.tpl	Legt eine Projektstruktur mit einer Drop Area sowie eine entsprechende Filtervorlage für das agorum core information center an.
agorum core Start Project minimal Template.tpl	(empfohlene Vorlage) Legt eine leere Projektstruktur an.
agorum core Start Project Template.tpl	Legt eine Projektstruktur mit einer entsprechenden Filtervorlage für das agorum core information center an.

Ein Projekt anlegen

---

1. Öffnen Sie links in der Seitenleiste Explorer.
2. Klicken Sie an einer beliebigen Stelle auf die rechte Maustaste.
3. Wählen Sie im Kontextmenü agorum core template manager > Neues Projekt installieren (aus Vorlage).
4. Geben Sie an, für wen Sie das Projekt installieren oder für wen es gedacht ist.
5. Wählen Sie ein Projekt-Template.
6. Füllen Sie die Felder Kundenname und Kundenkürzel.
   
   Ergebnis: Die Felder Name, Beschreibung und Präfix werden automatisch gefüllt.

   Hinweise: 
   • Der Name muss mit einem Buchstaben beginnen, gefolgt von mindestens 1 Buchstaben und / oder Zahlen. Der Name kann dann eines der folgenden Zeichen beinhalten: ., -, _, oder Leerzeichen. Er muss mit mindestens einem Kleinbuchstaben enden.
   • Das Präfix eines Projekts muss mindestens aus 3 Kleinbuchstaben bestehen und muss mit einem _ enden.
   • Für weiter Tipps zur Definition von Namen siehe Namensschema/Definitionen für agorum core-Plug-ins

7. Klicken Sie auf Anlegen.