Format JSON

Objet Package

L'objet racine d'un processus ZOKAS, au format zokas.package/1.

Un package est un document JSON qui décrit un processus complet : son identité, ses variables de lancement et la liste ordonnée de ses étapes. C'est le contenu d'un fichier .zokas.json, et le corps attendu par POST /processes.

Synopsis

{
  "format": "zokas.package/1",
  "name": "Traitement des factures fournisseurs",
  "version": "1.0.0",
  "description": "Lit les factures, les classe et demande une validation au-delà du seuil.",
  "project": "Comptabilité fournisseurs",
  "screenshots": "robot",
  "roi": { "minutes_per_run": "12", "hourly_cost": "45" },
  "variables": { "seuil": "1000" },
  "steps": [ { "id": "…", "type": "…", "label": "…", "props": { } } ]
}

Propriétés

Propriété	Type	Requis	Description
`format`	chaîne	oui	Toujours `"zokas.package/1"`. Tout autre valeur est refusée à l'import.
`name`	chaîne	oui	Nom du processus, unique dans l'Orchestrator. Sert d'identifiant fonctionnel : republier sous le même nom met à jour le processus.
`version`	chaîne	recommandé	Version sémantique (`MAJEUR.MINEUR.CORRECTIF`). Défaut : `0.1.0` (assistant), `0.0.0` (API).
`description`	chaîne	recommandé	Une ou deux phrases : ce que fait le processus et pour qui. Affichée dans ZOKAS Agent.
`variables`	objet	non	Variables de lancement : `{"nom": "valeur par défaut"}`. Valeurs en chaînes. Voir Utiliser des variables.
`steps`	tableau d'Étapes	oui	Étapes exécutées dans l'ordre. Au moins une.
`project`	chaîne	non	Nom ou identifiant du projet de rangement ; créé s'il n'existe pas.
`screenshots`	énumération	non	Captures par défaut : `robot` (étapes web et bureau), `nav` (preuves de navigation), `all`, `off` (échecs seulement).
`roi`	objet	non	Retour sur investissement pour le tableau de bord : `minutes_per_run` (temps manuel économisé par exécution) et `hourly_cost` (coût horaire).

Contraintes

Encodage UTF-8, sans commentaire (JSON strict).
Les clés inconnues à la racine sont conservées mais ignorées par le moteur.
Les valeurs de variables sont converties en chaînes à l'import.
Un package généré par l'assistant ne conserve que les clés de cette page.

Cycle de vie

Opération	Effet
Ouvrir dans Studio	validation : `format`, `steps` tableau, types connus ; identifiants manquants générés
`POST /processes`	publication ; même `name` = mise à jour en place
`POST /jobs`	exécution avec `variables` du package fusionnées avec celles du lancement (le lancement l'emporte)

Voir aussi

Source : orchestrator/zokas_orch/scenario.py — validate() ; orchestrator/zokas_orch/core.py — publish_process() ; desktop/shared/zk-engine.js — validate().

Mis à jour le 28 octobre 2026