Aller au contenu
SurfaceDocs
ENCommencer
DocsRéférence du Model

managedDocumentProfileV1

Propriétés, variantes, types et limites de managedDocumentProfileV1.

Cette référence décrit la structure complète de managedDocumentProfileV1. 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 "DocumentProfile@1" Requis. Discriminant exact de cette variante du contrat. Respecter la valeur littérale indiquée.
key string; min length 1 Requis. Identifiant sémantique stable utilisé par les références; le modifier change l’identité.
sourceSurfaceDefinitionPaths Array<string; min length 1; semantic validation> 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é.
template "article" | "report" | "manuscript" | "project-brief" Requis. Définit « template » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
sectionPolicy "ordered" | "grouped" Requis. Définit « section Policy » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options.
exportFormats Array<"docx" | "markdown" | "pdf"> Requis. Définit « export Formats » 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": "DocumentProfile@1",
  "exportFormats": [
    "pdf",
    "markdown"
  ],
  "key": "account-preference-documents",
  "sectionPolicy": "ordered",
  "sourceSurfaceDefinitionPaths": [
    "workspace/account-home/surface/preferences/surface/preference"
  ],
  "template": "report"
}

Références associées

Index complet du Model · Construire un Model

Exemples appliqués : Notes du client et document exporté

Le contenu reste éditable dans la fiche; le profil d’export sélectionne les soumissions autorisées.

Configuration

Objet du contrat managedDocumentProfileV1. Propriétés et valeurs admises.

{
  "contract": "DocumentProfile@1",
  "exportFormats": [
    "pdf",
    "markdown"
  ],
  "key": "account-preference-documents",
  "sectionPolicy": "ordered",
  "sourceSurfaceDefinitionPaths": [
    "workspace/account-home/surface/preferences/surface/preference"
  ],
  "template": "report"
}

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.

  1. Soumission S-1042
  2. Objet et besoin
  3. Proposition
  4. Références retenues
DISPOSITION ILLUSTRATIVEApp Clients / Soumissions
SurfaceClients / Atelier NordExemple
managedDocumentProfileV1managedDocumentProfileV1
Clients
CONTEXTE DU MODELAtelier NordConfiguration déclarative
exportFormats
2 éléments
key
account-preference-documents
sectionPolicy
ordered
sourceSurfaceDefinitionPaths
1 élément
template
report

Les valeurs ci-dessus reprennent le fragment de configuration; les références se résolvent dans le Model complet.

Recherchez un concept, un champ ou une action.Esc