Module Parametrage FR
Informations
| Module name | Parametrage |
| Editor / Editeur | Dolipar.org - http://dolipar.org/content/parametrage |
| Download or buy page / Page achat ou téléchargement | |
| Status / Statut / Estado | Stable |
| Prerequisites / Prérequis |
Dolibarr min version: 10.0.X Dolibarr max version: {{{maxversion}}} |
| Last update date / Date mise à jour fiche / Fecha última actualización | 2020-01-25 |
| Note / Nota |
Prérequis
Dolibarr 10.0.x
Résumé
Le module de paramétrage est le point d'arrivée de tous les modules paramétrables de Dolipar.org que sont les modules Cashdeskpar et Menupar. Les modules Facturepar et Corepar ont disparu au profit de ce module qui permet de créer à la volée toutes leurs fonctionnalités et plus.
Installation
- Téléchargez le fichier archive du module (.zip) depuis le site web www.dolistore.com ou récupérez le par toute autre manière.
- Placez le fichier dans le répertoire racine de dolibarr ou bien créez un dossier custom à la racine de dolibarr pour l'y placer avec tous vos modules supplémentaires ( Si vous choisissez cette solution, pensez à dé-commenter les deux lignes du fichier de conf en rapport)
- Décompressez le fichier par la commande unzip module_parametrage-X.Y.Z.zip
- L'emplacement correct du module doit être du type : htdocs/custom/parametrage.
- Aller dans l'emplacement d'installation du module et donner les privilèges de lecture et d'écriture au seveur PHP pour les fichiers suivants :
- parametrage_consts.php
- parametrage_default_consts.php
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 :
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
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.
Les types de paramètres du logiciel
Par convention dans les solutions logicielles web, on utilise trois types de paramètres :
1. Les paramètres base de données ( En majorité ) : Ce sont des paramètres stockés dans la base de données dans le but de pouvoir être gérés comme n’importe quel autre type de données.
2. Les paramètres fichiers : Il sont utilisés pour définir des paramètres qui dépendent de la plateforme ou qui définissent les paramètres d’accès à la base de données et ne peuvent donc pas être stockés en base de données.
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
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 ».
En plus de stocker les paramètres d’accès à la base de données, les constantes fichier sont utilisées pour référencer les chemins des différents sous-ensembles de l’application ainsi que le mode de fonctionnement (développement ou production). En un sens, les constantes fichiers concernent les paramètres à qui on affecte des valeurs une seule fois et ne sont pas destinés à être changés dans une installation.
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
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.
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:
1. Un fichier est plus facilement consultable qu’une table de base de données. Il peut même être consulté sans installation de Dolibarr.
2. Les modifications dans un fichier peuvent être gérées par un gestionnaire de versions tel que GIT. Dans le cas d’une table, Il faudra créer une table spéciale pour gérer l’historique avec le traitement qui s’ensuit.
Il existe toutefois quelques inconvénients mineurs :
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
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
Les modules paramétrables sont des modules conçus pour interagir efficacement avec le module de paramétrage. Leurs caractéristiques sont :
1. Tous les paramètres de ces modules sont stockés sur des fichiers.
2. Ils sont consultables et modifiables dans la configuration du module.
3. Dans la page de configuration du module, on peut définir une ou plusieurs pages qui afficheront une section de paramétrage pour changer les valeurs de paramètres à la volée.
4. On définit 3 type de paramètres : chaîne,intervalle et booléen
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
Ses tâches essentielles sont :
1. La recomposition de la configuration actuelle par chargement de paramètres de la base de données et de fichiers de configuration de modules paramétrables.
2. La modification des valeurs des paramètres actuels.
3. La sauvegarde et restauration de configurations.
4. L’inclusion de sections de paramétrage adaptées à des pages spécifiques.
La composition de configurations
Un clic sur le bouton de composition complète à partir d'une configuration montre la page suivante :
Puis en déroulant la page, on a les deux écrans suivants :
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 :
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) :
