Généralités à propos des modules

Les modules sont des codes-programmes qui peuvent être ajoutés à divers endroits de Mercator en vue d'en personnaliser de façon très pointue le fonctionnement. Ces modules se matérialisent par 2 types de fichiers :

• Fichiers PRG : fichiers textes reprenant une succession de commandes Xbase (compatible Dbase, Clipper, ...). Ces commandes sont exécutées séquentiellement. Ceci implique qu'il ne peut être fait usage des structures de blocs tels que if ... endif, do while ... enddo, for ... endfor, ...
• Fichiers FXP : ce type de fichiers correspond au résultat d'une compilation d'un code source PRG.

Mercator permet l'adjonction de différents types de modules :

• Modules accessibles via "Outils / Modules" : fichiers FXP déposés dans le sous-répertoire DATA de Mercator. Ces modules s'installent automatiquement dans le menu "Outils / Modules" et doivent être au format "compilés".
• Modules appelés par une touche de fonction : un module sur mesure peut être activé par une touche de fonction (voir Personnalisation des touches de fonction). La chaîne devra être de la forme DO 'MON FICHER.PRG' ou DO 'MON FICHER.FXP'.
• Module de démarrage : Mercator détecte automatiquement la présence du module AUTOEXEC.PRG ou AUTOEXEC.FXP dans le répertoire principal de Mercator. Si l'un de ces fichiers est trouvé, il est exécuté lors du démarrage de l'application, après l'ouverture des tables. (Version 4.1 minimum)
• Module après saisie de code utilisateur : Mercator détecte automatiquement la présence du module LOGIN.PRG ou LOGIN.FXP dans le répertoire principal de Mercator. Si l'un de ces fichiers est trouvé, il est exécuté après chaque saisie de code utilisateur. (Version 5.0 minimum)
• Module de fermeture :
  • Mercator permet de contrôler la fermeture de Mercator, et éventuellement de déclencher des opérations contenues dans un module. Pour cela, il faut placer dans le répertoire principal de Mercator un fichier BLOCK_QUIT.FXP compilé à partir de BLOCK_QUIT.PRG. Ce module doit renvoyer true (.T.) pour bloquer la fermeture de Mercator, false (.F.) pour autoriser la fermeture de Mercator.
  • Mercator détecte automatiquement la présence du module AUTOCLOSE.PRG ou AUTOCLOSE.FXP dans le répertoire principal de Mercator. Si l'un de ces fichiers est trouvé, il est exécuté lors de la fermeture de Mercator. (Version 7.2 minimum)
• Module de validation d'inventaire : Mercator détecte automatiquement la présence du module MODUL_INVENT.FXP dans le répertoire principal de Mercator. Si ce fichier est trouvé, il est utilisé lors de la validation d'un inventaire. Ce module doit être une fonction qui renvoie true (.T.) si l'inventaire peut être validé, false (.F.) dans le cas contraire.
• Module de validation de transfert dépôts : Mercator détecte automatiquement la présence du module MODUL_TRANSF.FXP dans le répertoire principal de Mercator. Si ce fichier est trouvé, il est utilisé lors de la validation d'un transfert de dépôts. Ce module doit être une fonction qui renvoie true (.T.) si le transfert peut être validé, false (.F.) dans le cas contraire.
• Module de validation de réapprovisionnement : Mercator détecte automatiquement la présence du module VALID_REAPPRO.FXP dans le répertoire principal de Mercator. Si ce fichier est trouvé, il est utilisé lors de la validation d'un réapprovisionnement. Ce module doit être une fonction qui renvoie true (.T.) si le transfert peut être validé, false (.F.) dans le cas contraire. (Version 6.0 minimum)
• Modules liés aux séquences accessibles via "Outils / Séquences / Modules" :
  • PRG/FXP Appel tiers : cette option permet de sélectionner un module qui s'active lors de chaque appel du client dans un document de vente ou du fournisseur dans un document d'achat. (vers. min 4.3.73) (voir exemple)
  • FXP Prétraitement clé : dans les documents de ventes ou d'achats de la gestion commerciale, ce module permet de modifier la clé de recherche article saisie par l'utilisateur. Plus d'info sur cette page.
  • PRG/FXP Avant recalcul ligne : cette option permet de sélectionner un module qui s'active lors de chaque modification sur une ligne de document, avant recalcul de la colonne "Total".
  • FXP validation article : cette option permet de sélectionner un module compilé FXP. Le nom de ce module ne peut pas contenir d'espace. Ce module doit être une fonction qui renvoie true (.T.) si l'article peut être saisi sur la ligne en cours, false (.F.) dans le cas contraire. Cette option permet de paramétrer des critères personnalisés autorisant ou non la sélection d'un article dans un document de vente ou d'achat. (Version 4.1 minimum)
  • PRG/FXP Après recalcul ligne : cette option permet de sélectionner un module qui s'active lors de chaque modification sur une ligne de document, après recalcul de la colonne "Total".
  • FXP Contrôle transformation : cette option permet de sélectionner un module compilé FXP. Le nom de ce module ne peut pas contenir d'espace. Ce module doit être une fonction qui renvoie true (.T.) si le document peut être transformé vers un stade ultérieur, false (.F.) dans le cas contraire. Cette option permet de paramétrer des critères personnalisés autorisant ou non la transformation d'un document (ex. commande en livraison).
  • PRG/FXP Après transformation : ce module s'exécute après la transformation d'un document vers un stade ultérieur.
  • FXP Contrôle validation : cette option permet de sélectionner un module compilé FXP. Le nom de ce module ne peut pas contenir d'espace. Ce module doit être une fonction qui renvoie true (.T.) si le document peut être validé, false (.F.) dans le cas contraire. Cette option permet de paramétrer des critères personnalisés autorisant ou non la validation d'un document.
  • FXP Contrôle paiement : cette option permet de paramétrer des critères personnalisés autorisant ou non le paiement. Ce module doit être une fonction qui renvoie true (.T.) si le paiement est accepté, false (.F.) dans le cas contraire.
  • PRG/FXP Avant validation document : cette option permet de sélectionner un module (PRG ou FXP) qui doit s'exécuter lors de chaque recalcul global du document, en début de cette procédure.
  • PRG/FXP Après validation document : cette option permet de sélectionner un module (PRG ou FXP) qui doit s'exécuter lors de chaque recalcul global du document, en fin de cette procédure.
  • PRG/FXP Avant impression document : ce module (disponible à partir de la version 8.0) s'exécute avant l'impression du document (exemple d'utilisation).
  • PRG/FXP Après impression document : ce module s'exécute après l'impression du document, en fin de cette procédure.
• Modules liés aux grilles des séquences : Mercator (4.3 minimum) permet, en sus du paramétrage de la grille de saisie, l'activation d'un module lié à cette grille de saisie. L'écriture de ce module se fait, en mode paramétrage de grille de séquence, après avoir cliqué sur le bouton ad hoc. Les modules sont stockés dans le répertoire des données de Mercator. Ils sont nommés comme suit :_ + nom de la séquence + extension PRG. (exemple 1 - exemple 2 - exemple 3 - exemple 4 - exemple 5)
• Modules liés à l'ID dans les signalétiques : voir Modules sur ID dans les signalétiques
• Modules de validation dans les signalétiques : Mercator (4.1.60 minimum) détecte automatiquement la présence des fichiers CLI_VALID.FXP, FOU_VALID.FXP, STOCK_VALID.FXP, PROJ_VALID.FXP, ... Lors de la validation d'une modification dans le signalétique correspondant, Mercator teste la présence de ce fichier et le cas échéant l'exécute. Ce module doit être une fonction qui renvoie true (.T.) si la modification peut être enregistrée, false (.F.) dans le cas contraire.
  Ces modules ne peuvent en aucun cas modifier la valeur de l'identifiant (C_ID, F_ID, ...). Il est déconseillé de faire usage dans ces modules des valeurs correspondant aux champs de la table sous-jacente; il faut utiliser les variables mémoires (m.C_NOM, m.S_MODELE, ... et non CLI.C_NOM, STOCK.S_MODELE) (voir exemple)
• Modules de validation dans les dépôts en caisse et remises en banque : Mercator (4.2 minimum) détecte automatique la présence des fichiers MODUL_DEPOT.FXP et/ou MODUL_BANK.FXP. Lors de la validation d'un dépôt en caisse ou d'une remise en banque, Mercator teste la présence du fichier correspondant et le cas échéant l'exécute. Ce module doit être une fonction qui renvoie true (.T.) si le mouvement peut être enregistré, false (.F.) dans le cas contraire.
• Modules liés aux grilles d'historiques clients, fournisseurs et de production : Mercator (4.3 minimum) détecte automatiquement la présence des fichiers HISTCLI.PRG, HISTFOU.PRG, HISTPROD.PRG et HISTCPTA.PRG, dans le répertoire principal de Mercator. (exemple) 
• Modules liés aux diverses grilles dans les signalétiques : Mercator (4.3 minimum) détecte automatiquement la présence des fichiers suivants, dans le répertoire principal de Mercator :
  • CLI_TARCLI.PRG pour le tarif particulier en fiche "Clients" (exemple)
  • CLI_HIST.PRG : pour l'historique en fiche "Clients" (exemple)
  • FOU_HIST.PRG : pour l'historique en fiche "Fournisseurs"
  • STOCK_INTERRO.PRG : pour l'interrogation en fiche "Articles"
  • STOCK_DISPO.PRG : pour le disponible en fiche "Articles"
  • STOCK_ARTLIENS.PRG : pour les articles liés en fiche "Articles" (exemple)
  • STOCK_ARTFOU.PRG : pour la liaison "Fournisseurs" en fiche "Articles" (exemple)
  • STOCK_ARTLOT.PRG : pour la grille des lots
  • STOCK_ARTLOT2.PRG : pour la grille des lots dans les documents
  • STOCK_GAM1 STOCK_GAM2 STOCK_GAM3 : pour les 3 grilles de la fenêtre de saisie des articles en gamme
  • DEST_HIST.PRG : pour l'historique en 4ème signalétique
  • PROJ_HIST.PRG : pour l'historique en fiche "Projets"
  • PROJ_INTERRO.PRG : pour l'interrogation en fiche "Projets"
  • TACT_HIST.PRG : pour l'historique en fiche "Contacts"
  • TACT_SIG.PRG : pour les liaisons en fiche "Contacts"
• Modules liés aux diverses grilles dans certains écrans de Mercator : Mercator (4.3.80 minimum) détecte automatiquement la présence des fichiers suivants, dans le répertoire principal de Mercator :
  • REAPPROV.PRG pour le réapprovisionnement
  • TRANSF_DEP.PRG pour le transfert de dépôts
  • INVENT.PRG pour l'inventaire
  • REMISES.PRG pour les remises (soldes & promotions)
  • LETTRAGE.PRG pour l'écran des lettrages
  • AUTO_LIVR_V.PRG pour les livraisons des commandes clients
  • AUTO_FACT_V.PRG pour les facturations des livraisons clients
  • AUTO_FACT_A.PRG pour les facturations des livraisons fournisseurs
• Module de menu : Mercator (4.3 minimum) détecte automatiquement la présence du fichier MENU.PRG ou MENU.FXP. Il est exécuté lors de l'initialisation ou de la réinitialisation de la barre des menus. Ceci permet de personnaliser cette barre. (exemple)

Remarque importante
Ces modules sont écrits sous l'entière responsabilité de leur auteur. Mercator n'effectue aucun contrôle sur la pertinence du code exécuté. De la sorte, INEO décline toute responsabilité en cas de dommages causés dans la base de données par un module sur mesure écrit de façon inadéquate.
Le fonctionnement des modules repris dans cette rubrique est garanti uniquement s'il est fait usage de la dernière version de Mercator.exe

Pour information, il est possible dans Mercator de compiler un fichier PRG afin de produire un fichier FXP. Via "Outils / Prompt Fox", il suffit d'exécuter une commande de type compile 'mon_fichier.prg'.