Code source wiki de Accueil Hypercerts

Version 38.1 par Matthieu Manginot le 23/07/2020 - 11:09
Afficher les derniers auteurs
1
2
3 {{toc/}}
4
5 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.
6
7 Ces dernières pourront être envoyées par mail, déposées dans le nuage, et même être certifiées authentiques et intègres grâce à une blockchain dédiée.
8
9 Une fois l'application connectée à Apogée et au LDAP, les gestionnaires de composantes pourront demander la génération et l'envoi des attestations de réussite en un clic.
10
11 {{info}}
12 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.
13 {{/info}}
14
15 == Prérequis ==
16
17 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é.
18
19 |=(((
20 Technologie
21 )))|=(((
22 Version
23 )))
24 |(((
25 JDK
26 )))|(((
27 11+
28 )))
29 |(% colspan="1" %)(((
30 SpringBoot
31 )))|(% colspan="1" %)(((
32 2.3
33 )))
34 |(% colspan="1" %)(((
35 Vaadin (Frontend)
36 )))|(% colspan="1" %)(((
37 14
38 )))
39 |(((
40 Tomcat
41 )))|(((
42 9+
43 )))
44 |(% colspan="1" %)(((
45 MariaDB
46 )))|(% colspan="1" %)(((
47 14+
48 )))
49 |(% colspan="1" %)(((
50 Maven
51 )))|(% colspan="1" %)(((
52 3.6+
53 )))
54 |(% colspan="1" %)(((
55 Connection Apogée
56 )))|(% colspan="1" %)(((
57 \\
58 )))
59 |(% colspan="1" %)(((
60 Connection Apogée via WS
61 )))|(% colspan="1" %)(((
62 \\
63 )))
64 |(% colspan="1" %)(((
65 Connection LDAP
66 )))|(% colspan="1" %)(((
67 \\
68 )))
69 |(% colspan="1" %)(((
70 Docker (optionnel)
71 )))|(% colspan="1" %)(((
72 docker-compose 3
73 )))
74
75 == Téléchargement des sources ==
76
77 Provisoirement, les sources de l'application peuvent être téléchargées à [[cet endroit>>url:http://download-sig.univ-lorraine.fr/home/download-sig/public/hypercerts||shape="rect"]].
78
79 == Installation d'Hypercerts ==
80
81 === **Initialisation de la base** ===
82
83 La base de données MariaDB/MySQL s'initialise avec la commande Flyway suivante :
84
85 {{code language="bash" theme="Eclipse"}}
86 mvn -Dflyway.configFiles=flyway.properties flyway:migrate
87 {{/code}}
88
89 Le fichier flyway.properties doit être créé à partir du fichier exemple flyway-sample.properties. Il contient les properties standard à Flyway.
90
91 {{code language="bash" theme="Eclipse" linenumbers="true" collapse="true"}}
92 # Flyway
93 # ConfigFiles : https://flywaydb.org/documentation/configfiles
94 # mvn -Dflyway.configFiles=xxx.properties flyway:migrate
95 flyway.url=jdbc:mariadb://localhost/hypercerts?serverTimezone=Europe/Paris
96 flyway.schemas=hypercerts
97 flyway.user=XXX
98 flyway.password=
99 # Emplacement des fichiers sql de migration
100 flyway.locations=classpath:db/migration
101 # baselineOnMigrate
102 flyway.baselineOnMigrate=false
103 {{/code}}
104
105 Au besoin, les fichiers sql de migration peuvent être trouvés sous //src/main/resources/db/migration//.
106
107 Pour remettre à zéro la base, lancer le script //src/main/resources/db/reset/reset.sql //puis exécuter à nouveau Flyway//.//
108
109 === Configuration l'application ===
110
111 Créer et compléter un fichier **application.yaml** à la racine du projet sur le modèle de **application-sample.yaml**
112
113 Des indications sont présents dans le fichier pour aider à sa configuration.
114
115 === **Éléments de configuration important ** ===
116
117 ==== Property (% style="letter-spacing: -0.003em;" %)//app.production//(%%) ====
118
119 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.
120
121 En étant à false, cette property autorise également l'interception de tout les mails applicatifs.
122
123 ==== **Envoi de mail** ====
124
125 (% style="color: rgb(0,51,102);" %)__**Sur votre environnement de test/développement**, pour empêcher l'envoi de mails de test en réel, il est conseillé :__
126
127 * d'utiliser un mail catcher ([[https:~~/~~/mailcatcher.me/>>url:https://mailcatcher.me/||shape="rect"]]) en remplacement de votre smtp
128 * ou de configurer l'application pour intercepter tout les mails applicatifs avec ces valeurs :
129 ** **app.production** à false
130 ** **spring.mail.intercept.active** à true
131 ** et **spring.mail.intercept.mails** contenant une ou plusieurs adresses de réception des mails
132
133 Enfin, la property **app.mails** sert à définir une ou plusieurs adresses permettant de recevoir les mails applicatifs. ⚠ Aujourd'hui, dans cette version tout les envois sont en copie de cette property. Elle peut être laissé vide.
134
135 ==== WebServices Apogée ====
136
137 Les WebServices Apogée sont appelés par l'intermédiaire d'une librairie UL.
138
139 Les properties différent du classique configUrlServices.properties de l'AMUE.
140
141 Des headers peuvent être ajoutés en paramètre de chaque WebService.
142
143 Exemple :
144
145 {{code language="bash" theme="Eclipse" linenumbers="true" collapse="true"}}
146 ws:
147 apogee:
148 administratif:
149 url: https://api.univ.fr/apo/amue_apo_administratif
150 headers:
151 # header1: value1
152 # header2: value2
153 username: xxxx
154 password: xxxx
155 {{/code}}
156
157 === Configurer et lancer le projet dans Eclipse ===
158
159 * Importer le projet Maven dans eclipse.
160 * Lorsque la configuration est terminée, démarrer l'application en faisant un clic droit sur {{code language="none"}}fr.univlorraine.hypercerts.Application.java{{/code}} et en choisissant 'Run As / Java Application'.
161
162 === Customisation des services ===
163
164 Plusieurs services sont personnalisables en fonction de votre environnement.
165
166 Sous //fr.univlorraine.hypercerts.apogee.service.customs// :
167
168 * ApogeeUserServiceCustomExample
169 ** Personnalisation de la récupération des adresses mails des utilisateurs Apogée à partir de l'uid LDAP
170 * BlocageServiceCustomExample
171 ** Personnalisation de la récupération des blocages/interdits à partir d'un code étudiant Apogée
172 * ComposanteServiceCustomExample
173 ** Personnalisation de la récupération :
174 *** de toutes les composantes
175 *** des composantes pour un utilisateur à partir de l'uid LDAP
176 *** du nombre de composantes pour un utilisateur à partir de l'uid LDAP
177
178 Pour personnaliser un de ces services :
179
180 1. Copier la classe en la renommant
181 1. Implémentation la ou les méthodes
182 11. Vous êtes libre de créer des repositories ou d'utiliser l'entityManager directement.
183 1. (((
184 Dé-commenter les 2 annotations :1. (((
185 @Service
186 )))
187 1. (((
188 et @Override~*~*
189 )))
190 )))
191 1. Au démarrage de l'application
192 11. Un ligne "//Overriding XXX for YYY implementation//" doit apparaître dans les logs
193
194 Exemple :
195
196 {{code language="java" theme="Eclipse" linenumbers="true" collapse="true"}}
197 /**
198 * Override default ApogeeUserService implementation.
199 * >> README
200 * Décommenter l'annotation @Service pour que le service soit instancié et l'annotation @OverrideApogeeUserService pour que l'implémentation soit utilisée.
201 *
202 * @author Matthieu Manginot
203 */
204 @NoArgsConstructor
205 @Slf4j
206 @Service
207 @OverrideApogeeUserService
208 public class ApogeeUserServicePERSO implements IApogeeUserService {
209
210 @PersistenceContext(unitName = "apogeeEntityManagerFactory")
211 private EntityManager entityManagerApogee;
212
213 @PostConstruct
214 public void init() {
215 log.info("Overriding {} for IApogeeUserService implementation", getClass().getCanonicalName());
216 }
217
218 /**
219 * @see fr.univlorraine.hypercerts.apogee.services.IApogeeUserService#getEmail(java.lang.String)
220 */
221 @Override
222 public String getEmail(final String uidLdap) {
223 /* Implémentation personnalisée de getEmail. entityManagerApogee.createNativeQuery... */
224 return "mail@univ.fr";
225 }
226 }
227 {{/code}}
228
229 ===
230 Customisation de Digiposte ===
231
232 //Documentation à venir.//
233
234 === Tâches Maven ===
235
236 * Lancer l'application (hors d'un IDE) :
237
238 {{code language="bash" theme="Eclipse"}}
239 mvn spring-boot:run
240 {{/code}}
241
242 * Lancer les tests :
243
244 {{code language="bash" theme="Eclipse"}}
245 mvn verify
246 {{/code}}
247
248 * Créer le package pour production :
249
250 {{code language="bash" theme="Eclipse"}}
251 mvn clean package -Pproduction
252 {{/code}}
253
254 === Makefile ===
255
256 Un Makefile est également disponible. A la racine, utilisez `make help` pour obtenir les commandes disponibles.
257
258 == Tests unitaires ==
259
260 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
261
262 {{status colour="Red" title="FONCTIONNEMENT A PRECISER"/}}
263
264 == Utilisation d'Hypercerts ==
265
266 |=(((
267 Vue
268 )))|=(((
269 Utilisation
270 )))
271 |(((
272 (% class="content-wrapper" %)
273 (((
274 [[image:attach:1-Accueil.png||height="250"]]
275 )))
276 )))|(((
277 (% class="content-wrapper" %)
278 (((
279 En tant que gestionnaire de scolarité, ou super admin, rendez vous sur l'application.
280
281 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 accès à toutes les composantes.
282
283 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.
284 )))
285 )))
286 |(((
287 (% class="content-wrapper" %)
288 (((
289 [[image:attach:2-Génération.png||height="250"]]
290 )))
291 )))|(((
292 \\
293 )))
294 |(((
295 (% class="content-wrapper" %)
296 (((
297 [[image:attach:3-diplomes.png||height="250"]]
298 )))
299 )))|(((
300 \\
301 )))
302 |(((
303 (% class="content-wrapper" %)
304 (((
305 [[image:attach:3-2.png||height="250"]]
306 )))
307 )))|(((
308 \\
309 )))
310 |(% colspan="1" %)(((
311 (% class="content-wrapper" %)
312 (((
313 === [[image:attach:4-etudiants.png||height="250"]] ===
314 )))
315 )))|(% colspan="1" %)(((
316 \\
317 )))
318
319 \\
320
321 \\
322
323 {{section}}
324 {{column width="60%"}}
325 {{recently-updated/}}
326 {{/column}}
327
328 {{column width="5%"}}
329 \\
330 {{/column}}
331
332 {{column width="35%"}}
333 ====== Navigate space ======
334
335 {{locationSearch reference="WebHome"/}}
336
337 {{pagetree/}}
338 {{/column}}
339 {{/section}}
340
341 {{code language="java" theme="Eclipse" linenumbers="true" collapse="true"}}
342 ws:
343 apogee:
344 administratif:
345 url: https://api.univ.fr/apo/amue_apo_administratif
346 headers:
347 # header1: value1
348 # header2: value2
349 username: xxxx
350 password: xxxx
351 {{/code}}