mise a jour documentation module gestion relations entreprises

docs/RelationsEntreprisesDoc.md

@@ -1,57 +1,156 @@
-# Documentation application "relations entreprises"
+# Documentation module gestion des "relations entreprises"
 
-Cette application permet à ses 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 permet à ses utilisateurs de retrouver et mémoriser toutes les relations entreprises dans un même endroit sous la forme d'une base interne.
 
-Pour tester l'application : `.../ScoDoc/entreprises`
-
-Faire la commande <code>flask db upgrade</code> si la base n'est pas à jour
+Faire la commande <code>flask db upgrade</code> si la base n'est pas à jour.
 
 ## Principales fonctionnalités
 
-L'application, intégrée à ScoDoc, fournit pour l'instant:
+Le module, intégrée à ScoDoc, fournit pour l'instant:
 
-- Saisie et gestion des entreprises
+- Saisie et gestion des entreprises et contacts
 - 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
+- Systemes de rôles
 
-## Saisie et gestion des entreprises
+## Systemes de rôles
 
-Pour la saisie d'une entreprise, il y a un bouton `Ajouter une entreprise` qui vous emmène vers un formulaire comportant 2 partie, la partie entreprise avec tous les champs sur l'entreprise (SIRET, nom, adresse, code postal, pays) puis la partie contact avec les champs concernant le contact de cette entreprise (nom, prenom, téléphone mail, poste, service) car il y a obligatoirement un contact pour chaque entreprise de la base.
+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.
 
-Le champ SIRET peut autoremplir les autres champs de la partie entreprise si le SIRET fournit correspond bien à celle d'une entreprise existante.
+### Rôle ObservateurEntreprise
+
+Permission de ce rôle:
+- Voir l'application relations entreprises
+
+### Rôle UtilisateurEntreprise
+
+Permissions de ce rôle:
+- Voir l'application relations entreprises
+- Modifier les entreprises
+
+### Rôle AdminEntreprise
+
+Permissions de ce rôle:
+- Voir l'application relations entreprises
+- Modifier les entreprises
+- Exporter les données de l'application relations entreprises (et importer)
+- Envoyer des offres
+- Valide les entreprises
+
+## Saisie et gestion des entreprises et contacts
+
+### Liste des entreprises
 
 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.
 
-Pour la gestion des entreprises, on peut modifier/supprimer à partir de la liste des entreprises ou à partir de leur fiche entreprise.
+### Fiche entreprise
 
-On peut également ajouter/modifier/supprimer un contact sur chaque fiche entreprise (minimum 1 contact sur chaque fiche entreprise).
+Chaque entreprises de la base possède une fiche entreprise avec dessus les informations de l'entreprise (SIRET, nom, adresse, code postal, pays), les contacts, les offres, les dernières opérations, l'historique concernant l'entreprise.
 
-Il y a une page qui liste tous les contacts avec le nom de l'entreprise dont ils appartiennent à la page : `.../ScoDoc/entreprises/contacts`
+### Ajouter une entreprise
 
-La liste des entreprises et des contacts peut être exporté en excel avec le bouton `Exporter la liste des entreprises` ou `Exporter la liste des contacts`.
+Pour ajouter une entreprise dans la base, il y a un bouton `Ajouter une entreprise` qui vous emmène vers un formulaire comportant 2 partie, la partie entreprise avec tous les champs sur l'entreprise (SIRET, nom, adresse, code postal, pays) puis la partie contact avec les champs concernant le contact de cette entreprise (nom, prenom, téléphone mail, poste, service) car il y a obligatoirement un contact pour chaque entreprise de la base avec au moins un moyen de contact (téléphone ou mail).
 
-### Historique des modifications des fiches entreprises
+### Formulaire `Ajouter une entreprise` auto remplissant
 
-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.
+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.
 
-Le formulaire de modification d'une entreprise permet de modifier les informations de l'entreprise (sauf le SIRET, si vous voulez modifier le SIRET, il faut recréer l'entreprise). Le formulaire prérempli les champs avec les informations actuelles.
+Il auto remplit les champs: nom, adresse, code postal, pays.
 
-### Historique à propos des entreprises
+### Modifier une entreprise
 
-Sur chaque fiche entreprise, on peut ajouter un étudiant ayant déjà réalisé un stage ou une alternance dans cette entreprise. Le formulaire possède plusieurs champs (l'étudiant, le type de l'offre, date de début et date de fin). Le champ étudiant propose des résultats en fonction de la saisie utilisateur (nom de l'étudiant).
+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.
 
-L'historique des étudiants est affiché sur la fiche entreprise.
+Les champs sont préremplis avec les informations actuelles de l'entreprise
+
+### Supprimer une entreprise
+
+Pour supprimer une entreprise, on peut le faire à partir de la liste des entreprises ou alors sur la fiche entreprise de l'entreprise avec le bouton `Supprimer`. La suppression d'une entreprise efface tous les éléments reliés à l'entreprise. (offres, contacts, historique, fichiers)
+
+### Validation d'une entreprise
+
+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
+
+### Ajouter un contact
+
+On peut ajouter un contact à une entreprise avec le bouton `Ajouter contact` présent sur la fiche entreprise 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.
+
+Les contacts ne peuvent pas avoir le même nom et prénom au sein d'une même entreprise.
+
+### Modifier un contact
+
+Pour modifier un contact, on peut le faire avec le bouton `Modifier contact` sous les informations du contact présent sur la fiche entreprise de celle-ci. Toutes les informations du peuvent être modifiés.
+
+Les champs sont préremplis avec les informations actuelles du contact
+
+### Supprimer un contact
+
+Pour supprimer un contact, on peut le faire avec le bouton `Supprimer contact`. On peut supprimer tous les contacts tant qu'il en reste un (il faut un minimum de 1 contact par fiche entreprise)
+
+### Page offres expirés
+
+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`
+
+### Pages contacts
+
+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.
+
+### Exportation des données
+
+Toutes les listes (entreprises et contacts) sont exportables en .xlxs avec des boutons présents au dessus des listes: `Exporter la liste des entreprise`, `Exporter la liste des contacts` et `Exporter la liste des contacts avec leur entreprise`
 
 ## Saisie et gestion des offres de stage et d'apprentissage
 
-Pour la saisie d'une offre, il y a un bouton `Ajouter offre` sur chaque fiche entreprise qui vous emmène vers le formulaire pour la saisie des offres avec les champs (intitulé, description, type de l'offre, missions, durée).
+### Ajouter une offre
 
-L'offre est ensuite ajouté a la fiche entreprise, elle peut être modifier et/ou supprimer. On peut également attacher un ou plusieurs fichiers à une offre (stocké sur disque) et en supprimer.
+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).
 
-Les fichiers attachés peuvent être téléchargé en cliquant sur le nom du fichier.
+### Modifier une offre
+
+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.
+
+Les champs sont préremplis avec les informations actuelles de l'offre
+
+### Supprimer une offre
+
+Pour supprimer une offre, on peut le faire avec le bouton `Supprimer l'offre`. On peut supprimer toutes les offres.
+
+### Attacher un fichier à une offre existante
+
+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
+
+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.
+
+### Supprimer un fichier attaché a une offre existante
+
+Chaque fichier attaché à une offre peut être supprimer (du disque)
+
+## 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
 
-Chaque offre peuvent être envoyé à un utilisateur ScoDoc avec le bouton `Envoyer l'offre`. Les offres reçues sont sur la page : `.../ScoDoc/entreprises/offres`
+### 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 des Offres reçues (`.../ScoDoc/entreprise/offres_recues`)
+
+### Page offres reçues
+
+La page des offres reçues affichent les offres qui ont été envoyés par d'autres utilisateurs ScoDoc.
+
+### Fonctionnalités à venir
+
+- Importation de données
+- API
+- améliorations et nouvelles fonctionnalités à voir avec les utilisateurs