ScoDoc/DocScoDoc
7
2
Fork 10
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

Ajout infos connecteur Apo

Browse Source
This commit is contained in:
Emmanuel Viennet 2024-11-01 09:21:12 +01:00
parent c93a8799e4
commit 508e1b1f7e
3 changed files with 87 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/BulletinsNotes.md
View File

@ -69,8 +69,8 @@ Les options sont:
* *faire figurer les UE validées sur les bulletins* : code jury des UE * *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 * *publier le bulletin sur le passerelle étudiants*: contrôle l'export XML des
bulletins, utilisé par le portail étudiant. Désactiver si vous ne voulez pas bulletins, utilisé par la passerelle étudiant. Désactiver si vous ne voulez pas
que les étudiants puisse lire leurs bulletins. que les étudiants puisse lire leurs bulletins.
* *Bannière "provisoire" sur les bulletins*: affiche la mention "Provisoire" (ou * *Bannière "provisoire" sur les bulletins*: affiche la mention "Provisoire" (ou

2
docs/FAQ.md
View File

@ -28,7 +28,7 @@ notes des étudiants inscrits à cette évaluation sont saisies, soit parce qu'i
s'agit d'une évaluation avec "prise en compte immédiate". s'agit d'une évaluation avec "prise en compte immédiate".
Les **étudiants n'ont pas accès à ScoDoc**, et ne peuvent donc pas voir leurs Les **étudiants n'ont pas accès à ScoDoc**, et ne peuvent donc pas voir leurs
notes, sauf si une interface spécifique est configurée ("portail", avec notes, sauf si une interface spécifique est configurée ("passerelle", avec
affichage sur leur ENT en général, cet affichage pouvant être désactivé depuis affichage sur leur ENT en général, cet affichage pouvant être désactivé depuis
ScoDoc pour un semestre particulier). A défaut, il faut leur envoyer leurs ScoDoc pour un semestre particulier). A défaut, il faut leur envoyer leurs
bulletins par mail. bulletins par mail.

125
docs/InterrogationPortail.md
View File

@ -1,48 +1,52 @@
# Interface avec un "portail" externe # Interface avec un "portail" externe
ScoDoc peut interagir avec un "portail" donnant des informations sur les étudiants.
Ceci permet de synchroniser les données ScoDoc avec celles des applications
externes comme Apogée. Pour simplifier l'administration, nous avons fait le choix
d'intercaler entre ScoDoc et les applications type Apogée un "portail"
(centralisation des autorisations, etc).
Le portail interroge aussi ScoDoc (en particulier pour la publication des bulletins et pour ScoDoc peut interagir avec un "portail" donnant des informations sur les
effectuer l'export des décisions de jury vers Apogée). Voir les services offerts par ScoDoc étudiants. Ceci permet de synchroniser les données ScoDoc avec celles des
sur la page [ServicesXml](ServicesXml.md). applications externes comme Apogée. Pour simplifier l'administration, nous avons
fait le choix d'intercaler entre ScoDoc et les applications type Apogée un
"portail" (centralisation des autorisations, etc).
L'adresse du portail est indiquée dans la préférence ```portal_url``` (voir [PreferencesScoDoc](PreferencesScoDoc.md)). Le portail interroge aussi ScoDoc (en particulier pour la publication des
bulletins et pour effectuer l'export des décisions de jury vers Apogée). Voir
les services offerts par ScoDoc sur la page [ServicesXml](ServicesXml.md).
L'adresse du portail est indiquée dans la préférence ```portal_url``` (voir
[PreferencesScoDoc](PreferencesScoDoc.md)).
Le code d'interface est dans le fichier source `sco_portal_apogee.py`. Le code d'interface est dans le fichier source `sco_portal_apogee.py`.
Les trois appels suivants sont utilisés: Les trois appels suivants sont utilisés:
* `getEtud` : information sur un étudiant - `getEtud` : information sur un étudiant
* `getEtapes` : liste des étapes Apogée - `getEtapes` : liste des étapes Apogée
* `getPhoto` : image de l'étudiant - `getPhoto` : image de l'étudiant
Ces appels sont détaillés dans les sections suivantes. Ces appels sont détaillés dans les sections suivantes.
## Information sur un étudiant
### Information sur un étudiant Le portail doit fournir une méthode web `getEtud.php` qui accepte les paramètres
Le portail doit fournir une méthode web `getEtud.php` qui accepte les paramètres suivants: suivants:
- `nip` : code NIP - `nip` : code NIP
- `ine` : code INE - `ine` : code INE
- `mail` : adresse e-mail
- `nom` : nom de l'étudiant - `mail` : adresse e-mail
- `prenom` : prénom de l'étudiant - `nom` : nom de l'étudiant
- `etape` : code étape Apogée - `prenom` : prénom de l'étudiant
On peut spécifier un nombre quelconque de paramètres; `getEtud.php` recherche les étudiants - `etape` : code étape Apogée
correspondant aux critères indiqués, et renvoie du code XML:
``` On peut spécifier un nombre quelconque de paramètres; `getEtud.php` recherche
les étudiants correspondant aux critères indiqués, et renvoie du code XML:
```xml
<etudiants> <etudiants>
<etudiant> <etudiant>
<nip>20600577</nip> <nip>20600577</nip>
@ -54,8 +58,8 @@ correspondant aux critères indiqués, et renvoie du code XML:
<naissance>08/01/1990</naissance> <naissance>08/01/1990</naissance>
<ville_naissance>Brest</ville_naissance> <ville_naissance>Brest</ville_naissance>
<code_dep_naissance>29</code_dep_naissance> <code_dep_naissance>29</code_dep_naissance>
<libelle_dep_naissance>Finisterre</libelle_dep_naissance> <libelle_dep_naissance>Finisterre</libelle_dep_naissance>
<mail>melanie.bourton@xxx.univ-yyy.fr</mail> <mail>melanie.bourton@xxx.univ-yyy.fr</mail>
<address>11 Pierre Dupont</address> <address>11 Pierre Dupont</address>
@ -70,11 +74,12 @@ correspondant aux critères indiqués, et renvoie du code XML:
<anneebac>2007</anneebac> <anneebac>2007</anneebac>
<nom_lycee>nom du lycée</nom_lycee> <nom_lycee>nom du lycée</nom_lycee>
<ville_lycee>ville lycée</ville_lycee> <ville_lycee>ville lycée</ville_lycee>
<codepostal_lycee>code postal lycée</codepostal_lycee> <codepostal_lycee>code postal lycée</codepostal_lycee>
<datefinalisationinscription>10/07/24</datefinalisationinscription>
<paiementinscription>true</paiementinscription> <paiementinscription>true</paiementinscription>
<bourse>N</bourse> <bourse>N</bourse>
</etudiant> </etudiant>
<etudiant> <etudiant>
@ -84,16 +89,47 @@ correspondant aux critères indiqués, et renvoie du code XML:
</etudiants> </etudiants>
``` ```
Les champs `<lycee>` (code du lycée), `<bac>` (intitulé du bac), `<mention>`, `<anneebac>` et `<paiementinscription>` sont optionnels. Les champs `<lycee>` (code du lycée), `<bac>` (intitulé du bac), `<mention>`,
`<anneebac>` et `<paiementinscription>` sont optionnels.
Le champ `<bac>` est un libellé, en général de la forme "ES-Economique et social". ScoDoc considère la première partie du libellé, jusqu'au caractère '-' comme la série du bac (uniquement si elle fait moins de 8 caractères). Le reste est alors considéré comme la "spécialité" du bac. Voir [DonneesAdmissions](DonneesAdmissions.md). Le champ `<bac>` est un libellé, en général de la forme "ES-Economique et
social". ScoDoc considère la première partie du libellé, jusqu'au caractère '-'
comme la série du bac (uniquement si elle fait moins de 8 caractères). Le reste
est alors considéré comme la "spécialité" du bac. Voir
[DonneesAdmissions](DonneesAdmissions.md).
Le champ `<paiementinscription>` (optionnel) vaut "true" ou "false" pour indiquer si l'étudiant a réglé ses frais d'inscription ou non. Le champ `<paiementinscription>` (optionnel) vaut "true" ou "false" pour
indiquer si l'étudiant a réglé ses frais d'inscription ou non.
### Champs spécifiques à Apogée
Les champs suivant sont optionnels et donnent des informations spécifiques à
Apogée:
```xml
<cod_stu>01</cod_stu>
<cod_rgi>1</cod_rgi>
<tem_brs_iaa>O</tem_brs_iaa>
<eta_edt_crt>E</eta_edt_crt>
<dat_edt_crt>10/07/24</dat_edt_crt>
<cod_pru>NO</cod_pru>
<cod_dip>VBTCYB</cod_dip>
<cod_etp>V2CYB</cod_etp>
<tem_rgl_sit_mil>O</tem_rgl_sit_mil>
```
Notes :
- `dat_edt_crt` est en principe la même chose que `datefinalisationinscription`:
ce champ est vide si l'étudiant n'a pas finalisé son incription.
### Liste des étapes Apogée ## Liste des étapes Apogée
`getEtapes.php` (pas de paramètres) renvoie un doc XML décrivant les étapes Apogée en cours. L'URL est paramétrable dans les préférences de ScoDoc.
La structure est la suivante: `getEtapes.php` (pas de paramètres) renvoie un doc XML décrivant les étapes
Apogée en cours. L'URL est paramétrable dans les préférences de ScoDoc. La
structure est la suivante:
``` ```
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<etapes> <etapes>
@ -110,10 +146,16 @@ La structure est la suivante:
... ...
</etapes> </etapes>
``` ```
Le code département (cj ou rt dans l'exemple ci-dessous) est arbitraire et utilisé par ScoDoc pour ne présenter à l'utilisateur que les étapes de son département (voir la propriété *code du département sur le portail* dans les paramètres).
On peut aussi présenter une liste sans section par département, comme ceci: (cocher la préférence indiquant le format dans ScoDoc) Le code département (cj ou rt dans l'exemple ci-dessous) est arbitraire et
``` utilisé par ScoDoc pour ne présenter à l'utilisateur que les étapes de son
département (voir la propriété *code du département sur le portail* dans les
paramètres).
On peut aussi présenter une liste sans section par département, comme ceci:
(cocher la préférence indiquant le format dans ScoDoc)
```xml
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<etapes> <etapes>
<etape code="V1XY">DUT CJ - Première Année</etape> <etape code="V1XY">DUT CJ - Première Année</etape>
@ -122,10 +164,11 @@ On peut aussi présenter une liste sans section par département, comme ceci: (c
</etapes> </etapes>
``` ```
### Image de l'étudiant ## Image de l'étudiant
`getPhoto.php` accepte le paramètre suivant: `getPhoto.php` accepte le paramètre suivant:
- `nip` : code NIP - `nip` : code NIP
et renvoie une image de l'étudiant (dans l'un des formats supportés par les navigateurs web). et renvoie une image de l'étudiant (dans l'un des formats supportés par les navigateurs web).
Si l'image ou l'étudiant n'existe pas, un code HTTP 404 peut être renvoyé. Si l'image ou l'étudiant n'existe pas, un code HTTP 404 peut être renvoyé.