Line 45: |
Line 45: |
| #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 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 |
| | | |
− | =Théorie du paramétrage du logiciel = | + | ==Théorie du paramétrage du logiciel :== |
| 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. |
| | | |
− | ==Les types de paramètres du logiciel== | + | ====1 - Les types de paramètres du logiciel:==== |
| Par convention dans les solutions logicielles web, on utilise trois types de paramètres : | | Par convention dans les solutions logicielles web, on utilise trois types de paramètres : |
| | | |
Line 57: |
Line 57: |
| 3. Les paramètres utilisateurs : Ce troisième type de paramètres concerne ceux qui sont spécifiques aux utilisateurs. Dans la plupart des applications, ces paramètres sont stockés au niveau du navigateur, dans les cookies ou dans sa base de données locale. | | 3. Les paramètres utilisateurs : Ce troisième type de paramètres concerne ceux qui sont spécifiques aux utilisateurs. Dans la plupart des applications, ces paramètres sont stockés au niveau du navigateur, dans les cookies ou dans sa base de données locale. |
| | | |
− | ==Les types de paramètres dans Dolibarr == | + | ====2 - Les types de paramètres dans Dolibarr :==== |
| Dans Dolibarr comme dans la plupart des applications web, les constantes base de données sont utilisées pour configurer les différentes options de l’application qui sont appelées à être modifiées au cours du sa mise en œuvre et sont stockées dans la table « llx_const ». | | Dans Dolibarr comme dans la plupart des applications web, les constantes base de données sont utilisées pour configurer les différentes options de l’application qui sont appelées à être modifiées au cours du sa mise en œuvre et sont stockées dans la table « llx_const ». |
| | | |
Line 64: |
Line 64: |
| Pour les paramètres utilisateurs , Dolibarr on utilise une table spéciale « llx_user_param » pour enregistrer les données de l’utilisateur. Les cookies sont seulement utilisées pour identifier la session. | | Pour les paramètres utilisateurs , Dolibarr on utilise une table spéciale « llx_user_param » pour enregistrer les données de l’utilisateur. Les cookies sont seulement utilisées pour identifier la session. |
| | | |
− | ==Le concept de configuration au sens large == | + | ====3 - Le concept de configuration au sens large :==== |
| On désigne comme configuration au sens large, l’ensemble de tous les paramètres d’une application adaptés à une entreprise ou une activité determinée. Un ERP tel que Dolibarr pourrait par exemple être utilisé par une entreprise de commerce de détail ou par une entreprise de production avec deux configurations complètement différentes. Les deux entreprises peuvent utiliser des modules communs avec des paramètres communs ou de modules, spécifiques au type d’entreprise. | | On désigne comme configuration au sens large, l’ensemble de tous les paramètres d’une application adaptés à une entreprise ou une activité determinée. Un ERP tel que Dolibarr pourrait par exemple être utilisé par une entreprise de commerce de détail ou par une entreprise de production avec deux configurations complètement différentes. Les deux entreprises peuvent utiliser des modules communs avec des paramètres communs ou de modules, spécifiques au type d’entreprise. |
| | | |
| De la on peut définir une configuration comme un ensembles de valeurs affectées à des paramètres. On peut utiliser une configuration pour enregistrer l’ensemble de valeurs de paramètres associés à chacun des deux types d’entreprises. Ceci inclut les modules activés, les valeurs de paramètres associés à chacun de ces modules ainsi que des valeurs associées à des paramètres de Dolibarr. | | De la on peut définir une configuration comme un ensembles de valeurs affectées à des paramètres. On peut utiliser une configuration pour enregistrer l’ensemble de valeurs de paramètres associés à chacun des deux types d’entreprises. Ceci inclut les modules activés, les valeurs de paramètres associés à chacun de ces modules ainsi que des valeurs associées à des paramètres de Dolibarr. |
| | | |
− | ==Considérations pour le stockage des paramètres de configurations == | + | ====4 - Considérations pour le stockage des paramètres de configurations :==== |
| On peut stocker les paramètres qui définissent une configuration dans une table de la base de données ou bien dans un fichier. Bien que traditionnellement on préfère utiliser les constantes base de données pour stocker les paramètres de l’application, on distingue plusieurs avantages pour l’utilisation de fichiers à la place: | | On peut stocker les paramètres qui définissent une configuration dans une table de la base de données ou bien dans un fichier. Bien que traditionnellement on préfère utiliser les constantes base de données pour stocker les paramètres de l’application, on distingue plusieurs avantages pour l’utilisation de fichiers à la place: |
| | | |
Line 80: |
Line 80: |
| 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 = | + | ==Définition d’une 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. C’est l’exécution de ce fichier qui installe 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. C’est l’exécution de ce fichier qui installe 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. |
| | | |
− | ==Les modules paramétrables == | + | =====1- Les modules paramétrables :===== |
| Les modules paramétrables sont des modules conçus pour interagir efficacement avec le module de paramétrage. Leurs caractéristiques sont : | | Les modules paramétrables sont des modules conçus pour interagir efficacement avec le module de paramétrage. Leurs caractéristiques sont : |
| | | |
Line 96: |
Line 96: |
| 5. Chaque paramètre peut être configuré pour apparaître ou non dans les sections de paramétrage autres que la page de configuration du module. | | 5. Chaque paramètre peut être configuré pour apparaître ou non dans les sections de paramétrage autres que la page de configuration du module. |
| | | |
− | ==Le module de paramétrage == | + | =====2 - Le module de paramétrage :===== |
| Ses tâches essentielles sont : | | Ses tâches essentielles sont : |
| | | |
Line 107: |
Line 107: |
| 4. L’inclusion de sections de paramétrage adaptées à des pages spécifiques. | | 4. L’inclusion de sections de paramétrage adaptées à des pages spécifiques. |
| | | |
− | =La composition de configurations = | + | ==La composition de configurations :== |
− | Un clic sur le bouton de '''composition complète''' à partir d'une configuration montre la page suivante :
| |
− | [[File:Page de composition complète.png|alt=Page de composition complète|none|thumb|1300x1300px|Page de composition complète 1/3]]
| |
− | Puis en déroulant la page, on a les deux écrans suivants :
| |
− | [[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]]
| |
| <br /> | | <br /> |
− | [[File:Page de composition complète 3-3.png|alt=Page de composition complète 3/3|none|thumb|1300x1300px|Page de composition complète 3/3]]Comme on voit sur ces copies d'écrans, cette page est composée de 3 sections. Chacune de ces sections contient des sous-sections qui contiennent à leur tour un ensemble de paramètres représentés dans une Jquery Datatable dans le but d'offrir une facilité dans la sélection,tri, et visualisation de paramètres.
| |
− |
| |
− | Chaque sous section est accompagnée d'une case à cocher permettant de sélectionner tous les paramètres qu'elle contient.
| |
− |
| |
− | Chaque paramètre est ensuite affiché sur trois colonnes :
| |
− |
| |
− | #Sélection : constitué d'une case à cocher pour sélectionner le paramètre.
| |
− | #Module : Module du paramètre, qui par convention est composé du mot sur la gauche du nom de paramètre avant le premier souligné.
| |
− | #Paramètre : Nom du paramètre.
| |
− | #Valeur : Valeur du paramètre.
| |
− | #Note : Description du paramètre dont la valeur est dans l'ordre :
| |
− | ##La description dans le commentaire métadata du paramètre dans le fichier de configuration pour les paramètres de modules paramétrables.
| |
− | ##La traduction du paramètre dans le fichier de langues avec le nom du paramètre comme clé pour les paramètres base de données et de modules paramétrables.
| |
− | ##La valeur du champs '''note''' dans le fichier '''llx_const''' pour les paramètres base de données.
| |
− |
| |
− | Les sections de la page de composition sont les suivantes :
| |
− |
| |
− | #Paramètres dans le fichier de configuration actuel :
| |
− | ##Paramètres du core : Toutes les constantes de la base de données dont le nom commence avec MAIN_ ou bien ne contient pas de souligné.
| |
− | ##Paramètres de modules non paramétrables : Toutes les constantes de la base de données dont le nom ne pas commence avec MAIN_ et qui contient un ou plusieurs caractères souligné. Le nom du module est dans ce cas le premier nom avant le souligné dans le nom du paramètre.
| |
− | ##Paramètres de modules paramétrables : Ce sont les constantes déclarées avec un '''define''' dans le fichier du module paramétrable.
| |
− | #Paramètres dans les fichiers de configuration de modules paramétrables :
| |
− | ##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 :
| |
− | ##Paramètres du core.
| |
− | ##Paramètres de modules non paramétrables.
| |
− |
| |
− | Une fois tous les paramètres désirés sélectionnés, un clic permet de les enregistrer dans le fichier de configuration actuel. En cas de conflit ( un même paramètre est sélectionné en double ), un message d'erreur est affiché indiquant les paramètres en double invitant à désélectionner l'un des deux, les deux paramètres apparaissant en rouge pour faciliter leur distinction.
| |
− |
| |
− | =Création de sections de paramétrage pour des pages spécifiques =
| |
− | Cette fonction permet la création de sections de paramétrages analogues à celles de '''Facturepar''' et '''Corepar'''. Le module inclut en standard une section de paramétrage pour la page de factures beaucoup plus complète que celle de '''Facturepar''' et qui contient 81 paramètres.
| |
− |
| |
− | Après la création d'une page de configuration pour une page spécifique, il est nécessaire pour l'activer de la déclarer dans le dictionnaire '''des correspondances de fichiers de configuration vers urls''' du module de paramétrage :
| |
− | [[File:Dictionnaire des correspondances config. vers url.png|alt=Dictionnaire des correspondances config. vers url|none|thumb|1300x1300px|Dictionnaire des correspondances config. vers url]]
| |
− | Ci dessous la section de paramétrage associée à la page d'édition de factures également accessible dans le site démo (http://dolipar.org/dolibarr/htdocs/compta/facture/card.php?facid=245) :
| |
− | [[File:Facturepar.png|alt=Facturepar|none|thumb|1300x1300px|Facturepar]]
| |