Zum Inhalt springen
Geprüft

Batch

Ein aufrufbares Programm, das mehrere Schritte orchestriert, ein mehrteiliger Ablauf mit einer ID zum Aufrufen.

Ein Batch-Programm orchestriert mehrere Schritte als eine aufrufbare Operation. Überall dort, wo ein Ablauf sonst über Komponenten hinweg kopiert würde, ein mehrstufiges Speichern, eine Schleife über Datensätze, eine Folge von API-Aufrufen, gibt ein Batch ihm einen Namen und eine ID. Aus Sicht des Aufrufers sieht es genau aus wie ein Get-Data- oder Set-Data-Programm: Rufe es mit der Aktion batch auf, übergib Parameter, bekomme ein Ergebnis zurück.

Eigenschaften

progFields

Batch-Parameter folgen der üblichen Form (data.field_id, data.type: "virtual", props.fieldType) und werden im Workflow des Batches als @field_id referenziert.

progEvents und der Workflow-Körper

Anders als bei einer Tabelle oder einem Alert ist die eigentliche Logik eines Batches kein Array auf oberster Ebene, sie liegt in progEvents, fast immer im Ereignis on_load, dessen Array workflow der Körper des Batches ist:

Ein Schritt in diesem Workflow kann jede Aktion aus dem Katalog Workflow sein: get_data, set_data, call_native_javascript, call_project_api, call_external_api, delay, update, raise_event, ein verschachtelter batch-Aufruf und mehr. Jeder Schritt kann props.condition tragen, um ihn zu sperren, oder props.async: true, um ihn auszulösen, ohne zu warten.

Einen Batch aufrufen

json
{
  "id": "1", "data": {
    "action": "batch",
    "name": { "prog": "5b1_bth_…", "properties": {}, "parameters": { "class_id": { "fx": "@glb_class_id" } } },
    "enabled": true
  }, "props": {}
}

Praxisbeispiel

Die Parameter deklarieren

progParams für alles, was der Batch von seinem Aufrufer braucht, gespiegelt in progFields.

Den Körper auf on_load bauen

Füge dem Workflow des Ereignisses on_load Schritte hinzu: ein get_data zum Lesen, eine Berechnung, ein set_data zum Zurückschreiben.

Wie jedes andere Programm aufrufen

Aktion batch, name.prog auf die ID dieses Batches gesetzt, Ergebnisse erreichbar über die eigenen Felder des Aufrufers.

Lege unter Programme einen Batch-Knoten an, deklariere Parameter auf seinem Tab Eigenschaften und baue dann die Schrittfolge im Editor Ereignisse → on_load → Workflow, demselben Workflow-Editor, den jedes andere Programm nutzt.

xml
<meta lang="json5">
{
  id: "rebuild_class_roster",
  menuTitle: "Batch Print Student Packets"
}
</meta>

<params lang="json5">
{
  in: { campus_in: "string" }
}
</params>

<datasource lang="json5">
{
  type: "table",
  table: "student_profiles_table",
  filter: {
    mode: "index",
    activeIndex: "campus_idx",
    indexes: { campus_idx: { campus: { from: "@campus_in", to: "@campus_in" } } }
  },
  limit: 50
}
</datasource>

<events lang="json5">
{
  before_record: [
    { action: "delay", name: { value: "1" } }
  ],
  after_record: [
    { action: "debug", name: { value: "Prepared one student packet for printing" } }
  ]
}
</events>

Ein Batch, der direkt an eine Datenquelle gebunden ist, führt seine Schritte before_record / after_record einmal pro passender Zeile aus, die iterative Form dieser Einheit.

json
{
  "properties": { "menuType": "batch", "menuName": "Rebuild Class Grades", "runAt": "server", "progParams": [] },
  "progFields": [
    { "id": "b2c3d4e5-…", "data": { "field_id": "class_id", "type": "virtual" }, "props": { "fieldType": "string" } }
  ],
  "progEvents": [
    {
      "id": "d4e5f6a7-…", "data": { "type": "on_load", "parameters": [], "condition": "" },
      "workflow": [
        { "id": "step-1", "data": { "action": "get_data", "name": { "prog": "97a_gtd_…", "parameters": { "class_id": { "fx": "@class_id" } } }, "enabled": true }, "props": {} },
        { "id": "step-2", "data": { "action": "set_data", "name": { "prog": "97a_std_…", "parameters": { "class_id": { "fx": "@class_id" } }, "outputField": "GLB_Grades" }, "enabled": true }, "props": {} }
      ]
    }
  ]
}