Mises en page de liste par défaut

Une disposition de liste enregistre les colonnes, les filtres et le tri d'une vue liste. Elle est stockée dans un document Filtre de liste (List Filter). Une disposition standard est livrée avec une application : elle est exportée en fichier JSON dans le module et créée sur chaque site à la migration.

Prérequis

• Un site en mode développeur (developer_mode dans la configuration du site).
• Le rôle System Manager.
• L'application et le module où exporter la disposition.

Créer une disposition standard

1. Ouvrez la vue liste du DocType, par exemple Facture de vente.
2. Ouvrez le menu des dispositions dans la barre de filtres, puis cliquez sur Créer une mise en page.
3. Saisissez le Nom de la mise en page, par exemple « Factures impayées ».
4. Cochez Standard (« Exporté dans le module et livré avec son application »).
5. Choisissez le Module de votre application.
6. Réglez les filtres, le tri et les colonnes, puis cliquez sur Créer.

La case Standard n'est proposée qu'à la création. Une disposition existante ne peut pas devenir standard.

À l'enregistrement, Dodock écrit le fichier :

<module>/doctype/<doctype>/list_filter/<nom>.json

Par exemple mon_app/mon_module/doctype/sales_invoice/list_filter/sales_invoice_factures_impayées.json. Le nom d'une disposition standard est <DocType>-<nom de la disposition>, identique sur tous les sites. Validez ce fichier dans le dépôt de votre application.

Synchronisation

bench migrate crée ou met à jour les dispositions standard à partir des fichiers. Une disposition standard dont le fichier a disparu est supprimée.

Un utilisateur garde ses dispositions personnelles à côté des dispositions standard. Le champ Ordre de la mise en page règle la position d'une disposition standard dans le menu. Une nouvelle disposition standard se place en dernier.

Règles

• Une disposition standard ne peut être modifiée ou supprimée qu'en mode développeur.
• Elle n'appartient à aucun utilisateur.
• Deux dispositions standard d'un même DocType ne peuvent pas avoir des noms qui ne diffèrent que par des espaces, tirets ou soulignés : elles donneraient le même fichier.