Aller au contenu

Concevoir des doctypes

Un doctype est un type d’enregistrement dans un domaine, comme crm.Company ou hr.Employee. Vous le déclarez une seule fois, et Facet y confronte chaque écriture. La définition porte les champs, les actions que les utilisateurs peuvent lancer, les enfants possédés, et les règles qui nomment chaque document et définissent son texte de recherche.

Vous ajoutez un doctype à un domaine de brouillon, ou vous retravaillez un doctype existant. Concevez dans un domaine de brouillonà ; publiez une fois le modèle au point (voir Domaines, brouillons et éditeurs de domaines).

  • Des droits d’édition. Il vous faut le droit de modifier les doctypes dans le domaine cible. Le rôle éditeur le donne pour les domaines que le compte édite.
  • Un domaine d’accueil. Le domaine doit exister avant que Facet n’y accepte un doctype.
  • Un nom d’action libre. Les noms d’action réservés (validate, create, update) ne sont pas disponiblesà ; ils désignent les hooks de cycle de vie.

Donnez à chaque champ un nom et un type, puis ajoutez les contraintes que vos données exigent. Les noms de champs suivent lower_snake_case ou camelCase. Voir Types de champs (guide) pour les types courants, et Types de champs (référence) pour la table complète.

2. Définir le libellé, l’icône et les modèles

Section intitulée « 2. Définir le libellé, l’icône et les modèles »
Élément Objectif
label Le nom que l’interface affiche, par exemple Company. À défaut, il reprend le nom du doctype.
icon Un nom d’icône Lucide en kebab-case, par exemple building-2.
display_name Un modèle Jinja2 qui nomme chaque document, par exemple {{ name }}.
search Un modèle Jinja2 pour le texte de recherche. Un doctype qui en est dépourvu reste hors de la recherche inter-doctypes.

Un doctype est exactement l’une de ces deux chosesà :

Type Déclaration Signification
Racine d’agrégat aggregate_root: true L’enregistrement que les utilisateurs créent et suppriment. C’est l’unité de verrouillage et de contrôle d’accès.
Enfant possédé aggregate_root: false plus member_of Une partie d’un document parent. Voir Composition parent/enfant.

4. Ajouter des actions, des enfants et un identifiant

Section intitulée « 4. Ajouter des actions, des enfants et un identifiant »

Ajoutez actions quand les utilisateurs ont besoin d’opérations typées au-del à des simples modifications (voir Actions nommées). Ajoutez children pour les parties possédées. Ajoutez un bloc identifier quand les documents ont besoin de numéros lisibles (voir Identifiants et contraintes d’unicité).

Soumettez la définition pendant que votre domaine de brouillon est ouvert. Facet valide le schéma, compile le script et renvoie les problèmes. Sur un domaine réel, tout changement ultérieur de la structure des données exige une montée de version (voir Faire évoluer un schéma).

Chaque écriture suit ensuite le même chemin : Facet valide le document, ajoute une ligne au journal, met à jour une projection et publie un événement.

App or user App or user

La définition ci-dessous déclare une racine crm.Company avec quatre champs. Envoyez-la à l’endpoint des doctypes de votre instance.

{
"domain": "crm",
"doctype": "Company",
"label": "Company",
"icon": "building-2",
"aggregate_root": true,
"schema_version": 1,
"display_name": "{{ name }}",
"search": "{{ name }} {{ industry }}",
"fields": {
"name": { "type": "string", "required": true, "filters": ["equality", "text_search"] },
"industry": { "type": "string", "filters": ["equality"] },
"status": {
"type": "enum",
"default": "lead",
"filters": ["equality"],
"values": [
{ "key": "lead", "label": "Lead" },
{ "key": "active", "label": "Active" }
]
},
"website": { "type": "url" }
}
}
Fenêtre de terminal
curl -k -X POST "https://facet.localhost:3443/Api/core/DocType" \
-H "Authorization: Bearer $FACET_API_KEY" \
-H "Content-Type: application/json" \
-d @company.json

-k ignore la vérification du certificat de l’adresse de développement locale. Une seconde soumission de la même définition répond 409 ; les mises à jour passent par l’éditeur de doctypes.

La création répond 422 Domain 'crm' does not exist

Section intitulée « La création répond 422 Domain 'crm' does not exist »

Créez d’abord le domaine. Un doctype doit se trouver dans un domaine, réel ou de brouillon.

Une définition n’accepte que des clés connues, et chaque entrée de champ vérifie ses propres clés. Le message nomme la clé et son emplacement. Le plus souvent, une contrainte est mal orthographiée, par exemple reqired au lieu de required.

La valeur de l’icône doit correspondre à un nom d’icône Lucide en kebab-case. Facet retombe sur un symbole simple quand le nom est inconnu.