Hoppa till innehållet
Verifierad

Batch

Ett anropsbart program som styr flera steg, en procedur i flera delar med ett id att anropa den med.

Ett Batch-program styr flera steg som en enda anropsbar operation. Överallt där en procedur annars skulle kopieras mellan Components, till exempel ett sparande i flera steg, en loop över poster eller en följd av API-anrop, ger en Batch den ett namn och ett id. Sett från den som anropar ser den ut precis som ett Get Data- eller Set Data-program: anropa den med åtgärden batch, skicka parametrar och få tillbaka ett resultat.

Egenskaper

progFields

Batch-parametrar följer den gemensamma formen (data.field_id, data.type: "virtual", props.fieldType) och refereras i Batchens workflow som @field_id.

progEvents och workflow-kroppen

Till skillnad från en Table eller en Alert ligger en Batchs egentliga logik inte i en array på toppnivå. Den ligger i progEvents, nästan alltid i händelsen on_load, vars workflow-array är Batchens kropp:

Ett steg i det workflow-flödet kan vara vilken åtgärd som helst i katalogen i Workflow: get_data, set_data, call_native_javascript, call_project_api, call_external_api, delay, update, raise_event, ett nästlat batch-anrop med mera. Varje steg kan ha props.condition för att styra när det körs, eller props.async: true för att starta det utan att vänta.

Anropa en Batch

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

Exempel steg för steg

Deklarera parametrarna

progParams för det som Batchen behöver av den som anropar, speglade i progFields.

Bygg kroppen på on_load

Lägg till steg i workflow för händelsen on_load: ett get_data för att läsa, en beräkning och ett set_data för att skriva tillbaka.

Anropa den som vilket program som helst

Åtgärden batch, med name.prog satt till den här Batchens id. Resultaten nås via anroparens egna fält.

Skapa en Batch-nod under Program, deklarera parametrar på fliken Egenskaper och bygg sedan stegföljden i editorn Events → on_load → Workflow, samma workflow-editor som alla andra program använder.

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 är bunden direkt till en datasource kör sina steg before_record / after_record en gång per matchande rad, den iterativa 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": {} }
      ]
    }
  ]
}