Différences

Ci-dessous, les différences entre deux révisions de la page.

--- licence4j [2023/09/11 16:31]
arame.mboup
+++ licence4j [2025/02/07 11:18] (Version actuelle)
mamadou.gueye_sensoft.sn
@@ Ligne 1: / Ligne 1: @@
-====== Génération des licences avec licence 4J ======
+====== Génération des licences avec licence 4J et déploiement sur le serveur ======
-===Processus création et mise à jour licence===
+===== Partie 1 : Mise en place nouvelle licence =====
 Le présent guide comporte les étapes à suivre pour la génération de licences avec l’outil ''licence 4J - Licence Manager'' qui est installé sur un serveur distant.
+==== Étape 1 : Se connecter au Serveur de licence ====
+Pour accéder au serveur de licence, faire la demande à **l’équipe Infra** qui vous fournira sur ce point les informations nécessaires pour vous connecter par VNC au serveur de licence installé sur une distribution Linux disposant d’une interface graphique.
-=== Les étapes ===
+==== Étape 2 : Démarrage de l'application de gestion ====
-== 1. Se connecter ==
+Une fois connecté sur le serveur, merci de procéder comme suite :
-Pour accéder au serveur de licence, faire la demande à l’équipe  Infra qui vous fournira sur ce point les informations nécessaires pour vous connecter par VNC au serveur de licence installé sur une distribution Linux disposant d’une interface graphique.
+  - Se positionner via ligne de commande terminal, sur le répertoire ou se trouve le JAR de l'application licence **cd opt/licence4J-licence-manager**
+  - Executer la commande suivante pour lancer l’application **java -jar LICENSE4J-License-Manager.jar**
-Une fois connecté sur le serveur,
+==== Étape 3 : Créer un produit ====
-Se positionner sur le répertoire ou se trouve le fichier
+Le produit représente la solution sur laquelle une gestion des licences doit être effectuée. Pour ce faire, merci de procéder comme suite :
-cd opt/licence4J-licence-manager
+  - Cliquer sur **Database Storage**
-La commande java -jar LICENSE4J-License-Manager.jar permet de lancer l’application.
+  - Sélectionner le menu **product**
+  - Cliquer **Create new product**
-== 2. Créer un produit ==
+{{:creation_produit.png?400|}}
-Pour créer un produit, sélectionnez le menu product puis create new product.
-Le produit représente la solution sur laquelle une gestion des licences doit être effectuée.
+==== Étape 4 : Créer une nouvelle licence ====
+Pour créer une nouvelle licence, un produit doit être déjà créé et disponible sur l’application licence4J Licence Manager. Pour ce faire, merci de faire comme suite :
+  - **Se positionner** sur le produit pour lequel nous souhaitons créer une licence et faire un **clique droit**
+  - Choisir **Generate new licence**
-== 3. Créer une licence ==
+==== Étape 5 : Renseigner les informations sur le client ====
-Pour créer une nouvelle licence, un produit doit être déjà créé et disponible sur l’application licence4J Licence Manager.
+Une fois sur generate new licence, passer à l'étape suivante :
-Il faut d'abord se positionner sur le produit pour lequel nous souhaitons créer une licence, ouvrir le menu contextuel et choisir Generate new licence.
+  - Renseigner les champs du formulaire **user information** (les champs **full name** et **Registered to** sont obligatoirement).
+  - Cliquer sur **suivant**
-== 4. Renseigner le client ==
+{{:user_infiormation.png?400|}}
-une fois sur generate new licence, nous allons d’abord sur user information et remplir les champs full name et Registered to.
-== 5. Renseigner le type de licence ==
+==== Étape 6 : Renseigner les informations sur le type de licence à générer ====
-Se positionner  sur licence type et tags pour renseigner les informations sur le type de licence à générer qui est le licence text.
+  - Se positionner sur la section **license type**
+  - Cocher **License Text**
+  - Faire **suivant**
-== 6. Renseigner les attributs et la durée de la validité ==
+{{:type_licence.png?400|}}
-Apres avoir choisi licence test, nous allons renseigner les attributs et la durée de validité de la licence. Nous allons dans licence text features renseigner Les attributs et la durée de validité de la licence
+==== Étape 7 : Renseigner les attributs et la durée de la validité ====
+Renseigner les champs suivantes :
+  - Licence quality : **1** (Exemple)
+  - Valid product edition : **Professional**
+  - Valid product version : **3.4** (la version de l'application défini sur le produit)
+  - Licence validity period : **1000** (Exemple)
+  - Maintenance period : **1000** (Exemple)
+  - Faire suivant
-== 7. Renseigner les paramètres d'activation ==
+{{:validite_.png?400|}}
-Nous allons dans activation information pour ajouter des paramètres customisés à la Licence.
+==== Étape 8 : Renseigner les paramètres d'activation de la licence ====
-== 8. Ajouter un paramètre personnalisé ==
+  - Cocher **activation required**
+  - Activation period : 0 (Exemple)
+  - Allowed activation account : 1 (Exemple)
+  - Dans le liste déroulante Activation return, sélectionner **License Text**
+  - Cocher **Reject License Désactivation**
+  - Cocher **Set activated license text generation time to activation time**
+  - Cocher **Check Any**
+  - Cocher **Hostname**
+  - Cocher **Ethernet Adress**
+  - Cocher **System Disk volume UUID**
+  - Cocher **HDD Serial Number**
+  - Faire **suivant**
+{{:activation.png?400|}}
+==== Étape 9 : Ajouter des paramètres customisés à la Licence ====
 Nous pouvons ajouter des paramètres composés d’une clé et d’une valeur associée à la licence pour un comportement spécifique sur un produit.
-Les paramètres que nous avons dans Asterbox sont :
+Pour le cas de CYNOD, merci de trouver ci-dessous les paramètres concernés :
-nbTerm : Prends une valeur numérique représentant le nombre de terminaux actifs autorisés pour cette licence.
-mode : les valeurs possibles sont production et test . Décrit le type d’environnement dans lequel la licence sera installée,  UAT  ou en Production.
+  - **nbTerm** : Prends une valeur numérique représentant le nombre de terminaux actifs autorisés pour cette licence.
-authorizedTerminals : Ce paramètre permet de renseigner la liste des numéros IMEI des terminaux autorisés pour cette licence. Les numéros IMEI doivent être séparés par des virgules (,) et ne doivent pas contenir d’espaces vides.
+  - **mode** : les valeurs possibles sont **production** et **test** . Décrit le type d’environnement dans lequel la licence sera installée, UAT ou en Production.
-(Ex : 123456789012347,987654321098743,...).
+  - **authorizedTerminals** : Ce paramètre permet de renseigner la liste des numéros IMEI des terminaux autorisés pour cette licence.
+__**NB :**__ //Les numéros IMEI doivent être séparés par des virgules (,) et ne doivent pas contenir d’espaces vides. (Ex :123456789012347,987654321098743,...)//
+{{:customisation.png?400|}}
+==== Étape 10 : Validation et obtention la licence ====
+  - Pour valider la création de la licence, poursuivre les étapes de création en appuyant sur **Next** puis **valider** la licence après vérification de la conformité des informations avec le bouton Finish.
+{{:validation_parame_trage.png?400|}}
+  - Pour obtenir la licence générée, se positionner sur la licence générée => ouvrir le menu contextuel pour copier le texte de licence ou directement utiliser l’option Export pour obtenir la licence.
+{{:licence_ge_ne_re_e.png?400|}}
+==== Étape 11 : Obtention de la clé publique ====
+Les clés publiques des produits à partager et à renseigner sur les différentes instances des applications se trouvent sous le menu Product.
+Pour les consulter, il est nécessaire de se positionner sur le produit en question au préalable.
+{{:cle_publique.png?400|}}
+==== Étape 12 : Configuration context application ====
+Pour ce faire, merci de procéder comme suite :
+  - Creer une fichier text sous le format suivant **licence_nomClient.l4j**
+  - Mettre dans ce fichier la licence copier précédemment sur le serveur de licence
+  - Creer un ticket support sur le projet **IT Production** contenant les instructions ci-dessous pour une prise en charge :
+    * Placer le fichier **licence_nomClient.l4j** joint dans le ticket, au niveau du répertoire **/conf** du serveur tomcat.
+    * Rajouter les configurations suivantes sur le fichier context du client
+<file sql context>
+<Environment name="publicKey" value="Valeur de la clé publique précédemment copié" type="java.lang.String"  override="true"/>
+<Environment name="licenseTextPath" value= Le bon chemin du répertoire /conf + "/licence_nomClient.l4j" type="java.lang.String"  override="true"/>
+<Environment name="productID" value="Cynod" type="java.lang.String"  override="true"/>
+<Environment name="productEdition" value="Professional" type="java.lang.String"  override="true"/>
+<Environment name="productVersion" value="3.4" type="java.lang.String"  override="true"/>
+<Environment name="licenseActivationUrl" value="https://licence.sensoft-labs.com/autoactivate" type="java.lang.String"  override="true"/>
+<Environment name="licenseOnlineAvailabilityUrl" value="https://licence.sensoft-labs.com/checkavailability" type="java.lang.String"  override="true"/>
+</file>
-== 9. Valider la création de la licence ==
+__**NB :**__ //Merci de mettre le bon chemin menant vers le fichier licence au niveau de la variable **licenseTextPath** et coller la clé publique précédemment copié sur la variable **publicKey**//
-Et enfin nous allons valider la création de la licence. Pour ce faire, nous allons poursuivre les étapes de création en appuyant sur Next puis valider la licence après vérification de la conformité des informations avec le bouton Finish.
-== 10. Obtenir la licence générée ==
+===== Partie 2 : Mise à jour licence ou ajout nouveau TPE =====
- Et Obtenir la licence générée en se positionnant sur la licence générée, ouvrir le menu contextuel pour copier le texte de licence ou directement utiliser l’option Export pour obtenir la licence.
+Pour autoriser un TPE à opérer sur le réseau, il faudra mettre à jour la liste des terminaux autorisés **authorizedTerminals** mentionné à l'étape 9.
+Merci de procéder comme suite  :
+  - Se connecter au serveur de licence
+  - Faire un clique droit sur le produit de licence précédemment créé
+  - Cliquer **Modify** =>> **Full** (with license string change)
+  - Faire suivant jusqu'à l'étape 9 décrit précédemment
+  - Faire un clique droit sur **authorizedTerminals** et cliquer sur le bouton **edit**
+  - Rajouter le/les codes IMEI sur le champ tout en respectant la règle de nomenclature
+  - Faire **suivant** jusqu'a la fin et terminer les modifications
+  - Faire à nouveau un **clique droit** sur le produit et cliquer sur **view**
+  - Copier la nouvelle licence généré dans un nouveau fichier **licence_nomClient.l4j**
+  - Creer un **ticket IT** sur Redmine pour une mise à jour du fichier sur le serveur
+__**NB :**__ **Il est obligatoire de demander dans le ticket IT, le redémarrage de l'instance Cynod pour appliquer la mise à jour**
+Pour plus d’informations sur cet outil et ses fonctionnalités, merci de vous référer à la documentation officielle de licence4j : https://www.license4j.com/documents/license-manager-gui/.