Nouvelle doc module relations entreprises par Arthur.

docs/RelationsEntreprises.md

@@ -1,20 +1,25 @@
-# Application "relations entreprises"
+# Module "relations entreprises"
 
-Cette application a pour but de permettre aux utilisateurs de retrouver et mémoriser toutes les relations entreprises dans un même endroit sous la forme d'une base interne à l'établissement.
+Ce module de ScoDoc a pour but de permettre aux utilisateurs de retrouver et
+mémoriser toutes les relations entreprises dans un même endroit.
+La base de données est commune aux départements de l'établissement, mais
+l'application offre des droits de consultation et de modification différenciés.
 
-Les utilisateurs interrogés insistent sur leur souhait d'avoir une interface simple et intuitive.
+Ce projet a été développée en 2021-2022, par un apprenti de l'IUT de
+Villetaneuse financé par l'Association ScoDoc.
 
+# Fonctionnalités
 
-## Principales fonctionnalités
+Le module, intégrée à ScoDoc, fournit pour l'instant:
 
-L'application, intégrée à ScoDoc, fournira:
+* Saisie et gestion des entreprises, sites et correspondants
+* Saisie et gestion des offres de stage et d'apprentissage
+* Saisie et gestion de la taxe d'apprentissage
+* Envoi des offres aux responsables de formations
+* Historique à propos des entreprises
+* Historique des modifications des fiches entreprises
+* Systèmes de rôles et de permissions pour les accès.
 
-- Saisie et gestion des entreprises
-- Saisie et gestion des offres de stage et d'apprentissage
-- Envoi des offres aux responsables de formations
-- Historique à propos des entreprises
-- Historique des modifications des fiches entreprises
-- Journal de bord des étudiants pour suivre les candidatures
 
 
 ## Les utilisateurs
@@ -27,220 +32,233 @@ L'application, intégrée à ScoDoc, fournira:
 Des actions et visibilités différentes selon le rôle de l'utilisateur (voir section "Rôles" plus loin).
 
 
-## Les entreprises
+## Rôles et permissions
 
-Les entreprises possèderont chacune une fiche avec toutes leurs informations.
+Ses rôles ne sont pas reliés à des département. Les rôles permettent aux utilisateurs d'avoir différentes permissions selon le rôle qu'il possède.
 
-Lorsqu'un utilisateur souhaite indiquer une relation avec une entreprise ou 
-a été contacté par une entreprise, il pourra saisir les informations de
-l'entreprise dans la base si elle n'existe pas encore.
-Si l'entreprise existe mais que l'utilisateur veut ajouter ou corriger des infos ? Ou ajouter un "correspondant" ? Peut-être un lien vers la modification de cette entreprise.
+Rôles:
+* AdminEntreprise
+* UtilisateurEntreprise
+* ObservateurEntreprise
 
+Permissions:
+* RelationsEntreprisesView -> Voir l'application relations entreprises
+* RelationsEntreprisesChange -> Modifier les entreprises
+* RelationsEntreprisesExport -> Exporter les données de l'application relations entreprises
+* RelationsEntreprisesSend -> Envoyer des offres
+* RelationsEntreprisesValidate -> Valide les entreprises
+* RelationsEntreprisesCorrespondants -> Voir les correspondants
 
-### Données sur l'entreprise:
 
-- SIRET
-- Nom
-- Adresse, Code postal, Ville, Pays
-- Élements de contact (nom, prénom, numéro de téléphone, email)
 
-Ces élements de contacts sont associés à une personne ou un service (par exemple "ressources humaine") au sein de l'entreprise. Il y en aura donc un nombre variable.
+## Saisie et gestion des entreprises, sites et correspondants
 
-Une entreprise peut avoir plusieurs éléments de contact, il peut s'agir d'une personne physique, du service ressources humaines d'une entreprise ou d'un autre service selon la situation.
+### Page "Entreprises"
 
-Les entreprises sont identifiés par leur SIRET (unique) pour éviter les duplications et doivent toujours posséder des éléments de contact sinon inexploitable par les utilisateurs.
+Les entreprises dans la base de données apparaissent alors dans une liste
+d'entreprise où leur SIRET est un lien vers leur fiche entreprise. Il y a 2
+checkbox pour pouvoir afficher toutes les entreprises de la base (les
+entreprises désactivées en rouge) ou/et que les associations partenaires.
 
-Les entreprises possède un SIRET pour chaque établissement de l'entreprise ce qui le rend unique, je pense donc que le SIRET est un bon moyen d'identifier une entreprise, peut-être mettre le SIREN aussi?
+### Fiche entreprise
 
-TODO: distinguer SIRET et SIREN, pour les grandes entreprises multi-sites voir https://www.economie.gouv.fr/entreprises/numeros-siren-siret
+Chaque entreprises de la base possède une fiche entreprise avec dessus les
+informations de l'entreprise (SIRET, nom, adresse, code postal, pays), les
+sites, les correspondants, les offres, les dernières opérations, l'historique
+concernant l'entreprise.
 
-(Les établissements avec le même SIREN sont présent sur la même fiche entreprise avec chacun leur adresse)
+### Ajouter une entreprise
 
-Un historique sur l'entreprise pour pouvoir savoir quel étudiant a déjà réalisé un stage ou un contrat d'alternance au sein de l'entreprise avec:
-- identifiant de l'étudiant INE ou ScoDoc id (`etudid`)
-- type de contrat
-- date début et fin
-- formation de l'étudiant (texte)
-- formation de l'étudiant: identifiant ScoDoc (`formsemestre_id`)
+Pour ajouter une entreprise dans la base, il y a un bouton `Ajouter une
+entreprise` sur la page "Entreprises" qui vous emmène vers un formulaire
+comportant 2 partie, une partie entreprise avec tous les champs sur l'entreprise
+(SIRET, nom, adresse, code postal, pays) puis une partie contact optionnelle
+avec les champs concernant le contact de cette entreprise (nom, prenom,
+téléphone mail, poste, service) avec au moins un moyen de contact (téléphone ou
+mail). Un site par défaut est automatiquement créé avec les informations de
+l'entreprise.  
 
-Un historique sur les modifications faites sur chaque fiche entreprise :
-- modification adresse
-- ajout/modification/suppression contact
-- ajout/modification/suppression offre
+En saisissant un SIRET dans le formulaire d'ajout d'entreprise, le formulaire
+peut auto remplir le formulaire si le SIRET saisi correspond à celle d'une
+entreprise. 
+Il auto-remplit les champs: nom, adresse, code postal. 
 
-L'ajout d'entreprise envoie un mail d'alerte au pole des relations extérieures.
+### Modifier une entreprise
 
+Pour modifier une entreprise, on peut le faire à partir de la liste des
+entreprises ou alors sur la fiche entreprise de l'entreprise avec le bouton
+`Modifier` sous les informations de l'entreprise. Toutes les informations de
+l'entreprise peuvent être modifiés sauf le SIRET. 
 
-## Les offres
+Les champs sont préremplis avec les informations actuelles de l'entreprise
 
-Une entreprise peut proposer des offres.
+### Activer/Désactiver une entreprise
 
-Un utilisateur reçoit une offre d'une entreprise, il peut saisir l'offre dans la base qui sera ensuite affiché sur la fiche entreprise de celle ci. L'offre pourra ensuite être validé ou non par un responsable de formation s'il pense que les missions sont adéquates à la formation.
+On peut activer et désactiver une entreprise, on peut le faire à partir de la
+liste des entreprises ou alors sur la fiche entreprise de l'entreprise avec le
+bouton `Désactiver` ou `Activer`. On peut écrire une note sur la désactivation
+de la fiche entreprise. 
 
-### Données sur les offres:
+### Validation d'une entreprise
 
-- Intitulé du poste
-- Présentation?
-- Type de l'offre
-- Missions
-- Durée
+Les administrateurs du module gestion des relations entreprises doivent valider
+les entreprises saisies par les utilisateurs pour qu'il soit affichés dans la
+liste des entreprises. 
 
-Chaque offre est reliée à une entreprise.
+### Ajouter et modifier un site
 
-Les utilisateurs ont la possibilité d'envoyer les offres aux responsables de formations par la suite les responsables de formations diffusent l'offre au sein de leur formation.
-Les responsables de formations ne sont reliés à aucun objet. Les utilisateurs envoient l'offre aux responsables de formations s'ils pensent que l'offre correspond bien à la formation.
+Pour ajouter/modifier un site sur une fiche entreprise, il y a un bouton
+`Ajouter site` et un autre bouton `Modifier` sous les informations d'un site sur
+la fiche entreprise qui vous emmène vers un formulaire pour ajouter un site ou
+modifier un site. (nom unique) 
 
-L'ajout d'une offre envoie un mail d'alerte au responsable du pole des relations extérieures.
+### Ajouter un correspondant
 
+On peut ajouter un correspondant à une entreprise avec le bouton `Ajouter
+correspondant` présent sous les informations des sites qui vous emmène vers un
+formulaire avec plusieurs champs (nom, prénom, téléphone, mail, poste, service).
+Les champs nom, prénom sont obligatoires. Il faut que le contact possède au
+moins un moyen de contact c'est-à-dire soit un téléphone, soit un mail. Le poste
+et le service dans lequel il travaille est optionel. 
 
-## Journal de bord
+Les contacts ne peuvent pas avoir le même nom et prénom au sein d'une même entreprise.
 
-Journal de bord pour les étudiants afin de suivre leurs candidatures dans les offres envoyées préalablement par son responsable de formation.
+On peut saisir plusieurs correspondants en une seule fois sur le même formulaire
+avec le bouton `Ajouter un correspondant`. 
 
-Sur le journal de bord apparaîtra les offres que la responsable de formation a reçu et valider puis envoyer à ces étudiants. Les étudiants doit pouvoir saisir un commentaire s'il n'a candidaté a l'offre ou indiquer qu'il a candidater.
+### Modifier un correspondant
 
-Les utilisateurs pourront avoir accès a ces journaux de bord pour constater l'avancée et l'implication des étudiants dans leurs candidatures.
+Pour modifier un correspondant, on peut le faire avec le bouton `Modifier
+correspondant` sous les informations du correspondant présent sur la fiche
+entreprise de celle-ci. Toutes les informations du correspondant peuvent être
+modifiés. 
 
-Les étudiants accèdent au journal de bord en se connectant avec leur compte personnel et peuvent commenter chaque offre de stage/alternance.
+Les champs sont préremplis avec les informations actuelles du contact.
 
-Possibilités:
-- Oui, j'ai candidaté (quand)
-- Non, je n'ai pas candidaté (pourquoi)
+### Supprimer un correspondant
 
+Pour supprimer un correspondant, on peut le faire avec le bouton `Supprimer correspondant`.
 
-Permettre aux entreprises d'avoir accès au bordereau de stage afin qu'il puisse le remplir (s'il compte déjà prendre un stagiaire) ou de proposer une offre de stage.
-Un lien pour télécharger un bordereau de stage ajouté par les utilisateurs de l'application pour les entreprises.
-XXX accès des entreprises: avec quel compte (identifiant). Quand et par qui ce compte est-il créé ? Je ne sais pas encore.
+### Page offres expirés
 
-## Rôles et actions associées
+C'est une page qui regroupe toutes les offres dont la date d'expiration est
+passées. Elle est accessible sur chaque fiche entreprise avec le bouton `Voir
+les offres expirées`. 
 
-2 rôles avec des droits différents.
+### Pages "Correspondants"
 
-Utilisateur possédant un rôle avec visibilité totale et toutes les actions possibles sur la base:
-    - le pôle des relations extérieures avec le responsable, son assistant et les chargés de relations entreprises;
-    - administrateur informatique.
-    - directeur de l'IUT?
+C'est une page qui affiche la liste des contacts avec le nom de leur entreprise
+cliquable qui envoie sur la fiche entreprise de l'entreprise. 
 
-Utilisateur possédant un rôle avec seulement une visibilité sur la base selon le département dont il appartient :
-    - les reponsables de formations
-    - les secrétariat pédagogiques
-    - les chefs de département
-    - le responsable administratif
+### Exportation/Importation des données
 
+Les données de la base sont exportables en .xlxs avec le bouton présent sur la
+page "Entreprises" `Exporter les données`. La feuille Excel est composée de 3
+feuilles:  
 
-## Processus
+* Feuille "Entreprises"
+* Feuille "Sites"
+* Feuille "Correspondants"
 
-Liste des principaux processus métiers identifiés: à préciser et compléter au cours du projet.
+On peut importer des données par fichier Excel (.xlxs) avec le bouton `Importer
+des données` présent sur la page "Entreprises". Il faut récupérer la feuille
+Excel exemple pour avoir les titres correctement présents avec le lien `Obtenir
+la feuille excel à remplir` et le remplir. L'importation réussie s'il passe les
+vérifications et sont directement ajoutés à la base. 
 
-### Ajout d'une entreprise
+Feuille importation:
+* Feuille "Entreprises": création et modification d'entreprises
+* Feuille "Sites": création et modification de sites / partie avec les titres en
+  rouges -> ajout de correspondant lié au site de la même ligne (1 seul ajout) 
+* Feuille "Correspondants": modification de correspondants uniquement 
 
- - Acteur: tout personnel autorisé (le responsable et l' assistant du pôle des relations extérieures et les chargés de relations entreprises).
- - Quand: à tout moment.
- - Action: saisie des données sur une nouvelle entreprise, avec un point de contact
- - Déclenche: notification au chargés de relations entreprises (à toutes les personnes du pôle des relations extérieures).
- - Remarques: recherche d'entreprises ressemblantes pour éviter doublons.
+## Saisie et gestion des offres de stage et d'apprentissage
 
-### Modification d'une entreprise
-- Acteur: tout personnel autorisé (le responsable et l' assistant du pôle des relations extérieures et les chargés de relations entreprises).
-- Quand: à tout moment.
-- Action: modifie les données sur une entreprise.
-- Déclenche: ajout des modifications dans un historique visible.
-- Remarques: ...
+### Visibilité d'une offre
 
-### Consultation des entreprises
-- Acteur: tout personnel autorisé.
-- Quand: à tout moment.
-- Action: moteur de recherche, liste des entreprises.
-- Déclenche: rien.
-- Remarques: ...
+Une offre est lié à un ou plusieurs départements se qui change sa visibilité.
 
-### Consultation des offres
+### Ajouter une offre
 
- - Acteurs: tout personnel autorisé.
- - Quand: à tout moment.
- - Action: moteur de recherche, liste des offres de stages et d'alternance publiées.
- - Déclenche: rien.
- - Remarques: les offres devront impérativement avoir une date d'expiration pour éviter d'afficher ici des offres anciennes.
+On peut ajouter une offre à une entreprise avec le bouton `Ajouter offre`
+présent sur la fiche entreprise qui vous emmène vers un formulaire avec
+plusieurs champs (intitulé, description, type de l'offre, missions, durée,
+départements et date d'expiration). 
 
-### Ajout d'une offre
+### Modifier une offre
 
- - Acteurs: tout personnel autorisé (le responsable et l' assistant du pôle des relations extérieures et les chargés de relations entreprises).
- - Quand: à tout moment.
- - Action: saisie des données sur une nouvelle offre.
- - Déclenche: notification au chargés de relations entreprises (à toutes les personnes du pôle des relations extérieures).
- - Remarques: ...
+Pour modifier une offre, on peut le faire avec le bouton `Modifier l'offre` sous
+les informations de l'offre présent sur la fiche entreprise de celle-ci. Toutes
+les informations du peuvent être modifiés. 
 
-### Validation d'une offre par un responsable de formation
-- Acteur: les responsables de formation
-- Quand: après la demande de validation d'une offre par le pôle des relations extérieures.
-- Action: valide l'ajout d'une offre.
-- Déclenche: notification au chargés de relations entreprises (à toutes les personnes du pôle des relations extérieures).
-- Remarques: si l'ajout d'une offre est non validé, elle peut être modifier par la suite 
+Les champs sont préremplis avec les informations actuelles de l'offre. 
 
-### Modification d'une offre
-- Acteurs: tout personnel autorisé (le responsable et l' assistant du pôle des relations extérieures et les chargés de relations entreprises).
-- Quand: à tout moment.
-- Action: modifie les données d'une offre.
-- Déclenche: ajout des modifications dans un historique visible.
-- Remarques: ...
+### Supprimer une offre
 
-### Suppression d'une offre
- - Acteurs: tout personnel autorisé (le responsable et l' assistant du pôle des relations extérieures et les chargés de relations entreprises).
- - Quand: à tout moment.
- - Action: suppression d'une offre expiré (peut-être dans d'autre cas à voir)
- - Déclenche: notification au chargés de relations entreprises (à toutes les personnes du pôle des relations extérieures).
- - Remarques: ...
+Pour supprimer une offre, on peut le faire avec le bouton `Supprimer l'offre`.
+On peut supprimer toutes les offres. 
 
-### Envoie d'une offre à un responsable de formation
- - Acteurs: tout personnel autorisé (le responsable et l' assistant du pôle des relations extérieures et les chargés de relations entreprises).
- - Quand: à tout moment.
- - Action: envoie d'une offre a un responsable de formation.
- - Déclenche: notification au responsable de formation.
- - Remarques: ...
+### Attacher un fichier à une offre existante
 
-### Envoie d'une offre aux étudiants par le responsable de formation
- - Acteurs: le responsable de formation.
- - Quand: après avoir reçu une offre de la part du pôle des relations extérieures
- - Action: envoie d'une offre aux étudiants d'une formation
- - Déclenche: notification aux étudiants, ajout de l'offre dans le journal de bord des étudiants afin qu'il puisse candidater et commenter leur candidature
- - Remarques: le responsable peut envoyer l'offre à tous ces élèves ou cibler les élèves.
+On peut attacher un ou plusieurs fichiers à une offre avec le lien `Ajoutez un
+fichier` sous les informations de l'offre qui vous emmène vers un formulaire ou
+il faut choisir le fichier à attaché. Les extensions de fichier acceptés sont
+.docx et .pdf 
 
-### Consultation journal de bord des étudiants
- - Acteurs: tout personnel autorisé.
- - Quand: à tout moment.
- - Action: accès aux journaux de bord par formation.
- - Déclenche: rien.
- - Remarques: ...
+Le fichier est stocké sur le disque.
 
-### ...
+### Télécharger un fichier attaché
 
+On peut télécharger un fichier attaché à une offre en cliquant sur le nom du
+fichier. 
 
-## Échanges de données avec ScoDoc et autres composants du SI
+### Supprimer un fichier attaché a une offre existante
 
-Dans cette section, on préciser les besoins de l'appli "relations entreprises": points API avec ScoDoc et éventuellement d'autres composants du SI.
+Chaque fichier attaché à une offre peut être supprimé.
 
-L'API de ScoDoc 9 étant en cours de rénovation, on précisera simplement, dans un premier temps, les besoins sans indiquer les points d'API précis. par exemple:
- - informations (dates, intitulés) sur une formation
- - informations sur les formations suivies par un étudiant identifié par son INE
- - récupérer l'id de l'utilisateur responsable d'une formation
- - ...
 
-Réfléchir à l'utilisation (ou non) d'un accès à l'annuaire LDAP de l'établissement pour avoir les rôles. Une autre solution serait de se reposer sur ScoDoc pour avoir les id utilisateurs et les rôles.
 
+## Saisie et gestion de la taxe d'apprentissage
 
-## Idées
+### Ajout taxe d'apprentissage
 
-Possibilité aux entreprises de saisir leurs offres avec validation par le pôle des relations extérieures.
+Sur la fiche entreprise, il est possible de saisir la taxe d'apprentissage
+versée par l'entreprise avec l'année, le montant et une note avec le bouton
+`Ajouter taxe d'apprentissage`.
 
-Possibilité d'importer des données déjà existantes (Excel).
+### Modifier/Supprimer taxe d'apprentissage
 
-## Architecture de l'application
+Il est possible de modifier et de supprimer les informations sur la taxe d'apprentissage.
+
+## Historique des modifications des fiches entreprises
+
+Toutes les opérations de création, modification, suppression est ajouté dans la
+liste des dernières opérations de toutes les entreprises et sur leur propre
+fiche entreprise qui sert d'historique des modifications. 
+
+## Ajouter un étudiant qui a déjà réalisé un stage ou une alternance au sein de l'entreprise
+
+On peut ajouter un étudiant qui a déjà réalisé un stage ou une alternance au
+sein de l'entreprise avec le bouton `Ajouter historique` qui vous emmène vers un
+formulaire avec les champs étudiant (auto suggestion de nom d'étudiant selon la
+saisie), type de l'offre, date début et date fin. 
+
+## Envoi des offres aux responsables de formations
+
+### Envoi des offres aux responsables
+
+Sous chaque offre, il y a un bouton `Envoyer offre` qui permet d'envoyer une
+offre à un utilisateur de ScoDoc avec un champ (auto suggestion). Les offres
+envoyées arrivent sur la page "Offres reçues"
+(`.../ScoDoc/entreprise/offres_recues`) 
+
+Envoie a plusieurs utilisateurs possible avec le bouton `Ajouter un responsable` qui rajoute un champ.
+
+### Page "Offres reçues"
+
+La page "Offres reçues" affichent les offres qui ont été envoyés par d'autres utilisateurs ScoDoc.
 
- - Module ScoDoc (blueprint) offrant pages pour les personnels et API.
 
- - Module étudiant: séparé, interfacé via API (à définir plus tard)
 
- - Module entreprises: séparé, interfacé via API: à définir (plus tard ?)
 
-## Questions