Paramétrer les documents

Dokos permet de personnaliser l'affichage et le comportement des documents (DocTypes) via des paramètres spécifiques. Ces paramètres peuvent être configurés directement depuis l'interface ou via des fichiers de configuration JSON pour une gestion plus avancée.

Paramétrer via l'interface

Pour accéder aux paramètres d'un document :

1. Allez dans Développeur > Personnalisation > Paramètres du document.
2. Sélectionnez le document que vous souhaitez configurer (ex: Facture de vente, Commande client).
3. Dans l'onglet Général, vous trouverez les options pour personnaliser l'affichage et le comportement du document.

Exemple : Configurer une facture de vente

Pour le document Facture de vente (Sales Invoice), vous pouvez :

• Activer ou désactiver des champs spécifiques.
• Définir des valeurs par défaut pour certains champs.
• Configurer des règles de validation.

Ces paramètres sont immédiatement appliqués et visibles pour tous les utilisateurs.

Paramétrer via des fichiers JSON (nouveauté)

Avec cette nouvelle fonctionnalité, Dokos permet de mapper les paramètres des documents via des fichiers JSON. Cela facilite la gestion centralisée et la réutilisation des configurations, notamment pour les environnements multi-sites ou les déploiements automatisés.

Structure des fichiers JSON

Les fichiers de mapping sont stockés dans le répertoire doctype_settings_map de chaque module. Par exemple :

• erpnext/accounts/doctype_settings_map/sales_invoice_(standard)/sales_invoice_(standard).json

Un fichier JSON de mapping suit cette structure :

{
  "doctype": "Sales Invoice",
  "settings_doctype": "DocType Settings Map",
  "settings_field": "sales_invoice_settings",
  "mappings": {
    "champ1": "valeur_par_defaut1",
    "champ2": "valeur_par_defaut2"
  }
}

Comment utiliser les fichiers JSON ?

1. Créer ou modifier un fichier JSON :
   • Naviguez dans le répertoire doctype_settings_map du module concerné.
   • Créez un sous-dossier pour le document (ex: sales_invoice_(standard)).
   • Ajoutez ou modifiez le fichier JSON en suivant la structure ci-dessus.
2. Appliquer les paramètres :
   • Les paramètres définis dans le fichier JSON sont automatiquement appliqués lors du chargement du document.
   • Pour forcer le rechargement des paramètres, vous pouvez exécuter la commande suivante dans le terminal :

     bench reload-doc
     

Exemple : Configurer les paramètres d'un client

Pour le document Client (Customer), vous pouvez mapper des paramètres comme suit :

{
  "doctype": "Customer",
  "settings_doctype": "DocType Settings Map",
  "settings_field": "customer_settings",
  "mappings": {
    "customer_group": "Individual",
    "territory": "France",
    "is_internal_customer": 0
  }
}

Cas d'usage

• Environnements multi-sites : Appliquez les mêmes paramètres à plusieurs instances Dokos.
• Déploiements automatisés : Intégrez les fichiers JSON dans vos scripts de déploiement pour une configuration cohérente.
• Personnalisation avancée : Gérez des configurations complexes sans intervention manuelle.

Bonnes pratiques

• Vérifiez les dépendances : Assurez-vous que les champs référencés dans les fichiers JSON existent bien dans le document cible.
• Testez en environnement de développement : Avant de déployer en production, testez les modifications dans un environnement de développement.
• Documentez vos configurations : Ajoutez des commentaires dans les fichiers JSON pour expliquer le rôle de chaque paramètre.

Résoudre les problèmes

Si les paramètres ne s'appliquent pas :

1. Vérifiez que le fichier JSON est correctement formaté.
2. Assurez-vous que le chemin du fichier est correct.
3. Exécutez bench reload-doc pour recharger les documents.
4. Consultez les logs pour identifier d'éventuelles erreurs (bench --site [votre_site] log).

::: tip Pour les développeurs, cette fonctionnalité permet de standardiser les configurations et de réduire les erreurs manuelles. Elle est particulièrement utile pour les projets nécessitant une gestion centralisée des paramètres. :::

      
flowchart TD
    A[Début] --> B[Choisir le document à configurer]
    B --> C[Configurer via l'interface ou JSON]
    C --> D[Appliquer les paramètres]
    D --> E[Vérifier les modifications]
    E --> F[Résoudre les problèmes si nécessaire]
    F --> G[Fin]