Aller au contenu principal

Schémas des artefacts

Tout ce qu’un créateur construit dans Parsware — une table, une vue, un formulaire, une requête, un rapport, un processus, une application — est en dessous un simple document JSON, et chaque type de document a un JSON Schema publié (draft 2020-12). Le concepteur est une façon d’écrire le document ; un éditeur, un script ou un assistant d’IA en est une autre. Quel que soit son auteur, la plateforme le vérifie avec le même schéma, à l’enregistrement et de nouveau quand une solution qui le contient est importée.

Chaque schéma est servi par ce site à l’adresse /schemas/<nom>.schema.json, si bien que n’importe quel outil JSON Schema peut vérifier un fichier avant son envoi :

npx ajv-cli validate --spec=draft2020 -s saved-query.schema.json -d visitors-by-purpose.json

Un document qui en contient un autre laisse cette partie au schéma de l’autre, comme le fait la plateforme : la query d’une requête enregistrée est un document de requête, vérifié avec parsware-query. Vérifiez-la là aussi.

Un refus de la plateforme indique les mêmes choses qu’un validateur : où dans le document (un JSON Pointer comme /aggregate/measures/0/function) et ce qui y est faux.

Tous les schémas​

DocumentSchémaPage
Tablemodel-driven-entityDéfinition de table
Groupe d’optionsmodel-driven-option-setDéfinition du groupe d’options
Vuemodel-driven-viewDéfinition de vue
Formulairemodel-driven-formDéfinition de formulaire
Application pilotée par modèlemodel-driven-appDéfinition d’application
Requêteparsware-query
Requête enregistréesaved-query
Rapportmodel-driven-report
Tableau de bordmodel-driven-dashboard
Application Studiostudio-app
Un écran Studio compiléui-tree
Application de portailportal-app
Guide de l’applicationapp-guide
Processusbpms-process
Dessin du processusbpms-design
Règle métier côté clientbusiness-rule
Étape de plug-in serveurplugin-stepÉtape de plug-in
Script de solutionsolution-script
Tâche planifiéescheduled-job
API personnaliséecustom-apiAPI personnalisée
Rôle de sécuritésecurity-role
Stratégie de donnéespolicy-definition
Variable d’environnementenvironment-variable
Données initialesseed-data
Ressource webweb-resource-manifestManifeste de ressource web
Application personnaliséecustom-app-manifestManifeste d’application
Contrôle personnalisécustom-control-manifestManifeste de contrôle
Archive d’une application ou d’un contrôle (parsware.json)artifact-packagePaquet d’artefact
Paquet de solutionsolution-packagePaquet de solution

Les champs description de chaque schéma expliquent ses membres ; une page existe là où la forme demande davantage.

Anciennes versions​

Quand la forme d’un document change d’une manière que les anciens fichiers ne peuvent satisfaire, l’ancien schéma est gardé à côté du nouveau, pour qu’une solution exportée avant le changement s’importe toujours : model-driven-form-v1 et model-driven-view-v1 y sont figés.

Ces fichiers sont ceux de la plateforme​

Les schémas d’ici sont des copies de ceux avec lesquels chaque service valide, et un test fait échouer la compilation dès qu’une copie diffère de sa source. Ce avec quoi vous vérifiez est ce avec quoi la plateforme vérifie.