diff --git a/docs/BulletinsNotes.md b/docs/BulletinsNotes.md index 44af9ad9a..980cfd03a 100644 --- a/docs/BulletinsNotes.md +++ b/docs/BulletinsNotes.md @@ -69,8 +69,8 @@ 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 +* *publier le bulletin sur le passerelle étudiants*: contrôle l'export XML des + bulletins, utilisé par la passerelle é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 diff --git a/docs/FAQ.md b/docs/FAQ.md index 8cf32eae2..738168d00 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -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". 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 ScoDoc pour un semestre particulier). A défaut, il faut leur envoyer leurs bulletins par mail. diff --git a/docs/InterrogationPortail.md b/docs/InterrogationPortail.md index 6c94e5672..c56663755 100644 --- a/docs/InterrogationPortail.md +++ b/docs/InterrogationPortail.md @@ -1,48 +1,52 @@ -# 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). +# Interface avec un "portail" externe -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). +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). -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`. 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. +## Information sur un étudiant -### Information sur un étudiant -Le portail doit fournir une méthode web `getEtud.php` qui accepte les paramètres suivants: +Le portail doit fournir une méthode web `getEtud.php` qui accepte les paramètres +suivants: - - `nip` : code NIP +- `nip` : code NIP - - `ine` : code INE - - - `mail` : adresse e-mail +- `ine` : code INE - - `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 -correspondant aux critères indiqués, et renvoie du code XML: -``` +- `etape` : code étape Apogée + +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 20600577 @@ -54,8 +58,8 @@ correspondant aux critères indiqués, et renvoie du code XML: 08/01/1990 Brest - 29 - Finisterre + 29 + Finisterre melanie.bourton@xxx.univ-yyy.fr
11 Pierre Dupont
@@ -70,11 +74,12 @@ correspondant aux critères indiqués, et renvoie du code XML: 2007 nom du lycée - ville lycée - code postal lycée + ville lycée + code postal lycée + 10/07/24 true - N + N @@ -84,16 +89,47 @@ correspondant aux critères indiqués, et renvoie du code XML: ``` -Les champs `` (code du lycée), `` (intitulé du bac), ``, `` et `` sont optionnels. +Les champs `` (code du lycée), `` (intitulé du bac), ``, +`` et `` sont optionnels. -Le champ `` 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 `` 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 `` (optionnel) vaut "true" ou "false" pour indiquer si l'étudiant a réglé ses frais d'inscription ou non. +Le champ `` (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 + 01 + 1 + O + E + 10/07/24 + NO + VBTCYB + V2CYB + O +``` + +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 -`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: +## 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: + ``` @@ -110,10 +146,16 @@ La structure est la suivante: ... ``` -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 DUT CJ - Première Année @@ -122,10 +164,11 @@ On peut aussi présenter une liste sans section par département, comme ceci: (c ``` -### Image de l'étudiant +## Image de l'étudiant + `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). Si l'image ou l'étudiant n'existe pas, un code HTTP 404 peut être renvoyé.