Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core Module und Plugins > ALBERT | AI Suite > ALBERT l AI Developer Studio


Mit ALBERT l AI Developer Studio arbeiten

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des Plugins ALBERT l AI Developer Studio. Aktualisieren Sie das hier beschriebene Plugin, um die Dokumentation verwenden zu können.

Diese Dokumentation zeigt, wie Sie das Developer Studio öffnen, einen Workspace einrichten, Dateien bearbeiten und gemeinsam mit ALBERT | AI entwickeln. Eine durchgehende Anleitung führt vom neuen Konfigurationsprojekt bis zum ersten einfachen Projekt; am Ende finden Sie praxisnahe Anwendungsfälle mit Beispiel-Prompts.

Voraussetzung: Sie sind für das Developer Studio berechtigt (siehe ALBERT l AI Developer Studio berechtigen), und für die Arbeit mit ALBERT | AI ist ein Sprachmodell eingetragen (siehe ALBERT l AI Developer Studio konfigurieren).

Begriffe

Begriff Bedeutung
Konfigurationsprojekt Die Einheit, in der in agorum core entwickelt wird – ein Plugin oder eine Kundenkonfiguration. Ein Konfigurationsprojekt ist ein Ordner unter /agorum/roi/customers mit einer Datei yml/project.yml (siehe Konfigurationsprojekte in agorum core).
Workspace Ihr Arbeitsbereich im Developer Studio: ein oder mehrere Konfigurationsprojekte und Ordner, die Sie gemeinsam bearbeiten. Der Workspace merkt sich die geöffneten Dateien und die zuletzt gewählte Datei und hat einen eigenen Chat mit ALBERT | AI.
Ordner im Workspace Ein beliebiger Ordner, der kein Konfigurationsprojekt ist, etwa ein Ordner mit Dokumentation. ALBERT | AI behandelt ihn als einfache Ablage ohne Projektaufbau.
Ressourcen Was zu einem Projekt gehört, aber nicht in seinem Ordner liegt: der Workspace-Ordner des Projekts unter /agorum/roi/workspace/<Projekt> und die MetaDB-Einträge, die die export.yml des Projekts nennt.

Developer Studio öffnen

  1. Öffnen Sie das Hauptmenü ≡.
  2. Wählen Sie Development > Open Developer Studio.

    Ergebnis: Das Fenster Developer Studio öffnet sich. Ohne geöffneten Workspace sehen Sie die Startseite mit den Schaltflächen Neuen Workspace erstellen und Bestehenden Workspace öffnen. Ist ein Workspace geöffnet, trägt das Fenster seinen Namen: Developer Studio - <Workspace>.

 

Explorer mit Projekt und Ressourcen (links), Editor (Mitte), ALBERT | AI (rechts)

 

Tipp: Damit Sie einen Workspace später schnell wiederfinden, heften Sie ihn an die Seitenleiste: Klicken Sie im agorum core Fenster (nicht im Developer-Studio-Fenster) unten links in der Seitenleiste mit der rechten Maustaste auf Developer Studio - <Workspace> und wählen Sie Als neuen Tab an Tab-Leiste anheften. Über In neuem Fenster öffnen im selben Kontextmenü arbeiten Sie im Developer Studio in einem eigenen Browser-Tab.

 

 

Kontextmenü eines Developer-Studio-Workspace in der Seitenleiste

Die Oberfläche

Bereich Inhalt
Datei (Menü oben) Neue Datei, Neuer Ordner, Neuer Workspace, Workspace öffnen, Projekte zum Workspace hinzufügen, Ordner zum Workspace hinzufügen, Ausgewählten Bereich aus Workspace entfernen, Workspace umbenennen, Workspace schließen, Workspace löschen.
Explorer (links) Baum mit den Projekten und Ordnern des Workspace. Zu jedem Projekt zeigt der Baum zusätzlich die Ressourcen. Die Symbolleiste darüber bietet Neue Datei, Neuer Ordner, Objekteigenschaften des ausgewählten Objekts kopieren und Ordner im Explorer einklappen.
Suche (links) Volltextsuche in allen Projekten und Ordnern des Workspace.
Editor (Mitte) Die geöffneten Dateien als Registerkarten. Ein ausgewählter Ordner öffnet sich hier als Liste.
ALBERT | AI (rechts) Der Chat des Workspace. ALBERT | AI sieht, welche Projekte, Ordner und Dateien Sie geöffnet oder ausgewählt haben.

Workspace einrichten

Workspace erstellen

  1. Klicken Sie auf der Startseite auf Neuen Workspace erstellen oder wählen Sie Datei > Neuer Workspace.
  2. Geben Sie einen Namen für den Workspace ein, etwa den Namen des Projekts oder der Aufgabe.
  3. Bestätigen Sie mit Speichern.

    Ergebnis: Der Workspace ist angelegt und geöffnet. Er ist noch leer.

Projekte und Ordner hinzufügen

  1. Wählen Sie Datei > Projekte zum Workspace hinzufügen.
    Das Fenster Objekt-Auswahl listet alle Konfigurationsprojekte.
  2. Grenzen Sie die Liste über das Feld Ergebnis in „Alles“ einschränken ein, etwa mit agorum.smartorga, und wählen Sie das Projekt aus. Sie können mehrere Projekte wählen.
  3. Klicken Sie auf OK.
  4. Für einen Ordner, der kein Projekt ist, wählen Sie Datei > Ordner zum Workspace hinzufügen und wählen den Ordner aus.

    Ergebnis: Die Projekte und Ordner erscheinen links im Explorer.

 

Tipp: Nehmen Sie neben Ihrem eigenen Projekt auch die Projekte auf, auf denen es aufbaut, etwa die Basisprojekte von NORA | 360°. ALBERT | AI kann deren Dateien dann als Vorbild lesen. Lesen darf ALBERT | AI ohnehin überall – schreiben aber nur in den Projekten und Ordnern des Workspace (siehe Mit ALBERT | AI entwickeln). Nehmen Sie deshalb nur Projekte auf, an denen tatsächlich gearbeitet werden soll.

Workspace verwalten

Aktion So geht’s
Workspace öffnen Datei > Workspace öffnen oder auf der Startseite Bestehenden Workspace öffnen. Die Auswahl sucht im Namen der Workspaces; Groß- und Kleinschreibung spielen keine Rolle.
Projekt oder Ordner entfernen Wählen Sie das Projekt oder den Ordner auf oberster Ebene im Explorer aus und wählen Sie dann Datei > Ausgewählten Bereich aus Workspace entfernen. Das Projekt selbst bleibt unverändert erhalten.
Workspace umbenennen Datei > Workspace umbenennen.
Workspace schließen Datei > Workspace schließen. Bei ungespeicherten Dateien fragt das Developer Studio nach.
Workspace löschen Datei > Workspace löschen und die Abfrage bestätigen. Gelöscht wird nur der Workspace – er kommt in den Papierkorb; die Projekte und Ordner darin bleiben erhalten.

Neue Workspaces legt das Developer Studio in Ihren eigenen Dateien an. Ein Workspace gehört deshalb einem Benutzer; mehrere Entwickler arbeiten am selben Projekt jeweils in ihrem eigenen Workspace. Die Einstellungen eines Workspace – geöffnete Dateien, ausgewählte Datei – speichert das Developer Studio automatisch. Wird derselbe Workspace in einem anderen Fenster geändert, fragt es, ob Sie ihn neu laden möchten.

Dateien bearbeiten

Im Workspace suchen

Wechseln Sie links in den Reiter Suche und geben Sie einen Suchbegriff ein. Gesucht wird in allen Projekten und Ordnern des Workspace. Ein Ordner im Ergebnis wird im Explorer angezeigt, eine Datei im Editor geöffnet.

Mit ALBERT | AI entwickeln


Jeder Workspace hat einen eigenen Chat mit ALBERT | AI; das Developer Studio legt ihn beim ersten Öffnen des Workspace an. ALBERT | AI arbeitet mit der KI-Voreinstellung Developer Studio und kennt laufend

So arbeitet ALBERT | AI im Developer Studio:

Tipps für gute Ergebnisse

Anleitung: Neues Konfigurationsprojekt anlegen und umsetzen


Diese Anleitung führt einmal durch den ganzen Ablauf: Sie legen ein neues Konfigurationsprojekt an, richten dafür einen Workspace ein und setzen mit ALBERT | AI ein einfaches Projekt um. Als Beispiel dient eine Vertragsablage für die fiktive Firma Musterfirma GmbH.

Schritt 1: Workspace erstellen

  1. Öffnen Sie das Developer Studio über ≡ > Development > Open Developer Studio.
  2. Wählen Sie Neuen Workspace erstellen und geben Sie als Namen Vertragsablage ein.
  3. Klicken Sie auf Speichern.

    Ergebnis: Der leere Workspace ist geöffnet, rechts steht der Chat mit ALBERT | AI bereit.

Schritt 2: Konfigurationsprojekt anlegen

Ein neues Projekt legt ALBERT | AI über den Konfigurator von agorum.dev an. Der Konfigurator bildet Projektname, Beschreibung und Metadaten-Präfix nach festen Regeln aus Ihren Angaben und legt die Grundstruktur an: project.yml, export.yml, Projektbeschreibung und Sprachdateien.

Halten Sie diese Angaben bereit:

Angabe Bedeutung
Projektart Kunden - Projekt, Partner - Projekt oder agorum - Projekt. Die Art bestimmt, wie Name, Beschreibung und Präfix gebildet werden.
Kunde oder Partner Der Name des Unternehmens, so wie es heißt, etwa Musterfirma GmbH. Er steht in der Beschreibung.
Kürzel Das Kürzel des Kunden oder Partners, der erste Teil des Projektnamens, etwa musterfirma. Erlaubt sind Wörter aus Buchstaben (ohne Umlaute) und Ziffern, jedes beginnt mit einem Buchstaben; mehrere Wörter trennen Sie mit Leerzeichen, Punkt oder Unterstrich. Das letzte Wort hat mindestens zwei Zeichen.
Projektname Der nächste Teil des Projektnamens, etwa contracts. Dieselben Regeln wie beim Kürzel.
Titel (optional) Der Name, unter dem das Projekt im Plugin Manager erscheint, etwa Musterfirma Vertragsablage. Ohne Angabe gilt die Beschreibung.
Unterprojekt (optional) Der Name eines Unterprojekts als letzter Teil des Projektnamens. Dieselben Regeln wie beim Kürzel.
Produkt und Lizenz (optional) Das Produkt, auf dem das Projekt aufsetzt (agorum core pro oder agorum core open; ohne Angabe das installierte Produkt), und ob das Projekt eine Lizenz benötigt (ohne Angabe: nein).
  1. Bitten Sie ALBERT | AI im Chat, das Projekt anzulegen, zum Beispiel:
    Lege ein neues Kunden-Projekt an: Kunde "Musterfirma GmbH", Kürzel musterfirma, Projektname contracts, Titel "Musterfirma Vertragsablage".
  2. ALBERT | AI nennt Ihnen den Projektnamen – im Beispiel musterfirma.contracts – und fragt, ob das Projekt angelegt werden soll. Das Projekt entsteht außerhalb des noch leeren Workspace, deshalb ist Ihre Zustimmung nötig. Bestätigen Sie.
  3. Wählen Sie Datei > Projekte zum Workspace hinzufügen, suchen Sie musterfirma.contracts und wählen Sie es aus.

    Ergebnis: Das neue Projekt erscheint links im Explorer, mit den Ordnern yml, doc und deploy (darin die Sprachdateien). Ab jetzt darf ALBERT | AI darin schreiben.

 

Tipp: Soll das Projekt auf einem bestehenden aufbauen, kann ALBERT | AI es auch klonen. Geben Sie dazu das Quellprojekt an. Ein Projekt umzubenennen ist ALBERT | AI nicht erlaubt.

Schritt 3: Anforderung beschreiben und eine Spec erstellen lassen

  1. Wählen Sie das Projekt musterfirma.contracts im Explorer aus.
  2. Beschreiben Sie im Chat, was entstehen soll, und schließen Sie mit „Erstelle eine Spec.“, zum Beispiel:
    Im Projekt musterfirma.contracts soll eine einfache Vertragsablage entstehen:
    - Metadaten für Verträge: Vertragsnummer (Text, Pflicht), Vertragspartner (Text, Pflicht),
      Vertragsart (Auswahl: Wartung, Miete, Lizenz, Sonstiges), Vertragsbeginn (Datum),
      Vertragsende (Datum), Kündigungsfrist in Monaten (Zahl)
    - eine Metadaten-Sammlung "Vertrag" mit diesen Feldern
    - eine Ordnerstruktur unter /agorum/roi/Files/Verträge mit den Unterordnern Aktiv und Archiv
    - Schreibe Autotests für die Metadaten und führe sie aus.
    Erstelle eine Spec.
  3. ALBERT | AI legt die Spezifikation im Projekt unter doc/specs/ an. Öffnen Sie sie im Explorer, lesen Sie sie und beantworten Sie die offenen Fragen – im Chat oder direkt im Abschnitt Antworten der Spec.
  4. Geben Sie die Spec frei, etwa mit „Die Spec passt, bitte umsetzen.“

    Ergebnis: Die Spec beschreibt Anforderungen, betroffene Dateien und Vorgehen, alle offenen Fragen sind geklärt.

Schritt 4: Umsetzen lassen und Ergebnis prüfen

ALBERT | AI setzt die Spec um: Es schreibt metadata.yml, metadata-collection.yml und structure-basis.yml, trägt Texte in die Sprachdateien ein, führt die YML-Dateien über den Konfigurator aus, lässt das Ergebnis vom QS-Agenten prüfen und führt die Autotests aus. Zum Schluss fasst ALBERT | AI zusammen, was entstanden ist und welche Quellen verwendet wurden.

Hinweis: Das Ausführen der YML-Dateien legt Metadaten im System und den Ordner Verträge außerhalb des Workspace an. Vor solchen Schritten nennt ALBERT | AI das Ziel und fragt Sie; bestätigen Sie, wenn es passt.

  1. Prüfen Sie die Zusammenfassung und die geänderten Dateien im Explorer.
  2. Laden Sie die agorum core Oberfläche neu (F5), damit neue Metadaten und Texte überall sichtbar werden.
  3. Prüfen Sie das Ergebnis wie ein Anwender: Legen Sie im Ordner Verträge/Aktiv ein Dokument ab und vergeben Sie die neuen Metadaten.
  4. Wünschen Sie Änderungen, beschreiben Sie sie im selben Chat. Für die nächste, neue Aufgabe – etwa eine Erfassungsmaske – starten Sie einen neuen Chat.

    Ergebnis: Ihr Projekt musterfirma.contracts enthält eine lauffähige Vertragsablage mit Autotests. Um es auf ein anderes System zu bringen, lässt sich das Projekt exportieren – auch das erledigt ALBERT | AI auf Wunsch über den Konfigurator.

Hinweis: Setzt ALBERT | AI eine Spec um, trägt es am Ende in der Regel selbst einen Changelog-Eintrag ein und erhöht die Version des Projekts. Prüfen Sie beides. Bei kleinen Aufgaben ohne Spec bitten Sie ausdrücklich darum, etwa: „Erhöhe die Version und trage einen Changelog-Eintrag ein.“

Praxisnahe Anwendungsfälle


Die folgenden Beispiele zeigen typische Aufgaben im Developer Studio. Passen Sie Namen und Anforderungen an Ihr Projekt an und starten Sie jede Aufgabe in einem neuen Chat.

Anwendungsfall Vorgehen und Beispiel-Prompt
Bibliothek, Autotest und Maske in einem Zug Fachlogik als Bibliothek, getestet, dann in einer Maske verwendet:
Erstelle im aktuell geöffneten Projekt eine lib zur Umrechnung von Distanzen
(m, km, Meilen, Yards, Fuß). Mache einen Autotest für diese lib und führe ihn aus.
Erstelle dann eine Maske mit Eingabefeld für den Wert, Auswahl für Quell- und
Zieleinheit, Button "Umrechnen" und Ausgabefeld. Verwende die lib.
Nenne Maske und lib distance-converter, den Autotest test-distance-converter.
Maske zum Bearbeiten von Metadaten Eine Maske für vorhandene Metadaten, mit Vorschau des Dokuments:
Erstelle eine Maske sample-metadata-edit.js, die als Widget registriert wird.
Sie bekommt die ID eines Dokuments und zeigt dessen Metadaten
musterfirma_contracts_number und musterfirma_contracts_end zum Bearbeiten,
rechts daneben das Dokument. Unten links "Abbruch", unten rechts "Speichern".
Erstelle einen Autotest für die Maske und teste das Ergebnis.
Freigabe-Workflow Wählen Sie das Projekt aus, in dem der Workflow entstehen soll:
Erstelle einen Workflow freigabe-workflow: Er startet immer mit einem Anhang.
Zuerst wählt der Starter einen Benutzer für die Freigabe (Weiter nur mit Auswahl,
Abbruch). Der Benutzer sieht ein Pflicht-Textfeld und die Buttons "Freigegeben",
"Gesperrt" und "Abbruch". Bei "Freigegeben" wird der Anhang nach
/agorum/roi/Files/WF/freigegeben verschoben, sonst endet der Workflow.
Unterstütze einen Debug-Modus, der bei Testläufen die Anhänge kopiert.
Den Workflow kann ALBERT | AI anschließend über den Konfigurator deployen; im Workflow-Editor prüfen Sie ihn grafisch.
Projekt übersetzen Feste Texte eines Projekts in Übersetzungsschlüssel überführen – in zwei Chats mit einer Tracking-Datei:
Im Projekt musterfirma.contracts: Erstelle eine Tracking-Datei doc/translations.md,
trage jede Datei des Projekts ein und prüfe Datei für Datei, ob sie Texte enthält,
die übersetzt werden müssen. Aktualisiere die Tracking-Datei nach jeder Prüfung.
Im zweiten Chat:
Nimm doc/translations.md und arbeite alle markierten Dateien ab: Schlüssel anlegen,
in die Sprachdateien eintragen, in der Tracking-Datei als erledigt markieren.
Danach lässt ALBERT | AI die Übersetzungen über den Konfigurator einlesen.
Bestehendes Plugin erweitern Nehmen Sie das Basisprojekt und Ihr eigenes Erweiterungsprojekt in den Workspace auf. Beispiel für NORA | 360°:
Erweitere den NORA-Objekttyp "Projekt" in meinem Projekt musterfirma.nora um ein
Feld "Projektstatus" (Anfrage, Angebot, In Durchführung, Abgeschlossen), Standardwert
Anfrage, farbig in der Card-Ansicht. Erstelle eine Spec.
Weitere Beispiele: NORA | 360° mit dem ALBERT | AI Dev Studio entwickeln.
Fehler eingrenzen Öffnen Sie die betroffene Datei und beschreiben Sie Beobachtung und Erwartung:
Beim Speichern in der geöffneten Maske kommt keine Meldung und die Metadaten
bleiben leer. Erwartet: Meldung "Gespeichert" und gesetzte Metadaten.
Baue Protokollausgaben ein, damit wir die Ursache finden.
Konfiguration analysieren ALBERT | AI liest MetaDB, Registrierungen und Metadaten-Definitionen:
Welche aguila-Widgets, Services und YML-Dateien hat das Projekt musterfirma.contracts
registriert? Gibt es Registrierungen, deren Skript nicht mehr existiert?
Projektwissen anlegen Halten Sie Regeln fest, die ALBERT | AI in diesem Projekt immer beachten soll:
Erstelle eine Übersicht über das Projekt musterfirma.contracts und speichere sie im
Projektwissen. Halte dort auch fest: Alle Oberflächentexte nur über
Übersetzungsschlüssel.
Mehr dazu: ALBERT l AI Developer Studio anpassen.

Werkzeuge von ALBERT | AI


ALBERT | AI arbeitet im Developer Studio mit der Werkzeuggruppe agorum_dev_studio_development_tools. Sie enthält unter anderem Werkzeuge zum Lesen und Schreiben von Dateien, für Wissen und Dokumentation, zum Lesen der MetaDB, für die Suche nach Icons, zum Ausführen von Autotests und die Werkzeuge des Konfigurators von agorum.dev. Die Werkzeuge aus agorum.ai.dev sind einzeln beschrieben:

Werkzeug Wofür ALBERT | AI es verwendet
undefined>configurator_tools Die Werkzeuggruppe des Konfigurators mit den vier Werkzeugen darunter.
undefined>configurator_list Nachsehen, was der Konfigurator in einem Projekt einrichten kann.
undefined>configurator_describe Die Vorgänge, Parameter, Regeln und Vorlagen einer Konfigurationsart lesen.
undefined>configurator_entries Nachsehen, was in einem Projekt bereits registriert ist, welche YML-Dateien und Sprachdateien es hat.
undefined>configurator_run Projekte anlegen, klonen und exportieren, Skripte registrieren und abmelden, YML-Dateien ausführen, Übersetzungen einlesen, neue Dateien aus Vorlagen anlegen.
undefined>run_autotest Autotests eines Projekts ausführen und die Ergebnisse auswerten.
undefined>icon_search Vorhandene Icons suchen, statt Icon-Namen zu erfinden.