Line 1:
Line 1:
<!-- BEGIN interlang links --> <!-- Do NOT edit this section
<!-- BEGIN interlang links --> <!-- Do NOT edit this section
Links below are automatically managed by PolyglotBot
Links below are automatically managed by PolyglotBot
−
You can edit links on the English source page : Module_Parametrage_EN --> <!-- END interlang links --> {{TemplateDocDevFr}} {{TemplateDocUtil}}
+
You can edit links on the English source page : Module_Parametrage_EN --> <!-- END interlang links -->
+
{{TemplateDocDevFr}} {{TemplateDocUtil}}
<seo metak="Ultimatepdf, Dolibarr, models, design, interface, invoice, order, proposal, project" />
<seo metak="Ultimatepdf, Dolibarr, models, design, interface, invoice, order, proposal, project" />
Line 31:
Line 32:
Le module est opérationnel et peut être activé.
Le module est opérationnel et peut être activé.
−
=Configuration=
−
Pour utiliser ce module, il vous faut d'abord l'activer. Pour cela, après s'être connecté avec un compte administrateur, allez sur la page "'''Accueil - Configuration - Modules'''". Le module apparaît dans "Dolipar", cliquez sur "Activer". Un pictogramme apparaît à la fin de la ligne du module, cliquez dessus pour accéder à la page de configuration spécifique à ce module :
−
−
Comme le module de paramétrage est un module système, toutes ses fonctionnalités se retrouvent dans la page de configuration suivante :
−
[[File:Page de configuration du module.png|alt=Page de configuration du module|none|thumb|1300x1300px|Page de configuration du module]]
−
La page de configuration se compose de deux parties :
−
−
#La section de configuration et d'utilisation du module, qui comprend :
−
##Le bouton d'activation du contrôle de modules paramétrables à travers le module de paramétrage : Ce bouton permet de remplacer tous les réglages dans les modules paramétrables par ceux définis dans le module de paramétrages. Actuellement, les deux seuls modules paramétrables existant concernés sont les modules Cashdeskpar et le gestionaire de menu Menupar. D'autres modules vont certainement étoffer cette liste dans le futur proche.
−
##Les boutons de composition de configurations: Permettent de composer le fichier de configuration du module de paramétrage. La composition complète permet d'auto-sélectionner au départ tous les paramètres de la configuration actuelle alors que la composition de base permet de partir d'une sélection vide ( Voir paragraphe : Composition de configurations)
−
##Le bouton de sauvegarde de configurations : Permet de sauvegarder la configuration actuelle dans un fichier. Il faut fournir un nom de fichier avant d'appuyer sur le bouton '''enregistrer'''.
−
##Le bouton de suppression de configurations : Permet de supprimer des fichiers de configuration préalablement enregistrés.
−
#La section de paramétrage du module de paramétrage : Cette section affiche tous les paramètres du module obtenus à travers la fonction de composition. Le bouton '''RAFRAICHIR LA PAGE''' commun à tous les modules paramétrables, permet de rafraîchir la page sans s'y déplacer pour visualiser immédiatement les effets de modification d'un paramètre
−
=Analyse du paramétrage logiciel dans Dolibarr :=
+
=Remarques sur le paramétrage logiciel en général et dans Dolibarr :=
Pour bien comprendre les fonctions du module, il est nécessaire de connaitre quelques notions sur le paramétrage de logiciel en général, puis pourquoi et comment on a implémenté toute une méthodologie de paramétrage dans Dolibarr avec les bénéfices qu'elle apporte.
Pour bien comprendre les fonctions du module, il est nécessaire de connaitre quelques notions sur le paramétrage de logiciel en général, puis pourquoi et comment on a implémenté toute une méthodologie de paramétrage dans Dolibarr avec les bénéfices qu'elle apporte.
Line 80:
Line 68:
1. Les requêtes SQL sont très utiles pour faire des consultations complexes. Un effort de programmation plus important est nécessaire pour faire des recherches complexes dans des fichiers texte.
1. Les requêtes SQL sont très utiles pour faire des consultations complexes. Un effort de programmation plus important est nécessaire pour faire des recherches complexes dans des fichiers texte.
−
=Définition d’une solution de gestion de configurations dans Dolibarr :=
+
=Description de notre solution de gestion de configurations dans Dolibarr :=
Dans le cas de Dolibarr, une configuration est un simple fichier php avec des directives '''define''' pour chaque paramètre de module paramétrable et une instruction du type $conf->global->XX=YY pour les paramètres base de données. C’est l’exécution de ce fichier qui définit la configuration choisie. Ces paramètres peuvent être modifiés pour ajuster la configuration. On peut aussi créer de nouvelles configurations par modification de configurations préexistantes.
Dans le cas de Dolibarr, une configuration est un simple fichier php avec des directives '''define''' pour chaque paramètre de module paramétrable et une instruction du type $conf->global->XX=YY pour les paramètres base de données. C’est l’exécution de ce fichier qui définit la configuration choisie. Ces paramètres peuvent être modifiés pour ajuster la configuration. On peut aussi créer de nouvelles configurations par modification de configurations préexistantes.
−
Cette solution inclut les modules paramétrables, les modules paramétrables et le module de paramétrage.
+
Cette solution inclut les modules paramétrables, les modules non paramétrables et le module de paramétrage.
===Les modules paramétrables :===
===Les modules paramétrables :===
Line 207:
Line 195:
###Les paramètres de type intervalle sont suivis par une indication de la borne inférieure et supérieure séparés par ‘''':'''’.
###Les paramètres de type intervalle sont suivis par une indication de la borne inférieure et supérieure séparés par ‘''':'''’.
##La valeur par défaut
##La valeur par défaut
−
##Le commentaire affiché s’il n’existe pas de traduction du paramètre en clé dans le fichier de langues.
+
##Le commentaire affiché s’il n’existe pas de traduction du paramètre en clé dans le fichier de langues.
+
+
=Configuration du module=
+
Pour utiliser ce module, il vous faut d'abord l'activer. Pour cela, après s'être connecté avec un compte administrateur, allez sur la page "'''Accueil - Configuration - Modules'''". Le module apparaît dans "Dolipar", cliquez sur "Activer". Un pictogramme apparaît à la fin de la ligne du module, cliquez dessus pour accéder à la page de configuration spécifique à ce module :
+
+
Comme le module de paramétrage est un module système, toutes ses fonctionnalités se retrouvent dans la page de configuration suivante :
+
[[File:Page de configuration du module.png|alt=Page de configuration du module|none|thumb|1300x1300px|Page de configuration du module]]
+
La page de configuration se compose de deux parties :
+
+
#La section de configuration et d'utilisation du module, qui comprend :
+
##Le bouton d'activation du contrôle de modules paramétrables à travers le module de paramétrage : Ce bouton permet de remplacer tous les réglages dans les modules paramétrables par ceux définis dans le module de paramétrages. Actuellement, les deux seuls modules paramétrables existant concernés sont les modules Cashdeskpar et le gestionaire de menu Menupar. D'autres modules vont certainement étoffer cette liste dans le futur proche.
+
##Les boutons de composition de configurations: Permettent de composer le fichier de configuration du module de paramétrage. La composition complète permet d'auto-sélectionner au départ tous les paramètres de la configuration actuelle alors que la composition de base permet de partir d'une sélection vide ( Voir paragraphe : Composition de configurations)
+
##Le bouton de sauvegarde de configurations : Permet de sauvegarder la configuration actuelle dans un fichier. Il faut fournir un nom de fichier avant d'appuyer sur le bouton '''enregistrer'''.
+
##Le bouton de suppression de configurations : Permet de supprimer des fichiers de configuration préalablement enregistrés.
+
#La section de paramétrage du module de paramétrage : Cette section affiche tous les paramètres du module obtenus à travers la fonction de composition. Le bouton '''RAFRAICHIR LA PAGE''' commun à tous les modules paramétrables, permet de rafraîchir la page sans s'y déplacer pour visualiser immédiatement les effets de modification d'un paramètre
=La composition de configurations :=
=La composition de configurations :=
−
<br />Ci dessous la page de composition de configuration ( composition complète ):
+
Ci dessous la page de composition de configuration obtenue en cliquant sur le bouton de composition complète . Les trois images sont obtenues en déroulant la page :
[[File:Page de composition complète.png|alt=Page de composition complète 1/3|none|thumb|1300x1300px|Page de composition complète 1/3]]
[[File:Page de composition complète.png|alt=Page de composition complète 1/3|none|thumb|1300x1300px|Page de composition complète 1/3]]
[[File:Page de composition complète 2-3.png|alt=Page de composition complète 2/3|none|thumb|1300x1300px|Page de composition complète 2/3]]
[[File:Page de composition complète 2-3.png|alt=Page de composition complète 2/3|none|thumb|1300x1300px|Page de composition complète 2/3]]
[[File:Page de composition complète 3-3.png|none|thumb|1300x1300px|Page de composition complète 3/3]]
[[File:Page de composition complète 3-3.png|none|thumb|1300x1300px|Page de composition complète 3/3]]
+
+
+
Nous obtenons un formulaires composé de 3 sections et un bouton '''composer''' pour l’envoyer. Chaque section est composée de sous-sections et chaque sous-section présente une série de paramètres dans une Datatable
+
+
Les 3 sections sont structurées comme ci-dessous :
+
+
#Paramètres dans le fichier de configuration actuel : Contient les paramètres du fichier de configuration actuel du module de paramétrage. Ils son présentés filtrés par type. On a donc un maximum de 3 sous sections :
+
##Paramètres du core : commençant avec MAIN_ ou ne contenant pas de caractères soulignés.
+
##Paramètres de modules non paramétrables : Autres paramètres de la base de données.
+
##Paramètres de modules paramétrables : Paramètres déclarés par l’instruction '''define'''.
+
#Paramètres dans les fichiers de configuration de modules paramétrables : Les fichiers de configuration des modules paramétrables sont structurés tout comme le fichier de configurations du module de paramétrage. On a donc pour chaque module paramétrable présent dans l’installation le paramètres :
+
##Paramètres du core.
+
##Paramètres de modules non paramétrables.
+
##Paramètres de modules paramétrables.
+
#Paramètres dans la base de données : Les paramètres contenus dans la table '''llx_const''' de la base de données de Dolibarr partagés en deux sous-sections :
+
##Paramètres du core.
+
##Paramètres de modules non paramétrables.
+
+
Chaque paramètre est représenté sur cinq colonnes :
+
+
#Sélection : Case à cocher pour sélectionner/désélectionner l’élément.
+
#Module : Pour les paramètres de modules paramétrables ou non paramétrables. Il est vide pour les paramètres du core.
+
#Paramètre : Nom complet du paramètre.
+
#Valeur : Valeur du paramètre.
+
#Note : Contient le commentaire affiché si le commentaire dans le fichier de configuration est vide et que le paramètre n’existe pas dans le fichier de langue
+
+
Chaque groupe de paramètres est représenté dans un élément Jquery Datatable est accompagné d’un bouton pour sélectionner l’ensemble du groupe.
+
+
La différence entre la composition complète et la composition de base réside en ce que dans la première, tous les paramètres présents dans les fichiers de configuration sont présélectionnes alors qu’aucun paramètre n’est sélectionné dans la seconde.
+
+
En appuyant sur le bouton composer, on lance la recréation du fichier de configuration du module de paramétrage avec les paramètres sélectionnés. En case de conflit de paramètre en double un message est affiché indiquant la localisation des conflits et en appliquant le style de surbrillance aux deux paramètres en double et en invitant à désélectionner l’une des deux comme dans l’exemple suivant ( Dans la deuxième image, la page est déroulée pour faire apparaître le deuxième élément ) :
+
[[File:Capture d’écran de 2020-01-26 13-58-07.png|alt=Conflit de paramètres 1/2|none|thumb|1300x1300px|Conflit de paramètres 1/2]]
+
[[File:Capture d’écran de 2020-01-26 13-58-14.png|alt=Conflit de paramètres 2/2|none|thumb|1300x1300px|Conflit de paramètres 2/2]]
+
<br />
+
+
=8 -Création de sections de paramétrage dans des pages spécifiques de Dolibarr=
+
La création de sections de paramétrage dans les pages spécifique de Dolibarr fait seulement appel aux paramètres de la base de données, paramètres du core ou de modules non paramétrables. Les paramètres de modules paramétrables existant dans les fichiers de configuration de leurs modules sont conçus pour être utilisés seulement dans les pages de ce dernier. Si on a besoin de faire appel à un paramètre de ce type, on peut toujours le déclarer en tant paramètres base de données à l’intérieur du module paramétrable.
+
+
C’est cette fonction qui a permis de rendre obsolètes les modules Facturepar, Facturepar plus et corepar. Le module Facturepar affichait une section de paramétrage dans la page d’édition de factures clients avec environ 24 paramètres alors que grâce au module de paramétrage, on a 81 paramètres contrôlables dans la cette page et on peut procéder de façon similaires pour toutes les pages de Dolibarr y compris celle de modules externe
+
+
Pour créer une section de paramétrage pour une page spécifique de de Dolibarr, il faut procéder en plusieurs étapes :
+
+
#Composition et sauvegarde dans des fichier d’une ou plusieurs configurations.
+
#Création manuelle d’un fichier de configuration en combinant les paramètres des fichiers composés.
+
#Création d’une entrée dans le dictionnaire de correspondance de configuration vers urls du module de paramétrage.
+
+
Pour la page d’édition de factures (ex : Facturepar) on a créé une entrée dans le dictionnaire comme dans l’image suivante :
+
[[File:Dictionnaire des correspondances config. vers url.png|alt=Dictionnaire des correspondances configurations / urls|none|thumb|1300x1300px|Dictionnaire des correspondances configurations / urls]]
+
Ce qui donne une section de paramétrage dans la page d’édition de factures comme dans l’image suivante accessible dans le site démo dans le lien http://dolipar.org/dolibarr/htdocs/compta/facture/card.php?facid=245 :
+
[[File:Facturepar.png|alt=Page de l'ex module Facturepar|none|thumb|1300x1300px|Page de l'ex module Facturepar]]
<br />
<br />
+
[[Category:Modules complémentaires]]
+
{{DEFAULTSORT:Module de Parametrage FR}}