Procédures générales

documentation

Installer MainTCP en tant que service Windows

Préambule

MainTCP est un micrologiciel développé par ACCEO [Avantage] qui permet à des logiciels tiers de se connecter aux données d’Avantage.

Concrètement, il ouvre un port local et sera à l’écoute sur ce port. Toutefois, ce micrologiciel n’est pas un service Windows, et n’a pas été conçu de la sorte. Pour assurer un accès constant et un redémarrage automatique, nous recommandons la procédure suivante pour créer un service Windows MainTCP.

Survol de ce que vous allez faire

En gros, vous aller installer un logiciel, NSSM, qui permet de lancer une exécutable “comme un service”.  Vous aller donc configurer NSSM pour exécuter MainTCP, tout simplement!

Installation

Pour exécuter le logiciel MainTCP.exe d’Avantage comme un service, vous pouvez utiliser l’outil NSSM (Non-Sucking Service Manager). Voici un résumé de la procédure :

  1. Téléchargez NSSM
    • Rendez-vous sur le site officiel de NSSM et téléchargez l’outil.
    • https://nssm.cc/download
  2. Installez NSSM
    • Extrayez le contenu du fichier téléchargé dans un répertoire de votre choix.
    • Exemple : C:\utilities\nssm
  3. Identifier le bon ‘MainTCP.exe’
    1. Vous devez exécuter le MainTCP qui se trouve dans le répertoire “officiel” d’avantage: pas une copie de l’exécutable, mais vraiment dans le répertoire où se situe les compagnies Avantage.
    2. ATTENTION : Si vous voulez exécuter MainTCP sur un poste différent qu’où se trouve les données avantage, sachez que vous devrez faire quelques manipulations supplémentaire (expliqué plus bas).
  4. Configurez le service
    1. Ouvrez une Invite de commandes ou une console Windows PowerShell en mode administrateur.
    2. Naviguez jusqu’au répertoire où vous avez extrait NSSM en exécutant la commande suivante:
      • CMD ou PowerShell : cd C:\utilities\nssm\win32
    3. Identifier le chemin vers MAINTCP.exe.
      1. NE PAS prendre  le MainTCP d’une installation Avantage faite ailleurs qu’où les données se trouve.  Il faut le MainTCP.exe qui est dans le répertoire “central” des données d’Avantage.
      2. ATTENTION!  Si MAINTCP.exe est sur un autre poste, VOUS NE DEVEZ PAS utiliser le lecteur réseau  (car n’existe typiquement que dans VOTRE session).  Utilisez le chemin UNC
    4. Utilisez la commande suivante pour installer MainTCP.exe comme un service :
      • CMD : nssm install MainTCP “C:\chemin\vers\MainTCP.exe”
      • PowerShell : ./nssm.exe install MainTCP “C:\chemin\vers\MainTCP.exe”
    5. Exemples :
      1. Invite de commandes
      2. PowerShell
    6. SI MainTCP.exe est sur un AUTRE POSTE,  vous devrez modifier l’usager exécutant le service:
  5.  Démarrez le service
    • Une fois configuré, vous pouvez démarrer le service avec la commande :
    • CMD : nssm start MainTCP
    • PowerShell : ./nssm.exe start MainTCP
      • Il est possible que vous voyez une erreur. Probablement que le service avait déjà été démarré.
  6. Vérifiez le service
    • Vous pouvez vérifier que le service fonctionne correctement en utilisant la commande :
      • CMD : nssm status MainTCP
      • PowerShell : ./nssm.exe status MainTCP
    • Exemple:
    • Vous pouvez aussi ouvrir le gestionnaire de service Windows pour le démarrer