Accueil Hypercerts

Version 42.1 par dufour18 le 23/07/2020 - 12:33

Vous cherchez à délivrer aux étudiants de votre université des attestations de réussite dématérialisées ? Hypercerts vous permettera de générer et envoyer des attestations officielles, numériques, et infalsifiable de façon automatique.

Ces dernières pourront être envoyées par mail, déposées dans le nuage, et même être certifiées authentiques grâce à une blockchain dédiée.

Une fois l'application connectée à Apogée et au LDAP, les gestionnaires de scolarité pourront demander la génération et l'envoi des attestations de réussite en un clic.

La version 1.0.x est une première version limitée à l'envoi des attestations par email. Bien que le cœur de l'application soit fonctionnel, les dépôts de documents dans les coffres digisposte et la certification cryptographique sont en cours de dévelopement actif.

Prérequis

Hypercerts est une application Java qui se connecte à Apogée et au LDAP. Elle requiert l'utilisation d'une base MariaDB pour son fonctionnement interne. Elle se déploie sur des serveurs comme une application SpringBoot classique. Le WAR pourra être pris en charge par un tomcat et servir les utilisateur•ices via l'URL configuré.

Technologie

Version

JDK

11+

SpringBoot

2.3

Vaadin (Frontend)

14

Tomcat

9+

MariaDB

14+

Maven

3.6+

Connection Apogée


Connection Apogée via WS


Connection LDAP


Docker (optionnel)

docker-compose 3

Téléchargement des sources

Provisoirement, les sources de l'application peuvent être téléchargées à cet endroit.

Installation d'Hypercerts

Initialisation de la base

La base de données MariaDB/MySQL s'initialise avec la commande Flyway suivante :

mvn -Dflyway.configFiles=flyway.properties flyway:migrate

Le fichier flyway.properties doit être créé à partir du fichier exemple flyway-sample.properties. Il contient les properties standard à Flyway. 

# Flyway
# ConfigFiles : https://flywaydb.org/documentation/configfiles
# mvn -Dflyway.configFiles=xxx.properties flyway:migrate
flyway.url=jdbc:mariadb://localhost/hypercerts?serverTimezone=Europe/Paris
flyway.schemas=hypercerts
flyway.user=XXX
flyway.password=
# Emplacement des fichiers sql de migration
flyway.locations=classpath:db/migration
# baselineOnMigrate
flyway.baselineOnMigrate=false

Au besoin, les fichiers sql de migration peuvent être trouvés sous src/main/resources/db/migration.

Pour remettre à zéro la base, lancer le script src/main/resources/db/reset/reset.sql puis exécuter à nouveau Flyway.

Configuration l'application

Créer et compléter un fichier application.yaml à la racine du projet sur le modèle de application-sample.yaml

Des indications sont présents dans le fichier pour aider à sa configuration.

Éléments de configuration important 

Property app.production

Pour les tests, mettre app.production à false pour obtenir une année supplémentaire (N-2) pour la génération, ainsi des diplômes avec résultats seront plus facilement trouvables.

En étant à false, cette property autorise également l'interception de tout les mails applicatifs.

Envoi de mail

Sur votre environnement de test/développement, pour empêcher l'envoi de mails de test en réel, il est conseillé :

  • d'utiliser un mail catcher (https://mailcatcher.me/) en remplacement de votre smtp
  • ou de configurer l'application pour intercepter tout les mails applicatifs avec ces valeurs :
    • app.production à false
    • spring.mail.intercept.active à true
    • et spring.mail.intercept.mails contenant une ou plusieurs adresses de réception des mails

Enfin, la property app.mails sert à définir une ou plusieurs adresses permettant de recevoir les mails applicatifs. ⚠ Aujourd'hui, dans cette version tous les envois sont en copie de cette property. Elle peut être laissé vide.

WebServices Apogée

Les WebServices Apogée sont appelés par l'intermédiaire d'une librairie UL.

Les properties différent du classique configUrlServices.properties de l'AMUE.

Des headers peuvent être ajoutés en paramètre de chaque WebService.

Exemple :

ws:
  apogee:
    administratif:
      url: https://api.univ.fr/apo/amue_apo_administratif
      headers:
#        header1: value1
#        header2: value2
      username: xxxx
      password: xxxx

Configurer et lancer le projet dans Eclipse

  • Importer le projet Maven dans eclipse.
  • Lorsque la configuration est terminée, démarrer l'application en faisant un clic droit sur fr.univlorraine.hypercerts.Application.java et en choisissant 'Run As / Java Application'.

Customisation des services

Plusieurs services sont personnalisables en fonction de votre environnement.

Sous fr.univlorraine.hypercerts.apogee.service.customs :

  • ApogeeUserServiceCustomExample
    • Personnalisation de la récupération des adresses mails des utilisateurs Apogée à partir de l'uid LDAP
  • BlocageServiceCustomExample
    • Personnalisation de la récupération des blocages/interdits à partir d'un code étudiant Apogée
  • ComposanteServiceCustomExample
    • Personnalisation de la récupération :
      • de toutes les composantes
      • des composantes pour un utilisateur à partir de l'uid LDAP
      • du nombre de composantes pour un utilisateur à partir de l'uid LDAP

Pour personnaliser un de ces services :

  1. Copier la classe en la renommant
  2. Implémentation la ou les méthodes
    1. Vous êtes libre de créer des repositories ou d'utiliser l'entityManager directement.

  3. Dé-commenter les 2 annotations :1.

    @Service

    1. et @Override**

  4. Au démarrage de l'application
    1. Un ligne "Overriding XXX for YYY implementation" doit apparaître dans les logs

Exemple :

/**
 * Override default ApogeeUserService implementation.
 * >> README
 * Décommenter l'annotation @Service pour que le service soit instancié et l'annotation @OverrideApogeeUserService pour que l'implémentation soit utilisée.
 *
 * @author Matthieu Manginot
 */
@NoArgsConstructor
@Slf4j
@Service
@OverrideApogeeUserService
public class ApogeeUserServicePERSO implements IApogeeUserService {

@PersistenceContext(unitName = "apogeeEntityManagerFactory")
private EntityManager entityManagerApogee;

@PostConstruct
public void init() {
log.info("Overriding {} for IApogeeUserService implementation", getClass().getCanonicalName());
}

/**
 * @see fr.univlorraine.hypercerts.apogee.services.IApogeeUserService#getEmail(java.lang.String)
 */
@Override
public String getEmail(final String uidLdap) {
/* Implémentation personnalisée de getEmail. entityManagerApogee.createNativeQuery... */
return "mail@univ.fr";
}
}


Customisation de Digiposte

Documentation à venir.

Tâches Maven

  • Lancer l'application (hors d'un IDE) :
mvn spring-boot:run
  • Lancer les tests :
mvn verify
  • Créer le package pour production :
mvn clean package -Pproduction

Makefile

Un Makefile est également disponible. A la racine, utilisez `make help` pour obtenir les commandes disponibles.

Tests unitaires

Pour s'assurez que les résultats d'admission de vos étudiants soient bien correctes, et afin d'éviter les faux positifs (donc envoyer une attestation de réussite à un•e étudiant•e non reçu•e aux examens), vous pouvez ajouter vos jeux de données.

Les tests utilisent 3 classes:

  • ResultatsTests.java
  • ResultatsTestCase.java
  • ResultatsServiceTest.java

ResultatTests.java énumère tous les tests. Il utilise l'objet ResultatTestCase dans lequel on précise:

  • Le codEtu
  • L'année
  • Le diplôme
  • La VDI
  • Le résultat attendu (le test réussi si c'est ce résultat qui est trouvé)

ResultatServiceTest.java est responsable du lancement des tests JUnit


Utilisation d'Hypercerts

Vue

Utilisation

1-Accueil.png

En tant que gestionnaire de scolarité ou super admin, rendez vous sur l'application.

Une fois le CAS passé, vous atteignez la page d'accueil de l'application. Vous y retrouvez les composantes dans lesquelles vous pourrez faire des demandes de génération en envoi d'attestations dématérialisées. Pour les gestionnaires, celles-ci correspondent à vos droits Apogée. Les super admins ont eux accès à toutes les composantes.

Dans le panneau de gauche, vous retrouvez une série d'onglets. Ceux-ci sont disposés de haut en bas, dans l'ordre de leur utilisation.

2-Génération.png

Pour lancer la génération d'attestations de réussite pour un diplôme (créer une campagne de dématérialisation) choisissez:

  • L'année académique
  • La composante
  • Le diplôme (les résultats proposés correspondent à la composante sélectionnée)

L'application retrouve les promotions d'étudiant.es et récapitule les informations avant le lancement des demandes.

Vous pouvez utiliser le bouton visualiser un specimen d'attestation pour valider visuellement le rendu des attestations qui vont être générées.

Veillez à ce que le libelle du diplôme soit bien celui que vous attendez.


  • Le bouton avec les flèches en rond permet de forcer une nouvelle recherche
  • Le bouton gomme permet d'effacer les paramètres

3-diplomes.png

Une fois vos demandes faites, vous retrouvez leur avancement dans la vue "Diplômes"

Après que le traitement des demandes soit fait, les diplômes passent dans la section 'Terminés'

On y retrouve des informations relatives à la génération et distribution des attestations.

Le même rapport a été envoyé par email au gestionnaire qui à fait la demande.

3-2.png

4-etudiants.png

Si on cherche à vérifier comme s'est déroulé la génération et distribution d'une attestation pour un•e étudiant•e, on peut utiliser la vue "Étudiants".


On peut utiliser le codEtu ou recherche par nom / prénom.


On retrouve toutes les années pour lesquelles l'un•e étudiant•e a été traitée. Pour chaque année sont précisés les diplôme, et pour chaque diplôme on retrouve le rapport des étapes dans l'ordre chronologique.

Si une erreur est survenue, la raison sera précisée ici.


Il est aussi possible de télécharger l'attestation avec le bouton "Télécharger l'attestation"

Administration

Connexions

TODO

Gestion

TODO


Recently Updated


Navigate space

ws:
  apogee:
    administratif:
      url: https://api.univ.fr/apo/amue_apo_administratif
      headers:
#        header1: value1
#        header2: value2
      username: xxxx
      password: xxxx