Inventaire des modules externes / NsListModExterne

1. Présentation

NsListModExterne (« Liste des modules externes ») fait l’inventaire de tous les modules externes installés sur votre Dolibarr : achetés sur le Dolistore, développés sur mesure ou installés pour un essai.

• Les modules sont recensés dans un fichier JSON, activés ou non : version, éditeur, numéro, famille, compatibilité, dépendances, fonctionnalités…
• Le fichier se génère et se télécharge depuis la page de réglages du module ; une tâche planifiée le régénère chaque jour.
• Il s’archive, se transmet à votre prestataire ou s’importe dans le module NsSuiviProd (« Suivi des sites »).
• Pas de menu ni de page supplémentaire : tout se passe dans les réglages.
• Le module est autonome et ne modifie pas le Core de Dolibarr.

2. Prérequis et installation

2.1 Prérequis

Élément	Version
Dolibarr	14.0 à 24.0 (testé sur 23.0)
PHP	7.4 à 8.3 (testé en 8.3)
Autre module	Aucun : le module est autonome
Module Travaux planifiés de Dolibarr	Nécessaire seulement pour la régénération quotidienne du fichier

2.2 Installation

1. Depuis Accueil > Configuration > Modules/Applications > Déployer/Installer un module externe, envoyer l’archive module_nslistmodexterne-X.Y.Z.zip (installer un module).
2. Dans la liste des modules, famille NSINFO, activer « Liste des modules externes ».
3. Ouvrir les réglages (roue crantée du module, activation et paramètres) et cliquer sur Générer le fichier JSON.

À l’activation, le module crée son dossier de documents, ses deux permissions et la tâche planifiée « Liste des modules externes : génération du fichier JSON ».

2.3 Mise à jour / réactivation

Après une mise à jour du module, désactiver puis réactiver le module : cette opération enregistre les nouvelles permissions et la tâche planifiée. Les réglages et le fichier déjà généré sont conservés.

3. Réglages

La page Liste des modules externes – Réglages s’ouvre par la roue crantée du module, dans la liste des modules. Elle est réservée aux administrateurs. Ses onglets ChangeLog et À propos donnent l’historique des versions et la présentation du module.

3.1 Fichier JSON des modules externes

Ligne	Contenu
Fichier	Nom du fichier, qui reprend l’adresse du Dolibarr (exemple : erp.client.fr.json), cliquable pour le télécharger, et son emplacement sur le serveur
Copie pour le module Suivi des sites	Affichée si le module Suivi des sites est activé : emplacement de la copie écrite en même temps (voir 7)
Date de dernière génération	Date et heure du fichier, ou « Pas encore généré »

• Générer le fichier JSON recalcule l’inventaire et réécrit le fichier ; le message indique le nombre de modules externes recensés. Le bouton demande la permission « Générer le fichier JSON des modules externes ».
• Télécharger enregistre le fichier sur votre poste.

3.2 Masquer le module

Le paramètre « Masquer le module dans la liste des modules de Dolibarr » retire le module de la page des modules.

• Le module reste actif : fichier JSON, copie et tâche planifiée continuent de fonctionner.
• Une fois masqué, il ne peut plus être ouvert ni désactivé depuis la liste des modules. Ses réglages restent accessibles par leur adresse directe, affichée sous le paramètre : la noter avant de masquer le module, elle sert à le faire réapparaître.
• Le réglage est propre à chaque entité.

4. Droits d’accès

Permission	Effet
Consulter la liste des modules externes	Aucune page à consulter pour le moment : le fichier se télécharge depuis les réglages
Générer le fichier JSON des modules externes	Bouton « Générer le fichier JSON » des réglages

La page de réglages, et donc le téléchargement du fichier, est réservée aux administrateurs de Dolibarr. La tâche planifiée génère le fichier sans permission particulière.

5. Contenu du fichier

Le fichier est au format JSON, lisible par un tableur, un script ou un outil de suivi de parc. Un fichier est produit par entité en multisociété.

5.1 L’instance

• date et heure de génération ;
• adresse de l’instance, entité, version de Dolibarr et version de PHP ;
• nombre de modules externes et nombre de modules activés.

5.2 Chaque module

Groupe	Informations
Identité	Nom technique, numéro, libellé, description, famille
Version et éditeur	Version, contenu du fichier de version, présence d’un ChangeLog, éditeur et son site, adresse de la dernière version
État	Activé ou non, date de la dernière activation, dossier d’installation
Compatibilité	Versions minimales de Dolibarr et de PHP, dépendances, modules requis et incompatibles
Réglages et langues	Page de réglages, fichiers de langue
Fonctionnalités	Nombre de permissions, de menus, d’onglets, de dictionnaires, de widgets et de tâches planifiées ; triggers, modèles de documents, hooks, CSS et JS

Seuls les modules externes sont recensés : les modules standard de Dolibarr sont écartés, ainsi que NsListModExterne lui-même.

6. Génération automatique

La tâche planifiée « Liste des modules externes : génération du fichier JSON » régénère le fichier une fois par jour. Elle se trouve dans Accueil > Configuration > Outils d’administration > Travaux planifiés, où sa fréquence peut être changée.

Le module Dolibarr Travaux planifiés doit être activé, et le lancement des travaux planifiés doit être programmé sur le serveur (voir la documentation de Dolibarr sur les travaux planifiés).

7. Utilisation avec NsSuiviProd

Le module NsSuiviProd (« Suivi des sites ») de votre prestataire suit les sites de ses clients : URL, versions installées et plugins.

• Dans l’onglet de plugins d’une URL, NsSuiviProd affiche un lien direct vers la page de réglages de NsListModExterne de ce Dolibarr, où télécharger le fichier.
• Le fichier téléchargé s’y importe en un clic : les plugins du site sont créés ou mis à jour, puis leurs versions Dolistore sont vérifiées.
• Quand NsSuiviProd est installé sur le même Dolibarr, une copie du fichier est écrite pour lui à chaque génération : il l’importe directement, sans téléchargement.

8. Limites connues et FAQ

Le module n’apparaît plus dans la liste des modules.

Il a été masqué (3.2). Ouvrir ses réglages par leur adresse directe et désactiver le paramètre « Masquer le module dans la liste des modules de Dolibarr ».

Le bouton « Générer le fichier JSON » est grisé.

L’utilisateur n’a pas la permission « Générer le fichier JSON des modules externes ».

Le fichier n’est pas régénéré chaque jour.

Vérifier que le module Travaux planifiés est activé, que la tâche du module est active et que le lancement des travaux planifiés est programmé sur le serveur.

Un module manque dans le fichier.

• Les modules standard de Dolibarr ne sont pas recensés, ni NsListModExterne lui-même.
• Un module dont le descripteur provoque une erreur au chargement est ignoré.

Une question ? Assistance NSINFO au 03 70 999 730 ou sur la page Assistance.