Prérequis : environnement technique mis en place
2.1 Sources
2.1.1 Solution 1 : Installation rapide
La personnalisation de l'application n'est pas prévue pour cette installation (couleurs, logos, etc..). Les étapes spécifiques à cette solution seront notées SOLUTION 1 dans le reste du document.
- Récupérer le war de la dernière version de eCandidat V2 sur https://github.com/EsupPortail/esup-ecandidat/releases
2.1.2 Solution 2 : Installation personnalisée
La personnalisation de l'application est prévue pour cette installation (couleurs, logos, etc..). Les étapes spécifiques à cette solution seront notées SOLUTION 2 dans le reste du document.
- Récupérer le zip de la dernière version de eCandidat V2 sur https://github.com/EsupPortail/esup-ecandidat/releases
- Dézipper l'archive dans un dossier puis passer au paramétrage de l'application
2.2 Paramétrage des ressources JNDI
- Copier les éléments situés dans le fichier context_samle.xml dans la déclaration des variables JNDI de votre serveur Tomcat (par exemple server.xml). Suivant le choix de la solution dans la partie 2.1, le fichier context_samle.xml se trouve :
- SOLUTION 1 : dans META-INF/
- SOLUTION 2 : dans /src/main/webapp/META-INF/
- Renseigner chaque propriété ou laisser les vide si vous n'en avez pas l’utilité
Propriété | Définition |
---|---|
Resource name="jdbc/dbEcandidat" | Déclaration de votre base de données MySql de eCandidat |
Parameter name="siscol.implementation" | Implémentation du service SiScol à utiliser.
|
Resource name="jdbc/dbSiScol" | Déclaration de votre base de données Apogée (pour le requêtage direct sur la base) |
Parameter name="app.url" | Url de l'application |
Parameter name="cas.url" | Url de votre service d'authentification CAS |
Parameter name="assistance.documentation.url" Parameter name="assistance.documentation.url.candidat" Parameter name="assistance.documentation.url.candidat.en" Parameter name="assistance.helpdesk.url" Parameter name="assistance.contact.mail" | Informations d'assistance, respectivement :
|
Parameter name="ldap.base" Parameter name="ldap.url" Parameter name="ldap.branche.people" Parameter name="ldap.user" Parameter name="ldap.pwd" | Informations de connexion au ldap, respectivement :
|
Parameter name="ldap.champs.uid" Parameter name="ldap.champs.displayName" Parameter name="ldap.champs.mail" Parameter name="ldap.champs.sn" Parameter name="ldap.champs.cn" Parameter name="ldap.champs.supannCivilite" Parameter name="ldap.champs.supannEtuId" Parameter name="ldap.champs.givenName" | Champs utilisés dans le ldap, respectivement :
|
Parameter name="ldap.filtre.personnel" | Filtre ldap de recherche de personnel (pour les gestionnaires ou membres de commission) Exemple : (eduPersonAffiliation=employee) ou !(eduPersonAffiliation=student) Attention à bien placer les parenthèses comme dans les deux exemples ci-dessus. |
Parameter name="admin.technique" | Login de l'admin technique |
Parameter name="mail.smtpHost" Parameter name="mail.smtpPort" Parameter name="mail.from" Parameter name="mail.from.noreply" Parameter name="mail.to" | Paramètres pour l'envoi de mail, respectivement :
|
Parameter name="file.cmis.atompub.url" Parameter name="file.cmis.repository" Parameter name="file.cmis.user" Parameter name="file.cmis.pwd" Parameter name="file.cmis.candidat.id" Parameter name="file.cmis.gestionnaire.id" Parameter name="file.cmis.enableVersioning" (nouveau en 2.2.3) | Paramètres de dématérialisation (solution CMIS), respectivement :
Attention : si vous renseignez ces informations, vous ne DEVEZ pas renseigner les paramètres de dématérialisation (solution FileSystem) |
Parameter name="file.filesystem.candidat.path" Parameter name="file.filesystem.gestionnaire.path" | Paramètres de dématérialisation (solution FileSystem), respectivement :
Attention : si vous renseignez ces informations, vous ne DEVEZ pas renseigner les paramètres de dématérialisation (solution CMIS) Attention : lorsque vous déclarez un répertoire, il faut un slash à la fin du path. |
Parameter name="limesurvey.path" Parameter name="limesurvey.user" Parameter name="limesurvey.pass" | Paramètres pour accéder aux webservices LimeSurvey, respectivement :
|
Parameter name="batch.fixedRate" | Fréquence de vérification de la table des batchs de l'application (en ms) |
Parameter name="piwikAnalytics.trackerUrl" Parameter name="piwikAnalytics.siteId" | Paramètres de piwik, optionnel (https://fr.piwik.org/), respectivement :
|
Parameter name="demoMode" | Mode démo. Doit être à false |
Parameter name="productionMode" | Mode production. Doit être à true |
Parameter name="enablePush" | Activation du push. Doit être à true |
Parameter name="pushTransportMode" | Paramétrage optionnel qui permet de spécifier le mode de push. 3 valeur possible : websocket, websocket-xhr ou long-polling. Par défaut websocket. websocket : toutes les communications passent par une websocket websocket-xhr : Websockets dans le sens serveur-->client, XHR dans le sens client–>server long-polling : HTTP long polling |
Parameter name="sessionTimeOut" | Paramètre optionnel qui permet de régler le timeout de session en secondes (par défaut 2700 secondes = 45 minutes). Un timeout à -1 implique que la session n'expire jamais. |
Parameter name="logMode" | Paramétrage optionnel du niveau de log. Par défaut le niveau de log est à info 3 valeurs possibles :
|
Parameter name="mail.to.fonctionnel" | Paramétrage optionnel de l'adresse mail permettant de recevoir les messages d'erreur non technique. Pour l'instant uniquement utilisé pour recevoir les éventuels messages d'incohérences d'insertion d'OPI |
Parameter name="clamAV.ip" Parameter name="clamAV.port" | Paramétrage optionnel de l'antivirus ClamAV (https://www.clamav.net/) pour le scan des pièces dématérialisées :
|
Parameter name="enableDeleteFileManuallyBatchDestruct" | Paramétrage optionnel. Valeur à "true" ou "false". Par défaut à "false" Utilisé pour le batch de destruction de dossier. S'il y a trop de fichiers à supprimer lors de la destruction des dossiers, il peut être préférable de les supprimer à la main directement sur le serveur de fichier. Ce témoin active ou désactive la destruction des fichiers automatiquement : true = Les fichiers candidats doivent être supprimés à la main false = Les fichiers candidats sont supprimés automatiquement |
Parameter name="enableDeleteRootFolderManuallyBatchDestruct" | Paramétrage optionnel. Valeur à "true" ou "false". Par défaut à "false" Utilisé pour le batch de destruction de dossier. Indique si vous souhaitez supprimer le dossier root de la campagne en cours de suppression ({file.filesystem.candidat.path}/Code Campagne/) pour les fichiers candidats à la main. true =Le dossier racine de campagne doit être supprimé à la main false =Le dossier racine de campagne est supprimé automatiquement |
Parameter name="pdf.signature.keystore.path" Parameter name="pdf.signature.pass" | Paramètres optionnels permettant d'activer l'ajout de signature électronique dans les PDF générés par l'application. Si les 2 paramètres sont renseignés, l'application tentera d'ajouter la signature électronique. |
Parameter name="enableExportAutoSizeColumn" | Active/Desactive l'autosizing des colonnes pour les exports excel, par defaut true |
Paramètres complémentaires pour un environnement en Load Balancing
Attention : ne renseignez surtout pas ces informations si vous ne faites pas de load balancing
Attention, dans cette configuration vous devrez avoir :
- Une instance de l'application dédiée aux gestionnaires. Cette instance ne peut pas être en mode load balancing. Cette instance aura une url propre. Exemple : http://eCandidat-gest.univ.fr
- Différentes instances de l'application dédiées aux candidats en mode load balancing. Ces instances auront la même url. Exemple : http://eCandidat.univ.fr
- Lors de chaque nouvelle installation, il est impératif de lancer une première fois l'application "Gestionnaire" en premier
- Pour les établissement utilisant la dématérialisation en mode "File System", il est nécessaire d'utiliser un répertoire partagé entre toutes les instances de l'application
Propriété | Définition |
---|---|
Parameter name="load.balancing.gestionnaire.mode" | Renseigné à "true" si il s'agit de l'instance gestionnaire. Renseigné à "false" si il s'agit d'une instance candidat |
Parameter name="load.balancing.candidat.id.instance" | Identifiant de l'instance, par exemple "1", "2", "3", etc... Attention, toutes les instances devront avoir un id différent. Préconisation :
|
Parameter name="load.balancing.candidat.url" | Obligatoire pour l'instance gestionnaire. Non utilisé pour l'instances candidat et donc facultative. Il s'agit de l'url de l'application côté candidat. |
Parameter name="load.balancing.refresh.fixedRate" | Par défaut 600000 (soit 10 minutes). Permet de régler (en millisecondes) la fréquence de rafraîchissement des données en cache. Voir : 2. Limitations du mode load-balancing#2.Limitationsdumodeload-balancing-Rafraîchissementdesdonnéesencache Si vous modifiez ce paramètre faites attention à ne pas mettre une fréquence de rafraîchissement trop courte ou trop longue. |
Exemple :
Instance gestionnaire :
<Parameter name="load.balancing.gestionnaire.mode" value="true" />
<Parameter name="load.balancing.candidat.id.instance" value="1" />
<Parameter name="load.balancing.candidat.url" value="http://eCandidat.univ.fr" />
Instance candidat 1 :
<Parameter name="load.balancing.gestionnaire.mode" value="false" />
<Parameter name="load.balancing.candidat.id.instance" value="2" />
Instance candidat 2 :
<Parameter name="load.balancing.gestionnaire.mode" value="false" />
<Parameter name="load.balancing.candidat.id.instance" value="3" />
etc....
2.3 Paramétrage des webservices Apogée
L'application 2.3.0 est livrée avec la version 5.20.la des Web Services de l'Amue. L'application a été testée avec le patch APOGEE 5.20.00. Nous ne garantissons le fonctionnement de l'application qu'avec ces versions.
Copier le fichier configUrlServices.sample.properties et renommer le en configUrlServices.properties puis éditer le. Suivant le choix de la solution dans la partie 2.1, le fichier configUrlServices.sample.properties se trouve :
- SOLUTION 1 : dans /WEB-INF/classes/
- SOLUTION 2 : dans /src/main/resources/
Renseigner les url de vos webservices utilisés dans l'application :
# WebServices Dossier Etudiant etudiantMetier.urlService=https://wsapogee.univ.fr/services/amue_apo_update_etudiant etudiantMetier.urlService.ssl=https://wsapogee.univ.fr/services/amue_apo_update_etudiant pedagogiqueMetier.urlService=https://wsapogee.univ.fr/services/amue_apo_pedagogique pedagogiqueMetier.urlService.ssl=https://wsapogee.univ.fr/services/amue_apo_pedagogique # URL des Services Apogee-OPI opiMetier.urlService=https://wsapogee.univ.fr/services/amue_opi opiMetier.urlService.ssl=https://wsapogee.univ.fr/services/amue_opi # URL du Services Apogee-PJ pj.urlService=http://wsapogee.univ.fr/services/PJ # URL des Services Apogee-OPI pjOpiMetier.urlService=http://wsapogee.univ.fr/services/amue_apo_pjopi pjOpiMetier.urlService.ssl=https://wsapogee.univ.fr/services/amue_apo_pjopi # URL du service de vérification d'INES checkInes.urlService=http://wsines.univ.fr/services/checkine
Info
SI vous avez des erreurs au niveau des dates sur les WebServices, par exemple : "java.sql.SQLDataException: ORA-01843: not a valid month", il faut que vous lanciez vos WS en rajoutant dans le java_opts -Duser.language=fr -Duser.region=FR sur le lanceur tomcat (/etc/init.d) des ws
2.4 Base de données
La base de données (qui doit être préalablement créée vide) est automatiquement alimentée au démarrage de l'application