Guide d'installation et de mise à jour de l'API V5

Introduction

L'API V5 a été développée pour faciliter l'intégration entre le système ERP d'un client et V5 Traçabilité. Dans ce guide, nous expliquerons comment installer l'API V5, ainsi que comment effectuer une mise à jour.

1. Pré-requis :
   1. Java
   2. Apache Tomcast/Hébergement
2. Installation de l'API V5
3. Configuration de l'API
4. Mise à jour de l'API

S'il n'est pas déjà présent sur le système, Java Runtime Environment (version 8-15) doit être installé. Cela peut être 32 ou 64 bits. Si vous installez l'API sur un système sur lequel des applications de traçabilité V5 sont également installées, Java sera déjà installé et cette étape peut être ignorée.

OpenJDK (Java Development Kit) est également compatible pour une utilisation avec l'API V5.

La première chose que nous devons faire pour installer l'API V5 est d'installer Apache Tomcat. L'API V5 prend en charge l'utilisation d'Apache Tomcat jusqu'à la version 10, et SG Systems recommande d'installer la version 9 ou 10.

D'autres plates-formes d'hébergement, telles que glassfish, peuvent également être utilisées à la place d'Apache Tomcat, mais pour cet exemple, nous utiliserons Tomcat.

Dans cet exemple, nous installerons Tomcat 9.0.75, en effectuant une installation « normale » du logiciel. Nous pouvons définir un port HTTP à utiliser par Tomcat, qui sera par défaut le port 8080. Cela peut entraîner des problèmes de conflit avec Rapports SG qui utilise également le port 8080 par défaut, nous vous conseillons donc d'utiliser un port différent ici (8181 dans cet exemple) si SG Reports est installé sur le système.

Un nom de service, un nom d'utilisateur et un mot de passe d'administrateur Tomcat peuvent également être définis ici, ce qui peut être à votre propre discrétion. Pour notre installation de démonstration, nous procédons comme suit :

Lors de l'installation, il vous sera demandé de pointer le programme d'installation vers le dossier d'installation de JRE. Celui-ci devrait être rempli automatiquement, mais sinon, vous devrez désigner le bon dossier.

Une fois l'installation terminée, l'option « Exécuter Apache Tomcat » doit être sélectionnée.

Ce nouveau service Windows devrait être configuré pour démarrer avec Windows à l'avenir afin de garantir un fonctionnement constant de l'API. Cela peut être défini dans les paramètres des services Windows ou dans la fenêtre des propriétés de Tomcat, que vous pouvez trouver en effectuant une recherche Windows pour « configurer Tomcat ». Le type de démarrage peut ensuite être défini dans l'onglet 'Général' :

Il est également recommandé de définir les paramètres de fuseau horaire pour Tomcat dans cette même fenêtre de propriétés. Sous l'onglet "Java", nous devrons coller '-Duser.timezone=GMT' dans le panneau « Options Java », puis appliquez :

Il est également recommandé d'augmenter le pool de mémoire maximal de Tomcat à 1024 Mo afin de mieux gérer les demandes de données plus volumineuses :

Pour vérifier l'installation correcte de Tomcat, il est recommandé à ce stade de vérifier la connectivité dans un navigateur Web. Pour cette installation, nous nous connecterions à http://127.0.0.1:8181/ (l'hôte local et le numéro de port que nous avons choisi lors de l'installation), et verrait ceci :

Une fois que nous nous sommes assurés d’avoir tous les prérequis en place, nous pouvons passer à l’API elle-même. La dernière version de l'API V5 peut être téléchargée ici. Cela téléchargera « V5-API.war ».

Ce fichier doit ensuite être placé dans :

*InstallDir*\Apache Software Foundation\*nom du service choisi*\webapps

Donc pour notre exemple c'est :

C:\Program Files\Apache Software Foundation\Tomcat 9.0_Tomcat9-V5-API\webapps

Une fois placé ici, et avec le service Tomcat en cours d'exécution, un dossier 'V5-API' sera automatiquement créé à côté du fichier 'war'.

L'installation de l'API V5 est maintenant terminée. Il ne reste plus qu'à le connecter à la base de données V5.

Dans le dossier d'installation principal de Tomcat (donc »C:\Program Files\Apache Software Foundation\Tomcat 9.0_Tomcat9-V5-API' dans notre cas ici), nous devons créer un nouveau dossier appelé 'config'. Téléchargez ensuite le fichier 'db_settings.properties' suivant ici.

Ouvrez ce fichier avec le Bloc-notes et supprimez tout ensemble de données qui n'est pas pertinent pour le type de base de données SQL utilisé avec la traçabilité V5. Si vous n'êtes pas sûr de cette méthode, veuillez contacter Assistance SG.

Contactez votre administrateur de base de données pour compléter les champs nom d'utilisateur et mot de passe.

Ensuite, placez ce fichier terminé dans le dossier indiqué ci-dessus et redémarrez le service Tomcat. La connexion à la base de données va maintenant être établie !

Pour obtenir des conseils sur l'utilisation de l'API V5, veuillez consulter notre section API dédiée. ici.

La mise à jour de l'API V5 est aussi simple que de retélécharger à nouveau le fichier 'V5-API.war' en utilisant ce lien. Une fois téléchargé, supprimez l'ancien fichier .war, ainsi que le dossier qu'il a créé lors de l'installation initiale.

Ensuite, répétez simplement les étapes ci-dessus depuis l'installation, déposez à nouveau le fichier 'V5-API.war' dans ce dossier, laissez-le extraire à nouveau le dossier, puis redémarrez le service Tomcat.

Vous pouvez désormais continuer à utiliser l'API, mise à jour vers la dernière version !