Saltar al contenido
Verificada

Batch

Un programa invocable que orquesta varios pasos, un procedimiento de varias partes con un único id para llamarlo.

Un programa Batch orquesta varios pasos como una única operación invocable. Allí donde un procedimiento se copiaría y pegaría en varios componentes, un guardado de varios pasos, un bucle sobre registros, una secuencia de llamadas a una API, un Batch le da un nombre y un id. Desde el lado de quien llama se ve exactamente igual que un programa Get Data o Set Data: lo llamas con la acción batch, pasas parámetros y recibes un resultado.

Propiedades

progFields

Los parámetros de Batch siguen la forma común (data.field_id, data.type: "virtual", props.fieldType) y se referencian dentro del flujo de trabajo del Batch como @field_id.

progEvents y el cuerpo del flujo de trabajo

A diferencia de una Tabla o una Alerta, la lógica real de un Batch no es un array de nivel superior, vive dentro de progEvents, casi siempre el evento on_load, cuyo array workflow es el cuerpo del Batch:

Un paso de ese flujo de trabajo puede ser cualquier acción del catálogo de Flujo de trabajo: get_data, set_data, call_native_javascript, call_project_api, call_external_api, delay, update, raise_event, una llamada batch anidada y más. Cada paso puede llevar props.condition para condicionarlo, o props.async: true para lanzarlo sin esperar.

Llamar a un Batch

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

Ejemplo práctico

Declara los parámetros

progParams para lo que necesite el Batch de quien lo llama, reflejado en progFields.

Construye el cuerpo en on_load

Añade pasos al flujo de trabajo del evento on_load: un get_data para leer, un cálculo, un set_data para volver a escribir.

Llámalo como cualquier otro programa

Acción batch, con name.prog establecido en el id de este Batch, y resultados accesibles mediante los campos de quien llama.

Crea un nodo Batch en Programas, declara los parámetros en su pestaña Propiedades y luego construye la secuencia de pasos en el editor Eventos → on_load → Flujo de trabajo, el mismo editor de flujos de trabajo que usa cualquier otro programa.

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 vinculado directamente a una fuente de datos ejecuta sus pasos before_record / after_record una vez por cada fila coincidente, la forma iterativa de la unidad.

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