Bulletins JSON avec matières (long_mat) et autres modifs

This commit is contained in:
Emmanuel Viennet 2022-11-27 23:39:48 +01:00
parent 383ddb1b4f
commit 6799937445
4 changed files with 116 additions and 57 deletions

View File

@ -1,5 +1,5 @@
# Edition des bulletins de notes
# Édition des bulletins de notes
Vous pouvez obtenir les bulletins de notes en différents formats:
@ -7,13 +7,15 @@ Vous pouvez obtenir les bulletins de notes en différents formats:
* fichier PDF (dit "version papier", car très pratique pour l'impression)
* données XML (pour interfaçage avec d'autres logiciels, comme par exemple le portail utilisé par les étudiants)
Vous pouvez aussi générer des classeurs PDF, documents regroupant tous les bulletins des étudiants d'un semestre, c'est utile pour imprimer tous les bulletins ou les archiver.
* données JSON ou XML (pour interfaçage avec d'autres logiciels, comme par
exemple la "passerelle" utilisée par les étudiants)
Vous pouvez aussi générer des classeurs PDF, documents regroupant tous les
bulletins des étudiants d'un semestre, c'est utile pour imprimer tous les
bulletins ou les archiver.
## Versions courtes, intermédiaires, longues
Les bulletins sont disponibles en trois versions:
* **version courte**: montre les moyennes d'UE et de modules, mais pas les notes des évaluations.
@ -22,29 +24,33 @@ Les bulletins sont disponibles en trois versions:
* **version longue**: montre les moyennes d'UE et de modules, et toutes les évaluations.
## Informations sur les bulletins
Voici un exemple de bulletin en version courte. Dans ce cas, vous constaterez que les noms abrégés des modules n'ont pas été choisis de façon très pertinente (ils sont redondants et peu compréhensibles). Les noms et codes de modules et d'UE peuvent être changés dans le programme pédagogique.
Voici un exemple de bulletin en version courte. Dans ce cas, vous constaterez
que les noms abrégés des modules n'ont pas été choisis de façon très pertinente
(ils sont redondants et peu compréhensibles). Les noms et codes de modules et
d'UE peuvent être changés dans le programme pédagogique.
![bulletin-info-short.png](screens/bulletin-info-short.png)
**Note:** les exemples présentés ici correspondent à une version très ancienne
de ScoDoc !
Le bulletin en version longue montre les notes obtenues aux différentes évaluations (contrôles et examens):
![bulletin-info-long.png](screens/bulletin-info-long.png)
Les UE capitalisées (acquises lors des semestres redoublés, [[CapitalisationUE| voir explications ici]]) sont automatiquement prises en compte sur
les bulletins, comme on le voit dans cet exemple:
![bulletin-ue-capitalisee-legend.png](screens/bulletin-ue-capitalisee-legend.png).
## Choix des informations à afficher
Le choix des informations affichées sur les bulletins est effectué via des options s'appliquant à tous les bulletins d'un semestre. Seul le responsable du semestre (directeur des études) et les responsables supérieurs peuvent changer ces options.
Le choix des informations affichées sur les bulletins est effectué via des
options s'appliquant à tous les bulletins d'un semestre. Seul le responsable du
semestre (directeur des études) et les responsables supérieurs peuvent changer
ces options.
Utiliser le menu "Réglages bulletins" depuis le tableau de bord semestre.
@ -52,7 +58,8 @@ Les options sont:
* *indiquer les absences* : indique le nombre d'absences
* *faire figurer les décisions* : afficher la décision du jury. Il est conseillé de n'activer cette option qu'après le jury définitif.
* *faire figurer les décisions* : afficher la décision du jury. Il est conseillé
de n'activer cette option qu'après le jury définitif.
* *afficher codes des modules*
@ -62,43 +69,65 @@ Les options sont:
* *faire figurer les UE validées sur les bulletins* : code jury des UE
* *publier le bulletin sur le portail étudiants*: contrôle l'export XML des bulletins, utilisé par le portail étudiant. Désactiver si vous ne voulez pas que les étudiants puisse lire leurs bulletins.
* *publier le bulletin sur le portail étudiants*: contrôle l'export XML des
bulletins, utilisé par le portail étudiant. Désactiver si vous ne voulez pas
que les étudiants puisse lire leurs bulletins.
* *Bannière "provisoire" sur les bulletins*: affiche la mention "Provisoire" (ou le message saisi) en filigrane
* *Bannière "provisoire" sur les bulletins*: affiche la mention "Provisoire" (ou
le message saisi) en filigrane.
* *Bannière "provisoire" si pas de décision de jury*: affiche la mention "Provisoire" en filigrane sur les bulletins quand il n'y a pas encore de décision de jury.
* *Bannière "provisoire" si pas de décision de jury*: affiche la mention
"Provisoire" en filigrane sur les bulletins quand il n'y a pas encore de
décision de jury.
* *Texte de la bannière "provisoire*: le texte à afficher en filigrane sur les bulletins provisoires.
* *Texte de la bannière "provisoire*: le texte à afficher en filigrane sur les
bulletins provisoires.
## Mise en page des bulletins PDF et autres réglages
Vous pouvez agir sur la mise en page des bulletins PDF en passant par la page "Réglages des bulletins de notes": suivre en bas de cette page le lien *Réglage de la mise en page et envoi mail des bulletins*.
Vous pouvez agir sur la mise en page des bulletins PDF en passant par la page
"Réglages des bulletins de notes": suivre en bas de cette page le lien *Réglage
de la mise en page et envoi mail des bulletins*.
Les paramètres réglables sont:
* marges additionnelles, exprimées en millimètres, étant entendu que le tableau de notes est toujours redimensionné pour occuper tout l'espace disponible entre les marges de la feuille, et tenir sur une page (c'est pourquoi un bulletin très long sera écrit plus petit qu'un bulletin court).
* titre des bulletins (typiquement `Université Paris 13 - IUT de Villetaneuse - Département %(DeptName)s`). Le symbole `%(DeptName)s` est remplacé par le nom du département.
* marges additionnelles, exprimées en millimètres, étant entendu que le tableau
de notes est toujours redimensionné pour occuper tout l'espace disponible
entre les marges de la feuille, et tenir sur une page (c'est pourquoi un
bulletin très long sera écrit plus petit qu'un bulletin court).
* titre des bulletins (typiquement `Université Paris 13 - IUT de Villetaneuse -
Département %(DeptName)s`). Le symbole `%(DeptName)s` est remplacé par le nom
du département.
* message texte accompagnant les bulletins envoyés par courrier électronique (mail).
Les champs des bulletins de notes PDF peuvent être paramétrés assez finement, voir [ParametrageBulletins](ParametrageBulletins.md).
Les développeurs peuvent coder (en Python) de nouveaux formats de bulletins. Voir la documentation sur [ApiGenerationBulletinsPdf](ApiGenerationBulletinsPdf.md).
Les champs des bulletins de notes PDF peuvent être paramétrés assez finement,
voir [ParametrageBulletins](ParametrageBulletins.md). Les développeurs peuvent
coder (en Python) de nouveaux formats de bulletins. Voir la documentation sur
[ApiGenerationBulletinsPdf](ApiGenerationBulletinsPdf.md).
## Classeurs PDF
Pour générer un fichier PDF regroupant tous les bulletins (une page par bulletin), utiliser le menu "bulletins" du tableau de bord semestre.
Pour générer un fichier PDF regroupant tous les bulletins (une page par
bulletin), utiliser le menu "bulletins" du tableau de bord semestre.
## Expédition par mail
ScoDoc vous permet d'envoyer par courrier électronique un bulletin à un étudiant. Pour cela, l'adresse mail de l'étudiant doit avoir été renseignée et être valide (voir la [FicheEtudiant](FicheEtudiant.md)).
Le mail contient un petit texte expliquant que le bulletin n'a pas de valeur officielle (seule la version distribuée après le jury fait foi), et le bulletin PDF en pièce jointe.
Le mail contient un petit texte expliquant que le bulletin n'a pas de valeur
officielle (seule la version distribuée après le jury fait foi), et le bulletin
PDF en pièce jointe.
Vous pouvez envoyer un bulletin via le menu "Autres opérations" de la page affichant le bulletin.
Vous pouvez aussi envoyer tous les bulletins par mail (chaque étudiant du semestre reçoit seulement le sien), via le menu "Bulletins" du semestre.
Voici un exemple du message envoyé aux étudiants avec leur bulletin:
```
M. Pierre Dupont,
@ -110,4 +139,5 @@ Pour toute question sur ce document, contactez votre enseignant ou le directeur
Cordialement,
la scolarité du département XXX.
```
(le contenu de ce message est paramétrable, voir ci-dessus).

View File

@ -38,11 +38,14 @@ apparait immédiatement sur la page d'accueil.
### Suppression d'un département
Opération très rarement nécessaire, proposée pour corriger une erreur
immédiatement après la création.
immédiatement après la création, et pour les tests.
flask delete-dept DEPT
flask delete-dept [-f] [--yes] DEPT
-f, --force: ignore département non existant
--yes : ne demande pas confirmation
### Création d'un utilisateur
Cette opération s'effectue en général depuis le logiciel, via un formulaire
ou un import Excel. Pour créer un utilisateur depuis le terminal, lancer:

View File

@ -1,24 +1,41 @@
# En cas de problèmes avec [coDoc
# En cas de problèmes avec ScoDoc
## Envoi des données "assistance"
Cette fonction est accessible via un lien en bas de la page d'accueil des
départements. Elle déclenche la copie de la base de données, son anonymisation
(suppression des informations permettant d'identifier les étudiants: les champs
sont effacés ou remplacés par des valeurs aléatoires), et son envoi vers le
serveur des développeurs ScoDoc pour analyse. Il est recommandé d'indiquer les
circonstances du problème rencontré ou de contacter les développeurs sur le salon
Discord.
## Diagnostic détaillé (pour les administrateurs)
Informations destinées aux administrateurs ayant un accès direct (ssh, root) au serveur.
## Récupération et envoi d'informations de diagnostic
Un script permet de générer quelques informations sur votre configuration pour les envoyer aux développeurs: logs, modifications du code source, version Linux installée etc.
Aucune information personnelle ou confidentielle exploitable n'est transmise.
Un script permet de générer quelques informations sur votre configuration pour
les envoyer aux développeurs: logs, modifications du code source, version Linux
installée etc.
```
# en tant que root sur le serveur:
cd /opt/scodoc/Products/ScoDoc/config
./diagnostic.sh
cd /opt/scodoc/tools
./diagnostic.sh -a -n
```
Ce script génère un fichier `tgz` et essaie de l'envoyer par mail aux développeurs.
Ce script génère un fichier `tgz`.
Si on n'indique pas l'option `-n`, il essaie immédiatement de l'envoyer par mail aux
développeurs. Il est fréquent que l'envoi de mail ne fonctionne pas: fichier
trop volumineux ou filtrage des mails. Dans ce cas, le copier et le transmettre
par un autre moyen (cloud, ...).
Ce fichier est dans `/tmp` et son nom exact est affiché par le script:
Si pour une raison ou une autre le serveur étudié n'est pas capable d'envoyer un mail vers l'extérieur, récupérer manuellement le fichier généré et l'envoyer. Ce fichier est dans /tmp et son nom exact est affiché par le script:
```ScoDoc diagnostic: informations about your system will be sent to emmanuel.viennet@univ-paris13.fr
and left in /tmp/scodoc-2016-09-05-1504631964
```

View File

@ -1154,6 +1154,15 @@ mais pas JSON compliant à cause des `NaN`.
* version `json` et `pdf` (`json` par défaut, ajoutez `/pdf` pour la version
pdf)
Pour les formations classiques (toutes sauf BUT), les bulletins JSON peut ou
non indiquer les matières. Par défaut, il est structuré en `UEs / modules`. Si
la version est `short_mat`ou `long_mat`, il sera structuré en
`UEs / matieres / modules`.
Les notes moyennes de matières ne sont calculées que si l'option
"*Afficher les matières sur les bulletins*" est activée pour le formsemestre
considéré (sinon, la note vaut toujours "*nd*"). `
* **Exemple de résultat:** [etudiant-formsemestre-bulletin.json](samples/sample_etudiant-formsemestre-bulletin.json.md)
#### **formsemestre-programme**