DocScoDoc/docs/AssiduitesDev.md

Module Assiduité

!!! warning Attention vous vous trouvez sur la documentation Développeur du module Assiduité.

La documentation utilisateur est [ici](Assiduites.md).

Le module Assiduité est le nouveau module introduit en 9.6 permettant la saisie précise de l'assiduité des étudiants et étudiantes.

Ce module a été développé par Matthias HARTMANN, pendant son alternance entre 2022 et 2024 (alternance financée par l'association ScoDoc) et remplace l'ancien module Absence.

Représentation en BDD

Le module Assiduité introduit deux nouveaux objets à la base ScoDoc :

• Assiduite : l'objet représentant une assiduité (absent,retard,present)
• Justificatif : l'objet représentant un justificatif (permet de justifier ou non une assiduité / plusieurs assiduités)

La modélisation est gérée dans le fichier app/models/assiduites.py.

Représentation de l'Assiduité

Le tableau si dessous reprend la représation des données d'une assiduité.

!!! warning Dans ScoDoc, l'heure affichée doit être celle affichée sur la montre des étudiants.

Assurez vous que la **timezone** du serveur soit la bonne.

champs	type	commentaire
id / assiduite_id	Integer	L'identifiant de l'assiduité
date_debut	DateTimeTZ	La date (+heure) de début de l'assiduité. Doit avoir une TIMEZONE
date_fin	DateTimeTZ	La date (+heure) de fin de l'assiduité. Doit avoir une TIMEZONE
etudid	Integer	L'identifiant de l'étudiant concerné par l'assiduité (clé externe)
moduleimpl_id	Integer	L'identifiant du moduleimpl concerné par l'assiduité. (plus d'infos) Peut être None (clé externe)
etat	Integer	L'état de l'assiduité (plus d'infos)
description	Text	La description de l'assiduité Peut être None
entry_date	DateTimeTZ	La date (+heure) de saisie de l'assiduité. Doit avoir une TIMEZONE. Par défaut à la date actuelle
user_id	Integer	L'identifiant de l'utilisateur qui a saisie l'assiduité. Peut être None (clé externe)
est_just	Boolean	Indique si l'assiduité est justifiée
external_data	JSON	Champs de données JSON peu utilisées dans ScoDoc même mais facilite la vie aux utilisateurs de l'API Peut être None

!!! tip Il est conseillé d'utiliser les méthodes du modèle Assiduité afin de créer / éditer / supprimer une assiduité.

Etats d'assiduité

!!! info Une classe EtatAssiduite simplifiant la traduction ETAT ↔ VALEUR est disponible dans app/scodoc/sco_utils.py

état	valeur
PRESENT	0
RETARD	1
ABSENT	2

!!! warning Seules les assiduités RETARD et ABSENT peuvent être justifiées.

Etudiants

Chaque assiduité est obligatoirement associée à un étudiant (Identite). Il est possible de récupérer toutes les assiduités d'un étudiant en utilisant la relation à partir du modèle Identite.

etudiant : Identite = Identite.get_etud(1234)
assiduites_etud : Query = etudiant.assiduites

# Identite.assiduites est une query et permet donc les filtrages etc.

# Première absence
prem_abs: Assiduite = assiduites_etud.filter(
    Assiduite.etat == scu.EtatAssiduite.ABSENT
).first()

ModuleImpl

Une assiduité peut être reliée à un ModuleImpl à l'aide du moduleimpl_id.

Cependant suite à une demande des utilisateurs, il existe un FAUX module nommé autre. Ce module permet de contourner la sécurité de la préférence forcer la saisie d'un module dans le cas où la saisie d'assiduité n'est pas directement en lien avec un module enregistré dans ScoDoc.

!!! warning Ce FAUX module n'est pas inscrit dans le moduleimpl_id mais dans external_data.

Voici le format de `external_data` : 
```json
{
    "module":"Autre",
    "cle-non-scodoc" : "valeur-non-scodoc"
}
```

Des fonctions ont été rédigées pour faciliter la gestion de ce FAUX module. Elles sont toutes disponibles dans la classe de l'objet Assiduité. (voir le code)

• get_module : récupère (si existant) le module associé à l'assiduité

  • Si module ScoDoc : renvoie l'objet Module (ou le titre du module si la traduction est active)
  • Si module external_data:Autre : renvoie la chaîne Autre module (pas dans la liste)
  • Si module external_data:? : renvoie la valeur liée à la clé "module" de external_data
  • Si pas de module : renvoie None (ou Module non spécifié si la traduction est active)

• get_moduleimpl_id : récupère (si existant) le moduleimpl_id associé à l'assiduité (comprend le module autre)

  • Si moduleimpl ScoDoc : renvoie l'id du moduleimpl
  • Si module dans external_data : renvoie la valeur liée à la clé "module" de external_data
  • Si pas de module : renvoie None

• set_moduleimpl_id : permet de mettre à jour le moduleimpl_id (prend en compte le module autre)

  On peut donner :

  • <int/str:moduleimpl_id> : l'identifiant d'un moduleimpl
  • "autre" : le module autre
  • "" : pas de module

Représentation du Justificatif

Le tableau si dessous reprend la représation des données d'un justificatif.

!!! warning Dans ScoDoc, l'heure affichée doit être celle affichée sur la montre des étudiants.

Assurez vous que la **timezone** du serveur soit la bonne.

champs	type	commentaire
id / justif_id	Integer	L'identifiant du justificatif
date_debut	DateTimeTZ	La date (+heure) de début du justificatif. Doit avoir une TIMEZONE
date_fin	DateTimeTZ	La date (+heure) de fin du justificatif. Doit avoir une TIMEZONE
etudid	Integer	L'identifiant de l'étudiant concerné par le justificatif (clé externe)
etat	Integer	L'état du justificatif(plus d'infos)
raison	Text	La raison du justificatifPeut être None
entry_date	DateTimeTZ	La date (+heure) de saisie du justificatif. Doit avoir une TIMEZONE. Par défaut à la date actuelle
user_id	Integer	L'identifiant de l'utilisateur qui a saisie le justificatif. Peut être None (clé externe)
fichier	Text	l'identifiant de l'archive justificatif si existante (plus d'infos)
external_data	JSON	Champs de données JSON non utilisé dans ScoDoc mais facilite la vie aux utilisateurs de l'API Peut être None

!!! tip Il est conseillé d'utiliser les méthodes du modèle Justificatif afin de créer / éditer / supprimer un justificatif.

Etats de Justificatif

!!! info Une classe EtatJustificatif simplifiant la traduction ETAT ↔ VALEUR est disponible dans app/scodoc/sco_utils.py

état	valeur
VALIDE	0
NON_VALIDE	1
ATTENTE	2
MODIFIE	3

!!! warning Seul l'état VALIDE permet de justifier des assiduités. Les autres états permettent d'organiser le travail administratif.

Etudiants

Chaque justificatif est obligatoirement associé à un étudiant (Identite). Il est possible de récupérer tous les justificatifs d'un étudiant en utilisant la relation à partir du modèle Identite.

etudiant : Identite = Identite.get_etud(1234)
justificatifs_etud : Query = etudiant.justificatifs

# Identite.justificatifs est une query et permet donc les filtrages etc.

# Première justificatif valide
prem_abs: Justificatif = justificatifs_etud.filter(
    Justificatif.etat == scu.EtatJustificatif.VALIDE
).first()

Fonctionnements des Assiduités

Cache

Métriques

Les métriques d'assiduités permettent le suivi de l'assiduité d'un étudiant avec plusieurs niveaux de précisions.

Il existe 4 métriques :

• compte : un simple comptage du nombre d'assiduités sans autre calcul
• journee : le calcul du nombre de journées concernées par les assiduités (chaque journée n'est comptée qu'une fois)
• demi : le calcul du nombre de demi-journées concernées par les assiduités (chaque demi-journée n'est comptée qu'une fois)
• heure : le calcul du nombre d'heures concernées par les assiduités.

Ces calculs sont réalisés grâce à la classe CountCalculator trouvable dans app/scodoc/sco_assiduites.py.

Il n'est pas nécessaire de créer un objet CountCalculator à chaque fois que vous voulez un calcul. Vous pouvez utiliser directement la fonction sco_assiduites.py#get_assiduites_stats.

!!! warning Les métriques sont utilisées dans les bulletins, sidebar et bilan.

Ces valeurs utilisent le [cache](#cache).

Permissions

Les fonctions relatives aux assiduités utilisent les permissions suivantes :

• AbsChange : permet de créer / éditer / supprimer les assiduités
• AbsJustifView : permet de voir les informations (descriptions) des assiduités (données personnelles cachées par défaut)

Fonctionnements des Justificatifs

Permissions

Les fonctions relatives aux justificatifs utilisent les permissions suivantes :

• AbsChange : permet de créer / éditer / supprimer les justificatifs
• AbsJustifView : permet de voir les informations (raison, fichiers) des justificatifs (données personnelles cachées par défaut)
• JustifValidate : permet de changer l'état d'un justificatif de Attente à Valide / Non Valide / Modifie

Gestion des archives justificatives

L'ensemble des fonctionnalités relatives aux archives justificatives (fichiers importés) est disponible dans le fichier app/scodoc/sco_archives_justificatifs.py

!!! note Le système global d'archive est disponible ici

Les archives sont enregistrées dans le dossier `/opt/scodoc-data/archives/`.

Voici la représentation de l’arborescence des fichiers justificatifs:

justificatif/
        └── <dept_id>/
            └── <etudid/oid>/
                └── <archive_id>/
                    ├── [_description.txt]
                    ├── [<filename.ext>]
                    └── [_trace.csv]

Les archives sont organisées par département, puis par étudiant.

Archive

L'archive_id est une chaîne de caractère générée à l'importation d'un fichier. Il s'agit de la date courante au format yyyy-mm-dd-hh-MM-ss.

!!! info Il existe une archive par justificatif (ayant au moins un fichier importé).

Une archive peut contenir plusieurs fichiers. Chaque fichier est renommé de façon à avoir un nom `serveur` (ascii sans espacement).

_description.txt

Le fichier _description.txt est généré par l'archiveur global mais n'est pas utilisé ici. (le fichier est vide)

_traces.csv

Le fichier _trace.csv est un fichier de log généré par l'archiveur. Il permet de tenir un registre des actions qui ont été effectuées sur l'archive. (Il est géré par sa propre classe Trace dans app/scodoc/sco_archives_justificatifs.py)

Son contenu est un CSV de la forme :

nom_fichier_srv,datetime_depot,datetime_suppr,user_id

• nom_fichier_srv : nom du fichier tel qu'il est enregistré sur le serveur
• datetime_depot : datetime au format iso indiquant la date de dépot du fichier
• datetime_suppr : datetime au format iso indiquant la date de suppression du fichier (par défaut None)
• user_id : identifiant de l'utilisateur ayant déposé le fichier.

!!! info le champs user_id est utilisé par ScoDoc pour afficher au non le fichier aux utilisateurs.

Seuls l'utilisateur qui a importé le fichier et ceux ayant la permission `JustifView` peuvent voir le fichier.

Gestion des fichiers

La classe JustificatifArchiver possède plusieurs fonctions pour simplifier la gestion des fichiers.

• save_justificatif : enregistre un fichier pour un étudiant. Génère l'archive si elle n'existe pas. Génère le fichier trace s'il n'existe pas et log le fichier. Renvoie le nom de l'archive et le nom du fichier (traduit en nom serveur).
• delete_justificatif : supprime un fichier d'une archive d'un étudiant. (Ajoute à la trace l'action). Si on ne donne pas de nom de fichier, supprime l'archive (et donc tous ses fichiers).
• list_justificatifs : retourne la liste des fichiers avec l'user_id de l'importateur.
• get_justificatif_file : renvoie une réponse de téléchargement (pour les vues) du fichier demandé.
• remove_dept_archive : supprime toutes les archives d'un département, supprime aussi toutes les traces