Aller au contenu
Vérifié

Lot

Un programme appelable qui orchestre plusieurs étapes, une procédure en plusieurs parties avec un seul identifiant pour l'appeler.

Un programme Lot orchestre plusieurs étapes comme une seule opération appelable. Partout où une procédure serait sinon copiée-collée entre Composants, un enregistrement en plusieurs étapes, une boucle sur des enregistrements, une suite d'appels d'API, un Lot lui donne un nom et un identifiant. Du point de vue de l'appelant, il ressemble exactement à un programme Obtenir des données ou Définir des données : appelez-le avec l'action batch, passez des paramètres, récupérez un résultat.

Propriétés

progFields

Les paramètres d'un Lot suivent la forme commune (data.field_id, data.type: "virtual", props.fieldType), référencés dans le workflow du Lot sous la forme @field_id.

progEvents et le corps du workflow

Contrairement à une Table ou une Alerte, la logique réelle d'un Lot n'est pas un tableau de premier niveau : elle vit dans progEvents, presque toujours l'événement on_load, dont le tableau workflow est le corps du Lot :

Une étape de ce workflow peut être n'importe quelle action du catalogue Workflow : get_data, set_data, call_native_javascript, call_project_api, call_external_api, delay, update, raise_event, un appel batch imbriqué, et plus encore. Chaque étape peut porter props.condition pour la conditionner, ou props.async: true pour la lancer sans attendre.

Appeler un Lot

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

Exemple concret

Déclarez les paramètres

progParams pour tout ce dont le Lot a besoin de son appelant, répercuté dans progFields.

Construisez le corps sur on_load

Ajoutez des étapes au workflow de l'événement on_load : un get_data pour lire, un calcul, un set_data pour réécrire.

Appelez-le comme n'importe quel autre programme

Action batch, name.prog défini sur l'identifiant de ce Lot, résultats accessibles via les propres champs de l'appelant.

Créez un nœud Lot sous Programmes, déclarez les paramètres dans son onglet Propriétés, puis construisez la séquence d'étapes dans l'éditeur Événements → on_load → Workflow, le même éditeur de workflow que tous les autres programmes.

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 Lot lié directement à une source de données exécute ses étapes before_record / after_record une fois par ligne correspondante, la forme itérative de l'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": {} }
      ]
    }
  ]
}