Documentation Frappe Framework

Frappe Framework

DocTypes

Ce chapitre détaille le fonctionnement des DocTypes : statut des documents, modules, types de champs, nommage, contrôleurs, DocTypes enfants, Single et virtuels, personnalisation et permissions.

1 min de lectureMis à jour le Source : docs.frappe.io

Contenu du chapitre

Ce chapitre détaille le fonctionnement des DocTypes : statut des documents, modules, types de champs, nommage, contrôleurs, DocTypes enfants, Single et virtuels, personnalisation et permissions.

Pages de ce chapitre, dans l’ordre de la documentation officielle :

  1. Docstatus : statut du document
  2. Modules
  3. DocField virtuel
  4. Types de champs
  5. Nommage des documents
  6. DocField
  7. Contrôleurs
  8. Paramètres de formulaire et de vues
  9. DocType enfant (table)
  10. DocType Single
  11. DocTypes virtuels
  12. Actions et liens
  13. Personnaliser les DocTypes
  14. Masquage des données (Data Masking)
  15. Types de permissions
  16. DocType Layout
  17. Allow on Submit

Dans ce chapitre

  1. 01Docstatus : statut du documentLe docstatus suit l’état d’une transaction dans Frappe : brouillon (0), soumis (1) ou annulé (2). Cette page explique ces états et la classe DocStatus côté serveur.
  2. 02ModulesChaque DocType appartient à un module. Les modules regroupent les modèles liés et déterminent le dossier où vivent les fichiers de contrôleur générés.
  3. 03DocField virtuelUn DocField virtuel est un attribut calculé d’un document qui n’est pas stocké en base. Cette page explique comment le définir, lui donner une source et son impact sur les API.
  4. 04Types de champsFrappe propose de nombreux types de champs pour saisir et stocker des données dans un document. Cette page décrit chaque type, ses options et son usage.
  5. 05Nommage des documentsChaque document Frappe possède une clé primaire name. Cette page détaille les méthodes de nommage disponibles, les règles de nommage (Document Naming Rule) et les cas particuliers.
  6. 06DocFieldUn DocField définit une propriété (un champ) d’un DocType : nom de colonne, libellé, type de donnée et conditions d’affichage. Cette page présente ses principales propriétés avec un exemple.
  7. 07ContrôleursUn contrôleur est la classe Python d’un DocType, héritée de frappe.model.Document. Cette page décrit ses méthodes, les hooks de cycle de vie, l’objet doc et les annotations de types.
  8. 08Paramètres de formulaire et de vuesLes paramètres de vue d’un DocType permettent de définir un champ titre affiché dans le formulaire et de montrer ce titre, plutôt que le nom, dans les champs Link.
  9. 09DocType enfant (table)Un DocType enfant ne peut être lié qu’à un DocType parent et sert à stocker plusieurs enregistrements pour un même document. Cette page montre comment le créer et le relier.
  10. 10DocType SingleUn DocType Single n’a qu’une seule instance en base de données, par exemple System Settings. Cette page explique son usage et son stockage dans la table tabSingles.
  11. 11DocTypes virtuelsUn DocType virtuel n’a pas de table en base de données : son contrôleur définit lui-même la source des données. Cette page explique le principe et montre un contrôleur d’exemple.
  12. 12Actions et liensLes actions ajoutent des boutons à la vue d’un DocType ; les liens (Connections) affichent les documents connectés sur le tableau de bord. Cette page explique leur configuration.
  13. 13Personnaliser les DocTypesFrappe permet d’adapter un DocType à chaque site sans toucher à sa définition : champs personnalisés, Property Setter, Customize Form, scripts et permissions.
  14. 14Masquage des données (Data Masking)Le masquage des données permet d’afficher un champ tout en masquant sa valeur sensible aux utilisateurs qui n’ont pas la permission Mask. Cette page explique l’activation et le fonctionnement interne.
  15. 15Types de permissionsLes types de permissions personnalisés ajoutent des droits au-delà de read, write, create, delete et submit. Cette page montre comment en créer un, le vérifier dans le code et l’attribuer aux rôles.
  16. 16DocType LayoutDocType Layout crée plusieurs vues de formulaire pour un même DocType sans le modifier : libellés, visibilité et valeurs par défaut différents, activation automatique par condition.
  17. 17Allow on SubmitAllow on Submit est une propriété de DocField qui laisse un champ modifiable après la soumission d’un document. Cette page explique quand l’utiliser, comment l’activer et les pièges à éviter.