workspaceRecordProfile
Propriétés, variantes, types et limites de workspaceRecordProfile.
Cette référence décrit la structure complète de workspaceRecordProfile. 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 |
|---|---|---|
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é. |
definitionPaths |
Array<string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)+$/u>; min length 1; max length 100 |
Requis. Définit « definition Paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
editActionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
identity |
closed object |
Requis. Sources des informations qui permettent de reconnaître la fiche. |
identity.title |
closed object OR closed object OR closed object |
Requis. Titre de l’objet ou de la section dans l’interface. |
identity.title.[kind=native].kind |
"native" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
identity.title.[kind=native].property |
"title" | "description" | "createdAt" | "updatedAt" |
Requis. Nom d’une propriété native reconnue; ce sélecteur ne permet pas un accès arbitraire. |
identity.title.[kind=field].kind |
"field" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
identity.title.[kind=field].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Sélecteur sémantique de Field utilisant le préfixe fields/. |
identity.title.[kind=calculation].kind |
"calculation" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
identity.title.[kind=calculation].calculationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
identity.avatar |
closed object |
Requis. Présentation visuelle de l’identité selon la variante admise. |
identity.avatar.kind |
"initials" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
identity.avatar.maximumLetters |
integer; ≥ 1; ≤ 4 |
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. |
identity.subtitle |
closed object OR closed object OR closed object; null |
Requis. Source du sous-titre ou absence explicite lorsque null est admis. |
identity.subtitle.[kind=native].kind |
"native" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
identity.subtitle.[kind=native].property |
"title" | "description" | "createdAt" | "updatedAt" |
Requis. Nom d’une propriété native reconnue; ce sélecteur ne permet pas un accès arbitraire. |
identity.subtitle.[kind=field].kind |
"field" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
identity.subtitle.[kind=field].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Sélecteur sémantique de Field utilisant le préfixe fields/. |
identity.subtitle.[kind=calculation].kind |
"calculation" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
identity.subtitle.[kind=calculation].calculationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
valueLabels |
Array<closed object>; max length 100 |
Requis. Correspondances entre valeurs stables et libellés destinés à l’usager. |
valueLabels[].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Sélecteur sémantique de Field utilisant le préfixe fields/. |
valueLabels[].values |
Array<closed object>; min length 1; max length 100 |
Requis. Ensemble de valeurs admises ou comparées selon l’opération déclarée. |
valueLabels[].values[].value |
string; max length 4000 OR number OR true | false |
Requis. Valeur effective interprétée selon le type et le discriminant du contexte parent. |
valueLabels[].values[].label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
card |
closed object |
Requis. Présentation résumée de la fiche dans une collection. |
card.summary |
closed object OR closed object OR closed object; null |
Requis. Définit « summary » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
card.summary.[kind=native].kind |
"native" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
card.summary.[kind=native].property |
"title" | "description" | "createdAt" | "updatedAt" |
Requis. Nom d’une propriété native reconnue; ce sélecteur ne permet pas un accès arbitraire. |
card.summary.[kind=field].kind |
"field" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
card.summary.[kind=field].fieldPath |
string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u |
Requis. Sélecteur sémantique de Field utilisant le préfixe fields/. |
card.summary.[kind=calculation].kind |
"calculation" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
card.summary.[kind=calculation].calculationKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
card.tags |
closed object; null |
Requis. Classification ou configuration de présentation des tags autorisés. |
card.tags.namespace |
"user" |
Requis. Espace de noms qui détermine le vocabulaire et la portée des valeurs. |
card.tags.maximumVisible |
integer; ≥ 0; ≤ 20 |
Requis. Nombre maximal d’éléments dans l’aperçu; la collection complète reste accessible séparément. |
card.metricKeys |
Array<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u>; max length 20 |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
card.openLabel |
string; min length 1; max length 4000 |
Requis. Libellé de l’accès au détail de l’objet. |
queryBindings |
Array<closed object>; max length 100 |
Requis. Associations de Queries nommées aux valeurs de paramètres issues du contexte. |
queryBindings[].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é. |
queryBindings[].queryKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence à une Query déclarée; le moteur de données applique le périmètre et les droits. |
queryBindings[].parameters |
Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u OR string; min length 1; max length 120; /^[a-zA-Z][a-zA-Z0-9]*$/u, closed object OR closed object OR closed object>; semantic validation |
Requis. Paramètres nommés de l’opération ou de la Query et valeurs associées. |
queryBindings[].parameters{key}.[kind=entity-id].kind |
"entity-id" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
queryBindings[].parameters{key}.[kind=entity-id].definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Requis. Chemin exact d’une définition du Model; il ne désigne pas l’ID d’une fiche. |
queryBindings[].parameters{key}.[kind=field].kind |
"field" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
queryBindings[].parameters{key}.[kind=field].field |
closed object |
Requis. Définit « field » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
queryBindings[].parameters{key}.[kind=field].field.definitionPath |
string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u |
Requis. Chemin exact d’une définition du Model; il ne désigne pas l’ID d’une fiche. |
queryBindings[].parameters{key}.[kind=field].field.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. |
queryBindings[].parameters{key}.[kind=literal].kind |
"literal" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
queryBindings[].parameters{key}.[kind=literal].value |
string; max length 4000 OR number OR true | false OR null |
Requis. Valeur effective interprétée selon le type et le discriminant du contexte parent. |
metrics |
Array<closed object>; max length 20 |
Requis. Métriques déclarées basées sur une Query et un agrégat canonique. |
metrics[].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é. |
metrics[].queryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
metrics[].value |
"aggregate" |
Requis. Valeur effective interprétée selon le type et le discriminant du contexte parent. |
metrics[].singularLabel |
string; min length 1; max length 4000 |
Requis. Libellé utilisé pour une seule unité du résultat. |
metrics[].pluralLabel |
string; min length 1; max length 4000 |
Requis. Libellé utilisé pour plusieurs unités du résultat. |
metrics[].navigation |
closed object; null |
Requis. Destinations déclarées dans l’ordre de présentation. |
metrics[].navigation.kind |
"record-related-group" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
metrics[].navigation.relatedGroupKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
detail |
closed object |
Requis. Sections, Actions, paramètres et relations de la fiche ouverte. |
detail.primaryActionKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u; null |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
detail.primaryActionLabel |
string; min length 1; max length 4000; null |
Requis. Définit « primary Action Label » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
detail.creationActionKeys |
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é. |
detail.actionKeys |
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é. |
detail.sections |
Array<closed object OR closed object OR closed object>; min length 1; max length 40 |
Requis. Sections déclarées dans l’ordre de lecture ou de rendu. |
detail.sections[].[kind=fields].kind |
"fields" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
detail.sections[].[kind=fields].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é. |
detail.sections[].[kind=fields].label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
detail.sections[].[kind=fields].fieldPaths |
Array<string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u>; min length 1; max length 100 |
Requis. Définit « field Paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
detail.sections[].[kind=content].kind |
"content" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
detail.sections[].[kind=content].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é. |
detail.sections[].[kind=content].label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
detail.sections[].[kind=query-view].kind |
"query-view" |
Requis. Sélectionne la variante et les propriétés admises dans cette branche. |
detail.sections[].[kind=query-view].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é. |
detail.sections[].[kind=query-view].label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
detail.sections[].[kind=query-view].queryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
detail.sections[].[kind=query-view].viewKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
detail.settings |
closed object |
Requis. Fields présentés dans le formulaire de paramètres de la fiche. |
detail.settings.fieldPaths |
Array<string; min length 8; max length 127; /^fields\/[a-zA-Z][a-zA-Z0-9]*$/u>; max length 100 |
Requis. Définit « field Paths » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
detail.tags |
closed object; null |
Requis. Classification ou configuration de présentation des tags autorisés. |
detail.tags.namespace |
"user" |
Requis. Espace de noms qui détermine le vocabulaire et la portée des valeurs. |
detail.tags.maximumVisible |
integer; ≥ 0; ≤ 20 |
Requis. Nombre maximal d’éléments dans l’aperçu; la collection complète reste accessible séparément. |
detail.relatedGroups |
Array<closed object>; max length 40 |
Requis. Groupes de relations avec Query et aperçu limité, puis accès à la collection complète. |
detail.relatedGroups[].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é. |
detail.relatedGroups[].label |
string; min length 1; max length 4000 |
Requis. Libellé destiné à l’usager dans l’interface. |
detail.relatedGroups[].queryBindingKey |
string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u |
Requis. Référence par clé stable à la déclaration nommée correspondante; le compilateur contrôle son existence et sa compatibilité. |
detail.relatedGroups[].maximumVisible |
integer; ≥ 1; ≤ 100 |
Requis. Nombre maximal d’éléments dans l’aperçu; la collection complète reste accessible séparément. |
detail.relatedGroups[].openAllLabel |
string; min length 1; max length 4000 |
Requis. Libellé de l’accès à la collection complète, par exemple Voir tout. |
detail.relatedGroups[].rowIcon |
closed object; null |
Requis. Définit « row Icon » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
detail.relatedGroups[].rowIcon.catalog |
Géré par Surface; fourni par les outils du Model. |
Requis. Définit « catalog » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
detail.relatedGroups[].rowIcon.revision |
"0.468.0" |
Requis. Définit « revision » pour cet objet. Respecter le type, les variantes et les limites de la colonne Options. |
detail.relatedGroups[].rowIcon.name |
string; min length 1; max length 120; semantic validation |
Requis. Nom lisible de l’élément dans le contexte qui le présente. |
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.
Les paramètres d’implémentation de cette structure sont gérés par Surface. Utilisez les outils du Model pour les produire; ils ne sont pas des valeurs à saisir dans une fiche.
Références associées
Index complet du Model · Construire un Model
Exemples appliqués : Notes visibles, réglages accessibles
Placez le suivi dans la Surface et le courriel dans les paramètres, en conservant les mêmes Fields.
Configuration
Objet du contrat workspaceRecordProfile. Propriétés et valeurs admises.
{
"key": "client",
"definitionPaths": [
"workspace/clients/surface/client"
],
"editActionKey": "edit-client",
"identity": {
"title": {
"kind": "field",
"fieldPath": "fields/company"
},
"avatar": {
"kind": "initials",
"maximumLetters": 2
},
"subtitle": {
"kind": "field",
"fieldPath": "fields/status"
}
},
"valueLabels": [
{
"fieldPath": "fields/status",
"values": [
{
"value": "prospect",
"label": "Prospect"
},
{
"value": "active",
"label": "Actif"
}
]
}
],
"card": {
"summary": {
"kind": "field",
"fieldPath": "fields/notes"
},
"tags": {
"namespace": "user",
"maximumVisible": 3
},
"metricKeys": [],
"openLabel": "Ouvrir le client"
},
"queryBindings": [],
"metrics": [],
"detail": {
"primaryActionKey": null,
"creationActionKeys": [],
"actionKeys": [],
"sections": [
{
"kind": "fields",
"key": "follow-up",
"label": "Suivi du client",
"fieldPaths": [
"fields/notes",
"fields/status"
]
}
],
"settings": {
"fieldPaths": [
"fields/email"
]
},
"tags": {
"namespace": "user",
"maximumVisible": 3
},
"relatedGroups": [],
"primaryActionLabel": null
}
}
Variante et raccordement
Fragment à placer dans presentation.recordProfiles[].detail.settings. Propriétés et valeurs admises.
{
"fieldPaths": [
"fields/email"
]
}
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.
- Identité du client
- Notes et suivi
- Paramètres
- Soumissions liées
key- client
definitionPaths- 1 élément
editActionKey- edit-client
identity- Objet déclaré
valueLabels- 1 élément
Les valeurs ci-dessus reprennent le fragment de configuration; les références se résolvent dans le Model complet.