Hopp til innholdet
Bekreftet

Batch

Ett kallbart program som styrer flere trinn, en prosedyre i flere deler med én id å kalle den med.

Et Batch-program styrer flere trinn som én kallbar operasjon. Overalt der en prosedyre ellers ville blitt kopiert mellom komponenter, som en lagring i flere trinn, en løkke over poster eller en rekke API-kall, gir en Batch den ett navn og én id. Fra den som kaller ser den helt ut som et Get Data- eller Set Data-program: kall den med batch-handlingen, send inn parametere og få et resultat tilbake.

Properties

progFields

Batch-parametere følger den felles formen (data.field_id, data.type: "virtual", props.fieldType) og refereres til i Batchens arbeidsflyt som @field_id.

progEvents og arbeidsflytkroppen

I motsetning til en tabell eller et varsel ligger en Batchs egentlige logikk ikke i en array på toppnivå, men inne i progEvents, nesten alltid i on_load-hendelsen, der workflow-arrayen er Batchens kropp:

Et trinn i den arbeidsflyten kan være en hvilken som helst handling i katalogen under Workflow: get_data, set_data, call_native_javascript, call_project_api, call_external_api, delay, update, raise_event, et nøstet batch-kall og flere. Hvert trinn kan ha props.condition for å styre om det kjører, eller props.async: true for å starte det uten å vente.

Kalle en Batch

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

Eksempel

Deklarer parameterne

progParams for alt Batchen trenger fra den som kaller, speilet inn i progFields.

Bygg kroppen i on_load

Legg til trinn i arbeidsflyten til on_load-hendelsen: et get_data for å lese, en beregning og et set_data for å skrive tilbake.

Kall den som alle andre programmer

batch-handling, name.prog satt til denne Batchens id, og resultatene er tilgjengelige gjennom kallerens egne felt.

Opprett en Batch-node under Programmer, deklarer parametere på fanen Egenskaper, og bygg trinnrekken i editoren Events → on_load → Workflow, den samme arbeidsflyteditoren som alle andre programmer bruker.

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 som er bundet direkte til en datakilde, kjører trinnene before_record / after_record én gang per rad som treffer, den iterative formen av enheten.

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