Consistency

Ce Module permet la création de contrôle de cohérence personnalisé. Il se base sur une requête SQL validant le contrôle que l'on souhaite mettre en place, et un tooltip apparait sur la fiche de l'élément. Il est aussi possible d'afficher un indicateur de cohérence sur les listes des éléments.

Présentation

Le Module consistency permet de créer vos propres règles de cohérence personnalisées à partir des informations contenues dans votre base de données. La création des alertes de cohérence se base sur des requêtes SQL.

Une fois la règle de cohérence crée et active, elle peut s'afficher comme une colonne supplémentaire au niveau de la liste des élements

La règle de cohérence s'affiche enfin sous la forme d'une alerte sur la page principale de l'élément associé

Consistency est livré avec plusieurs exemples de règles de cohérences présente dans le répertoire xmlsample desquels vous inspirer pour créer les votres.

Configuration des fonctionnalités du module

Il n'y a pas à proprement parlé de configuration à réaliser sur le module à part son activation.

Démarrage

Les fonctionnalités de consistency sont accessibles depuis l'onglet de menu principal Outils Patas. Votre menu secondaire présente alors les entrées de menu suivantes :

consistency : l'entrée principale consistency permet d’afficher toutes les règles définies dans votre environnement (même si celles-ci ne sont pas actives). En cliquant sur le titre de la règle, on peut visualiser et modifier celle-ci. Nouvelle règle de cohérence : cette entrée vous affichera la page de création d'une nouvelle regle de cohérence. Importer une règle : cette entrée affichera une page permettant de copier un fichier d'import d'une liste au format XML. (Voir "Import d'une règle" plus bas).

Liste des règles de cohérence

La liste des règles affiche les régles de cohérence présente dans votre environnement

Vous pouvez accéder aux règles présentes en cliquant sur l'icone en début de chaque ligne mais aussi créer une nouvelle règle en cliquant sur les boutons dédiés

Création d'une règle de cohérence

Ouvrez la page de création d'une règle depuis le lien de menu Outils Patas > consistency > Nouvelle règle :

Libellé	le libellé sera affiché en tant que titre sur la liste de l'élément, mais aussi le titre du message d'information
Description	Le texte associé à la règle de cohérence affiché au niveau du message d'information
Element associé au contrôle	l'élément auquel le contrôle de cohérence est associé. La liste des éléments se trouve plus bas dans la documentation.
Niveau d'alerte	Permet d'indiquer le niveau d'alerte (la couleur du message d'information), d'informatif (en vert) à critique (en rouge).
Auteur	champs libre pour saisir l'auteur de la règle de gestion.
Liste active	Pour activer la règle au niveau de votre Dolibarr.
Requête du controle de cohérence	Il s'agit d'une requête SQL effectuant un contrôle dans les données, afin d'activer ou non la règle de cohérence. si le contrôle est positif, la requête retourne une ligne de données, si il est négatif il n't a pas de données. Pour bypasser la protection contre le SQL injection de dolibarr, il convient de remplacer le SELECT par #SEL#. L'indentifiant associé à l'élément est transmi à la requête via la balise #ID#

Page de création

Pour l'exemple, créons une liste des produits et services affichant leur prix de vente, de revient et PMP, accessible depuis le menu principal Produits/Services :

Ouvrez la page de création d'une nouvelle liste et saisissez les données ci-contre puis terminez la première étape de création de la liste en cliquant sur le bouton Créer

Une fois la liste créée, trois nouveaux champs sont affichés et peuvent être modifié en édition de la fiche : Export CSV autorisé : cette fonctionnalité permettra l'export CSV des résultats de la liste pour un retraitement ultérieur. Forcer l'affichage de tous les résultats : cette fonctionnalité forcera l'affichage de tous les résultat de la liste sans filtrage. Selon la complexité de votre requête et la quantité d'information à traiter, activer cette fonctionnalité peut ralentir le système Liste active : suite à sa création, une liste est par défaut, Inactive. Modifiez son état pour permettre son affichage depuis les liens de menus déclarés sur sa fiche.

Trois boutons sont présent en bas de l'écran :

• Modifier vous permettra d'entrer en édition de la liste pour en modifier la requête ou tout autre élément (menus d'accès, onglets d'affichage …
• Importation / Exportation de la page générera le fichier XML que vous pourrez modifier avant de le copier pour l'exporter
• Supprimer effacera la liste de votre base de données. Désactivez toujours une liste avant de la supprimer. Si vous effectuez une suppression sans avoir désactivé la liste auparavant, elle restera présente dans votre base de donnée et sur votre interface, mais vidée de son contenu|warn

Autres fonctionnalités

Onglet dans l'élément

Il est possible d'afficher un myList comme un onglet d'un élément pour cela il faut utiliser dans la requete SQL un alias particulier pour la table associé à l'élément

prefix	Element
s	Tiers (société)
p	Produit
e	Stock (entrepot)
p	Projet
p	Propal
c	commande
f	Facture
t	ticket
pf	Demande de prix
cf	commande fournisseur
ff	Facture Fournisseur

Import d'une règle de cohérence

Il est possible de créer une règle de cohérence en important un fichier XML.

Des exemples de règles sont livrés avec le module consistency dans le dossier XMLsample

Depuis la page Outils Patas > Consistency > Importer une règle, collez le fichier XML dans la zone de saisie et cliquez sur le bouton Lancer l'importation. Activez la règle depuis sa fiche et elle sera prise en compte dans votre environnement.