diff --git a/documentation/docs/connecteurs.md b/documentation/docs/connecteurs.md index e80d11c74efc042cb613b2ad31e86939186f28c3..bff84422e883e8088caf3030ec35bba9d97ddf1f 100644 --- a/documentation/docs/connecteurs.md +++ b/documentation/docs/connecteurs.md @@ -1,10 +1,10 @@ Connecteurs ==== -**Mes Formations** est alimentée via des synchronisations exploitant des données exposées dans le SI de l'établissement qui l'instale. +L'application **Mes Formations** est alimentée via des synchronisations exploitant des données exposées dans le SI de l'établissement qui l'installe. Ces données sont présentés : -- soient depuis le SIRH (SIHAM, HARPEGE, ...) -- soient depuis un concentrateur de données (par exemple *OCTOPUS* à Caen) +- soient depuis le SIRH : SIHAM, HARPEGE, autres SIRH ; +- soient depuis un concentrateur de données (par exemple *OCTOPUS* à Caen). Nous aborderons tout d'abord la composition des vues puis le moyen de déclencher ces synchronisations et finalement comment adapter les vues et la configuration de la synchronisation. @@ -15,16 +15,16 @@ Vues ## Données liées aux référentiels RH -On retrouve dans ce groupe de vues les descriptions des correspondances, des corps, des grades et des emplois-types +On retrouve dans ce groupe de vues les descriptions des correspondances, des corps, des grades et des emplois types 1. V_MESFORMATIONS_CORRESPONDANCE_TYPE -1. V_MESFORMATIONS_CORRESPONDANCE -1. V_MESFORMATIONS_CORPS -1. V_MESFORMATIONS_GRADE -1. V_MESFORMATIONS_EMPLOITYPE +2. V_MESFORMATIONS_CORRESPONDANCE +3. V_MESFORMATIONS_CORPS +4. V_MESFORMATIONS_GRADE +5. V_MESFORMATIONS_EMPLOITYPE ### V_MESFORMATIONS_CORRESPONDANCE_TYPE -Cette vue présente directement la liste des différents types de correspondances (BAP, CNU, ...) +Cette vue présente directement la liste des différents types de correspondances : BAP, CNU, autres types. | Nom de la colonne | Type | Obligatoire | Commentaire | |-------------------|---------------|-------------|---------------| @@ -90,7 +90,7 @@ Exemple depuis l'instance de démonstration. ### V_MESFORMATIONS_GRADE -Cette vue liste les grades des agent·es +Cette vue liste les grades des agent·es. | Nom de la colonne | Type | Obligatoire | Commentaire | |-------------------|---------------|-------------|---------------------------------------------------------| @@ -103,7 +103,7 @@ Cette vue liste les grades des agent·es | DATE_FIN | date | Non | Exemple depuis l'instance de démonstration. -```cvs +```csv 'id';'code';'libelle_court';'libelle_long';'description';'date_debut';'date_fin' "1","1021","I.G.E.N.","INSPECTEUR GENERAL DE L'EDUCAT.NATIONALE",null,null,null "2","1011","INSP.ADM.","INSPECTEUR D ADMINISTRATION",null,null,null @@ -112,13 +112,31 @@ Exemple depuis l'instance de démonstration. ### V_MESFORMATIONS_EMPLOITYPE +Cette vue liste les emplois types des agent·es. +| Nom de la colonne | Type | Obligatoire | Commentaire | +|-------------------|---------------|-------------|---------------------------------------------------------| +| ID | integer | Oui | Clef primaire | +| C_EMPLOITYPE | varchar(64) | Oui | | +| LIBELLE_COURT | varchar(256) | Oui | | +| LIBELLE_LONG | varchar(1024) | Oui | | +| DATE_DEBUT | date | Oui | | +| DATE_FIN | date | Non | + +Exemple depuis l'instance de démonstration. +```csv +'id';'code';'lib_court';'lib_long';'date_debut';'date_fin' +"1","E2A41","E_E2A41","Administrateur-trice des systèmes d'information","2023-09-01",null +"2","A1C46","E_A1C46","Ingénieur-e de recherche en expérimentation","2023-09-01",null +"3","C2C46","E_C2C46","Ingénieur-e électrotechnicien-ne","2023-09-13",null +``` + ## Données liées aux structures On retrouve dans cette catégorie les vues : 1. V_MESFORMATIONS_STRUCTURE_TYPE -1. V_MESFORMATIONS_STRUCTURE +2. V_MESFORMATIONS_STRUCTURE ### La vue listant les types de structures V_MESFORMATIONS_STRUCTURE_TYPE @@ -158,27 +176,77 @@ Cette vue présente la liste des structures | PARENT_ID | integer | Non | Clef étrangère vers V_MESFORMATIONS_STRUCTURE | | NIV2_ID | integer | Non | Clef étrangère vers V_MESFORMATIONS_STRUCTURE | -**N.B.**: -Dans cette vue vous pouvez limiter le liste des structures que vous voulez présenter. -Attention toutefois a bien remonter les structures référencées par les colonnes parent_id et niv2_id +**N.B.** : +Dans cette vue, vous pouvez limiter la liste des structures que vous voulez présenter. +Attention toutefois a bien remonté les structures référencées par les colonnes parent_id et niv2_id ## Données liées aux référentiels Agent·es On retrouve ici quatre vues : 1. V_MESFORMATIONS_AGENT la liste des agent·es -1. V_MESFORMATIONS_AGENT_AFFECTATION la liste des affectations présentées des agent·es -1. V_MESFORMATIONS_AGENT_GRADE la liste des grades (correspondances/corps/grade) présentées des agent·es -1. V_MESFORMATIONS_AGENT_STATUT la liste des statuts des agent·es +2. V_MESFORMATIONS_AGENT_AFFECTATION la liste des affectations présentées des agent·es +3. V_MESFORMATIONS_AGENT_GRADE la liste des grades (correspondances/corps/grade) présentées des agent·es +4. V_MESFORMATIONS_AGENT_STATUT la liste des statuts des agent·es + +### La liste des agent·es V_MESFORMATIONS_AGENT -### La listes des agent·es V_MESFORMATIONS_AGENT +Cette vue liste les agent·es ayant accès à l'application. + +| Nom de la colonne | Type | Obligatoire | Commentaire | +|-------------------|---------------|-------------|-----------------------------------------------| +| C_INDIVIDU | varchar(40) | Oui | Clef primaire | +| PRENOM | varchar(256) | Oui | | +| NOM_USAGE | varchar(256) | Oui | | +| NOM_FAMILLE | varchar(256) | Non | | +| LOGIN | varchar(256) | Oui | | +| EMAIL | varchar(1024) | Oui | | +| SEXE | varchar(1) | Non | | +| DATE_NAISSANCE | DateTime | Non | | + + +Exemple depuis l'instance de démonstration. +```csv +'c_individu';'prenom';'nom_usage';'nom_famille';'login';'email','sexe','date_naissance' +40,"Violette","Purple",null,"violette","violette@univ-demo.fr",null,null +41,"Blanche","White","Weiss,"blanche","blanche@univ-demo.fr",null,null +... +``` + +**N.B.** : +Les champs `SEXE` et `DATE_NAISSANCE` ne sont pas obligatoires (pour des raisons RGPD), mais ils peuvent être nécessaire pour le calcul d'indicateur. + +### La liste des agent·es V_MESFORMATIONS_AGENT_AFFECTATION + +Cette vue liste les affectations des agents + +| Nom de la colonne | Type | Obligatoire | Commentaire | +|-------------------|-------------|-------------|-----------------------------------------------| +| ID | integer | Oui | Clef primaire | +| AGENT_ID | varchar(40) | Oui | Clef étrangère vers V_MESFORMATIONS_AGENT | +| STRUCTURE_ID | integer | Oui | Clef étrangère vers V_MESFORMATIONS_STRUCTURE | +| T_PRINCIPALE | varchar(1) | Oui | | +| T_HIERARCHIQUE | varchar(1) | Oui | | +| T_FONCTIONNELLE | varchar(1) | Oui | | +| QUOTITE | integer | Oui | | +| DATE_DEBUT | DateTime | Oui | | +| DATE_FIN | DateTime | Non | | + +Exemple depuis l'instance de démonstration. +```csv +'id';'agent_id';'structure_id';'t_principale';'t_hierarchique';'t_fonctionnelle','quotite','date_debut','date_fin' +4577,"40",15,"O","O","O",80,"2025-01-01",null +4578,"40",21,"N","N","O",20,"2025-01-01","2025-08-31" +``` +### La liste des agent·es V_MESFORMATIONS_AGENT_GRADE +### La liste des agent·es V_MESFORMATIONS_AGENT_STATUT ## Données liées aux responsabilités 1. STRUCTURE_RESPONSABLE -1. STRUCTURE_GESTIONNAIRE -1. AGENT_VALIDEUR +2. STRUCTURE_GESTIONNAIRE +3. AGENT_VALIDEUR Configuration de la biliothèque === @@ -186,13 +254,13 @@ Configuration de la biliothèque ## L'accés aux bases de données sources Les bases de données sources doivent être déclaré comme ORM pour cela, il est nécessaire de les déclarer comme fichier de configuration local (non synchronisé dans le dépôt). -Dans la suite je présente la configuration faite à Caen exploitant deux bases de données sources : +Dans la suite, je présente la configuration faite à Caen exploitant deux bases de données sources : 1. OCTOPUS qui est un concentrateur de données 2. UNIFORMSUP qui regroupe des informations sur les étapes et diplômes **Ajout de l'ORM pour OCTOPUS** -Dans cet exemple, octopus est une base de donnée pgsql (penser à installer le drivers associé). +Dans cet exemple, octopus est une base de donnée pgsql (penser à installer le *driver* associé). Fichier 'config/autoload/database-octopus.local.php' ```php @@ -259,7 +327,7 @@ return [ ``` **Ajout de l'ORM pour UNIFORMSUP** -Dans cet exemple, uniformsup est une base de donnée oracle (penser à installer le drivers OCI8). +Dans cet exemple, uniformsup est une base de donnée oracle (penser à installer le *driver* OCI8). Fichier 'config/autoload/database-uniform.local.php' ```php @@ -326,11 +394,11 @@ return [ Le fichier configurant les synchronisations est composé de deux blocs : 1. data_sources la liste des ORM utilisables -2. la liste des synchronisation (les tables de correspondance) +2. la liste des synchronisations (les tables de correspondance) -La liste des ORM utilisables est un simple table référencant les ORM précédemment définis. +La liste des ORM utilisables est un simple table référencant les ORMs précédemment définis. -Le synchronisation on la structure suivante : +La synchronisation on la structure suivante : ```php 'NOM_DE_LA_SYNCHRONISATION' => [ 'order' => ORDRE DE PRIORITE, @@ -353,7 +421,7 @@ Les synchronisations utilisées à Caen sont fourni comme exemple : ## Lancer une synchronisation -La synchronisation est lancé en ligne de commande il est possible de lancer l'ensemble des synchronisations ou une synchronisation +La synchronisation est lancé en ligne de commande, il est possible de lancer l'ensemble des synchronisations ou une synchronisation ```bash /var/www/html$ php public/index.php synchroniser-all