Eigene Trigger und Aktionen für AutoFlow Intelligence dokumentieren
Diese Anleitung richtet sich an Entwickler von Business-Central-Apps, die AutoFlow eigene Trigger oder Aktionen hinzufügen – Hersteller-Apps und kundenspezifische Erweiterungen (PTEs).
AutoFlow Intelligence arbeitet mit allen Triggern und Aktionen, die in der Umgebung installiert sind, nicht nur mit denen von AutoFlow. Bevor es einen Schritt konfiguriert, liest es dessen Dokumentation. Deine App liefert sie, wenn AutoFlow danach fragt. Antwortet deine App nicht, beschreibt AutoFlow Intelligence den Schritt aus dem, was es sehen kann – Beschreibung, Einstellungen auf der Konfigurationsseite, Ausgaben und die Einstellungen in bestehenden Flows – und kennzeichnet die Seite als automatisch erzeugt. Das funktioniert, aber das Modell muss mehr raten. Dokumentierte Schritte liefern deutlich bessere Ergebnisse.
AutoFlow Intelligence nutzt nur die Schritte, die auch im Editor zur Auswahl stehen. Blendet deine App einen Schritt mit OnFilterActions aus (zum Beispiel, solange er nicht lizenziert ist), bietet ihn auch die KI nicht an. Die Prüfungen, die deine App beim Veröffentlichen ausführt (OnValidateFlowStep), greifen schon, während die KI den Flow baut. Der Flow ist dann noch nicht gespeichert: FlowVersionId ist 0 – lies den Schritt aus Configuration und Definition, nicht aus der Datenbank.
Was du lieferst
Für jeden Trigger und jede Aktion deiner App:
- Eine Seite – englisches Markdown, geschrieben für das Modell: was der Schritt tut, jede Einstellung mit Schlüssel und erlaubten Werten, die Ausgaben, ein kurzes Beispiel des Schritts in einer Flow-Definition und typische Fehler. Die Seiten in den AutoFlow Agent Docs zeigen den Aufbau.
- Eine Spec (optional, empfohlen) – ein JSON-Objekt im Format von
spec/_FORMAT.md:kind(actionodertrigger),id(die Ordinalzahl des Enum-Werts),name, die Konfigurationsschlüssel mit Typen und Vorgaben, die Ausgaben und Regeln. AutoFlow Intelligence prüft jeden Flow, den es baut, gegen die Regeln – Fehler fallen so auf, bevor der Benutzer den Entwurf sieht.
So übergibst du sie
AutoFlow Core löst zwei Events an der Codeunit mse365 AF-CO Config. Mgt. aus:
OnGetActionAgentDocs(Action; var Docs; var Spec; var Handled)OnGetTriggerAgentDocs(EventTrigger; var Docs; var Spec; var Handled)
Abonniere sie in deiner App und antworte nur für deine eigenen Enum-Werte:
codeunit 50100 "ACME Step Agent Docs"
{
Access = Internal;
[EventSubscriber(ObjectType::Codeunit, Codeunit::"mse365 AF-CO Config. Mgt.", 'OnGetActionAgentDocs', '', false, false)]
local procedure OnGetActionAgentDocs(Action: Enum "mse365 AF-CO Action"; var Docs: Text; var Spec: Text; var Handled: Boolean)
begin
if Handled then
exit;
case Action of
Action::"ACME Send Shipment":
begin
Docs := SendShipmentPage();
Spec := SendShipmentSpec();
end;
else
exit;
end;
Handled := true;
end;
local procedure SendShipmentPage(): Text
var
Tb: TextBuilder;
begin
Tb.AppendLine('# Send shipment (ACME)');
Tb.AppendLine('');
Tb.AppendLine('Sends the shipment of a posted sales shipment to the ACME carrier portal.');
// ...
exit(Tb.ToText());
end;
local procedure SendShipmentSpec(): Text
begin
exit('{"kind":"action","id":50100,"name":"SendShipment","configuration":[],"outputs":[],"rules":[]}');
end;
}
Regeln für den Subscriber:
- Beginne mit
if Handled then exit;und setzeHandlednur für Werte, die deine App deklariert. - Keine Seiten, Dialoge oder Meldungen, keine Schreibzugriffe auf die Datenbank und keine Fehler – AutoFlow fragt, während die KI im Hintergrund arbeitet.
- Baue lange Texte mit einem
TextBuilderaus Textstücken von höchstens 1.000 Zeichen. Das kompiliert auf jeder Business-Central-Version, die AutoFlow unterstützt. - AutoFlow fragt nur, wenn die KI den Schritt braucht – der Aufwand ist gering. Gespeichert wird nichts.
Wir pflegen unsere eigenen Seiten als .md- und .json-Dateien neben der App und erzeugen die Subscriber-Codeunit daraus im Build. Das musst du nicht – ändern sich deine Schritte oft, bleiben die Docs so aber leicht zu prüfen.
So testest du es
Rufe dieselbe Funktion auf, die AutoFlow Intelligence nutzt, und prüfe die Antwort:
Assert.IsTrue(ConfigMgt.GetActionAgentDocs(Enum::"mse365 AF-CO Action"::"ACME Send Shipment", Docs, Spec), 'documented');
Assert.IsTrue(SpecObject.ReadFrom(Spec), 'spec is JSON');
Starte dann AutoFlow Intelligence mit einer Anfrage, die deinen Schritt braucht. Im Sitzungsprotokoll (AutoFlow Intelligence Setup → Sitzungen) siehst du, dass die Doku des Schritts gelesen wird.