MyField
|
Ce Module permet de personnaliser les libellés des menus, onglets, champs des fiches et listes de Dolibarr.
Vous pouvez choisir vous-même le libellé de vos menus, le libellé des onglets et champs des fiches et listes |
Présentation
Selon le type de myfield (champs d'une fiche, liste, onglet,...), plusieurs autres options peuvent être appliquées aux champs des fiches telles qu'une couleur de fond, les afficher/ cacher, ajouter un masque de saisie, saisie en majuscule...
Le jeu combiné des permissions utilisateurs et des droits d'accès aux myFields permet de paramétrer les accès des utilisateurs à la vue des champs, leur contenu et leur modification.
MyField permet encore de cacher des menus à des groupes d'utilisateurs et d'en modifier l'URL de destination.
Paramétrage
La configuration du module s'effectue depuis la page d'administration des modules accessible par les menus Accueil > Configuration > Modules en cliquant sur l'icône 
ou l'icône 
en bout de ligne.
Page de configuration du module
Activation du contexte pour le développement
MyField permet d'afficher sur certaines pages de Dolibarr les contextes utilisables pour limiter les actions de personnalisations des myFields. Ces contextes seront utiles lors de la création de myFields pour limiter l'action du module aux seules pages possédant dans leur code le contexte indiqué sur la fiche du myField. Paramétrer l'affichage des contexte sur vos pages vous permettra de les identifier pour paramétrer au mieux vos myfields.
|
L'activation de l'affichage des contextes se traduit par des messages du type ci-contre |
Droits des administrateurs
Vous pouvez aussi choisir de désactiver l'utilisation des droits d'accès pour l'utilisateur administrateur. Si ce paramètre est activé, l'administrateur verra, hors de tout groupe, les myfields en fonctionnement.
Remplacement des boutons natifs
MyField permet le remplacement des boutons standards de Dolibarr par des icônes.
|
au lieu de | 
|
Information de support
Vous trouverez en bas de la page de configuration les informations techniques liées à votre installation. Ces informations techniques seront utiles et pourront vous être demandées si vous rencontrez un bug dans l'utilisation du module :
Permissions
Les accès aux fonctionnalités du module peuvent être restreints aux utilisateurs et groupes existants ou créés ultérieurement à l'installation du module. Cliquez sur le – pour ajouter un permission. Une permission accordée est symbolisée par un coche verte (
).
Permissions utilisateurs et groupes
|
Les accès aux fonctionnalités du modules peuvent être restreints aux utilisateurs et groupes, depuis leur fiche puis onglet Permissions, selon les permissions ci-contre |
Permissions par défaut
|
Les permissions par défaut (Accueil > Configuration > Sécurité > Permissions par défaut), accordées à tout utilisateur créé ultérieurement à l'installation du module, si il n'est pas ajouté à un groupe, sont les suivantes |
Démarrage
Les fonctionnalités de MyField sont accessibles depuis l'onglet de menu principal Patastools. Votre menu secondaire présente alors les entrées de menu suivantes :
| MyField | L'entrée principale affiche la liste de tous les myFields de votre environnement |
|
Nouveau myField |
Ces entrées afficheront la page de création d'un nouveau myField selon son type :
|
| Liste des éléments | Cette entrée affichera également la liste des myFields enregistrés sur votre environnement |
| Droits d'accès aux éléments | Cette page vous permettra de paramétrer les habilitations des groupes d'utilisateurs aux fonctionnalités de MyFields, tabs et menus. |
| Import XML | Cette entré affichera une page permettant de copier un fichier d'import d'un myfield au format XML. |
Création du myField
La page de création d'un myField de type menu est accessible depuis le lien de menu secondaire Patas-tools > MyField > Nouveau myMenu.
|
|
Suite à la création d'un myField, il sera nécessaire d'en définir les droits d'accès par groupes d'utilisateurs depuis le lien de menu secondaire du même nom (Voir plus loin)
Personnalisons le menu Accueil.
Personnalisons le menu secondaire Propositions commerciales et l'entrée de menu secondaire Nouvelle proposition.
|
L'entrée de menu secondaire sera déplacée d'un rang vers le bas avec le code -1 dans le champ Déplacement de sa fiche |
Suite à l'application de ces deux personnalisations, le menu secondaire devient :
|
plutôt que |
|
Pour différencier les entrées de menu secondaire du même nom, saisissez le menu de niveau supérieur auquel elles sont rattachées séparées par un dièse (#) :
|
Ajoutez au libellé le menu secondaire : Propositions commerciales#Liste
|
Pour obtenir
|
Personnalisation d'un onglet avec myField
Création du myField
La page de création d'un myField est accessible depuis le lien de menu secondaire Patastools > MyField > Nouveau MyTab.
- Type de myField : le champ automatiquement rempli en fonction du lien de menu sur lequel vous avez cliqué.
- Libellé natif : saisissez ici le libellé natif du champ tel qu'il est affiché à l'écran.
- Contexte d'activation : le contexte d'activation permet de limiter l'action des myFields sur les seuls champs des pages comportant le contexte indiqué ici.
Si aucun contexte n'est saisi, les modifications apportées à l'onglet par le myfield s'appliqueront à tous les champs du même libellé de toutes les fiches. Liste des principaux contexte
- Une liste des contextes est disponible sur le wiki de dolibarr.
- Texte de remplacement : texte de votre choix qui sera affiché à la place du libellé natif.
- Auteur
- Affichage : MyField permet de cacher des onglets. Sélectionnez dans la liste déroulante :
- Visible : le champ sera affiché. Il s'agit du fonctionnement standard de Dolibarr.
- Invisible : le champ sera absent des fiches
- Caché : le champ sera absent des fiches mais pourra être affiché (Show/Hide).
- Couleur : utilisez le sélecteur de couleur pour déterminer la couleur de fond du myField.
- Déplacement : saisissez 1 pour décaler vers la droite, -1 vers la gauche.
- Taille du champ de saisie à définir selon vos besoins. Si laissé vide, la valeur native du champ est conservée.
- URL de redirection : saisissez ici l'URL de la page qui s'affichera au clic sur l'onglet de menu. Si ce champ est laissé libre, l'URL native du menu sera conservée.
|
|
N'indiquez ici que la partie de l'URL suivant /htdocs/ |
Requête d'affichage : voir section Fonctionnement, ci-dessous
Suite à la création d'un myField, il sera nécessaire de définir les droits d'accès aux myFields par groupes d'utilisateurs depuis le lien de menu secondaire du même nom (Voir section Configuration des droits d'accès).
Exemple de personnalisation d'un onglet
Personnalisons l'onglet fiche des fiches des éléments.
La fiche devient alors
|
|
Si l'onglet est actif, la couleur sera affichée sur ses bords |
Personnalisation d'un champ avec myField
Création du myField
La page de création d'un myField est accessible depuis le lien de menu secondaire Patastools > MyField > Nouveau MyField.
- Type de myField : le champ automatiquement rempli en fonction du lien de menu sur lequel vous avez cliqué.
- Libellé natif du champ : saisissez ici le libellé natif du champ tel qu'il est affiché à l'écran.
- Contexte d'activation : le contexte d'activation permet de limiter l'action des myFields sur les seuls champs des pages comportant le contexte indiqué ici. Soi aucun contexte n'est saisi, les modifications apportées à l'onglet par le myfield s'appliqueront à tous les champs du même libellé de toutes les fiches.
- Liste des principaux contexte :
Fiche Contexte Adhérent membertypecard Catégories categorycard Commandes ordercard Commande fournisseur ordersuppliercard Contact contactcard Contrat contractcard Don doncard Entrepôt warehousecard Expédition expeditioncard Facture client invoicecard Facture fournisseur suppliercard Intervention interventioncard Livraison deliverycard Note de frais tripandexpensecard Produit productcard Projet projectcard Proposition commerciale propalcard Règlement client paiementcard Règlement fournisseur paymentsupplier Salaire salarycard Tache projecttaskcard Tiers thirdpartycard Utilisateur usercard
- Une liste des contextes est disponible sur le wiki de dolibarr.
- Texte de remplacement : texte de votre choix qui sera affiché à la place du libellé natif.
- Auteur
- Affichage : MyField permet de cacher des champs. Sélectionnez dans la liste déroulante :
- Visible : le champ sera affiché. Il s'agit du fonctionnement standard de Dolibarr.
- Invisible : le champ sera absent des fiches
- Caché : le champ sera absent des fiches mais pourra être affiché (Show/Hide).
- Couleur : utilisez le sélecteur de couleur pour déterminer la couleur de fond du myField.
- Déplacement : saisissez 1 pour remonter d'un champ, -1 pour descendre. :
|
|
Le déplacement d'un champ d'une fiche n'est effectué qu'au sein de son tableau. Il est donc possible de remonter ou descendre un champ, mais pas de le changer de colonne |
- Taille du champ de saisie : à définir selon vos besoins. Si laissé vide, la valeur native du champ est conservée.
- Obligatoire : cochez cette case pour rendre la saisie de valeurs dans le champ obligatoire pour enregistrer la création ou les modifications de la page
|
|
Le contrôle du champ en création et modification n'est effectué que si l'on rentre en édition du champ lui-même |
|
|
N'indiquez ici que la partie de l'URL suivant /htdocs/ |
- Masque de saisie : le masque de saisie est paramétrable avec les caractères suivants :
- a pour une lettre (A-Z,a-z)
- 9 pour un chiffre (0-9)
- * pour un caractère alphanumérique (A-Z,a-z,0-9)
- Vous pouvez ajouter dans le champ les caractères que vous souhaitez pour constituer votre masque. Par exemple, si vous souhaitez ajouter un indicatif international au champ téléphone, le masque sera : +0099-(9)999999999
- UPPERCASE pour forcer la saisie en majuscule.
- Requête d'affichage : Voir section Fonctionnement
Suite à la création d'un myField de type champ, il sera nécessaire de définir les droits d'accès aux myFields par groupes d'utilisateurs depuis le lien de menu secondaire du même nom (Voir section Configuration des droits d'accès).
Exemple de personnalisation d'un champ
Personnalisons le champ Id. prof. 2 (SIRET) des fiches de tiers.
Le champ a été paramétré en tant qu'invisible. En cliquant sur le lien Show/Hide au-dessus du tableau, le champ sera affiché selon les paramètres enregistrés sur la fiche du myField :
En édition du champ, le masque sera activé et ne permettra que la saisie de chiffres (masque saisi 999 999 999 99999) et sa complétion vérifiée (rendu obligatoire) pour empêcher l'enregistrement de la page sans qu'il ne soit rempli :
Personnalisation d'un myField de liste
Création du myField
Les mylist de liste permettent de limiter l'affichage de champs.
Masquons le champ Tiers de la liste des contrats avec le myField suivant :
Liste des principaux contexte :
| Liste | Contexte |
| Contrat | contractlist |
| Proposition commerciale | propallist |
| Commande | orderlist |
| Facture client | invoicelist |
| Facture fournisseur | supplierorderlist |
| Proposition commerciale fournisseur | supplier_proposallist |
| Intervention | interventionlist |
| Expédition | shipementlist |
| Produits/services | productservicelist |
La liste ne contient plus le champs Tiers, et il n'est pas possible de le sélectionner dans le sélecteur de champs.
|
|
Si vous rendez un myField de liste invisible, il sera invisible de tous les utilisateur. Pour le cacher seulement à un ou des groupes d'utilisateurs, laissez le visible et jouter ensuite avec les droits d'accès ! |
Requête SQL de traitement
Fonctionnement
La requête de traitement va conditionner l'affichage des champs selon la correspondance de l'objet à la requête. Il est alors possible, par exemple, d'afficher des champs différents selon que l'objet est un produits ou un service.
Saisissez ici la requête d'affichage applicable au champs sur l'exemple suivant :
#SEL# if llx_product.type=1 FROM llx_product WHERE rowid=#ID#
Exemple
Avec le myfield suivante :
On obtient la fiche suivante sur un produit :
Tandis que sur la fiche d'un service :
Configuration des droits d'accès
En tant qu'utilisateur administrateur, tous les myFields vous sont visibles.
|
|
Sur la page d'accueil du module MyField, l'application des personnalisations est désactivée |
Si vous n'avez pas défini de groupes utilisateurs, les myfields sont affichés sur les interfaces de tous les utilsiateurs.
Depuis l'entrée de menu secondaire Patas-Tools > MyField > droits d'accès aux onglets, paramétrez les accès des groupes d'utilisateurs :
Il existe quatre droits d'accès :
 Bloqué en accès
|
 Bloqué en modification
|
Comportement selon les droits d'accès
- Bloqué en accès (
) : Le champ sera caché aux utilisateurs du groupe. Ils ne pourront pas l'afficher : le lien
Show/Hide ne sera pas actif :
- Accès en lecture mais bloqué en modification (
): Les utilisateurs du groupe pourront afficher le champ, mais ne pourront pas en modifier le contenu.
- Accès en lecture et Accès en modification (
) : Les utilisateurs du groupe pourront afficher le champ et le modifier si leurs permissions de groupe ou d'utilisateur le leur permettent. Les paramètres du champ s'appliquent alors (obligatoire, masque de saisie,...) :
Autres fonctionnalités
Import des myField
Il est possible d'enregistrer une liste de myfields et leurs paramétrages en important un fichier XML. Depuis la page Outils Patas-M > MyField > Importer un onglet, collez le fichier XML dans la zone de saisie et cliquez sur le bouton Lancer l'importation.
|
|
Si vous cochez la case Écraser les données précédentes, votre liste de myfields se résumera à ceux présent dans le ficher que vous importez |
Paramétrer ensuite les droits d'accès des utilisateurs au myField.
Context d'activation
Fiche Contexte Adhérent membertypecard Catégories categorycard Commandes ordercard Commande fournisseur ordersuppliercard Contact contactcard Contrat contractcard Don doncard Entrepôt warehousecard Expédition expeditioncard Facture client invoicecard Facture fournisseur suppliercard Intervention interventioncard Livraison deliverycard Note de frais tripandexpensecard Produit productcard Projet projectcard Proposition commerciale propalcard Règlement client paiementcard Règlement fournisseur paymentsupplier Salaire salarycard Tache projecttaskcard Tiers thirdpartycard Utilisateur usercard
Questions fréquentes
Ce chapitre répertorie les difficultés rencontrées avec le module. Vous y trouverez donc des éléments de réponse quant à son utilisation. Si vous rencontrez une autre erreur que celles décrites ci-dessous lors de l'utilisation de ce module :
- Désactivez et réactivez le module,
- Vérifier sur le ChangeLog si une nouvelle version a été publiée,
- Ré-installez/mettez à jour le module,
- Vérifiez que le remplacement de fichiers natifs de Dolibarr ne soit pas nécessaire au bon fonctionnement du module.
- Vérifiez qu'aucune incompatibilité avec un autre module ne soit indiquée. Le cas échéant, suivez nos préconisations.
Si, malgré ces manipulations, l'erreur persiste, contactez-nous en utilisant le formulaire dédié (http://docs.patas-monkey.com/support/). Ce formulaire est le mode de contact à privilégier pour toute difficulté d'utilisation ou remontée de bug. Aussi, nous vous remercions de ne pas multiplier les canaux d'échange pour un même objet.
- Affichage d'un message en haut des pages de Dolibarr
- Si vos pages de Dolibarr affichent un message semblable à l'image suivante, il ne s'agit pas d'un message d'erreur, mais de l'affichage des contextes de la page courante. Pour ne plus voir ces lignes affichées, désactivez l'affichage du contexte
(voir Configuration).
- Message erreur d'ordonnancement
- Certaines pages de certaines versions de Dolibarr présentent un erreur dans leur code empêchant la bonne application de la personnalisation des champs. MyField permet de les identifier pour les corriger.
- Le message d'erreur s'affiche en bas de page et est le suivant :
- En vous aidant de l'URL de la page, ouvrez le fichier du noyau de Dolibarr pour le modifier. Par exemple, si la page qui comporte le message est http://.../htdocs/custom/myField/admin/extrafields.php, ouvrez successivement les dossiers htdocs, custom, myField, admin et ouvrez le fichier extrafields.php.
L'erreur vient de l'inversion des lignes llxFooter(); et $db->close(); en fin de fichier.
Modifiez le code de la page pour obtenir :
au lieu de :
