Frappe Framework
Fonctionnalités d’un DocType
Cinquième étape du tutoriel : définir le nommage des documents Article, organiser la mise en page du formulaire et configurer les permissions par rôle.
Objectif
Au chapitre précédent, nous avons créé le DocType Article. Voyons maintenant quelles autres fonctionnalités peuvent être personnalisées.
Nommage
Si vous avez créé un document depuis le formulaire, vous avez sans doute remarqué que la valeur name du document était un hachage généré aléatoirement. Modifions le DocType pour que la valeur saisie dans Article Name devienne le name du document.
- Ouvrez la liste des DocTypes depuis la barre de recherche et cliquez sur Article.
- Descendez jusqu’à la section Naming et saisissez
field:article_namedans le champ Auto Name. - Cliquez sur Save.
- Revenez à la liste des articles et créez un nouvel article.
Désormais, le name du document correspond à l’Article Name, et il doit être unique parmi les articles : impossible de créer deux articles portant le même nom. La documentation officielle illustre cette étape par une animation.
Vous pouvez vérifier les enregistrements en lançant une requête select dans la console MariaDB :
MariaDB [_ad03fa1a016ca1c4]> select * from tabArticle;
| ------------ | ---------------------------- | ---------------------------- | --------------- | --------------- | ----------- | -------- | ------- |
| name | creation | modified | modified_by | owner | docstatus | parent | parent
| ------------ | ---------------------------- | ---------------------------- | --------------- | --------------- | ----------- | -------- | ------- |
| bd514646b9 | 2020-10-10 16:24:43.033457 | 2020-10-10 16:24:43.033457 | Administrator | Administrator | 0 | NULL | NULL
| Catch 22 | 2020-10-10 16:41:49.734499 | 2020-10-10 16:41:49.734499 | Administrator | Administrator | 0 | NULL | NULL
| ------------ | ---------------------------- | ---------------------------- | --------------- | --------------- | ----------- | -------- | ------- |Conseil
Pour connaître les différents modes de nommage, consultez la page Nommage des documents.
Mise en page du formulaire
Organisons la disposition des champs dans le formulaire pour mieux exploiter l’espace disponible. Ouvrez le DocType Article, descendez jusqu’à la section Fields et ajoutez deux nouveaux champs de type Column Break et Section Break. Nous masquons aussi le champ Image, qui n’a pas besoin d’apparaître dans le formulaire. La documentation officielle montre la manipulation dans une animation.
Paramètres du formulaire
Dans le DocType Article, descendez jusqu’à la section Form Settings et saisissez image dans le champ Image Field. L’image s’affichera alors en haut à gauche du formulaire. Vous pouvez aussi activer Allow Rename pour autoriser le renommage des documents.
Permissions
Vous pouvez définir quels rôles sont autorisés sur un DocType et quelles actions leur sont interdites. Ouvrez le DocType Article, descendez jusqu’à la section Permission Rules et ajoutez les rôles.
Il est aussi possible de configurer le type d’action permis pour chaque rôle. Ajoutons un rôle Librarian qui dispose de toutes les actions, et un rôle Library Member qui n’a que l’action Read.
Pour tester, créez un utilisateur avec le rôle Librarian et un autre avec le rôle Library Member. Connectez-vous avec chacun d’eux et observez les actions autorisées.
Étape suivante : Méthodes de contrôleur.
