Aller au contenu

Domaines, brouillons et éditeurs

Un domaine est un secteur métier avec ses propres doctypes et ses propres données. Vous construisez un domaine dans un brouillon : une zone de travail privée dont le nom commence par _. Dans un brouillon, vous modifiez les définitions librement. Quand le modèle est prêt, vous le publiez sous son nom définitif. Facet crée alors le domaine réel et supprime le brouillon.

Ouvrez un brouillon quand vous concevez un nouveau domaine, ou quand vous modifiez un domaine réel et voulez d’abord tester. Le brouillon est aussi l’endroit où les co-éditeurs travaillent avec vousà : quiconque édite le brouillon garde le droit d’éditer le domaine publié.

  • Le rôle éditeur. Il vous permet d’ouvrir un brouillon. Facet vous enregistre comme premier éditeur de ce brouillon.
  • Des droits d’édition sur le domaine réel pour en dériver un brouillon. Utilisez l’action Modifier un existant du Builder.
  • Un administrateur pour les co-éditeurs. Un administrateur dresse la liste des co-éditeurs dans l’onglet Éditeurs d’un domaine. Vous ne pouvez pas ajouter des co-éditeurs vous-même.

Dans le Builder, créez un nouveau brouillon. Facet génère le nomà ; il commence toujours par _. Renseignez les deux champs de nom en une foisà :

Champ Règle Objectif
Nom Lettres minuscules, chiffres et tirets. Commence par une lettre. Le nom du domaine réel que vous comptez publier.
Libellé Texte libre, jusqu’à 64 caractères. Le nom affiché dans toute l’interface.

Créez les doctypes de votre modèle (voir Concevoir des doctypes). Dans un brouillon, Facet assouplit les règles de version : vous pouvez retirer un champ, changer un type ou sauter une version. Tous les autres contrôles de schéma restent en vigueur, et chaque script doit compiler.

Le cache des définitions se met à jour une à deux secondes après l’enregistrement. Retestez un changement après une courte attente, avant de le juger.

Ouvrez une session d’aperçu depuis le brouillon. Facet montre alors le brouillon dans l’application réelleà : vous ouvrez des pages, lancez des actions et créez des documents, le tout dans le brouillon. Les références inter-domaines vers des domaines réels n’affichent aucune donnée pendant l’aperçu.

Ouvrez l’onglet Vérification. Facet liste les problèmes et les avertissements de chaque doctype du brouillon. Un brouillon vide signale qu’il n’y a rien à publier. Corrigez les problèmes avant de publier (voir Vérifier un domaine avant publication).

Ouvrez la confirmation de publication. Vous y choisissez le nom cible et le modeà :

  • Publication à neuf — le nom cible doit être libre. Facet crée le domaine et copie vos doctypes.
  • Publication par-dessus — le domaine cible existe. Pour chaque doctype modifié, la version de schéma doit dépasser la version réelle d’exactement une unité, avec une entrée de migration pour l’écart (voir Faire évoluer un schéma).

Facet recopie les co-éditeurs vers le domaine publié, dépose les demandes d’attribution inter-domaines, puis supprime le brouillon. La publication revalide le modèleà : le graphe de composition doit être fermé, et le contrôle de version de la publication par-dessus doit passer.

Open a draft Open a draft

L’appel ci-dessous publie un brouillon vers un domaine neuf nommé orders. Lisez la clé d’API dans la variable d’environnement FACET_API_KEY.

Fenêtre de terminal
curl -k -X POST "https://facet.localhost:3443/Api/core/Domain/_3fjqk2m8p1xz/publish" \
-H "Authorization: Bearer $FACET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"target_name": "orders", "overwrite": false}'

La réponse nomme le domaine publié et signale les demandes d’attribution et les avertissements éventuels. -k ignore la vérification du certificat de l’adresse de développement locale.

Le nom doit être en lettres minuscules, chiffres et tirets, et commencer par une lettre. Un nom qui commence par _ est un nom de brouillon. Corrigez le champ Nom ou le nom cible, puis publiez de nouveau.

La version réelle et votre version de brouillon diffèrent de plus d’une unité, ou une entrée de migration manque. Augmentez la version d’un cran à la fois, ou publiez plutôt vers un domaine neuf.

Le cache des définitions se met à jour une à deux secondes après un enregistrement. Attendez un instant et retestez.

Supprimer un domaine est une action d’administrateur, et Facet refuse tant que l’un de ses brouillons est ouvert. Abandonnez d’abord le brouillon.