ESUPSGC

Arborescence des pages

Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.
Commentaire: Màj doc api crous

...

Nom du champ esup-sgcUsageObligatoire Source à 'privilégier' / Format
eppn Identifiant métier : eduPersonPrincipalNameOuieduPersonPrincipalName - obligatoire dans toutes les sources - car permet de faire le lien -> shib, ldap et sql
email Envoi d’email d’information lors de l’évolution de la carte ; ticket paybox, ... et aussi pour crous/izly
→ obligatoire

Oui

shib/ldap - champ mail
eduPersonPrimaryAffiliationCatégorisation population – moteur de recherche Nonshib/ldap - champ eduPersonPrimaryAffiliation
supannEtuId moteur de recherche Nonshib/ldap - champ supannEtuId
supannEmpIdmoteur de rechercheNonshib/ldap - champ supannEmpId
supannCodeINE

affichage / construction identifiant ESCR / identfiant crous/izly pour les étudiants

→ obligatoire dans CROUS/IZLY et ESCR

Ouishib/ldap - champ supannCodeINE
supannEntiteAffectationPrincipalemoteur de rechercheNonshib/ldap - champ supannEntiteAffectationPrincipale
firstnameAffichage / moteur de rechercheOuishib/ldap - champ givenname
nameAffichage / moteur de rechercheOuishib/ldap - champ sn
schacDateOfBirth

Date de naissance - obligatoire dans les contrôles d’accès.
Format :  yyyyMMdd  

Ouishib/ldap - champ schacDateOfBirth
schacExpiryDate

Date de fin de droits – les cartes de l’individu sont marquées comme caduques cette date passée. Format UTC :  yyyyMMddHHmmss'Z'

Cette date est également envoyée aux services qui ont besoin d'une date de fin (expiration) telles que les contrôles d'accès, ESCR, le CROUS (dueDate).

Ouishib/ldap - champ schacExpiryDate
referenceStatutPopulation crous (psg, etd, prs, hbg, fct, fpa, stg) - permet de calculer le tarif et société crous depuis le fichier ESIST.xmlOui sql
indiceIndice du personnel - permet de calculer le tarif et société crous depuis le fichier ESIST.xmlNon sql
secondaryIdIdentifiant secondaire quelconque – affichage / moteur de recherche / web service
spécificité COMUE NU : doit correspondre au leocode
Non ...
instituteÉtablissement, affichage ...Nonrègle d'un spelUserInfoService : nom (libellé) de l'établissement
supannEtablissement

Code RNE Établissement - permet de calculer le tarif et société crous depuis le fichier ESIST.xml

Depuis la 1.1.1, ce code RNE ainsi récupéré est envoyé dans l'API CROUS en tant que rneOrgCode

Oui

shib/ldap - champ supannEtablissement code UAI / RNE :
"{UAI}0761904G" pour désigner l'université de Rouen

address

Affichage / moteur de recherche
Est affiché par défault dans le champ "Courrier Interne" dans le bloc "Adresse" du formulaire de demande de carte.

Nonpeut correspondre à supannEntiteAffectationPrincipale ou champs sql spécifique
externalAddress

Affichage / moteur de recherche
Est affiché par défault dans le champ "Domicile" dans le bloc "Adresse" du formulaire de demande de carte.

Non
recto1Libellé sur rectoNonldap, sql, ou/et calculé via des règles d'un spelUserInfoService
recto2Libellé sur rectoNonldap, sql, ou/et calculé via des règles d'un spelUserInfoService
recto3Libellé sur rectoNonldap, sql, ou/et calculé via des règles d'un spelUserInfoService
recto4Libellé sur rectoNonldap, sql, ou/et calculé via des règles d'un spelUserInfoService
recto5Libellé sur rectoNonldap, sql, ou/et calculé via des règles d'un spelUserInfoService
verso1Libellé sur verso (dématérialisé)Nonldap, sql, ou/et calculé via des règles d'un spelUserInfoService
verso2Libellé sur verso (dématérialisé)Nonldap, sql, ou/et calculé via des règles d'un spelUserInfoService
verso3Libellé sur verso (dématérialisé)Nonldap, sql, ou/et calculé via des règles d'un spelUserInfoService
verso4Libellé sur verso (dématérialisé)Nonldap, sql, ou/et calculé via des règles d'un spelUserInfoService
verso5Libellé sur verso (dématérialisé)Nonldap, sql, ou/et calculé via des règles d'un spelUserInfoService
freeField1Champ libre - peut servir à la recherche/affichageNonlibre
freeField2Champ libre - peut servir à la recherche/affichageNonlibre
freeField3Champ libre - peut servir à la recherche/affichageNonlibre

supannRefId4ExternalCard


supannRefId donnant des numéros de cartes 'externes', cad non issus du SGC (et donc issus d'un autre SGC)
Déprécié : merci d'utiliser csn4ExternalCard et control4ExternalCard
Non

shib/ldap - champ supannRefId - atend en dur
{ISO15693}le-numero-csn
{LEOCARTE:ACCESS-CONTROL}le-numero-access-control

csn4ExternalCardcsn des cartes 'externes', cad non issus du SGC (et donc issus d'un autre SGC)Nonle-numero-csn (on pourra utiliser le champ supannRefId pour le faire transiter)
access-control4ExternalCardnuméro de carte de contrôle d'accès des cartes 'externes', cad non issus du SGC (et donc issus d'un autre SGC)Nonle-numero-access-control (on pourra utiliser le champ supannRefId pour le faire transiter)
jpegPhoto4ExternalCardjpegPhoto donnant la photo de cartes 'externes', cad non issus du SGC (et donc issus d'un autre SGC)Non

shib/ldap - champ jpegPhoto

sql : jpegPhoto correspondant à une photo jpeg exportée en base64

jpegPhotojpegPhoto donnant la photo par défaut pour un utilisateur : c'est cette photo qui est proposée par défaut lors de la première demande de carte ou via la demande de carte via l'API REST (sans spécifier une photo spécifique)Non

shib/ldap - champ jpegPhoto

sql : jpegPhoto correspondant à une photo jpeg exportée en base64

userType

affichage : onglet par userType
gestionnaire par userType
spécificité COMUE NU : ComueNuAccessControlCardIdService calcule un identifiant de carte à destination
d'une application desfire pour contrôle d'accès en fonction de userType (P, E ou I).

Oui

règle d'un spelUserInfoService

Attention, le nombre maximal de caractères du userType est limité à 3 ; les libellés à donner dans les messages i18n sont libres quand à eux ; 
vous pouvez modifier/ajouter ces libellés dans src/main/webapp/WEB-INF/i18n/sgc-messages.properties

templatethème (template) de carte à utiliserOuirègle d'un spelUserInfoService - doit correspondre à une clef de template
editabletrue ou false selon que l'utilisateur est 'éditable ou non'Non

remplace l'usage de ROLE_USER_NO_EDITABLE (qui en tant que 'groupe' doit forcément correspondre à un groupe/champ ldap)
si utilisé, il vous faut supprimer la référence à ROLE_USER_NO_EDITABLE dans sgcMappingGroupesRoles (et inversement)

requestFreetrue ou false selon que l'utilisateur doit payer le renouvellement de la carteNonremplace l'usage de ROLE_USER_RENEWAL_PAYED (qui en tant que 'groupe' doit forcément correspondre à un groupe/champ ldap)
si utilisé, il vous faut supprimer la référence à ROLE_USER_RENEWAL_PAYED dans sgcMappingGroupesRoles (et inversement)
blockUserMsg

Texte HTML affiché à l'utilisateur (vue utilisateur) en lieu et place du formulaire de demande de carte. Si vide (ou non spécifié dans la configuration), le formulaire de demande eest inchangé simplement.

Non

règle d'un spelUserInfoService - peut permettre de personnaliser le message disant à l'utilisateur qu'il ne peut pas demander de carte actuellement via eusp-sgc (car son inscription n'est pas en règle par exemple).

synchronize

Champ permettant d'indiquer que l'utilisateur (et ses cartes) doit être synchronisé depuis les userInfoServices.
synchronize est à 'true' par défaut (fonctionnement usuel), si celui-ci est donné à false l'utilisateur et ses cartes restent figées dans esup-sgc : celà permet par exemple de conserver les anciennes cartes d'utilisateurs plus remontés par le SI (ldap/bd). A noter que même si synchronize est à false, le changement d'état de la carte en caduque en fonction de la date de fin enregistrée en base (schacExpiryDate) s'opère et provoque alors à cette date une mise à jour des informations utilisateurs/cartes sur les services tels que le contrôle d'accè, l'API CROUS, le LDAP ...

Nonrègle d'un spelUserInfoService - dans la configuration donnée par défaut, on met synchronize à 'false' pour les utilisateurs n'ayant plus d'adresses mail de renseignées dans le Système d'Information (ldap/bd).
academicLevelChamp academicLevel permettant de transmettre le niveau d'étude de l'étudiant (en cours) à l'API ESCR (carte étudiante européenne).
Ce niveau, si transmis, est notamment affiché derrière l'url correrspondant au qrcode de la carte étudiante européenne (page internet précisant si l'individu est effectivement étudiant ).
Non

Cf la doc de l'API ESCR :
Current academic level of the student.
Possibles values are :
6 - bachelor’s degree.
7 - master’s degree.
8 - doctorate.

picChamp pic utilisé pour générer l'ESCN en utilisant un pic spécifique à l'étudiant ciblé en lieu et place du pic donné par défaut dans la configuration du bean escUidFactoryService de applicationContext-crous.xml ; utile pour un esup-sgc servant plusieurs établissements et relié à ESCR.Non


Note supplémentaire sur le editable (et requestFree qui se comporte de la même manière) : après avoir utilisé un temps le userInfo editable (ou requestFree) et que vous voulez finalement revenir à l'usage de ROLE_USER_NO_EDITABLE (ou ROLE_USER_RENEWAL_PAYED),
il vous faut également supprimer les références au groupe ROLE_USER_NO_EDITABLE (ou ROLE_USER_RENEWAL_PAYED) et remettre les editable à true (ou request_free à true) dans la base esupsgc pour réinitialiser les caculs : 
delete from roles where role='ROLE_USER_NO_EDITABLE';
update user_account set editable = true;
ou
delete from roles where role='ROLE_USER_RENEWAL_PAYED';

...

  • %csn% (en hexadécimal)
  • %reverse_csn% (le csn retourné par paires, en hexadécimal)
  • %csn_dec% (en décimal)
  • %reverse_csn_dec% (le csn retourné par paires, en décimal)
  • %eppn%
  • %escn%
  • %esi%
  • %secondary_id%
  • %csn_dec% 
  • %photo%
  • ... et enfin les identifiants de cartes générés par esup-sgc, via des 'CardIdService' (cf CardIdsService)
    • dont %access-control% pour l'identifiant de contrôle d'accès
  • %enabled_date% (la date d'activation de la carte - au format generalizedTime - yyyyMMddHHmmss'Z' )
  • %due_date% (la date de fin de validité de la carte - au format generalizedTime - yyyyMMddHHmmss'Z'  - peut permettre d'informer supanncmsdatefin)
  • %etat_date% (la date de dernier changement d'état de la carte - au format generalizedTime - yyyyMMddHHmmss'Z' - correspondra logiquement dans le ldap à %enabled_date% )
  • %etat% (l'état de la carte - correspondra logiquement à ENABLED )
  • %photo%
  • ... et enfin les identifiants de cartes générés par esup-sgc, via des 'CardIdService' (cf CardIdsService)
    • dont %access-control% pour l'identifiant de contrôle d'accès
Bloc de code
languagexml
themeRDark
<bean
Bloc de code
languagexml
themeRDark
<bean id="ldapValidateService" class="org.esupportail.sgc.services.ldap.LdapValidateService">
 <property name="ldapTemplate" ref="ldapTestTemplate"/>
 <property name="peopleSearchFilter" value="(eduPersonPrincipalName={0})"/>
 <property name="ldapCardIdsMappingMultiValues">
  <map>
   <!-- Exemple clé multi-valuée -->
   <entry key="supannRefId">
    <list>
     <value>{ISO15693}%csn%</value>
     <value>{LEOCARTE:ACCESS-CONTROL}%access-control%</value>
    </list>
   </entry>
   <!-- Exemple clé multi-valuée -->
   <entry key="autreExemple">
    <list>
     <value>%reverse_csn%@ISO15693</value>
    </list>
   </entry>
  </map>
 </property>
 <property name="ldapCardIdsMappingValue">
  <map>
    <!-- Exemple clé simple -->
    <entry key="jpegPhoto" value="%photo%"/>
  </map>
 </property>
</bean>

...

Bloc de code
languagepy
themeRDark
#!/usr/bin/python                                                                                                                                                                                                  
# -*- coding: utf-8 -*-                                                                                                                                                                                            
import cgi
import requests

arguments = cgi.FieldStorage()
eppn = arguments['eppn'].value

print "Content-Type: text/plain"
print ""
print eppn

resp = requests.get(url = 'https://esup-sgc.univ-ville.fr/wsrest/api/get?eppn=%s' % eppn)

csn = ''
acccesControlId = ''
data = resp.json()
for user in data :
    for card in user['cards'] :
        if card['etat'] == 'ENABLED' :
            csn = card['csn']
			acccesControlId = card['desfireIds']['access-control']
open_file = open('/opt/export-sgc/a.txt', 'a+b')
open_file.write('card enabled for %s : csn -> %s, access-control : %s\n' % (eppn, csn, acccesControlId))
open_file.close()
print 'OK'
 

applicationContext-crous.xml

ApiCrousService :

Permet d’activer l’envoi de données au CROUS via l’api

BashValidateService

Le SGC propose une implémentation ValidateService appelant une commande BASH à chaque activation ou désactivation de carte.

Cela peut vous permettre d'appeler une commande curl qui sera plus souple que le RestValidateService décrit ci-dessus ou tout autre commande de votre système d'exploitation.

Exemple avec une commande curl : les arguments sont positionnés via %s  : le premier argument %s étant replacé par le csn de la carte et le deuxième %s par l'eppn.

Notez l'usage de &#34; pour échapper le double quotes "


Bloc de code
languagexml
theme
Bloc de code
languagexml
themeRDark
<bean id="apiCrousServicegraviteeValidateService" class="org.esupportail.sgc.services.crous.ApiCrousServiceBashValidateService">
 		<property name="enablevalidateBashCmd" value="false"/>
 <property name="webUrl" value="curl --data '{&#34;altroCodice&#34;: &#34;%s&#34;}' --request PATCH --url 'https://gravitee-api-pp.nuonet.fr" />
 <property name="appId" value="xxxxxxxxxxxxx" />
 <property name="appSecret" value="yyyyyyyyyyyy" />
 example.org/persons/sigb/sebina/cardnumber?eppn=%s' --header 'Content-Type: application/json' --header 'X-Gravitee-Api-Key: xxxaa779-1b5b-4cd3-84a0-123456789'"/>
 		<property name="restTemplateinvalidateBashCmd" refvalue="restTemplate" />
</bean>

 Pour récupérer appId et appSecret la procédure est la suivante : 

...

curl --data '{&#34;altroCodice&#34;: &#34;%s&#34;}' --request PATCH --url 'https://gravitee-api.example.org/persons/sigb/sebina/cardnumber?eppn=%s' --header 'Content-Type: application/json' --header 'X-Gravitee-Api-Key: xxxaa779-1b5b-4cd3-84a0-123456789' -X 'DELETE'"/>
</bean>

applicationContext-crous.xml

ApiCrousService :

Permet d’activer l’envoi de données au CROUS via l’api

Bloc de code
languagexml
themeRDark
<bean id="apiCrousService" class="org.esupportail.sgc.services.crous.ApiCrousService">
 <property name="enable" value="false"/>
 <property name="webUrl" value="https://api-pp.nuonet.fr" />
 <property name="clientId" value=""/>
 <property name="clientSecret" value=""/>
 <property name="accessUrl" value="https://acces.lescrous.fr"/>
 <property name="restTemplate" ref="restTemplate" />
</bean>

 Pour récupérer appId et appSecret la procédure est la suivante : 

  1. se rendre sur https://dev-pp.lescrous.fr afin de vous créer une application et demander la souscription à l'API Beforeizly.
  2. une fois vos tests validés, vous pouvez vous connecter avec le même utilisateur sur https://dev.lescrous.fr et faire la même démarche pour obtenir vos identifiants de production.
  3. clientId et clientSecret doivent être informés en fonction.

  4. accessUrl doit rester https://acces.lescrous.fr pour la pre-production comme la production
  5.  webUrl doit être renseigné à https://api-pp.nuonet.fr pour la préproduction et https://api.lescrous.fr pour la production.

Attention : les opérations sur les API de la pré-production comme de la production de l'API Crous/Izly peuvent provoquer l'envoi de mails auw ayants-droits manipulés.

...

EsistCrousService :

Fait référence au fichier XML de calcul des tarifs CROUS

...

  • Nom : « Ecriture SGC »

  • Configuration NFC : « Ecriture ESUP SGC » (spécifié dans applicationContext-desfire.xml)

  • Application externe : « Web Service Write Esup SGC »

  • Contrôle du tagId : « via Esup SGC »

  • Valeur par défaut pour la validation sans confirmation : true → cela permet de valider le bon encodage de la carte, si cette valeur est laissée à false [non cochée], sans la validation manuelle, la carte reste à l'état "en cours d'impression", et dans le cadre de l'édition en 1 temps/passe, la carte est réimprimée/réencodée en continue !

  • Visible : true
  • Application d'écriture pour esup-sgc-client: true

Voir aussi la configuration des applications optionnelles : Applications ESUP-SGC / ESUP-NFC-TAG optionnelles