Configuration du connecteur

Fichiers de configuration

Le comportement du connecteur peut être modifié en modifiant sa configuration dans des fichiers de configuration.

Windows

Liste des fichiers

Les fichiers de configuration du connecteur doivent être placés dans le répertoire C:\Program Files(x86)\Gustave\Connector\Configuration.

La configuration se répartit dans 2 fichiers :

connector.yml qui contient tout ce qui concerne le comportement du connecteur et son interaction avec les logiciels desquels il récupère les données ; c’est le plus souvent utilisé et c’est celui à utiliser quand ce n’est pas précisé
connector-jvm.bat qui permet de personnaliser la configuration de la JVM (machine virtuelle Java)

Créer un fichier

Ouvrir l’explorateur dans le répertoire de configuration.
Faire un clic droit, Nouveau, Fichier texte
Saisir le nom du fichier qu’on souhaite créer

Windows ajoute automatiquement l’extension .txt au fichier. Lorsque que l’explorateur Windows est configuré pour ne pas afficher les extensions des fichiers, cela n’apparaît pas. Il est alors nécessaire d’afficher temporairement les extensions des fichiers, de renommer le fichier en enlevant .txt et de cacher à nouveau les extensions des fichiers.

macOS

Les fichiers de configuration doivent être placés dans le répertoire ${HOME}/Library/Application Support/gustave-connector/conf.

${HOME} est le répertoire de l’utilisateur dans lequel se trouvent tous ses fichiers (souvent /Users/nom).

La configuration se répartit en 2 fichiers :

connector.yml (utilisé le plus souvent) qui contient tout ce qui concerne le comportement du connecteur et son interaction avec les logiciels desquels il récupère les données
connector-jvm.sh qui permet de personnaliser la configuration de la JVM (machine virtuelle Java)

Prise en compte de la configuration

La configuration du connecteur n’est prise en compte qu’au démarrage de l’application. Il est ainsi nécessaire de redémarrer l’application pour prendre en compte la nouvelle configuration.

Windows

Le script stop.bat se trouvant dans le répertoire d’installation du connecteur permet d’arrêter l’instance actuellement en exécution. Il suffit de double cliquer dessus pour la lancer et d’attendre que la fenêtre de terminal se ferme.

Il faut ensuite lancer le script start.bat pour démarrer à nouveau le connecteur avec la nouvelle configuration.

macOS

L’exécution du connecteur est gérée par launchd sous macOS. Il faut donc demander à launchd de relancer le connecteur et la commande suivante permet de le faire :

launchctl stop app.gustave.connector.daemon

Il n’est pas nécessaire de le relancer avec la commande start dans la mesure où launchd est configuré pour faire tourner systématiquement le connecteur.

Configuration du connecteur

Serveur web

L’interface graphique du connecteur est une application web. Elle est servie par un serveur HTTP embarqué dans le connecteur qui tourne par défaut sur le port 8888 et qui est ainsi accessible sur http://localhost:8888/.

Dans le cas où le port 8888 est déjà utilisé sur la machine, il est nécessaire de choisir un autre port. Pour cela, il faut modifier la configuration dans le fichier connector.yml.

La configuration à mettre est la suivante :

server:
  port: 9999

Cela fera démarrer le serveur sur le port 9999 et rendra ainsi accessible l’interface d’administration du connecteur sur http://localhost:9999/.

Synchronisation

Par défaut, la synchronisation se fait tous les jours sauf le dimanche à et quart et moins le quart toutes les heures comprises entre 6 et 0 (de 6h15 à 0h45).

A partir de la version 1.9.0, il est possible de changer cette configuration comme ceci (l’exemple montre la valeur par défaut) :

synchronization:
  schedule: 0 15,45 0,6-23 * * MON-SAT

La configuration utilise la syntaxe cron. Cet outil permet de déchiffrer et valider cette syntaxe.

La granularité de cet outil est la minute, alors que le connecteur travaille en secondes. Il est donc nécessaire d’ajouter 0 devant ce qui est inséré dans l’outil (cela signifie à la seconde 0).

Logiciels

Toute la configuration relative aux logiciels de synchronisation est à mettre dans le fichier connector.yml, que ce soit sous Windows ou macOS.

Vega

Les propriétés de configuration disponibles pour le connecteur Vega sont les suivants (présentées ici avec leur valeur par défaut) :

vega:
  database-directory: C:\Vega5\Fichiers
  clear-working-directory-after-synchronization: true

database-directory permet de modifier le répertoire dans lequel se trouve la base de données de Vega. Elle se trouve généralement dans le répertoire d’installation de Vega, ce qui correspond à la valeur par défaut.

clear-working-directory-after-synchronization permet de ne pas supprimer le répertoire de travail temporaire à la fin de la synchronisation pour aller voir l’état de certains fichiers par exemple. Il faut dans ce cas mettre la valeur false.

Lorsqu’on désactive le nettoyage automatique du répertoire de travail, il faut penser à aller le supprimer soi-même.

Il est important de réactiver cette option après l’investigation, au risque d’encrasser inutilement le disque dur de la machine. Les répertoires temporaires ne sont pas automatiquement nettoyés sous Windows.

Quand Vega utilise la Vegabox, la base de données se trouve dans un disque réseau comme par exemple : \\VEGABOX-189405\vegabox$\vega5\Fichiers.

Kiné+4000

Les propriétés disponibles pour configurer le connecteur Kiné+4000 sont présentées ici avec leurs valeurs par défaut :

kine4000:
  clear-working-directory-after-synchronization: true
  install-directory: C:\X4

Lorsqu’on désactive le nettoyage automatique du répertoire de travail, il faut penser à aller le supprimer soi-même.

install-directory permet de configurer l’emplacement du répertoire où est installé Kiné+4000.

Par défaut, les données sont cherchées dans ${kine4000.install-directory}/donnee (en mode mono-poste) et dans ${kine4000.install-directory}/donnee/BDD/Base_X4 (en mode multi-poste). Parfois, l’arborescence habituelle du répertoire d’installation n’est pas respectée. Dans ce cas, il faut modifier une de ces deux valeurs (présentes ici avec leurs valeurs par défaut) en fonction du mode d’installation :

kine4000:
  database-directory: ${kine4000.install-directory}${file.separator}donnee
  multi-station-database-directory: ${kine4000.install-directory}${file.separator}donnee${file.separator}BDD${file.separator}Base_X4

Kinémax

Les propriétés disponibles pour le connecteur Kinémax sont les suivantes (présentées avec leurs valeurs par défaut) :

kinemax:
  database:
    host: localhost
    port: 9154
    name: CABINET

Elle permettent de modifier le nom d’hôte (host), le port (port) de la base de données, ainsi que le nom de la base (name).

Répertoire de travail

Par défaut, lorsqu’il a besoin d’un répertoire temporaire pour travailler (extraction des données de VEGA et Kiné+4000), le connecteur crée un répertoire temporaire à l’endroit prédestiné à cela sur le système sur lequel il tourne (/tmp sur les systèmes UNIX et Temp dans le répertoire de l’utilisateur sous Windows). Mais il est parfois nécessaire d’utiliser une autre partition ou un autre lecteur pour des raisons d’espace disque insuffisant. Dans ce cas, il est possible de choisir le répertoire à utiliser.

working-directory:
    base-working-directory: /tmp/my-custom-working-directory

Configuration de la JVM

Windows

La configuration de la JVM sous Windows doit être insérée dans le fichier connector-jvm.bat.

Ce fichier .bat est un fichier exécutable qui définit des variables lisibles par le mécanisme de démarrage du connecteur.

Configuration de la mémoire utilisable

set MAX_MEMORY=1G

Cette option permet d’indiquer à la JVM qu’elle ne peut pas utiliser plus de 1 Go de mémoire vive.

On peut écrire 2G pour 2 Go mais aussi 512M pour 512 Mo.

Configuration de n’importe quel autre paramètre de démarrage

La variable EXTRA_ARGS permet de configurer n’importe quel autre paramètre de démarrage.

L’exemple suivant permet de modifier la taille maximale de la stack trace :

set EXTRA_ARGS="-Xms=256M"

macOS

La configuration de la JVM sous macOS doit être insérée dans le fichier connector-jvm.sh.

Ce fichier .sh est un fichier exécutable qui définit des variables lisibles par le mécanisme de démarrage du connecteur.

Configuration de la mémoire utilisable

MAX_MEMORY=1G

Cette option permet d’indiquer à la JVM qu’elle ne peut pas utiliser plus de 1 Go de mémoire vive.

On peut écrire 2G pour 2 Go mais aussi 512M pour 512 Mo.

Configuration de n’importe quel autre paramètre de démarrage

La variable EXTRA_ARGS permet de configurer n’importe quel autre paramètre de démarrage.

L’exemple suivant permet de modifier la taille maximale de la stack trace :

EXTRA_ARGS="-Xms=256M"