Configuration de l'application#

Attributs génériques#

  1. GEN_ACADEMIC_YEAR_LABEL : l'année académique courante en format yyyy-yyyy; exemple 2020-2021. Cet attribut doit être mis à jour cahque année.
  2. GEN_AVATAR : le nom du fichier contenant une image utilisée comme avatar pour des utlisateurs, étudiants ou candidats qui n'ont pas de photo passeports. Le fichier doit être placé dans le dossier "/resources/images"de l'application Okapi LMD.
  3. GEN_CANDIDAT_ENCRYPTED_PASSWORD : le mot de passe crypté du compe générique des candidats. Le gestionnaire d'Okapi LMD doit crypter ce mot de passe en utilisant l'outil de cryptage accessible via le menu principal.
  4. GEN_CANDIDAT_ENCRYPTED_USERNAME : l'identifiant crypté utilisé par l'application Okapi LMD pour les candidats à l'admission. Okapi LMD a besoin d'un compte d'utilisateur générique pour la gestion des candidats. Le gestionnaire d'Okapi LMD doit connaître l'identifiant de ce compte, le crypter en utilisant l'outil de cryptage accessible via le menu principal. C'est la valeur cryptée qu'il faut assigner à cet attribut de configuration. Exemple : si "candidat" est l'identifiant du compte générique des étudiants, il faut crypter le mot "candidat" et assigner le résultat de ce cryptage dans l'attribut "GEN_CANDIDAT_ENCRYPTED_USERNAME".
  5. GEN_CANDIDAT_MAIL_ENABLED : sa valeur doit être "true" ou "false". Quand un candidat introduit se demande d'admission via Okapi LMD, il est possible d'envoyer une alerte par mail au préposé aux inscriptions pour lui annoncer le dépôt d'une nouvelle demande d'admission. Cette alerte n'est envoyée que si l'attribut GEN_CANDIDAT_MAIL_ENABLED a la valeur "true". L'alerte est envoyée à l'adresse mail renseignée par l'attribut MAIL_REGISTRATION_DEPARTMENT!!!!!
  6. GEN_DEFAULT_NATIONALITY : le code ISO de la nationalité par défaut; exemple : "BF" pour le Burkhina-Fasso. La fiche de l'étudiant doit mentionner sa nationalité. Lorsque celle-ci n'est pas renseignée, Okapi adopte la nationalité par défaut.
  7. GEN_DEVISE : la devise de référence pour toute opération relative au paiement
  8. GEN_ECM_CANDIDAT_ENABLED prend la valeur "true" ou "false" selon que les documents d'un candidat à l'admission peuvent ou non être déposés sur le serveur GED. La valeur "true" de cet attribut n'a de sens que si l'attribut GEN_ECM_ENABLED a la valeur "true".
  9. GEN_ECM_ECUE_ENABLED prend la valeur "true" ou "false" selon que la documentation relative à un ECUE peut être ou pas déposée sur le serveur de GED. La valeur "true" de cet attribut n'a de sens que si l'attribut GEN_ECM_ENABLED a la valeur "true".
  10. GEN_ECM_ENABLED prend la valeur "true" ou "false" selon que le serveur de GED est actif ou pas. Si cet attribut prend est déclaré comme "true" alors que le srevur de GED n'est pas activé, l'application Okapi LMD aura un problème de performance pour toutes les opérations faisant recours à la GED comme, par exemple, la recherche sur les fiches d'étudiant ou d'utilisateur.
  11. GEN_HOURS_PER_CREDIT : facteur qui détermine le nombre de crédits d'un ECUE. La somme totale des masses horaires valorisables des différentes composantes d'un ECUE est calculé. Cette somme est divisée par ce facteur pour obtenir le nombre de crédits de l'ECUE.
  12. GEN_ECM_PERSONNEL_ENABLED prend la valeur "true" ou "false" selon que les documents d'un utilisateur peuvent ou non être déposés sur le serveur GED. La valeur "true" de cet attribut n'a de sens que si l'attribut GEN_ECM_ENABLED a la valeur "true".
  13. GEN_ECM_STUDENT_ENABLED prend la valeur "true" ou "false" selon que les documents des étudiants peuvent ou non être déposés sur le serveur GED. La valeur "true" de cet attribut n'a de sens que si l'attribut GEN_ECM_ENABLED a la valeur "true".
  14. GEN_ECM_UE_ENABLED : sa valeur doit être "true" ou "false". La documentation relative à une Unité d'Enseignement pêut être déposée sur le serveur GED s'il est activé. Pour que cela soit possible, il faut que l'attribut GEN_ECM_UE_ENABLED ait la valeur "true" et que le serveur GED soit ativé.
  15. GEN_EXTERNAL_APPLICATION_URL : lien permettant de se connecter à l'application Okapi LMD. Le gestionnaire d'Okapi LMD doit connaître ce lien. Exemple : https://okapi.okapidigit.net/okapiLmd
  16. GEN_LEVENSHTEIN_TRESHOLD est le nombre minimal de caractères différents qui doivent exister entre deux chaînes de caractères pour que Okapi LMD considère qu'elles font référence deux personnes différentes. S'il y a moins de lettres différentes, Okapi LMD considère qu'il pourrait s'agir de la même personne. Ce calcul est utilisé pour réduire le risque d'attribuer plusieurs matricules au même étudiant. Lorsqu'il y a une trop grande similarité entre les chaînes de caractères formées du nom, prénom , lieu et date de naissance d'une nouvelle fiche et celle d'une fiche existante, Okapi suspecte une redondance et demande un traitement manuel de la nouvelle fiche.
  17. GEN_LEVENSHTEIN_TRESHOLD est le nombre minimal de caractères différents qui doivent exister entre deux chaînes de caractères pour que Okapi LMD considère qu'elles font référence deux personnes différentes. S'il y a moins de lettres différentes, Okapi LMD considère qu'il pourrait s'agir de la même personne. Ce calcul est utilisé pour réduire le risque d'attribuer plusieurs matricules au même étudiant. Lorsqu'il y a une trop grande similarité entre les chaînes de caractères formées du nom, prénom , lieu et date de naissance d'une nouvelle fiche et celle d'une fiche existante, Okapi suspecte une redondance et demande un traitement manuel de la nouvelle fiche.
  18. GEN_MAIL_ENABLED prend la valeur "true" ou "false" selon que l'application Okapi peut ou pas envoyer automatiquemebt des mails. La valeur de cet attribue conditionne tous les autres attributs qui ont trait à l'envoi des mails, notamment GEN_CANDIDAT_MAIL_ENABLED.
  19. GEN_MARK_VALIDITY_TIMEOUT indique le nombre d'années avant qu'une note de réussite obtenue par un étudiant à un ECUE ne devienne obsolète. Si la note est obsolète, l'étudiant ne peut pas être dispensé de l'ECUE.
  20. GEN_MENU_BLOCK_SIZE : taille du menu latéral gauche qui apparaît sur la page qui contient les paramètres de configuration de l'application.
  21. GEN_OKAPICOLLEGE_EJB_URL contient le lien EJB de connexion à l'aplliation Okapi Etudiant si elle existe. Ce lien peut être utilisé pour injecter des données dans Okapi LMD à partir de Okapi Etudiant. Exemple : http://localhost:8080/wildfly-services
  22. GEN_PHOTO_HEIGHT : la hauteur , en pixels, des photos passeports; exemple : 128.
  23. GEN_PHOTO_WIDTH : la largeur , en pixels, des photos passeports; exemple : 99.
  24. GEN_STUDENT_ENCRYPTED_PASSWORD : le mot de passe crypté du compe générique des étudiants. Le gestionnaire d'Okapi LMD doit crypter ce mot de passe en utilisant l'outil de cryptage accessible via le menu principal.
  25. GEN_STUDENT_ENCRYPTED_USERNAME : l'identifiant crypté utilisé par l'application Okapi LMD pour les étudiants. Okapi LMD a besoin d'un compte d'utilisateur générique pour la gestion des étudiants. Le gestionnaire d'Okapi LMD doit connaître l'identifiant de ce compte, le crypter en utilisant l'outil de cryptage accessible via le menu principal. C'est la valeur cryptée qu'il faut assigner à cet attribut de configuration. Exemple : si "etudiant" est l'identifiant du compte générique des étudiants, il faut crypter le mot "etudiant" et assigner le résultat de ce cryptage dans l'attribut "GEN_STUDENT_ENCRYPTED_USERNAME".
  26. GEN_UNIVERSITY_ID : ID de l'université. C'est un code alphanumérique de 3 caractères au maximum. Il est utilisé dans la composition automatuique des matricules des étudiants.
  27. GEN_UNIVERSITY_ACRONYM : le nom de l'université en abrégé; exemple "UJKZ";
  28. GEN_UNIVERSITY_COUNTRY : le pays de de l'université en abrégé; exemple "Burkina-Fasso";
  29. GEN_UNIVERSITY_LOGO : le nom du fichier contenant l'image du logo de l'université. Le fichier doit être placé dans le dossier "/opt/okapi/images".
  30. GEN_UNIVERSITY_NAME : le nom complet de l'université. Exemple : Université Joseph Ki-Zerbo.
  31. GEN_UNIVERSITY_WEB_SITE : le lien qui mène au site Internet de l'université. Exemple : https://www.univ-ouaga1.gov.bf

Attributs de la GED#

  1. ECM_CMIS_BROWSER_SERVICE_URL : cet atribut est utilisé par Okapi pour contacter le serveur GED en utiisant le protocole CMIS. sa veleur doit être "/alfresco/api/-default-/public/cmis/versions/1.1/browser" pour Alfresco.
  2. ECM_CONNECTION_TIMEOUT : délai , en milli secondes, endéans lequel la connexion à la GED doit être établi. Passé ce délai, la connexion est considérée comme non établie.
  3. ECM_ENCRYPTED_PASSWORD : Okapi doit connaître le mot de passe du compte de connexion à la GED. Le gestionnaire d'Okapi LMD doit crypter ce mot de passe en utilisant l'outil de cryptage accessible via le menu principal. C'est le résultat de ce cryptage qu'il faut assigner à l'attribut ECM_ENCRYPTED_PASSWORD.
  4. ECM_ENCRYPTED_USERNAME : le nom d'utilisateur utilisé par Okapi pour se connecter à la GED. Le gestionnaire d'Okapi LMD doit le crypter en utilisant l'outil de cryptage accessible via le menu principal. C'est le résultat de ce cryptage qu'il faut assigner à l'attribut ECM_ENCRYPTED_USERNAME. Il faut que ce nom d'utilisateur ait été créé sur la GED et qu'il dispose de tous les privilèges sur l'espace accesible à Okapi sur la GED. Il doit être protégé dans la GED par le mot de passe mentionné par l'attribut ECM_ENCRYPTED_PASSWORD .
  5. ECM_PERSON_CALL_STRING : paramètres utilisés pour obtenir un ticket d'authentification sur la GED. Pour Alfresco, ça doit être "/alfresco/api/-default-/public/alfresco/versions/1/people?alf_ticket="
  6. ECM_PERSON_UPDATE_STRING : cet attribut est utilisé par Okapi pour retrouver le compte d'une personne sur la GED. Si on utilise Alfresco comme GED, sa valeur doit être "/alfresco/api/-default-/public/alfresco/versions/1/people/{id}".
  7. ECM_OKAPI_ROOT : la racine de l'espace qui contient tous les documents d'Okapi : les documents des ECUE (exemple : notes de cours) et des UE, les documents et photos des candidats à l'inscription, les documents et photos des étudiants, les photos et documents des membres du personnel, etc ... Valeur par défaut : "/okapi".
  8. ECM_SCHEME_SERVER_PORT : le protocole, le serveur et le port du serveur GED. Exemple "https://ged.okapidigit.net:8095"
  9. ECM_TICKET_CALL_STRING : ce paramètre est utilisé par Okapi pour se connecter à la GED après avoir obtenu un ticket d'authentification. Sa valeur doit être "/alfresco/service/api/login?" pour Alfresco.
  10. ECM_URL_ID_STRING : cet attribut est utilisé par Okapi pour retrouver une document sur la GED. Si on utilise Alfresco comme GED, sa valeur doit être "/share/page/folder-details?nodeRef=workspace://SpacesStore/"
  11. ECM_URL_PATH_STRING : cet attribut est utilisé par Okapi pour retrouver des documents sur le serveur GED; sa valeur doit être "/share/page/repository#filter=path|" pour Alfresco.

Mail#

  1. MAIL_REPLY_TO : l'adresse de retour utilisée par Okapi dans les mails qu'il envoie automatqiuement, lors de l'inscription des candidats par exemple.
  2. MAIL_SMTP_PORT : le port du relai de mails utilisé par Okapi.
  3. MAIL_SSL_ENABLED prend la valeur "true" ou "false" selon que SSL est utilisé ou pas.
  4. MAIL_REPLY_TO_PERSONAL_NAME : le nom complet utiisé par Okapi dans les mails qu'il envoie automatiquement.
  5. MAIL_STARTTLS_PORT : le port TLS utilisé par Okapi lors de l'envoie des mails via le relai.
  6. MAIL_STARTTLS_ENABLED prend la valeur "true" ou "false" selon que TLS est utilisé ou pas.
  7. MAIL_FROM : l'adresse source utilisée par Okapi dans les mails qu'il envoie automatiquement.
  8. MAIL_SMTP_AUTH_REQUIRED prend la valeur "true" ou "false" selon que le relai exige ou non l'authentification pour relayer les mails.
  9. MAIL_SMTP_HOST : le nom DNS ou l'adresse IP du relai.
  10. MAIL_ENCRYPTED_AUTH_USERNAME : l'identifiant utilisé pour s'authentifier sur le relai. Le gestionnaire d'Okapi LMD doit le crypter en utilisant l'outil de cryptage accessible via le menu principal. C'est le résultat de ce cryptage qu'il faut assigner à l'attribut MAIL_ENCRYPTED_AUTH_USERNAME.
  11. MAIL_REGISTRATION_DEPARTMENT : l'adresse mail à laquelle Okapi envoie les alertes annonçant les demandes d'admission des candidats à l'inscription.
  12. MAIL_ENCRYPTED_AUTH_PASSWORD : le mot de passe du compte permettant de se connecter au relai. Le gestionnaire d'Okapi LMD doit crypter ce mot de passe en utilisant l'outil de cryptage accessible via le menu principal. C'est le résultat de ce cryptage qu'il faut assigner à l'attribut MAIL_ENCRYPTED_AUTH_PASSWORD.

Inscription#

  1. INSCRIPTION_AGE_MINIMUM : âge minimal - nombre d'années - que doit avoir un étudiant pour s'inscrire dà un programme.
  2. INSCRIPTION_AUTORISATION_MAILING : prend la valeur "true" ou "false" selon que l'étudiant peut ou non envoyer par mail sa demande d'autorisation au responsable des inscriptions.
  3. INSCRIPTION_DEBUT : date du début des inscriptions au sein de l'université. Si une entité fixe sa propre date de début des inscriptions, elle a priorité sur celle fixée au niveaux supérieurs.
  4. INSCRIPTION_FIN : date du fin des inscriptions au sein de l'université. Si une entité fixe sa propre date de fin des inscriptions, elle a priorité sur celle fixée au niveaux supérieurs.
  5. INSCRIPTION_MAX_PAR_AN : nombre d'inscriptions simultanées autorisé pour un étudiant au cours d'une année académique.
  6. INSCRIPTION_MAX_PAR_CYCLE1 : nombre d'inscriptions autorisé pour un étudiant dans le 1er cycle.
  7. INSCRIPTION_MAX_PAR_CYCLE2 : nombre d'inscriptions autorisé pour un étudiant dans le 2ème cycle.
  8. NSCRIPTION_MAX_PAR_CYCLE3 : nombre d'inscriptions autorisé pour un étudiant dans le 3ème cycle.
  9. INSCRIPTION_MAX_PAR_CYCLE4 : nombre d'inscriptions autorisé pour un étudiant dans le 4ème cycle.
  10. INSCRIPTION_MAX_PAR_PROGRAMME : nombre d'inscriptions autorisé pour un étudiant dans un Programme.

Modules décentralisables#

test link Les modules décentralisables sont ceux qui peuvent être traités par des entités académiques décentralisées. Par défaut, Okapi considère les modules suivants comme décentralisables :

  • AutorisationEntite
  • EcueEntite
  • ExonerationEntite
  • InscriptionEntite
  • PaiementEntite
  • ResultatEcueEntite
  • ResultatUeEntite
  • SouscriptionUeEntite
  • ProgrammeEntite

La valeur de l'attribut doit avoir le format suivaht : fiche.<classe entité>.x . Exemple : fiche.AutorisationEntite.x , fiche.ProgrammeEntite.x.

La liste des classes entités peut être obtenue auprès du support.