Code source wiki de 01 - Documentation technique

Version 49.1 par Matthieu Manginot le 21/04/2021 - 12:23
Afficher les derniers auteurs
1
2
3 {{toc/}}
4
5 == Prérequis ==
6
7 * Hypercerts est une application Java qui se connecte à Apogée et au LDAP.
8 * Elle requiert l'utilisation d'une base MariaDB pour son fonctionnement interne.
9 * Elle se déploie sur des serveurs comme une application SpringBoot classique.
10
11 |=(((
12 Technologie
13 )))|=(((
14 Version
15 )))
16 |(((
17 JDK
18 )))|(((
19 11+
20 )))
21 |(% colspan="1" %)(((
22 SpringBoot
23 )))|(% colspan="1" %)(((
24 2.3
25 )))
26 |(% colspan="1" %)(((
27 Vaadin (Frontend)
28 )))|(% colspan="1" %)(((
29 14
30 )))
31 |(((
32 Tomcat
33 )))|(((
34 9+
35 )))
36 |(% colspan="1" %)(((
37 MariaDB
38 )))|(% colspan="1" %)(((
39 14+
40 )))
41 |(% colspan="1" %)(((
42 Maven
43 )))|(% colspan="1" %)(((
44 3.6+
45 )))
46 |(% colspan="1" %)(((
47 Connection Apogée
48 )))|(% colspan="1" %)(((
49 \\
50 )))
51 |(% colspan="1" %)(((
52 Connection Apogée via WS
53 )))|(% colspan="1" %)(((
54 6.00.50
55 )))
56 |(% colspan="1" %)(((
57 Connection LDAP
58 )))|(% colspan="1" %)(((
59 \\
60 )))
61
62 == Téléchargement des sources ==
63
64 Dernière version des sources : [[hypercerts-1.0.5.2-SNAPSHOT.zip>>url:https://download-sig.univ-lorraine.fr/public/hypercerts/hypercerts-1.0.5.2-SNAPSHOT.zip||shape="rect"]]
65
66 == Installation d'Hypercerts ==
67
68 === **Initialisation / Mise à jour de la base** ===
69
70 La base **hypercerts **MariaDB/MySQL s'initialise / se met à jour avec la commande **Flyway** suivante :
71
72 {{code language="bash" theme="Eclipse"}}
73 mvn -Dflyway.configFiles=flyway.properties flyway:migrate
74 {{/code}}
75
76 Le fichier **flyway.properties doit être créé** à partir du fichier exemple flyway-sample.properties. Il contient les properties standard à Flyway.
77
78 {{code language="bash" theme="Eclipse" linenumbers="true" collapse="true"}}
79 # Flyway
80 # ConfigFiles : https://flywaydb.org/documentation/configfiles
81 # mvn -Dflyway.configFiles=xxx.properties flyway:migrate
82 flyway.url=jdbc:mariadb://localhost/hypercerts?serverTimezone=Europe/Paris
83 flyway.schemas=hypercerts
84 flyway.user=XXX
85 flyway.password=
86 # Emplacement des fichiers sql de migration
87 flyway.locations=classpath:db/migration
88 # baselineOnMigrate
89 flyway.baselineOnMigrate=false
90 {{/code}}
91
92 Au besoin, les fichiers sql de migration peuvent être trouvés sous **src/main/resources/db/migration**.
93
94 Pour remettre à zéro la base de données **hypercerts**, lancer le script **src/main/resources/db/reset/reset.sql// //**puis exécuter à nouveau **Flyway**//.//
95
96 === Configuration de l'application ===
97
98 Créer et compléter un fichier **application.yaml** à la racine du projet sur le modèle de **application-sample.yaml**
99
100 Des indications sont présentes dans le fichier pour aider à sa configuration ou **ci-dessous**.
101
102 === Maven / Exécution de l'application ===
103
104 * **Sous un** **IDE**, exemple Eclipse//, //**avec le fichier de configuration à la racine** :
105 ** (% style="color: rgb(0,0,0);" %)Clic droit sur "Application.java > Run As > Java Application"
106 * Lancer l'application (**hors d'un IDE**),// //**avec fichier de configuration à la racine** :
107
108 {{code language="bash" theme="Eclipse"}}
109 mvn spring-boot:run
110 {{/code}}
111
112 * Lancer les tests :
113
114 {{code language="bash" theme="Eclipse"}}
115 mvn verify
116 {{/code}}
117
118 * Créer le package pour production :
119
120 {{code language="bash" theme="Eclipse"}}
121 mvn clean package -Pproduction
122 {{/code}}
123
124 * Sous un serveur, comme Tomcat, le fichier de config peut être déposé à la racine du tomcat avec précision de son emplacement via les options JAVA, exemple :
125
126 {{code language="bash" theme="Eclipse"}}
127 export JAVA_OPTS="$JAVA_OPTS -Dspring.config.location=$HOMEDIR/application.yaml"
128 {{/code}}
129
130 == (% style="letter-spacing: -0.006em;" %)**Configuration**(%%) ==
131
132 === Property //app.production// ===
133
134 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.
135
136 En étant à **false**, cette **property **autorise également la configuration de l'**interception globale de tous les mails applicatifs**.
137
138 ==== **Envoi de mail** ====
139
140 (% 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é :__
141
142 * d'utiliser un mail catcher ([[https:~~/~~/mailcatcher.me/>>url:https://mailcatcher.me/||shape="rect"]]) en remplacement de votre smtp
143 * **ou** de configurer l'application pour intercepter globalement tous les **mails applicatifs** avec ces valeurs :
144 ** **app.production** à //false//
145 ** **spring.mail.intercept.active** à //true//
146 ** et **spring.mail.intercept.mails** contenant une ou plusieurs adresses de réception des mails
147 ** Pour éviter l'envoi de **mails Digiposte de test en réel**, il conviendra de renseigner : **spring.mail.intercept.mailDigiposte** avec une adresse mail / liste
148
149 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 de mails ont en copie de cette property. Elle est optionnelle et peut être laissée à vide.
150
151 === Envoi des attestations aux étudiants ===
152
153 Les attestations peuvent être envoyées aux étudiants par **mail** __**et/ou**__ sur **Digiposte**.
154
155 Pour **activer l'envoi par mail**, mettre la property **app.useMailDelivery** à true.
156
157 Pour **activer l'envoi sur Digiposte**, mettre la property **app.usingDigiposteDelivery** à true.
158
159 Il est possible de **modifier le comportement par défaut** de l'application au moment de la création des campagnes, en activant la property **app.overrideDeliveryOnGeneration**.
160
161 Ce qui affichera le choix suivant dans l'interface pour **tous les gestionnaires** :
162
163 [[image:attach:image2021-3-19_12-1-4.png||width="1020"]]
164
165 === WebServices Apogée ===
166
167 Les WebServices Apogée sont appelés par l'intermédiaire d'une librairie UL.
168
169 Les **properties **différent du classique fichier de configuration **configUrlServices.properties** de l'AMUE.
170
171 Des **headers **peuvent être ajoutés en paramètre de chaque WebServices.
172
173 Exemple :
174
175 {{code language="bash" theme="Eclipse" linenumbers="true" collapse="true"}}
176 ws:
177 apogee:
178 administratif:
179 url: https://api.univ.fr/apo/amue_apo_administratif
180 headers:
181 # header1: value1
182 # header2: value2
183 username: xxxx
184 password: xxxx
185 {{/code}}
186
187 === Customisation des templates de mail ===
188
189 Les properties suivantes servent à indiquer les templates personnalisés :
190
191 * spring.mail.templateName.**attestation** : pour le mail à destination de l'étudiant contenant l'attestation
192 * spring.mail.templateName.**creationDigiposte** : pour le mail à destination de l'étudiant envoyé après la création du coffre Digiposte
193 * spring.mail.templateName.**creationCampagne** : pour le mail d'une nouvelle campagne (à destination du gestionnaire qui a lancé la campagne)
194 * spring.mail.templateName.**reportCampagne** : pour le mail de rapport de campagne (à destination du gestionnaire qui a lancé la campagne)
195
196 ❓ Par défaut, les valeurs sont vides et les templates par défaut de l'application sont utilisés
197
198 Pour customiser un template :
199
200 * **Copier et renommer un template HTML** présent sous **src/main/resources/templates**
201 * Par exemple pour le mail d'attestation :
202 ** Renommer** mail-attestation.html** en **mail-attestation-custom.html**
203 ** Adapter le template
204 ** Dans la config, saisir spring.mail.templateName.**attestation **: **mail-attestation-custom.html**
205
206 === Customisation des services ===
207
208 Plusieurs services sont personnalisables en fonction de votre environnement.
209
210 Sous **fr.univlorraine.hypercerts.apogee.service.customs** :
211
212 * **ApogeeUtilisateurServiceCustomExample//
213 //**
214 ** Personnalisation de la récupération des adresses mails des utilisateurs Apogée à partir de l'uid Apogée
215 * **ApogeeBlocageServiceCustomExample//
216 //**
217 ** Personnalisation de la récupération des blocages/interdits à partir d'un code étudiant Apogée
218 * **ApogeeComposanteServiceCustomExample//
219 //**
220 ** Personnalisation de la récupération :
221 *** de toutes les composantes 
222 **** → utilisé pour donner les droits sur toutes les composantes aux super admins
223 *** des composantes pour un utilisateur à partir de l'uid Apogée
224 *** du nombre de composantes pour un utilisateur à partir de l'uid Apogée
225 * **ApogeeUidServiceCustomExample**\\
226 ** Personnalisation de la récupération de l'uid Apogée d'un utilisateur à partir de son uid Ldap
227
228 (% style="color: rgb(0,51,102);" %)__Pour personnaliser un de ces services :__
229
230 1. Copier la classe en la renommant
231 1. Implémenter la ou les méthodes
232 11. Vous êtes libre de créer des repositories ou d'utiliser l'entityManager directement
233 1. (((
234 Dé-commenter les 2 annotations :1. (((
235 **@Service** → Pour que Spring implémente le Service au démarrage
236 )))
237 1. (((
238 et **@OverrideXXX** → Pour que l'implémentation surcharge le service par défaut
239 )))
240 )))
241 1. Au démarrage de l'application
242 11. Une ligne "//Overriding XXX for YYY implementation//" doit apparaître dans les logs
243 1. Sans IDE, penser à ajouter les imports suivant :
244 11. import org.springframework.stereotype.Service;
245 11. import fr.univlorraine.hypercerts.apogee.services.annotations.**OverrideXXX**;
246 \\
247
248 {{code language="java" theme="Eclipse" title="Exemple" linenumbers="true" collapse="true"}}
249 /**
250 * Override default ApogeeUtilisateurService implementation.
251 * >> README
252 * Décommenter l'annotation @Service pour que le service soit instancié et l'annotation @OverrideApogeeUtilisateurService pour que l'implémentation soit utilisée.
253 *
254 * @author Matthieu Manginot
255 */
256 @NoArgsConstructor
257 @Slf4j
258 // @Service
259 // @OverrideApogeeUtilisateurService
260 public class ApogeeUtilisateurServiceCustomExample implements IApogeeUtilisateurService {
261
262 @PersistenceContext(unitName = "apogeeEntityManagerFactory")
263 private EntityManager entityManagerApogee;
264
265 @PostConstruct
266 public void init() {
267 log.info("Overriding {} for IApogeeUtilisateurService implementation", getClass().getCanonicalName());
268 }
269
270 /**
271 * @see fr.univlorraine.hypercerts.apogee.services.IApogeeUtilisateurService#getMail(java.lang.String)
272 */
273 @Override
274 public String getMail(final String uidApogee) {
275 /* Implémentation personnalisée de getMail. entityManagerApogee.createNativeQuery... */
276 return null;
277 }
278 }
279 {{/code}}
280
281 === Configuration de Digiposte ===
282
283 Dans **application.yaml** sous **digiposte.***
284
285 * **digiposte**
286 ** **codeDistributeur** : Code distributeur Digiposte (fourni par Digiposte)
287 ** **codeEmetteur** : Code emetteur Digiposte (PID) (fourni par Digiposte)
288 ** **type** : Type de campagne : en mode OPT-IN = PREINSCRIPTION ou mode OPT-OUT = PREINSCRIPTION_WITH_VALIDATED_MEMBERSHIP (param Digiposte)
289 ** **sendMailHypercerts** : Envoi du mail Hypercerts pour informer l'étudiant qu'un coffre Digiposte est crée
290 ** **docDigiposteEtudiant** : Url de la documentation Digiposte pour les étudiants présente dans le mail d'information
291 ** **sendMailDigiposte** : Envoi du mail Digiposte : 'YES' ou 'NO' (param Digiposte)
292 ** **checkMailMode** : Vérification du mail : mail vérifié par l'émetteur = CHECKED ou mail non vérifié = INFORMATION (param Digiposte)
293 ** **urlAccesDirect** : Urls d'accès direct à Digiposte pour les adhésions ou les résiliations\\
294 *** **adhesions** : Url pour les adhésions directes
295 *** **resiliations** : Url pour les résiliations directes
296 ** **adhesions** : Configuration de l'envoi des adhésions (création des coffres)\\
297 *** **ftp** : Connexion au sftp Digiposte des adhésions
298 *** **ws** : Connexion au ws Digiposte
299 ** **routages** : Configuration de l'envoi des routages (dépôt des attestations dans les coffres)
300 *** **ftp **: Connexion au sftp Digiposte des routages
301 *** (% style="letter-spacing: 0.0px;" %)**publisher**(%%) : Configuration du publisher : Clé publique pour la sécurisation des routages
302
303
304 Egalement, pour éviter l'envoi de (% style="letter-spacing: 0.0px;" %)**mails Digiposte de test en réel**(%%), il faudra activer l'interception globale des mails et renseigner : (% style="letter-spacing: 0.0px;" %)**spring.mail.intercept.mailDigiposte**(%%) avec une adresse mail / liste
305
306 {{info}}
307 Une fois configuré, il faudra activer Digiposte avec la property **app.usingDigiposteDelivery : true**
308 {{/info}}
309
310 === Réaliser un test réel en production ===
311
312 Pour par exemple valider Digiposte en production, il est possible d'intercepter les mails pour un ou plusieurs étudiants d'un diplôme. (Intercepter = Remplacement du mail de l'étudiant par celui configuré)
313
314 {{info}}
315 Si l'interception globale est activée, elle **sera prioritaire** sur celle-ci
316 {{/info}}
317
318
319 Dans **application.yaml** sous **spring.mail, il faudra décommenter les éléments suivant pour activer l'interception :**
320
321 * **interceptEtudiants
322 **
323 ** **codDiplome :** A remplacer par le code diplôme à intercepter**
324 **
325 *** **"codEtudiant" :  **A remplacer par le code étudiant à intercepter
326
327 Exemple :
328
329 {{code language="bash" theme="Eclipse" linenumbers="true" collapse="true"}}
330 spring:
331 mail:
332 ...
333 interceptEtudiants:
334 ABCDEF:
335 "12345678": interceptMail@univ.fr
336 {{/code}}
337
338 Un message d'avertissement sera affiché dans l'interface pour le diplôme concerné :
339
340 [[image:attach:image2021-4-21_12-2-30.png||height="250"]]
341
342 ----
343
344 == (% style="letter-spacing: -0.006em;" %)Administration(%%) ==
345
346 Les super admins ont accès à des vues supplémentaires. Des onglets pour ces dernières apparaissent dans le panneau de gauche.
347
348 === Gestion ===
349
350 \\
351
352 |=(((
353 Vue
354 )))|=(((
355 Utilisation
356 )))
357 |(((
358 (% class="content-wrapper" %)
359 (((
360 [[image:attach:image2021-2-23_10-42-24.png||height="400"]]
361 )))
362 )))|(((
363 Cette vue permet de lancer les tâches qui s’exécutent automatiquement de façon manuelle.
364
365 Trigger CRON jobs permet de lancer toutes les tâches de dématérialisation jusqu'à ce qu'elles aboutissent toutes.
366
367 On peut aussi utiliser des boutons pour lancer plus finement des tâches.
368
369 À noter que si l'application n'est pas configurée pour utiliser Digiposte, les boutons sous Digiposte n'auront pas d'effet.
370 )))
371
372 === Loggers ===
373
374 \\
375
376 |=(((
377 Vue
378 )))|=(((
379 Utilisation
380 )))
381 |(((
382 (% class="content-wrapper" %)
383 (((
384 [[image:attach:image2021-2-23_10-42-53.png||height="400"]]
385 )))
386 )))|(((
387 Cette vue permet de modifier à chaud sans re-démarrage le niveau de logs de tout les loggers de l'application.
388
389 Utile pour par exemple afficher les requêtes SQL (filtre: sql) ou des logs plus précis en fonction des classes/packages.
390 )))