Suivi des sites / NsSuiviProd

Documentation du module · version 23.0.1 · éditeur NSINFO

1. Présentation

NsSuiviProd (« Suivi des sites ») tient dans Dolibarr le suivi des sites que vous installez et maintenez pour vos clients : Dolibarr, WordPress ou toute autre application.

Une fiche par site, rattachée au tiers du client, avec un type de site (Dolibarr, WordPress…).
Les URL du site : production, développement, sandbox, chacune avec sa version installée et la date de son dernier contrôle.
Une version actuelle par type de site, dans les réglages, qui permet de savoir quelles URL sont à mettre à jour.
Les plugins installés sur chaque URL, avec leur version et leur version sur le Dolistore, importés depuis le fichier des modules externes du Dolibarr du client.
Un historique complet de toutes les actions dans l’agenda du site.
Le module ne modifie pas le Core de Dolibarr.

2. Prérequis et installation

2.1 Prérequis

Élément	Version
Dolibarr	20.0 à 24.0 (testé sur 23.0)
PHP	7.4 à 8.3 (testé en 8.3)
Framework NSINFO (module « NSINFO »)	23.8.0 ou supérieur, installé et activé
Module Agenda de Dolibarr	Recommandé : historique des actions et derniers événements
Module NsListModExterne (« Liste des modules externes »)	Sur le Dolibarr du client, pour importer ses plugins (facultatif)

Le framework NSINFO est obligatoire. Si le module « NSINFO » n’est pas installé et activé, ou si sa version est antérieure à 23.8.0, l’activation de « Suivi des sites » est refusée avec un message qui l’indique. Le framework NSINFO est gratuit : framework NSINFO.

2.2 Installation

Installer et activer le module NSINFO (version 23.8.0 ou supérieure).
Depuis Accueil > Configuration > Modules/Applications > Déployer/Installer un module externe, envoyer l’archive module_nssuiviprod-X.Y.Z.zip (installer un module).
Dans la liste des modules, famille NSINFO, activer « Suivi des sites ».
Attribuer les permissions aux utilisateurs ou groupes concernés.
Vérifier la configuration (roue crantée du module, activation et paramètres).

À la première activation, le module crée :

ses tables (sites, URL, plugins) et les dictionnaires Types de site et Types d’URL, déjà remplis ;
la numérotation des sites, avec le modèle standard activé ;
le menu Suivi des sites et l’onglet Suivi des sites de la fiche tiers.

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 colonnes, permissions, menus et le glisser-déposer des URL. Les données et les réglages sont conservés.

3. Configuration

La page de réglages s’ouvre par la roue crantée du module, ou par le menu Suivi des sites > Réglages (droit « Accéder aux réglages du module »).

3.1 Numérotation des sites

Chaque site reçoit une référence automatique à sa création. Deux modèles sont proposés :

standard (activé par défaut) : préfixe, année, mois et compteur ;
avancé : masque personnalisable (année, mois, compteur, code du tiers…), avec une aide sur le champ du masque.

3.2 Catégorie des produits plugins

Le réglage « Catégorie des produits plugins » indique la catégorie de produits qui regroupe vos plugins et modules à la vente ou à la location.

Seuls les produits de cette catégorie et de ses sous-catégories sont proposés comme plugins, acceptés à l’enregistrement et reliés automatiquement (voir 10).
Sans catégorie, tous les produits sont proposés.

3.3 Dolistore

L’option « Vérifier les versions Dolistore automatiquement après l’import des modules externes » (activée par défaut) lance, juste après chaque import, la recherche des versions Dolistore des plugins de l’URL puis leur liaison aux produits. L’import est alors plus long. Désactivée, ces deux étapes se lancent à la main par les boutons de l’onglet de l’URL.

3.4 Version actuelle par type de site

Le tableau « Référentiel des versions : version actuelle par type de site » donne, pour chaque type de site (Dolibarr, WordPress…), la version actuelle au format x.y.z (exemple : 24.0.2), puis Enregistrer.

Une URL dont la version installée est inférieure n’est pas à jour ; égale ou supérieure, elle est à jour (voir 7.4).
Laisser la case vide pour un type de site sans comparaison : ses URL sont en « Pas de version actuelle ».
Une valeur qui n’est pas au format x.y.z n’est pas enregistrée et un message l’indique.

3.5 Dictionnaires

Types de site (Dolibarr, WordPress…) et Types d’URL (accès direct, administration, API…) : liens directs vers les dictionnaires de Dolibarr, réservés aux administrateurs.

4. Droits d’accès

Permission	Effet
Consulter les sites	Voir les sites, leurs URL et leurs plugins, l’accueil du module et l’onglet du tiers
Créer / modifier les sites, leurs URL et leurs plugins	Créer et modifier les sites, ajouter, modifier et supprimer les URL et les plugins, importer les modules externes, vérifier les versions Dolistore
Supprimer les sites	Supprimer un site
Accéder aux réglages du module	Menu Réglages et pages de réglages, aussi pour un utilisateur non administrateur

Les menus, fiches et listes du module sont réservés aux utilisateurs internes. Un utilisateur externe (portail client) ne voit que l’onglet Suivi des sites de son propre tiers.

5. Menus et accueil

Le menu du haut Suivi des sites ouvre l’accueil du module et un menu de gauche :

Sites : Nouveau site, Liste des sites, Sites à mettre à jour (liste des URL dont la version installée est inférieure à la version actuelle) ;
URL et Plugins installés : listes de toutes les URL et de tous les plugins ;
Réglages (selon le droit) ;
Réduire le menu : le menu de gauche se réduit à ses icônes.

L’accueil présente deux tableaux : les URL des sites en service par situation et les sites en service par type. Chaque ligne ouvre la liste correspondante.

6. Les sites

6.1 Créer un site

Menu Suivi des sites > Nouveau site, ou bouton de création depuis l’onglet du tiers.
Saisir le nom du site, le tiers du client, le type de site et une description.
Enregistrer : la référence est attribuée et le site est en service.

6.2 Le bandeau du site

Le bandeau, en haut de tous les onglets du site, affiche la référence, le nom du site, le tiers et le type de site.

Chacun a son crayon : un clic ouvre la modification directement dans le bandeau, avec les boutons Modifier et Annuler.
Sous le bandeau, la fiche ne montre plus que la description, et seulement si elle est remplie.
Le bloc des derniers événements (10 derniers) est affiché en bas à droite, avec un lien vers l’onglet Événements et un bouton d’ajout d’un événement lié au site et au tiers.

6.3 Arrêter et remettre en service

Le bouton Arrêter le site le passe à l’état arrêté (il n’apparaît plus dans les tableaux des sites en service) ; Remettre en service le réactive. Les crayons du bandeau sont masqués sur un site arrêté.

6.4 Onglet du tiers

L’onglet Suivi des sites de la fiche tiers, avec le nombre de sites, liste les sites du client : type, URL avec leur environnement, leur version installée, leur situation et la date du dernier contrôle, et statut.

7. Les URL d’un site

Une URL correspond à une instance du site. La section URL de la fiche site, avec leur nombre dans le titre, présente d’abord l’import des modules externes, puis le tableau des URL.

Colonne	Contenu
Environnement	Icône de couleur : Production (serveur vert), Développement (code orange), Sandbox (parasol violet, « bac à sable »)
Type d’URL	Accès direct, administration, API… (dictionnaire Types d’URL)
URL et Libellé	Adresse cliquable et nom de l’URL (facultatif). L’onglet de ses plugins affiche l’icône de l’environnement, suivie du nom s’il est saisi ; l’adresse apparaît au survol de l’onglet
Version installée	Numéro de la version (exemple : `23.0.3`), saisi ou repris du fichier des modules externes à l’import
Situation	Voir 7.4, avec la version actuelle du type de site quand elle diffère
Date du dernier contrôle	Date de la dernière vérification de l’URL
Complément	Informations complémentaires en texte enrichi (identifiants d’accès, remarques…)

7.1 Ajouter une URL

La dernière ligne du tableau sert à l’ajout : environnement, type, adresse, libellé (facultatif), version installée et date du dernier contrôle (date du jour par défaut), puis Ajouter. Un onglet de plugins est créé automatiquement pour la nouvelle URL.

Pour un Dolibarr équipé du module NsListModExterne, l’import crée l’URL tout seul, avec sa version et ses plugins.

7.2 Fiche d’une URL

Le crayon d’une ligne ouvre la fiche de l’URL pour modifier tous ses champs, dont le complément. La date du dernier contrôle y est préremplie avec la date du jour : enregistrer la fiche note le contrôle du jour, sauf si la date est changée.

7.3 Ordre des URL

L’ordre des URL se change par glisser-déposer de la poignée en fin de ligne, comme les lignes d’une proposition commerciale (flèches haut / bas à défaut). L’ordre des onglets de plugins suit l’ordre des URL.

7.4 Situation d’une URL

La situation compare la version installée à la version actuelle du type du site :

Situation	Signification
À jour	La version installée est égale ou supérieure à la version actuelle
Mise à jour disponible	La version installée est inférieure à la version actuelle
Version non renseignée	Aucune version installée n’est saisie
Pas de version actuelle	Aucune version actuelle n’est réglée pour le type du site

Les versions sont comparées nombre par nombre (22 < 22.0.4 < 24.0.2). La liste des URL a un filtre par situation et une colonne Version actuelle (en gras quand elle n’est pas installée) ; le menu Sites à mettre à jour ouvre directement les URL en « Mise à jour disponible ».

7.5 Supprimer une URL

La corbeille d’une ligne supprime l’URL avec tous ses plugins : la confirmation indique leur nombre, et un seul événement de l’agenda liste les plugins supprimés.

8. Import des modules externes

Le module gratuit NsListModExterne (« Liste des modules externes »), installé sur le Dolibarr du client, produit un fichier JSON de tous ses modules externes, nommé d’après l’adresse de ce Dolibarr (exemple : erp.client.fr.json) et téléchargeable depuis ses réglages.

L’import se fait en haut de la section URL de la fiche site, en une seule opération :

Choisir le type d’URL et l’environnement à donner à l’URL si elle doit être créée (« Si l’URL n’existe pas, elle est créée avec : »).
Choisir le fichier puis cliquer sur Importer le fichier. Pour l’instance où est installé NsSuiviProd, Importer le fichier de cette instance reprend directement son propre fichier.

L’import :

retrouve l’URL du site qui correspond à l’adresse du Dolibarr du fichier, ou la crée (si plusieurs URL correspondent, l’import s’arrête avec un message) ;
donne à l’URL la version exacte de Dolibarr du fichier et la date du jour comme date du dernier contrôle ;
ajoute ou met à jour les plugins de l’URL (même nom technique, ou à défaut même libellé), avec toutes les informations du fichier : version, éditeur, description, compatibilité, dépendances, fonctionnalités… ;
signale les plugins nouveaux Nouveau et ceux qui ne sont plus dans le fichier Absent du dernier import : ils sont conservés, et le bouton Supprimer les plugins absents de l’onglet les retire après confirmation ;
relie les plugins aux produits, puis, si l’option Dolistore est activée, vérifie leurs versions sur le Dolistore et relance la liaison aux produits.

Si une étape échoue, rien n’est enregistré. Les messages affichés et l’agenda du site rendent compte de chaque étape.

9. Les plugins

9.1 Un onglet par URL

La section Plugins installés de la fiche site présente un onglet par URL (icône de l’environnement, nom de l’URL s’il est saisi et nombre de plugins). Le tableau d’un onglet affiche, pour chaque plugin :

une case à cocher (première colonne), l’icône de location (voir 9.3) et le produit Dolibarr relié ;
le nom du plugin, avec un badge Nouveau ou Absent du dernier import après un import, et la description du module sur une ligne (terminée par « … » si elle est trop longue, texte complet au survol) ;
l’éditeur, et les liens vers la page Dolistore et vers le site de l’éditeur ;
la version installée et la version Dolistore, en orange avec une flèche quand elle est plus récente.

Au-dessus du tableau : pour une URL déjà importée, un lien vers les réglages de NsListModExterne sur le Dolibarr de cette URL, où télécharger le fichier, avec un bouton de copie juste après ; et les boutons Supprimer les plugins absents, Relier les plugins aux produits et Vérifier les versions Dolistore (icône du Dolistore avec une pastille de mise à jour).

9.2 Ajouter un plugin

La dernière ligne du tableau ajoute un plugin à l’URL de l’onglet : produit de la catégorie des plugins ou nom libre (plugin WordPress par exemple), version et location.

9.3 Location

Un plugin est en location (abonnement, icône de contrat violette) ou hors location (acheté, chariot gris).

Un clic sur l’icône, dans la fiche site, bascule l’état.
Dans la liste des plugins, les actions de masse Mettre en location et Retirer de la location changent plusieurs plugins à la fois.
L’import des modules externes ne modifie jamais ce choix.

9.4 Recherche, tri et suppression

La ligne de filtres du tableau cherche par location, produit, plugin (nom, nom technique et description), éditeur, version et version Dolistore plus récente.
Un clic sur un titre de colonne (location, produit, plugin, éditeur, version, version Dolistore) trie les lignes ; un second clic inverse l’ordre. Les versions sont triées nombre par nombre.
Les cases à cocher (ou celle du titre, pour tous) puis Supprimer les plugins sélectionnés suppriment plusieurs plugins après confirmation.
La liste Plugins installés du menu regroupe les plugins de tous les sites, avec la colonne Éditeur.

9.5 Fiche d’un plugin

La fiche d’un plugin regroupe ses informations en onglets : Général, Module (nom technique, numéro, éditeur, famille, activé, dossier…), Compatibilité (Dolibarr et PHP minimum, dépendances, incompatibilités), Fonctionnalités (permissions, menus, onglets, tâches planifiées…) et Dolistore et import.

10. Dolistore et produits

Versions Dolistore

Le bouton Vérifier les versions Dolistore d’un onglet (ou l’action de masse de la liste des plugins), et l’import si l’option est activée, interrogent le Dolistore et enregistrent, pour chaque module trouvé, sa version en vente, son libellé et sa référence.

Un module est reconnu par son nom technique ou son libellé. Une fois identifié, il est mémorisé : il est retrouvé directement sur tous les sites de tous vos clients.
Un module introuvable n’est pas recherché de nouveau pendant 7 jours depuis la fiche site.
Les liens Dolistore ouvrent la page du produit, ou une recherche du module sur le Dolistore s’il n’est pas encore identifié.

Liaison aux produits

Le bouton Relier les plugins aux produits relie les plugins sans produit à un produit de la catégorie des plugins :

d’abord par la référence Dolistore (le produit de même référence, ou sa version LOC_ pour un plugin en location) ;
sinon par la référence ou le libellé du produit (sans préfixe « Module Dolibarr – » ou « Location module – »), comparé au nom technique, au libellé ou au libellé Dolistore du plugin.

Pour une meilleure liaison, cliquer d’abord sur Vérifier les versions Dolistore (qui mémorise la référence Dolistore), puis sur Relier les plugins aux produits. Après un import, ces deux étapes sont faites automatiquement si l’option Dolistore est activée.

11. Suivi des actions dans l’agenda

Avec le module Agenda de Dolibarr, chaque action est enregistrée comme événement du site, lié au site et à son tiers, avec son détail dans la note de l’événement :

Objet	Actions enregistrées
Site	Création, modification (champ par champ : ancienne → nouvelle valeur), arrêt, remise en service, suppression (événement alors rattaché au tiers)
URL	Ajout (valeurs saisies), modification, déplacement (nouvel ordre), suppression (avec la liste de ses plugins, supprimés avec elle)
Plugin	Ajout, modification (aussi depuis sa fiche), passage en location ou non, suppression
Actions groupées	Import (fichier, instance, URL créée ou mise à jour, version installée, plugins créés, mis à jour, reliés, nouveaux et absents), vérification Dolistore (versions plus récentes), liaison aux produits, suppressions groupées : un seul événement par action, avec la liste des plugins

Ces événements apparaissent dans le bloc des derniers événements de la fiche (le titre de la liste de l’onglet Événements en donne le nombre), dans l’onglet Événements du site et dans l’agenda du tiers.

12. Limites connues et FAQ

Le glisser-déposer des URL ne conserve pas l’ordre.

Après l’installation ou une mise à jour, le module doit être désactivé puis réactivé.

Une URL reste en « Pas de version actuelle ».

Aucune version actuelle n’est réglée pour le type de son site : la saisir dans les réglages (3.4).

L’import a créé une nouvelle URL au lieu de mettre à jour l’existante.

L’URL est retrouvée d’après l’adresse du Dolibarr indiquée dans le fichier. Si l’adresse saisie sur le site est différente (autre nom, sous-dossier…), corriger l’adresse de l’URL existante, supprimer l’URL créée et importer de nouveau.

Aucun événement n’est enregistré.

Le module Agenda de Dolibarr doit être activé, et l’utilisateur doit avoir le droit de lire les événements pour voir le bloc des derniers événements.

Un plugin n’est pas relié à son produit.

Le produit doit être dans la catégorie des plugins (ou une sous-catégorie).
Un module absent du Dolistore, ou dont le nom diffère trop du libellé du produit (nom anglais du module face à un produit en français, par exemple), ne peut pas être relié automatiquement : le relier à la main dans sa fiche.

Un module n’est pas trouvé sur le Dolistore.

La recherche se fait sur le nom technique et le libellé du module. Un module qui n’est pas vendu sur le Dolistore, ou dont le libellé est trop différent, reste « non trouvé » et n’est pas recherché de nouveau pendant 7 jours.

Autres limites

L’import des plugins ne concerne que les URL de type Dolibarr équipées du module NsListModExterne ; la version et les plugins des autres sites (WordPress…) se saisissent à la main.
Supprimer une URL supprime aussi ses plugins.

Un projet Dolibarr ? Parlons-en.

Développement d’un module, paramétrage, migration ou simple question : nous vous répondons rapidement.