Avant de déployer eP-Core, il est nécessaire de le configurer. Modifiez le fichier eP-Core/epCore.properties comme indiqué ci-dessous puis exécutez updateJar-Core.bat (ou updateJar-Core.sh sous Linux) qui va mettre à jour le fichier epCore.properties qui se trouve dans la librairie eP-Core-<version>.jar

Cette configuration sera commune à tous les modules utilisant eP-Core installé sur le serveur Geronimo. Les propriétés à redéfinir sont:

UNDEF_DIR_NAME    =  _UNCLASS_ 
PIMS_ROOT         =  /local/path/to/pims_root/ 
PIMS_REPOSITORY_1 =  a   
PIMS_REPOSITORY_2 =  b   
PIMS_REPOSITORY_3 =  c   
PIMS_SHARE        =  b/share   
PIMS_ARCHIVE      =  transfert/archive   
PIMS_SYSTEM       =  adm
PIMS_ARCHIVE_FILE =  path/relative/to/pims_system/studyArchived.txt
PIMS_DROP_ZONE    =  path/to/dropzone

Nom des répertoires, sur l'espace disque de stockage dédié à ePims, qui contient les projets/études n’appartenant pas à un programme/projet (= les projets orphelins et études orphelines).

Le repository d'ePims, autrement dit le répertoire racine de l'espace de stockage où toutes les données de ePims sont stockées.

Répertoires, relatifs à PIMS_ROOT, dans lesquels les données relatives aux études sont stockées.

Répertoire, relatifs à PIMS_ROOT, contenant les données dites partagées, n’appartenant pas spécifiquement à une étude. On retrouve ici, par exemple, les acquisitions de contrôles réalisées sur les instruments.

Répertoire, relatif à PIMS_ROOT, dans lequel sont transférés les données qui sont à archiver (à copier sur bandes)

Répertoire, relatif à PIMS_ROOT, dans lequel les données “administratives” et systèmes sont sauvegardées (logs files…)

Fichiers copiés dans les répertoires des études lorsque celles-ci sont archivées afin d’en avertir l’utilisateur. Ce fichier est donné avec le projet. Il doit contenir un tag « #DATE#. » qui sera remplacé par la date effective à laquelle l’étude à été archivée. Le chemin spécifié est relatif au répertoire PIMS_SYSTEM.

Répertoire, relatif à PIMS_ROOT, utilisé pour le transfert de fichiers vers le système ePims

1. Dans le cas où geronimo est exécuté comme un service, les chemins absolus spécifiés dans ePCore.properties ne doivent pas référencer une disque logique réseau ! Soit ils référencent un disque local c:\path\to… soit ils référencent une connexion réseau sous la forme d'une UNC \\serveur\path\to….
2. Les chemins absolus doivent être écrits soit avec des “/” soit les “\” doivent être doublés ! Exemple :

      PIMS_ROOT=C:/temp/root
      PIMS_ROOT=\\\\serveur\\path\\to\\pims\\root

Une fois la librairie mise à jour (via updateJar-Core.bat ou updateJar-Core.sh, cf ci-dessus), il est nécessaire de la déployer au niveau dans le serveur Geronimo. Ceci afin d'être partagée par les autres modules.
Pour cela, depuis la console d'administration de Geronimo, sélectionner la rubrique “Services/Common Libs”, dans File télécharger le fichier eP-Core-<version>.jar puis spécifier les caractéristiques suivantes : group = lib, Artifact = eP-Core, version =<version> et type=jar.

<version> est de la forme “3.4.0”

Remarque : Si eP-Core.jar doit être redéployé (si erreur lors de la configuration ou autres) il ne sert à rien de repasser par la console Geronimo. Car celui-ci ne remplacera pas le fichier si la version est la même. Il faut donc :

1. arrêter le serveur
2. se rendre dans le dossier de la librairie : [GERONIMO_HOME]/repository/lib/eP-Core/<version>
3. remplacer l'ancien fichier eP-Core.jar par le nouveau
4. redémarrer le serveur

La nouvelle configuration devrait être prise en compte.

Différents modules d'ePims sont déployés à partir de de l'application d'entreprise (EAR) eP-EAR.ear. Ces modules sont eP-Web, eP-WebServices et eP-Admin. Ces modules (ou certains d'entre-eux) dépendent de ressources fournies par le serveur d'application qu'est Geronimo.

Ce chapitre, décrit la configuration / création des ressources nécessaire au niveau de Geronimo et la configuration des modules ePims.

Avant de déployer l'application, il est nécessaire de modifier certains fichiers de configuration et de créer une connexion à la base de données depuis le serveur Geronimo.

Modifier le fichier resources_deployment_plans/deploy_ds.xml afin de spécifier les valeurs suivantes (remplacer [key] par la valeur)

• DB Password : … name=“Password”>[db_pwd]</config-property-setting>
  
• DB User Name: … name=“UserName”>[db_login]</config-property-setting>
  
• Nom du serveur et de la base de données : … name=“ConnectionURL”>jdbc:postgresql:jdbc:postgresql:[database_host]/[database_name]</config-property-setting>
  

Remarque : Si lors de l'étape de la configuration du serveur Geronimo (apache_geronimo_2.0) la version de la librairie postgresql n'était pas identique, il faut également modifier la partie dépendance pour postgresql dans ce fichier (deploy_ds.xml)

Il existe un certain nombre de fichiers de configuration à modifier sous eP-EAR/eP-Web en fonction de son environnement et des identifiants utilisés lors de la configuration de Geronimo. La configuration se fait en plusieurs étapes

• Modification du fichier eP-EAR/eP-Web/jnlp/epplate.jnlp : Configuration de l'application de gestion des plaques robot. Il faut spécifier l'adresse du serveur de geronimo où sera installé ePims. Modifier dans le fichier la ligne [Server_address] et la remplacer par l'adresse du serveur d'installation de geronimo. /!\ Ne pas oublier le port, voir l'installation du serveur geronimo pour le connaitre (exemple : http://edyp-epims:8008) :

<?xml version="1.0" encoding="utf-8"?>
<!-- JNLP File eP-Plate Application -->
<jnlp  spec="1.0+"  codebase="$$codebase">
  <information>
    ...
  </information>
  <security>
    ...
  </security>
  <resources>
    ...                             
  </resources>  
  <application-desc main-class="cea.edyp.plate.ui.PlateApp">
  	<argument>[Server_address]</argument>
  </application-desc>
</jnlp> 

• Fichier eP-EAR/eP-Web/WEB-INF/classes/eP-Web.properties : Configuration des propriétés spécifique à eP-Web
  • Pour le serveur FTP: si le serveur FTP choisi permet l'authentification via la BD de ePims, seules les propriétés 1 et 2 sont nécessaires, FTP_AUTH_DB devant être mis à true. Dans le cas contraire, il faut mettre FTP_AUTH_DB à false et spécifier un login / password valide pour l'utilisateur servant à la connection FTP (propriété 3 et 4)

      FTP_HOST= ftpServ      1.
      FTP_AUTH_DB= true      2.
      FTP_USER= username     3.
      FTP_PASSWD= password   4.

1. le host du serveur FTP
2. spécifie si le serveur FTP utilise une authentification classique (false) ou via la BD (true)
3. le mot de passe pour l’authentification auprès du serveur FTP, si FTP_AUTH_DB = false
4. le login utilisé pour l’authentification auprès du serveur FTP, si FTP_AUTH_DB = false

• Autres proriétés

webmaster_mail= adresse mail      1.

1. l'adresse mail du web master devant être contacter en cas de problème

Modifier les fichiers install_ePims ou redeploy_ePims ( *.bat pour Windows ou *.sh pour Linux) sous eP-EAR/.

Renseigner les informations de connexion au serveur Geronimo en indiquant respectivement le chemin vers le répertoire d'installation de Geronimo, le login et le password de connexion (en tant qu'administrateur) pour les variables GERONIMO_HOME_DIR, GERONIMO_LOGIN et GERONIMO_PASSWORD.

Pour cette étape il faut que votre serveur Geronimo soit démarré.

Pour une 1ere installation
Exécuter le script eP-EAR/install_ePims.bat sous Windows ou eP-EAR/install_ePims.sh sous Linux.
Le script d'installation, à partir des configurations préalablement réalisées par l'utilisateur,

• Configure les ressources (DataBase / JMS / Realm) nécessaires
  
• Met à jour eP-Web, lui même mis à jour avec les propriétés utilisateurs, dans l'application eP-EAR
• Met à jour eP-Admin, lui même mis à jour avec les propriétés utilisateurs, dans l'application eP-EAR
• Déploie l'application d'entreprise eP-EAR

Pour une mise à jour
Exécuter le script eP-EAR/redeploy_ePims.bat sous Windows ou eP-EAR/redeploy_ePims.sh sous Linux.
Le script de mise à jour fait la même chose que le script d'installation sauf concernant les ressources puisque celles-ci sont déjà configurées dans Geronimo.
Seules les nouvelles ressources ou celles nécessitant d'être modifiées sont mise à jour.

En cas d'erreur lors du déploiement
Il se peut qu'il y ait une ou des erreurs lors du déploiement de l'application (problème de version postgresql, de mot de passe, de configuration des applications, etc…). Dans ce cas la commande de déploiement de Geronimo peut avoir laisser des traces qui vont générer des erreurs dans les tentatives d'installation/mise à jour suivantes. Vérifier que les dossiers suivants, si ils existent, ne sont pas vide :

• [GERONIMO_HOME]\repository\console\dbpool\epims_ds\1.0\epims_ds-1.0.rar
• [GERONIMO_HOME]\repository\console\jms\epims_jms\1.0\epims_jms-1.0.rar
• [GERONIMO_HOME]\repository\default\ePims\1.0\ePims-1.0.car

Si l'un de ces dossiers existe ET est vide il faut le supprimer. C'est un artéfact de la tentative d'installation précédente.

Dans “Applications/Applications EARs” vérifier que l'application default/ePims/1.0/car soit listée et en statut “running”. Saisir l'adresse http://localhost:8080/ePims. En cas de problème lors du login, vérifier qu'il existe au moins un actor/actor_role dans la BD Pims. Normalement, deux utilisateurs sont créés par défaut: admin/admin et guest/guest

Dézipper la distribution de eP-Back. Un répertoire eP-Back-<version> est créé et contient l'arborescence suivante :

conf
  |-- instruments.xml : fichier de configurations pour les instruments
  |-- eP-Back.properties : fichier de configuration nécessaire à eP-Back
lib
  | -- librairies utilisés par l'application
eP-Back-<version>.jar : executable
eP-Back.bat : script de démarrage de eP-Back
VERSION: fichier d'informations

• Fichier ./conf/eP-Back.properties : Configurer de l'environnement pour eP-Back

  webservices.url=http://[epims-webservices_host]//
  epims.root=[PIMS_ROOT]

webservices.url : host et port du serveur ePims

epims.root: path complet au Pims root où eP-Back transfert les données.

• Fichier ./conf/instruments.xml : Configuration des instruments. Seuls les instruments connus d'ePims (et donc référencés dans la base de données ePims) pourront être reconnus par eP-Back. Le fichier de configuration pour les instruments est de la forme :

<instruments>
  <instrument>
    <label>CB501</label>
    <name>CB501</name>
    <src>d:/temp</src>
    <format>QTOF Waters</format>
    <removeFiles>false</removeFiles>
    <transfer_mode>0</transfer_mode>
  </instrument>
  <instrument>
    ...
  </instrument>
</instruments>

Les informations contenues dans ce fichier sont:

• label : Le nom de la configuration
• name : Le nom de l'instrument(comme indiqué dans la BD de ePims),
• src : le chemin d'accès aux répertoires contenant les analyses issues de cet instrument
• format : le nom du format de données (identifiant eP-Back)
• removeFiles : spécifie si les analyses doivent être supprimées ou non après copies
• transfer_mode: spécifie le mode de transfert souhaité par défaut. Les modes de transfert possibles sont ‘0’ pour la copie depuis les instruments vers le SAN et ‘1’ pour la suppression sur les instruments des analyses déjà sauvegardées. Ces deux dernières propriétés peuvent être modifiées au niveau de l'interface utilisateur d'eP-Back.

Il est possible de définir plusieurs configurations pour un même instruments, dans le cas, par exemple, ou les analyses sont générées dans plusieurs répertoires sources …

Pour ce qui est des données supportées, vous trouverez

• La liste et les spécificités des formats supportés : supportedFormats.
• La description du RawData nécessaire pour eP-Back

Dézipper la distribution de eP-TAF. Un répertoire eP-TAF-<version> est créé et contient l'arborescence suivante :

conf
  | -- wrapper.conf : fichier de configurations pour installer eP-TAF comme service Windows NT
  | -- configuration.xml : Configuration de la gestion des acquisitions
  | -- eptaf.properties : configuration de l'environnement d'eP-TAF
  | -- spring-eptaf.xml : fichier spécifique à l'application. //**Aucune modification ne doit être faire ici**//
lib
  | -- librairies utilisés par l'application
logs
  | -- fichier de log lors de l'exécution 
eP-TAF-<version>.jar : application eP-TAF
wrapper.exe : permet d'installer eP-TAF comme  service Windows. A utiliser uniquement via les bat ci dessous
InstallApp-NT.bat : script d'installation d'eP-TAF comme service Windows.
UninstallApp-NT.bat : script de désinstallation d'eP-TAF comme service Windows.
run.bat : script d'exécution d'eP-TAF dans une console DOS

Pour utiliser eP-TAF comme application standard, il suffit d'exécuter le script run.bat, une fois que les configurations nécessaire on été réalisées (cf le chapitre suivant)

Pour arrêter eP-TAF, taper CTRL-C…

Une fois que les configurations nécessaire on été réalisées (cf le chapitre suivant), exécuter le script InstallApp-NT.bat. Puis, aller dans le panneau de configuration / Outils Administrateur / Services.

Démarrer le service ayant le nom ePims Automatic File Transfer Service apparait dans la liste. Vous pouvez arreter et démarrer le service à tout moment par ce biais.

Pour supprimer le service, exécuter le script UninstallApp-NT.bat après avoir arrété le service

  jms.url_provider=tcp://localhost:61616
  ftp.host=[host]
  ftp.login=[login]
  ftp.password=[password]

jms.url_provider : host du serveur ePims (configuré comme serveur JMS)

ftp.host: host du serveur FTP. Celui-ci peut être le même que celui configuré pour eP-Web.

ftp.login/ftp.password : authentification pour la connexion au serveur FTP. Cet utilisateur peut être un utilisateur spécifique ou un utilisateur enregistré dans la BD de ePims si le serveur FTP est configuré pour utiliser la BD pour l'authentification

1. Répertoire destination par défaut. REP_DEF désigne le répertoire où seront copiées les acquisitions si aucun répertoire spécifique n'est défini (voir ci dessous)

   <bean id="defaultDestination" class="cea.edyp.eptaf.Destination">
     <property name="path"><value>[REP_DEF]</value></property>
   </bean>

2. Le MessageFilter permet de ne considérer que les acquisitions qui nous intéressent. Un ensemble de clé/valeur peut être utilisé pour filtrer les acquisitions. Dans l'exemple si dessous, seuls les acquisitions ayant été réalisées sur un instrument dont le nom commence par ORBI seront traitées. L'ensemble des propriétés pouvant être testées est donné en fin de document

   <bean id="messageFilter" class="cea.edyp.eptaf.MessageFilter">
     <property name="properties">
       <map>
	  <entry>
	   <key><value>acquisitionFileDescriptor.acquisition.instrument.name</value></key>
	   <value>^ORBI</value>
	  </entry>
        </map>
     </property>
  </bean>

3. Le dispatcher permet de spécifier où copier les acquisitions qui répondent à certains critères. Les acquisitions considérées ici devront, bien évidement, passer le filtre spécifié au niveau du MessageFilter. Les propriétés spécifiques aux acquisitions sont les mêmes que celles pouvant être utilisées dans le MessageFilter.

  <bean id="dispatcher" class="cea.edyp.eptaf.FilterDispatcher">
    <property name="properties">
      <map>
	 <entry>
	   <key><value>sampleDescriptor.studyDescriptor.program</value></key>
	   <value>AMT</value>
	 </entry>
      </map>
    </property>
    <property name="destinationPath"><value>d:/VDTEST/AMT</value></property>   
  </bean>

Dans la partie map, les clés/valeurs spécifiées permettent de sélectionner les acquisitions (en fonction de leurs propriétés) pour lesquelles le répertoire destination ne sera pas celui par défaut.

Le destinationPath désigne le répertoire où copier les acquisitions.

Il est également possible d'ajouter une propriété folderName permettant de définir un sous répertoire (relatif à destinationPath) qui aura pour valeur (dans l'exemple) le nom de l'étude d'appartenance de l'acquisition. Toute propriété de l'acquisition peut êter utilisée comme nom du sous-répertoire. POur pouvoir utiliser cette fionctionnalité, il faut spécifier “cea.edyp.eptaf.DynamicDispatcher” comme class du dispatcher (et non pas “cea.edyp.eptaf.FilterDispatcher” référençant les dispatcher classique).

  ...
  <property name="destinationPath"><value>d:/VDTEST/AMT</value></property>  
  <property name="folderName"><value>sampleDescriptor.studyDescriptor.nomenclature</value></property>  

• Fichier wrapper.conf. Seul le chemin vers l'exécutable java est à configurer :

wrapper.java.command=C:\Program Files\Java\jdk1.5.0_11\bin\java

Propriétés du message

Un schéma du contenu d'un message est donné ci-dessous. Pour spécifier une propriété il faut donner son chemin depuis l'objet !AcquisitionMessage. Ainsi pour tester le projet de rattachement de l'acquisition il faut spécifier sampleDescriptor.studyDescriptor.project

Nota : la nature de l'acquisition (AcquisitionDescriptor ⇒ Nature dans le schéma ci-dessus) peut avoir les valeurs suivantes :

• BLANK
• CONTROL_LC
• CONTROL_INSTRUMENT
• RESEARCH