Documentation Frappe Framework

Frappe Framework

Créer des champs personnalisés à l’installation d’une app

Les champs personnalisés créés dans le bureau s’exportent en fixtures et sont réimportés quand l’application est installée ou mise à jour.

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

À quoi servent ces fixtures

Une application personnalisée peut ajouter automatiquement des champs personnalisés (Custom Fields) à des DocTypes qui ne lui appartiennent pas, lorsqu’elle est installée sur un nouveau site.

Mise en place

  1. Créez les champs personnalisés requis par l’application, depuis l’application web Frappe.
  2. Dans hooks.py, déclarez la fixture Custom Field :
python
fixtures = ["Custom Field"]
  1. Exportez les fixtures avant de valider l’application :
terminal
bench --site mysite export-fixtures

Cette commande crée un dossier fixtures dans l’application, et un fichier .csv ou .json qui décrit les champs personnalisés ajoutés. Ce fichier est importé automatiquement quand l’application est installée sur un nouveau site, ou mise à jour avec bench update.

Point d’attention

La même méthode accepte des DocTypes de type Single, par exemple « Website Settings », comme fixtures. La source ne détaille pas le filtre qui limiterait l’export à une partie des champs.