Vai al contenuto
Verificata

Batch

Un programma richiamabile che orchestra più passi, una procedura in più parti con un solo id con cui chiamarla.

Un programma Batch orchestra più passi come un'unica operazione richiamabile. Ovunque una procedura verrebbe altrimenti copiata e incollata tra più Componenti, un salvataggio in più passi, un ciclo sui record, una sequenza di chiamate API, un Batch le dà un solo nome e un solo id. Dal punto di vista di chi chiama sembra esattamente un programma Leggi dati o Imposta dati: lo si chiama con l'azione batch, si passano i parametri e si ottiene un risultato.

Proprietà

progFields

I parametri del Batch seguono la forma comune (data.field_id, data.type: "virtual", props.fieldType) e sono referenziati nel workflow del Batch come @field_id.

progEvents e il corpo del workflow

A differenza di una Tabella o di un Avviso, la logica vera di un Batch non è un array di primo livello: vive dentro progEvents, quasi sempre nell'evento on_load, il cui array workflow è il corpo del Batch:

Un passo dentro quel workflow può essere qualsiasi azione del catalogo Workflow: get_data, set_data, call_native_javascript, call_project_api, call_external_api, delay, update, raise_event, una chiamata batch annidata e altro. Ogni passo può avere props.condition per condizionarlo, o props.async: true per avviarlo senza attendere.

Chiamare un Batch

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

Esempio pratico

Dichiara i parametri

progParams per tutto ciò di cui il Batch ha bisogno da chi lo chiama, rispecchiati in progFields.

Costruisci il corpo su on_load

Aggiungi passi al workflow dell'evento on_load: un get_data per leggere, un calcolo, un set_data per scrivere di nuovo.

Chiamalo come qualsiasi altro programma

Azione batch, name.prog impostato sull'id di questo Batch, risultati raggiungibili tramite i campi di chi chiama.

Crea un nodo Batch sotto Programmi, dichiara i parametri nella sua scheda Proprietà, poi costruisci la sequenza di passi nell'editor Eventi → on_load → Workflow, lo stesso editor di workflow che usa ogni altro programma.

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>

Un Batch associato direttamente a un'origine dati esegue i suoi passi before_record / after_record una volta per ogni riga corrispondente, la forma iterativa dell'unità.

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