Code source wiki de 01 - Documentation technique

Version 44.1 par Matthieu Manginot le 22/03/2021 - 09:34

version	line-number	content
9.1	1
	2
	3	{{toc/}}
	4
2.1	5	== Prérequis ==
	6
10.1	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.
2.1	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" %)(((
1.1	49	\\
2.1	50	)))
	51	\|(% colspan="1" %)(((
	52	Connection Apogée via WS
	53	)))\|(% colspan="1" %)(((
21.1	54	6.00.50
2.1	55	)))
	56	\|(% colspan="1" %)(((
	57	Connection LDAP
	58	)))\|(% colspan="1" %)(((
	59	\\
	60	)))
	61
	62	== Téléchargement des sources ==
	63
44.1	64	Dernière version des sources : [[hypercerts-1.0.5.1-SNAPSHOT.zip>>url:https://download-sig.univ-lorraine.fr/public/hypercerts/hypercerts-1.0.5.1-SNAPSHOT.zip\|\|shape="rect"]]
2.1	65
	66	== Installation d'Hypercerts ==
	67
27.1	68	=== Initialisation / Mise à jour de la base ===
2.1	69
39.1	70	La base hypercerts MariaDB/MySQL s'initialise / se met à jour avec la commande Flyway suivante :
2.1	71
	72	{{code language="bash" theme="Eclipse"}}
	73	mvn -Dflyway.configFiles=flyway.properties flyway:migrate
	74	{{/code}}
	75
33.1	76	Le fichier flyway.properties doit être créé à partir du fichier exemple flyway-sample.properties. Il contient les properties standard à Flyway.
2.1	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
36.1	92	Au besoin, les fichiers sql de migration peuvent être trouvés sous src/main/resources/db/migration.
2.1	93
39.1	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//.//
2.1	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
33.1	100	Des indications sont présentes dans le fichier pour aider à sa configuration ou ci-dessous.
2.1	101
33.1	102	=== Maven / Exécution de l'application ===
2.1	103
39.1	104	* Sous un IDE, exemple Eclipse//, //avec le fichier de configuration à la racine :
33.1	105	** (% style="color: rgb(0,0,0);" %)Clic droit sur "Application.java > Run As > Java Application"
39.1	106	* Lancer l'application (hors d'un IDE),// //avec fichier de configuration à la racine :
32.1	107
33.1	108	{{code language="bash" theme="Eclipse"}}
	109	mvn spring-boot:run
	110	{{/code}}
32.1	111
33.1	112	* Lancer les tests :
32.1	113
33.1	114	{{code language="bash" theme="Eclipse"}}
	115	mvn verify
	116	{{/code}}
32.1	117
33.1	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
36.1	130	== (% style="letter-spacing: -0.006em;" %)Configuration(%%) ==
33.1	131
34.1	132	=== Property //app.production// ===
2.1	133
39.1	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.
2.1	135
39.1	136	En étant à false, cette property autorise également la configuration de l'interception de tous les mails applicatifs.
2.1	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
13.1	143	* ou de configurer l'application pour intercepter tous les mails applicatifs avec ces valeurs :
	144	app.production** à //false//
	145	spring.mail.intercept.active** à //true//
2.1	146	et spring.mail.intercept.mails** contenant une ou plusieurs adresses de réception des mails
	147
36.1	148	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.
2.1	149
42.1	150	=== Envoi des attestations aux étudiants ===
	151
	152	Les attestations peuvent être envoyées aux étudiants par mail __et/ou__ sur Digiposte.
	153
	154	Pour activer l'envoi par mail, mettre la property app.useMailDelivery à true.
	155
	156	Pour activer l'envoi sur Digiposte, mettre la property app.usingDigiposteDelivery à true.
	157
	158	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.
	159
	160	Ce qui affichera le choix suivant dans l'interface pour tous les gestionnaires :
	161
	162	[[image:attach:image2021-3-19_12-1-4.png\|\|width="1020"]]
	163
34.1	164	=== WebServices Apogée ===
2.1	165
	166	Les WebServices Apogée sont appelés par l'intermédiaire d'une librairie UL.
	167
36.1	168	Les properties différent du classique fichier de configuration configUrlServices.properties de l'AMUE.
2.1	169
36.1	170	Des headers peuvent être ajoutés en paramètre de chaque WebServices.
2.1	171
	172	Exemple :
	173
	174	{{code language="bash" theme="Eclipse" linenumbers="true" collapse="true"}}
	175	ws:
	176	apogee:
	177	administratif:
	178	url: https://api.univ.fr/apo/amue_apo_administratif
	179	headers:
	180	# header1: value1
	181	# header2: value2
	182	username: xxxx
	183	password: xxxx
	184	{{/code}}
	185
35.1	186	=== Customisation des templates de mail ===
	187
37.1	188	Les properties suivantes servent à indiquer les templates personnalisés :
35.1	189
37.1	190	* spring.mail.templateName.attestation : pour le mail à destination de l'étudiant contenant l'attestation
	191	* spring.mail.templateName.creationDigiposte : pour le mail à destination de l'étudiant envoyé après la création du coffre Digiposte
	192	* spring.mail.templateName.creationCampagne : pour le mail d'une nouvelle campagne (à destination du gestionnaire qui a lancé la campagne)
	193	* spring.mail.templateName.reportCampagne : pour le mail de rapport de campagne (à destination du gestionnaire qui a lancé la campagne)
	194
	195	❓ Par défaut, les valeurs sont vides et les templates par défaut de l'application sont utilisés
	196
38.1	197	Pour customiser un template :
	198
	199	* Copier et renommer un template HTML présent sous src/main/resources/templates
	200	* Par exemple pour le mail d'attestation :
	201	Renommer mail-attestation.html en mail-attestation-custom.html**
	202	** Adapter le template
	203	Dans la config, saisir spring.mail.templateName.attestation : mail-attestation-custom.html**
	204
2.1	205	=== Customisation des services ===
	206
	207	Plusieurs services sont personnalisables en fonction de votre environnement.
	208
36.1	209	Sous fr.univlorraine.hypercerts.apogee.service.customs :
2.1	210
36.1	211	* **ApogeeUtilisateurServiceCustomExample//
	212	//**
25.1	213	** Personnalisation de la récupération des adresses mails des utilisateurs Apogée à partir de l'uid Apogée
36.1	214	* **ApogeeBlocageServiceCustomExample//
	215	//**
2.1	216	** Personnalisation de la récupération des blocages/interdits à partir d'un code étudiant Apogée
36.1	217	* **ApogeeComposanteServiceCustomExample//
	218	//**
2.1	219	** Personnalisation de la récupération :
15.1	220	*** de toutes les composantes
	221	**** → utilisé pour donner les droits sur toutes les composantes aux super admins
25.1	222	*** des composantes pour un utilisateur à partir de l'uid Apogée
	223	*** du nombre de composantes pour un utilisateur à partir de l'uid Apogée
36.1	224	* ApogeeUidServiceCustomExample\\
25.1	225	** Personnalisation de la récupération de l'uid Apogée d'un utilisateur à partir de son uid Ldap
2.1	226
15.1	227	(% style="color: rgb(0,51,102);" %)__Pour personnaliser un de ces services :__
2.1	228
	229	1. Copier la classe en la renommant
	230	1. Implémenter la ou les méthodes
	231	11. Vous êtes libre de créer des repositories ou d'utiliser l'entityManager directement
	232	1. (((
	233	Dé-commenter les 2 annotations :1. (((
36.1	234	@Service → Pour que Spring implémente le Service au démarrage
2.1	235	)))
	236	1. (((
36.1	237	et @OverrideXXX → Pour que l'implémentation surcharge le service par défaut
2.1	238	)))
	239	)))
	240	1. Au démarrage de l'application
	241	11. Une ligne "//Overriding XXX for YYY implementation//" doit apparaître dans les logs
25.1	242	1. Sans IDE, penser à ajouter les imports suivant :
	243	11. import org.springframework.stereotype.Service;
37.1	244	11. import fr.univlorraine.hypercerts.apogee.services.annotations.OverrideXXX;
15.1	245	\\
2.1	246
15.1	247	{{code language="java" theme="Eclipse" title="Exemple" linenumbers="true" collapse="true"}}
2.1	248	/**
26.1	249	* Override default ApogeeUtilisateurService implementation.
2.1	250	* >> README
26.1	251	* Décommenter l'annotation @Service pour que le service soit instancié et l'annotation @OverrideApogeeUtilisateurService pour que l'implémentation soit utilisée.
2.1	252	*
	253	* @author Matthieu Manginot
	254	*/
	255	@NoArgsConstructor
	256	@Slf4j
26.1	257	// @Service
	258	// @OverrideApogeeUtilisateurService
	259	public class ApogeeUtilisateurServiceCustomExample implements IApogeeUtilisateurService {
2.1	260
	261	@PersistenceContext(unitName = "apogeeEntityManagerFactory")
	262	private EntityManager entityManagerApogee;
	263
	264	@PostConstruct
	265	public void init() {
26.1	266	log.info("Overriding {} for IApogeeUtilisateurService implementation", getClass().getCanonicalName());
2.1	267	}
	268
	269	/**
26.1	270	* @see fr.univlorraine.hypercerts.apogee.services.IApogeeUtilisateurService#getMail(java.lang.String)
2.1	271	*/
	272	@Override
26.1	273	public String getMail(final String uidApogee) {
	274	/* Implémentation personnalisée de getMail. entityManagerApogee.createNativeQuery... */
	275	return null;
2.1	276	}
	277	}
	278	{{/code}}
	279
40.1	280	=== Configuration de Digiposte ===
2.1	281
40.1	282	Dans application.yaml sous digiposte.*
	283
	284	* digiposte
	285	codeDistributeur** : Code distributeur Digiposte (fourni par Digiposte)
	286	codeEmetteur** : Code emetteur Digiposte (PID) (fourni par Digiposte)
	287	type** : Type de campagne : en mode OPT-IN = PREINSCRIPTION ou mode OPT-OUT = PREINSCRIPTION_WITH_VALIDATED_MEMBERSHIP (param Digiposte)
	288	sendMailHypercerts** : Envoi du mail Hypercerts pour informer l'étudiant qu'un coffre Digiposte est crée
	289	docDigiposteEtudiant** : Url de la documentation Digiposte pour les étudiants présente dans le mail d'information
	290	sendMailDigiposte** : Envoi du mail Digiposte : 'YES' ou 'NO' (param Digiposte)
	291	checkMailMode** : Vérification du mail : mail vérifié par l'émetteur = CHECKED ou mail non vérifié = INFORMATION (param Digiposte)
	292	urlAccesDirect** : Urls d'accès direct à Digiposte pour les adhésions ou les résiliations\\
	293	* adhesions** : Url pour les adhésions directes
	294	* resiliations** : Url pour les résiliations directes
	295	adhesions** : Configuration de l'envoi des adhésions (création des coffres)\\
	296	* ftp** : Connexion au sftp Digiposte des adhésions
	297	* ws** : Connexion au ws Digiposte
	298	routages** : Configuration de l'envoi des routages (dépôt des attestations dans les coffres)
	299	* ftp **: Connexion au sftp Digiposte des routages
	300	* publisher** : Configuration du publisher : Clé publique pour la sécurisation des routages
41.1	301	\\
40.1	302
41.1	303	{{info}}
	304	Une fois configuré, il faudra activer Digiposte avec la property app.usingDigiposteDelivery : true
	305	{{/info}}
	306
39.1	307	\\
2.1	308
41.1	309	\\
	310
40.1	311	----
	312
34.1	313	== (% style="letter-spacing: -0.006em;" %)Administration(%%) ==
2.1	314
9.1	315	Les super admins ont accès à des vues supplémentaires. Des onglets pour ces dernières apparaissent dans le panneau de gauche.
	316
8.1	317	=== Gestion ===
	318
	319	\\
	320
	321	\|=(((
	322	Vue
	323	)))\|=(((
	324	Utilisation
	325	)))
	326	\|(((
	327	(% class="content-wrapper" %)
	328	(((
31.1	329	[[image:attach:image2021-2-23_10-42-24.png\|\|height="400"]]
8.1	330	)))
	331	)))\|(((
	332	Cette vue permet de lancer les tâches qui s’exécutent automatiquement de façon manuelle.
	333
	334	Trigger CRON jobs permet de lancer toutes les tâches de dématérialisation jusqu'à ce qu'elles aboutissent toutes.
	335
	336	On peut aussi utiliser des boutons pour lancer plus finement des tâches.
	337
	338	À noter que si l'application n'est pas configurée pour utiliser Digiposte, les boutons sous Digiposte n'auront pas d'effet.
	339	)))
16.1	340
	341	=== Loggers ===
	342
	343	\\
	344
	345	\|=(((
	346	Vue
	347	)))\|=(((
	348	Utilisation
	349	)))
	350	\|(((
	351	(% class="content-wrapper" %)
	352	(((
31.1	353	[[image:attach:image2021-2-23_10-42-53.png\|\|height="400"]]
16.1	354	)))
	355	)))\|(((
	356	Cette vue permet de modifier à chaud sans re-démarrage le niveau de logs de tout les loggers de l'application.
	357
31.1	358	Utile pour par exemple afficher les requêtes SQL (filtre: sql) ou des logs plus précis en fonction des classes/packages.
16.1	359	)))

Code source wiki de 01 - Documentation technique

Arborescence des pages

Pour vous aider