surfaceConsolidationProfile
Propriétés, variantes, types et limites de surfaceConsolidationProfile.
Cette référence décrit la structure complète de surfaceConsolidationProfile. Chaque chemin représente une propriété, y compris les objets imbriqués, les éléments de listes et les branches conditionnelles. Une branche identifiée par kind, contract ou mode n’admet que ses propres propriétés.
Structure et valeurs
| Champ | Options / valeurs attendues | Description |
|---|---|---|
contract |
"SurfaceConsolidationProfile@1" |
Requis. Discriminant exact de cette variante du contrat. Respecter la valeur littérale indiquée. |
key |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité. |
currentSelection |
closed object |
Requis. Définit « current Selection » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
currentSelection.contract |
"SurfaceWorkSelectionBinding@1" |
Requis. Discriminant exact de cette variante du contrat. Respecter la valeur littérale indiquée. |
currentSelection.linkTypePath |
string; min length 1; max length 4000 |
Requis. Définit « link Type Path » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
workDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Requis. Chemin exact du type de définition concerné; chaque référence doit exister dans le Model et respecter le périmètre déclaré. |
proposalDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 20 |
Requis. Chemin exact du type de définition concerné; chaque référence doit exister dans le Model et respecter le périmètre déclaré. |
decisionDefinitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Requis. Chemin exact du type de définition concerné; chaque référence doit exister dans le Model et respecter le périmètre déclaré. |
targetDefinitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u>; min length 1; max length 100 |
Requis. Chemin exact du type de définition concerné; chaque référence doit exister dans le Model et respecter le périmètre déclaré. |
workTargetLinkTypePath |
string; min length 1; max length 4000 |
Requis. Type de relation déclaré, avec sources, cibles et direction compatibles avec ce parcours. |
retainedProposalLinkTypePath |
string; min length 1; max length 4000 |
Requis. Type de relation déclaré, avec sources, cibles et direction compatibles avec ce parcours. |
decisionTargetLinkTypePath |
string; min length 1; max length 4000 |
Requis. Type de relation déclaré, avec sources, cibles et direction compatibles avec ce parcours. |
decisionFields |
closed object |
Requis. Définit « decision Fields » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
decisionFields.stateFieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Clé de Field déclaré sur le type concerné; le type de valeur doit être compatible avec cet usage. |
decisionFields.retainedState |
string; min length 1; max length 4000 |
Requis. Définit « retained State » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
decisionFields.appliedState |
string; min length 1; max length 4000 |
Requis. Définit « applied State » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
decisionFields.rationaleFieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Clé de Field déclaré sur le type concerné; le type de valeur doit être compatible avec cet usage. |
decisionFields.authorFieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Clé de Field déclaré sur le type concerné; le type de valeur doit être compatible avec cet usage. |
targetFormActionKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 100 |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
selectionPatch |
true | false |
Requis. Définit « selection Patch » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
workState |
closed object; optional |
Facultatif. Définit « work State » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
workState.fieldKey |
string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Clé d’un Field déclaré sur la définition de Surface référencée. |
workState.openValue |
string; min length 1; max length 4000 |
Requis. Définit « open Value » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
workState.resolvedValue |
string; min length 1; max length 4000 |
Requis. Définit « resolved Value » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
maximumSourceReferences |
integer; ≥ 1; ≤ 100 |
Requis. Borne de cardinalité ou de budget pour la ressource nommée. Les dépassements sont refusés; null signifie une absence de borne uniquement lorsque le schéma l’admet. |
retainedTitle |
string; min length 1; max length 4000 |
Requis. Définit « retained Title » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
appliedTitle |
string; min length 1; max length 4000 |
Requis. Définit « applied Title » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
Règles de lecture
Les chemins suffixés par [] décrivent chaque élément d’une liste; {key} décrit chaque valeur d’un dictionnaire. Le symbole ↻ renvoie à la même expression récursive. Un objet fermé refuse les propriétés supplémentaires. Les mentions de validation sémantique signalent un contrôle complémentaire : la conformité des types ne suffit pas à rendre une référence, une permission ou une transition valide. Les références doivent être résolues dans le Model et le contexte de l’usager.
La présence d’une ancienne variante ne permet pas d’y ajouter une propriété d’une variante plus récente. Le compilateur contrôle la version et la cohérence du Model complet.
Exemple de structure
Ce fragment respecte le schéma de cette section. Ses références métier doivent être définies dans le Model qui l’utilise.
{
"contract": "SurfaceConsolidationProfile@1",
"key": "step-selection",
"currentSelection": {
"contract": "SurfaceWorkSelectionBinding@1",
"linkTypePath": "application/current-work-selection"
},
"workDefinitionPath": "workspace/workshop/surface/work/surface/step",
"proposalDefinitionPaths": [
"workspace/workshop/surface/work/surface/step/surface/exploration",
"workspace/workshop/surface/work/surface/step/surface/task/surface/result"
],
"decisionDefinitionPath": "workspace/workshop/surface/work/surface/step/surface/decision",
"targetDefinitionPaths": [
"workspace/reference/surface/character",
"workspace/reference/surface/location",
"workspace/reference/surface/location/surface/sub-location",
"workspace/reference/surface/clue",
"workspace/reference/surface/event",
"workspace/manuscript/surface/book",
"workspace/manuscript/surface/book/surface/chapter",
"workspace/manuscript/surface/book/surface/chapter/surface/scene",
"workspace/documentation/surface/index/surface/category/surface/entry"
],
"workTargetLinkTypePath": "application/contributes-to",
"retainedProposalLinkTypePath": "application/retains",
"decisionTargetLinkTypePath": "application/contributes-to",
"decisionFields": {
"stateFieldKey": "status",
"retainedState": "accepted",
"appliedState": "accepted",
"rationaleFieldKey": "rationale",
"authorFieldKey": "authorId"
},
"targetFormActionKeys": [
"edit-character",
"edit-location",
"edit-sub-location",
"edit-clue",
"edit-event",
"edit-book",
"edit-chapter",
"edit-scene"
],
"selectionPatch": true,
"maximumSourceReferences": 30,
"retainedTitle": "Proposition retenue",
"appliedTitle": "Consolidation appliquée"
}
Références associées
Index complet du Model · Construire un Model
Exemples appliqués : Conserver et consulter le résultat
Le résultat conserve une référence canonique et le document exporté respecte son budget de lecture.
Configuration
Objet du contrat surfaceConsolidationProfile. Propriétés et valeurs admises.
{
"contract": "SurfaceConsolidationProfile@1",
"key": "step-selection",
"currentSelection": {
"contract": "SurfaceWorkSelectionBinding@1",
"linkTypePath": "application/current-work-selection"
},
"workDefinitionPath": "workspace/workshop/surface/work/surface/step",
"proposalDefinitionPaths": [
"workspace/workshop/surface/work/surface/step/surface/exploration",
"workspace/workshop/surface/work/surface/step/surface/task/surface/result"
],
"decisionDefinitionPath": "workspace/workshop/surface/work/surface/step/surface/decision",
"targetDefinitionPaths": [
"workspace/reference/surface/character",
"workspace/reference/surface/location",
"workspace/reference/surface/location/surface/sub-location",
"workspace/reference/surface/clue",
"workspace/reference/surface/event",
"workspace/manuscript/surface/book",
"workspace/manuscript/surface/book/surface/chapter",
"workspace/manuscript/surface/book/surface/chapter/surface/scene",
"workspace/documentation/surface/index/surface/category/surface/entry"
],
"workTargetLinkTypePath": "application/contributes-to",
"retainedProposalLinkTypePath": "application/retains",
"decisionTargetLinkTypePath": "application/contributes-to",
"decisionFields": {
"stateFieldKey": "status",
"retainedState": "accepted",
"appliedState": "accepted",
"rationaleFieldKey": "rationale",
"authorFieldKey": "authorId"
},
"targetFormActionKeys": [
"edit-character",
"edit-location",
"edit-sub-location",
"edit-clue",
"edit-event",
"edit-book",
"edit-chapter",
"edit-scene"
],
"selectionPatch": true,
"maximumSourceReferences": 30,
"retainedTitle": "Proposition retenue",
"appliedTitle": "Consolidation appliquée"
}
Variante et raccordement
Fragment à placer dans documentProfiles[]. Propriétés et valeurs admises.
{
"contract": "DocumentProfile@3",
"key": "client-quotes-export",
"source": {
"kind": "record-query",
"recordProfileKey": "client",
"queryBindingKey": "client-quotes",
"viewKey": "quotes-table"
},
"exportFormats": [
"markdown"
],
"budget": {
"maximumRows": 100,
"maximumPages": 4,
"maximumOutputBytes": 1000000
}
}
Exemple de disposition UI
La disposition illustrative ci-dessous situe cette configuration dans l’app Clients/Soumissions. Chaque fragment s’insère à l’emplacement indiqué; ses références aux Fields, Queries et Actions correspondent aux déclarations du Model.
- Soumission S-1042
- Objet et besoin
- Proposition
- Références retenues
key- step-selection
currentSelection- Objet déclaré
workDefinitionPath- workspace/workshop/surface/work/surface/step
proposalDefinitionPaths- 2 éléments
decisionDefinitionPath- workspace/workshop/surface/work/surface/step/surface/decision
Les valeurs ci-dessus reprennent le fragment de configuration; les références se résolvent dans le Model complet.