Gå til indhold
Bekræftet

Batch

Ét program, der kan kaldes og styrer flere trin, en procedure i flere dele med ét id at kalde den ved.

Et Batch-program styrer flere trin som én operation, der kan kaldes. Overalt, hvor en procedure ellers ville blive kopieret ind i flere komponenter, fx en gemning i flere trin, et loop over poster eller en række API-kald, giver en Batch den ét navn og ét id. Set fra den, der kalder, ligner den præcis et Get Data- eller Set Data-program: kald den med batch-handlingen, send parametre, og få et resultat tilbage.

Egenskaber

progFields

Batch-parametre følger den fælles form (data.field_id, data.type: "virtual", props.fieldType) og bruges i Batchens workflow som @field_id.

progEvents og workflow-kroppen

I modsætning til en tabel eller en Alert ligger en Batchs egentlige logik ikke i et array på øverste niveau, men inde i progEvents, næsten altid i on_load-hændelsen, hvis workflow-array er Batchens krop:

Et trin i det workflow kan være enhver handling i kataloget i Workflow: get_data, set_data, call_native_javascript, call_project_api, call_external_api, delay, update, raise_event, et indlejret batch-kald og flere. Hvert trin kan have props.condition for at styre, om det kører, eller props.async: true for at starte det uden at vente.

Kald af en Batch

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

Eksempel fra praksis

Deklarer parametrene

progParams for det, Batchen skal bruge fra den, der kalder, spejlet over i progFields.

Byg kroppen på on_load

Tilføj trin til workflowet i on_load-hændelsen: et get_data til at læse, en beregning og et set_data til at skrive tilbage.

Kald den som ethvert andet program

batch-handling, name.prog sat til denne Batchs id, og resultater kan nås gennem kalderens egne felter.

Opret en Batch-node under Programmer, deklarer parametre på fanen Egenskaber, og byg derefter trinrækkefølgen i editoren Events → on_load → Workflow, den samme workflow-editor, som alle andre programmer bruger.

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>

En Batch, der er bundet direkte til en datakilde, kører sine before_record- og after_record-trin én gang for hver matchende række, den iterative form af enheden.

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": {} }
      ]
    }
  ]
}