Pages enfant
  • 2. Installation initiale

Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

2.1.2 Solution 2 : Installation personnalisée

...

  • Récupérer le zip 'distribution' de la dernière version de DossierWeb-V3 sur https://sourcesupgithub.renater.frcom/projectsEsupPortail/esup-dossieretumdw/ (onglet Fichiers)releases
  • Dézipper l'archive dans un dossier puis passer au paramétrage de l'application

2.2 Paramétrage

  • Copier les éléments situés dans le fichier ou renommer le fichier context.sample.xml dans la déclaration des variables JNDI de votre serveur Tomcat (par exemple server.xml). .xml en context.xml. Y renseigner les paramètres ci-dessous et placer le fichier context.xml dans le répertoire /conf de Tomcat.
    • Suivant le choix de la solution dans la
    partie 2
    • partie 2.1, le
    fichier 
    • fichier context.sample.xml se trouve :
      • État
        colourBlue
        titleSolution 1
         : dans META-INF/ (peut également être placé dans le répertoire 'conf' de tomcat)
      • État
        colourBlue
        titleSolution 2
         : dans /src/main/webapp/META-INF/
PropriétéDéfinition
jdbc/dbMdwDéclaration de votre base de données MySql de monDossierWeb
jdbc/dbApogee

Déclaration de votre base de données Apogée (pour le requêtage direct sur la base)

  • Attention Le user doit avoir accès à la fonction APOGEE.PKB_CRD.CREDIT_ACQUIS_ELP pour permettre la récupération des crédits acquis, hors WebServices Apogée.

clefApogeeDecryptBlob

Clé Apogée pour décrypter les Blob de la base Apogée (ex : signature certificat de scolarité)

Pour information, cette clé est visible dans le package PKB_CRY2

app.urlUrl de l'application
startServletMobiletrue pour démarrer la servlet mobile, false ne proposer que la vue desktop
cas.urlUrl de votre service d'authentification CAS. Ex : https://auth.univ-ville.fr (l'application ajoute automatiquement /login)

ldap.url

ldap.userDn

ldap.password

ldap.uid.attribute

ldap.ou.people

ldap.ou.student

Informations de connexion au ldap, respectivement :

  • url du ldap, son port et son baseDn. Ex : ldaps://ldap.univ-ville.fr:636/dc=univ,dc=fr (l'application ajoute automatiquement ou=people lors de l’exécution des filtres)
    • possibilité d'indiquer plusieurs urls séparées par des points-virgules
  • user du ldap
  • mot de passe du user
  • attribut référençant l'identifiant/login du compte ("uid" par défaut)
  • organizational unit contenant les personnels
  • organizational unit contenant les étudiants

uportal.ws

uportal.groupes.autorises

Configuration de l'authentification des enseignants via les groupes uPortal de l'ENT

  • url des Web Services uPortal
  • liste des groupes autorisés (séparés par un point virgule) à accéder à MDW en tant qu'enseignant

loginApogee

checkTesUtilisateurApogee

profilUtilisateurApogee 

Configuration de l'authentification des enseignants via la table UTILISATEUR d'Apogée

  • Mettre loginApogee à false pour ne pas utiliser cette fonctionnalité
  • Mettre checkTesUtilisateurApogee à true pour vérification du temoin en service si loginApogee = true
  • Profil attribué aux utilisateurs Apogée : ENS (enseignant) ou GEST (gestionnaire) 

attributGroupeLdap

listeGroupesLdap

listeGroupesLdapAdmin

Configuration de l'authentification des enseignants via des groupes LDAP

  • le nom de l'attribut contenant les groupes ldap
  • La liste des groupes ldap autorisant l’accès à mondossierWeb en tant qu'enseignant séparés par un point virgule.
  • La liste des groupes ldap autorisant l'acces à mondossierWeb en tant qu'admin séparés par un point virgule. Laisser vide pour ne pas utiliser.

attributLdapEtudiant

typeEtudiantLdap

attributLdapCodEtu

Configuration de l'authentification des étudiants

  • La propriété ldap du contact désignant son type
  • Le type ldap désignant un étudiant (Possibilité d'indiquer plusieurs valeurs séparées par des point-virgules)
  • La propriété ldap du contact désignant son codetu
sourceResultats

Source des résultats lors de l'appel aux Web Services Apogée pour récupérer les notes et résultats

  • Apogee ou Apogee-extraction
productionModeMode production. Doit être à true

enablePush

webSocketPush

showLoadingIndicator

Configuration du Push :

  • Activation du push. Doit être à true pour utiliser "showLoadingIndicator"
  • true pour activer les webScocket quand utilisation du push sinon utilisation du long-polling
  • true si on doit afficher l'indicateur de loading entre certains écrans. Push obligatoire
EnablePdfSecurityActiver la sécurité sur les pdf générés par l'application (pdf encryption)

mail.smtpHost

mail.from

mail.to

mail.startDisabling

mail.stopDisabling

liste.erreur.a.ignorer

Paramètres pour l'envoi des mails d'erreur, respectivement :

  • host smtp
  • champs from du mail
  • champs to du mail
  • début de la période de désactivation des mails d'erreur
  • fin de la période de désactivation des mails d'erreur
  • liste des erreurs à ignorer séparées par un point-virgule

param.elasticsearch.url

param.elasticsearch.port

param.elasticsearch.cluster

param.elasticsearch.index

param.elasticsearch.index.champrecherche

param.elasticsearch.index.champcodeobjet

param.elasticsearch.index.champversionobjet

param.elasticsearch.index.champlibelleobjet

Configuration de la connexion a ElasticSearch

  • l'url du serveur
  • le port d'écoute
  • le nom du cluster
  • le nom de l'index contenant les objets provenant d'apogée
  • le nom de l'attribut du document sur lequel on effectue la recherche lors de la recherche rapide. Peut être un champ enrichi. Ex : [CODE] LIBELLE
  • le nom de l'attribut du document contenant le code de l'objet Apogée
  • le nom de l'attribut du document contenant la version de l'objet Apogée
  • le nom de l'attribut du document contenant le libellé de l'objet Apogée
Avertissement
Par convention, le type des objets doit être dans l'attribut ElasticSearch nommé "_type". Valeurs possible : CMP, VET, ETU, ELP
Info

L'implémentation d'ElasticSearch au sein de monDossierWeb dépend de la version installée. Pour changer le version utilisée et passer en v1, il faut partir du package source et modifier le pom.xml (voir doc Personnalisation)

param.apogee.mail.annuaire

emailConverter.implementation

Configuration de la récupération du mail de l'étudiant

  •  true pour que l'email de l'étudiant (état-civil) soit récupéré par le WS dans l'annuaire, false pour que ce soit une implémentation différente qui s'en charge.

  • nom de l'interface java pour la récupération du mail si param.apogee.mail.annuaire=false.

codetuFromLogin.implementation

loginFromCodetu.implementation

 

Configuration de la récupération des identifiants Apogée d'un étudiant

  • Interface pour la récupération du cod_etu à partir du login
  • Interface pour la récupération du login à partir du codetu
etatcivil.nom.affichage

Affichage du nom des étudiants

  • "basique" pour utilisation du nom usuel en priorité / "standard" pour un affichage de type "nom patronymique (nom usuel)"
resultat.implementationConfiguration de la classe chargée de la récupération des notes et résultat d'un étudiant dans Apogéeserveurphoto.implementation

Configuration de la récupération des photos

  • Interface pour la gestion des photos

google.analytics.account

 

 

piwik.tracker.url

piwik.site.id

Configuration de la plateforme web analytics (facultatif). Google Analytics ou Piwik.

Paramètres de Google Analytics, optionnel respectivement :

  • ID du compte Google Analytics

Paramètres de piwik, optionnel (https://fr.piwik.org/), respectivement :

    • L'url du piwik installé dans votre établissement
    • L'id du projet piwik

2.3 Paramétrage des webservices Apogée

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 :

...


attributLdapDoctorant

valeursAttributLdapDoctorant

Permet d'identifer les utilisateurs pour lesquels on souhaite prioritairement vérifier si l'attribution du profil "enseignant" est possible. Sans ce paramètrage, les utilisateurs cibles auraient obtenus le profil "etudiant". Typiquement le cas des doctorants (pouvant également effectuer de l'enseignement)

  • Attribut ldap permettant de caractériser un doctorant

  • Une ou plusieurs valeurs (séparées par ;) de l'attribut ldap ci-dessus permettant de caractériser un doctorant

attributLdapGestionnaire

valeursAttributLdapGestionnaire

Permet d'identifer les utilisateurs auxquels attribuer le profil "gestionnaire"

  • Attribut ldap permettant de caractériser un gestionnaire, ex : edupersonaffiliation
  • Liste des valeurs (séparées par ;) de l'attribut ldap ci-dessus permettant de caractériser un gestionnaire. Ex : staff

apoWsUsername

apoWsPassword

Indiquer de manière facultative un utilisateur des WebServices Apogée lors des appels aux WebServices Apogée (voir roles.xml et users.xml dans la configuration des WebServices).

Attention : Un utilisateur correctement authentifié auprès du WebService doit possèder au moins un des rôles nécessaires à l'appel des méthodes utilisées par MDW, même si la méthode autorise le rôle "anonymous".

Dans ce cas, le user défini dans users.xml devra possèder le rôle ROLE_ANONYMOUS.

sourceResultats

Source des résultats lors de l'appel aux Web Services Apogée pour récupérer les notes et résultats

  • Apogee ou Apogee-extraction
productionModeMode production. Doit être à true
debugModeActive les traces en mode debug pour les classes java du package "mondossierweb"


enablePush

showLoadingIndicator

Configuration du Push :

  • Activation du push. Doit être à true pour utiliser "showLoadingIndicator"
  • true si on doit afficher l'indicateur de loading entre certains écrans. Push obligatoire
EnablePdfSecurityActiver la sécurité sur les pdf générés par l'application (pdf encryption) : crypte le contenu du PDF à l'aide d'un mot de passe de propriétaire généré aléatoirement pour empêcher sa modification avec Acrobat Reader.


pdf.sign.keystore.path

pdf.sign.password

pdf.sign.creator

pdf.sign.reason

pdf.sign.location

pdf.sign.contact

Paramètres pour la signature électronique des pdf, respectivement :

  • path vers le keystore
  • mot de passe du keystore
  • "creator" à indiquer dans la signature (optionnel)
  • "reason" à indiquer dans la signature (optionnel)
  • "location" à indiquer dans la signature (optionnel)
  • "contact" à indiquer dans la signature (optionnel)


La signature électronique par un certificat validé par une autorité de certification (le certificat de l'université) permet d'assurer l'authenticité du document.

A l'ouverture du document avec Acrobat Reader il est possible de consulter le certificat et son authenticité (si validé par une autorité de certification). Bien sûr, un document signé ne peut pas être modifié. La signature est plus sécurisée que l'encryption ci-dessus.


pdf.sign.alt.tsa.url

pdf.sign.alt.tsa.username

pdf.sign.alt.tsa.password

pdf.sign.alt.tsa.tokensize

Paramètre de la Time Stamp Authority (TSA) pour une signature compatible ALT : Nécessité de posséder un certificat délivré par une authentité de certification externe. La signature ALT doit être activée dans l'adminView (onglet PDF)

  • url de la Time Stamp Authority 
  • username auprès de la TSA
  • Mot de passe auprès de la TSA
  • Taille estimée du token

mail.smtpHost

mail.from

mail.to

mail.startDisabling

mail.stopDisabling

liste.erreur.a.ignorer

Paramètres pour l'envoi des mails d'erreur, respectivement :

  • host smtp
  • champs from du mail
  • champs to du mail
  • début de la période de désactivation des mails d'erreur
  • fin de la période de désactivation des mails d'erreur
  • liste des erreurs à ignorer séparées par un point-virgule

param.elasticsearch.url

param.elasticsearch.port

param.elasticsearch.cluster

param.elasticsearch.index

param.elasticsearch.index.champrecherche

param.elasticsearch.index.champcodeobjet

param.elasticsearch.index.champversionobjet

param.elasticsearch.index.champlibelleobjet

Configuration de la connexion a ElasticSearch

  • l'url du serveur
  • le port d'écoute
  • le nom du cluster
  • le nom de l'index contenant les objets provenant d'apogée
  • le nom de l'attribut du document sur lequel on effectue la recherche lors de la recherche rapide. Peut être un champ enrichi. Ex : [CODE] LIBELLE
  • le nom de l'attribut du document contenant le code de l'objet Apogée
  • le nom de l'attribut du document contenant la version de l'objet Apogée
  • le nom de l'attribut du document contenant le libellé de l'objet Apogée
Avertissement
Par convention, le type des objets doit être dans l'attribut ElasticSearch nommé "_type". Valeurs possible : CMP, VET, ETU, ELP


Info

L'implémentation d'ElasticSearch au sein de monDossierWeb dépend de la version installée. Pour changer le version utilisée et passer en v1, il faut partir du package source et modifier le pom.xml (voir doc Personnalisation)


recherche.autocompletion.elp

Configuration de la recherche rapide

  • true pour autoriser l'autocomplétion sur les ELP dans la vue RechercheRapide.

param.apogee.mail.annuaire

emailConverter.implementation

Configuration de la récupération du mail de l'étudiant

  •  true pour que l'email de l'étudiant (état-civil) soit récupéré par le WS dans l'annuaire, false pour que ce soit une implémentation différente qui s'en charge.

  • nom de l'interface java pour la récupération du mail si param.apogee.mail.annuaire=false.

codetuFromLogin.implementation

loginFromCodetu.implementation


Configuration de la récupération des identifiants Apogée d'un étudiant

  • Interface pour la récupération du cod_etu à partir du login
  • Interface pour la récupération du login à partir du codetu
etatcivil.nom.affichage

Affichage du nom des étudiants

  • "basique" pour utilisation du nom usuel en priorité / "standard" pour un affichage de type "nom patronymique (nom usuel)"
resultat.implementationConfiguration de la classe chargée de la récupération des notes et résultat d'un étudiant dans Apogée
serveurphoto.implementation

Configuration de la récupération des photos

  • Interface pour la gestion des photos

google.analytics.account



piwik.tracker.url

piwik.site.id

Configuration de la plateforme web analytics (facultatif). Google Analytics ou Piwik.

Paramètres de Google Analytics, optionnel respectivement :

  • ID du compte Google Analytics

Paramètres de piwik, optionnel (https://fr.piwik.org/), respectivement :

    • L'url du piwik installé dans votre établissement
    • L'id du projet piwik

2.2.1 Paramétrage des logs

Le fichier logback.xml est livré avec une configuration par défaut des logs.

Il définit notamment l'historisation des accès dans un fichier mondossierweb-security.log avec les informations suivantes : login, IP, profil (student ou teacher) , numéro étudiant si c'est un étudiant, accès ou non possible à l'adminView.

Il est tout à fait possible de modifier ce fichier (il faudra alors le faire à chaque installation d'une nouvelle version).

Par exemple, pour supprimer les logs d'accès, il suffit de supprimer le bloc logger name="fr.univlorraine.mondossierweb.security" ou de lui assigner un level "error".

2.3 Paramétrage des webservices Apogée

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 :

  • État
    colourBlue
    titleSolution 1
     : dans /WEB-INF/classes/
  • État
    colourBlue
    titleSolution 2
     : dans /src/main/resources/

A partir de la version 1.5.2

Renseigner :

  • Les URLs des WebServices Apogée utilisés par l'application
  • État
    colourGreen
    titleOptionnel
    Les informations d'authentification aux WebServices Apogée si nécessaire (dépend de votre installation des WebServices Apogée)
    • Il est possible de paramétrer un user différent par service.
  • État
    colourGreen
    titleOptionnel
    Des headers si vous en avez l'utilité :
    • Il est possible de paramétrer des headers pour chaque service sous la forme : api.header.NomDuService.NomDuHeader = ValeurDuHeader
    • L'exemple ci-dessous correspond aux headers nécessaires pour utiliser l'API Manager "Gravitee".
Bloc de code
languagebash
# WebServices
administratifMetier.urlService=https://apo-ws.univ.fr/administratifMetier
etudiantMetier.urlService=https://apo-ws.univ.fr/etudiantMetier
pedagogiqueMetier.urlService=https://apo-ws.univ.fr/pedagogiqueMetier
geographieMetier.urlService=https://apo-ws.univ.fr/geographieMetier
offreFormationMetier.urlService=https://apo-ws.univ.fr/offreFormationMetier

#Header
api.header.administratifMetier.X-Gravitee-Api-Key = xxxxxx-xxxxxx-xxxx-xxxxx
api.header.etudiantMetier.X-Gravitee-Api-Key = xxxxxx-xxxxxx-xxxx-xxxxx
api.header.pedagogiqueMetier.X-Gravitee-Api-Key = xxxxxx-xxxxxx-xxxx-xxxxx
api.header.geographieMetier.X-Gravitee-Api-Key = xxxxxx-xxxxxx-xxxx-xxxxx
api.header.offreFormationMetier.X-Gravitee-Api-Key = xxxxxx-xxxxxx-xxxx-xxxxx

#Authentification WS Apogée
etudiantMetier.apo-ws-user = userEtudiant
etudiantMetier.apo-ws-pwd = *******



Versions antérieures à la 1.5.2

État
colourBlue
titleSolution 2

...

: Il faut également ajouter la librairie des WebServices Apogée dans le répertoire correspondant à la version utilisée (cf artifactId 'apo-webservicesclient' dans le pom.xml) sous src\main\resources\repository\gouv\education\apogee\apo-webservicesclient\{version} afin que maven puisse trouver la librairie lors de la compilation.

Renseigner les url de vos webservices dans configUrlServices, les URLs des WebServices utilisés dans l'application :

Bloc de code
languagebash
themeEclipselanguagebash
titleUrl WebServices Apogée
# WebServices Dossier Etudiant  
administratifMetier.urlService=https://wsapogee.univ.fr/services/AdministratifMetier
etudiantMetier.urlService=https://wsapogee.univ.fr/services/EtudiantMetier
pedagogiqueMetier.urlService=https://wsapogee.univ.fr/services/PedagogiqueMetier
geographieMetier.urlService=https://wsapogee.univ.fr/services/GeographieMetier

# Web Services Référentiel 
offreFormationMetier.urlService=https://wsapogee.univ.fr/services/OffreFormationMetier

# WebServices Dossier Etudiant  
administratifMetier.urlService.ssl=https://wsapogee.univ.fr/services/AdministratifMetier
etudiantMetier.urlService.ssl=https://wsapogee.univ.fr/services/EtudiantMetier
pedagogiqueMetier.urlService.ssl=https://wsapogee.univ.fr/services/PedagogiqueMetier
geographieMetier.urlService.ssl=https://wsapogee.univ.fr/services/GeographieMetier

# Web Services Référentiel 
offreFormationMetier.urlService.ssl=https://wsapogee.univ.fr/services/OffreFormationMetier

#SSL
WS_SSL_MODE=false;
WS_KEY_STORE_PATH=C:/client_keystore
WS_CERTIF_STORE_PATH=C:/client_keystore
WS_KEY_PASS=password
WS_KEY_TYPE=jks

...

Copier le fichier apogeeRequest.sample.xml et renommer le en apogeeRequest.xml.

Suivant le choix de la solution dans la partie 2.1, le fichier apogeeRequest.sample.xml se trouve :

...

Info
Pour plus de précisions voir le paragraphe "Requêtes SQL" dans la partie : Personnalisation

 


2.5 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.

...

7) Depuis le répertoire bin de logstash, lancer la commande suivante pour installer le plugin "input-jdbc" :

...


Bloc de code
./plugin install logstash-input-jdbc
 


8) Dans le répertoire qui contient ElasticSearch et Logstash, créer un fichier apogee-test.conf à partir du fichier exemple suivant permettant de récupérer les composantes, VET, ELP, et étudiants valides sur n et n-1 : apogee-test-exemple.conf

...

Bloc de code
titleschedule une fois par heure entre 5h et 23h
...
jdbc_driver_class => "Java::oracle.jdbc.driver.OracleDriver"
schedule => "0 5-23 * * *"
statement => "SELECT ...

 


9) Puis, depuis le répertoire bin, de logstash :


 

Bloc de code
./logstash -f ../../apogee-test.conf
 


Info
Attention : Il est nécessaire de relancer la commande ci-dessus à chaque redémarrage d'ElasticSearch.
L'idéal est de l'ajouter dans un script de démarrage juste après la commande de démarrage d'ES .

On peut voir sur http://localhost:9200/_plugin/head/ que l'index est créé et renseigné