From 6bfb229995de5e75f52c00f3389b4a183e89913c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Thu, 24 Mar 2022 11:04:36 +0100 Subject: [PATCH] fix doc for admin/generation-documents --- admin/generation-documents.md | 269 ++++++++++++++++++++-------------- 1 file changed, 156 insertions(+), 113 deletions(-) diff --git a/admin/generation-documents.md b/admin/generation-documents.md index 5497248..9f20cc8 100644 --- a/admin/generation-documents.md +++ b/admin/generation-documents.md @@ -276,6 +276,9 @@ Présence à l'échange * `address` (Adresse): l'adresse actuelle ::: { .vendee } + +Au 23 mars 2022, ces champs ne sont plus disponibles: + * `numCaf` (texte): le numéro CAF; * `numSS` (texte): le numéro de sécurité sociale; * `numMSA` (texte): le numéro MSA; @@ -283,121 +286,139 @@ Présence à l'échange * `doctor` (ThirdParty): le médecin traitant; * `situationProf` (texte): la situation professionnelle; * `situationProfDate` (Date): date de la situation professionnelle; -* `statutLogement` (texte): statut au regard du logement; -* `niveauEtude` (texte): le niveau d''étude; -* `identifiantPoleEmploi` (texte) -* `accompagnementMissionLocale` (texte) -* `gensDuVoyage` (bool): `true` si la personne fait partie des gens du voyage -* `titreDeSejour` (TitreDeSejour): entité TitreDeSejour -* `titreDeSejourComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `situationProfessionelle` (SituationProfessionelle): entité SituationProfessionelle -* `aidantFamilial` (bool): `true` si la personne fait partie des gens du voyage -* `tempsDeTravail` (TempsDeTravail): entité TempsDeTravail -* `situationProfessionelleComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `situationProfessionelleStartDate` (Date) -* `niveauEtude` (NiveauEtude): entité NiveauEtude -* `mobilite` (mMbilite): entité Mobilite -* `permisDeConduire` (bool): `true` si la personne a un permis de conduire -* `moyenDeTransport` (bool): `true` si la personne a un moyen de transport -* `infoSocioProComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `entourage` (Entourage): entité Entourage -* `entourageComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `numeroSecuriteSociale` (texte) -* `caisseSecuriteSociale` (texte) -* `pasDeMedecinTraitant` (bool): `true` si la personne n'a pas de médecin traitant -* `medecinTraitant` (Tiers): entité ThirdParty -* `medecinTraitantTexteLibre` (texte) -* `mdph` (texte) -* `mdphStartDate` (Date) -* `mdphEndDate` (Date) -* `mdphComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `aah` (texte) -* `aahStartDate` (Date) -* `aahEndDate` (Date) -* `aahComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `rqth` (texte) -* `rqthStartDate` (Date) -* `rqthEndDate` (Date) -* `rqthComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `pcdh` (texte) -* `pcdhStartDate` (Date) -* `pcdhEndDate` (Date) -* `pcdhComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `adpa` (texte) -* `adpaStartDate` (Date) -* `adpaEndDate` (Date) -* `adpaComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `gir` (texte) -* `girStartDate` (Date) -* `girEndDate` (Date) -* `girComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `infoMedicaleComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `statutLogement` (StatutLogement): entité StatutLogement -* `statutLogementComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `caisseDeRetraitePrincipale` (texte) -* `caisseDeRetraiteComment` (Comment): Commentaire (avec la date de la dernière mise à jour) -* `caissesDeRetraiteComplementaires` (texte): Caisses de retraite complémentaires, séparées par des virgules + +Par ailleurs, la nature de ces champs a changé: + +* `statutLogement` +* `niveauEtude` + +Ces champs sont disponibles, dès le 22 mars: + +* `extras.majeur.isNull` (bool): si un dossier "majeur" a été créé +* `extras.majeur.caisseDeRetraiteComplementaire` (liste de texte): les caisses de retraite complémentaires, en liste de texte; +* `extras.majeur.caisseDeRetraiteComplementaireText` (texte): les caisses de retraite complémentaires, dans un seul champ texte, séparé par des virgules; +* `extras.majeur.numeroCAF` (texte): le numéro CAF; +* `extras.majeur.numeroSecuriteSociale` (texte): le numéro de sécurité sociale; +* `extras.majeur.numMSA` (texte): le numéro MSA; +* `extras.majeur.mutuelle` (texte): le nom de la mutuelle +* `extras.majeur.medecinTraintant` (ThirdParty): le médecin traitant; +* `extras.majeur.situationProfessionelle` (texte): la situation professionnelle; +* `extras.majeur.situationProfessionelleComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.situationProfessionelleStartDate` (Date) +* `extras.majeur.statutLogement` (StatutLogement): statut au regard du logement; +* `extras.majeur.niveauEtude` (NiveauEtude): le niveau d''étude; +* `extras.majeur.identifiantPoleEmploi` (texte) +* `extras.majeur.accompagnementMissionLocale` (texte) +* `extras.majeur.gensDuVoyage` (bool): `true` si la personne fait partie des gens du voyage +* `extras.majeur.titreDeSejour` (TitreDeSejour): entité TitreDeSejour +* `extras.majeur.titreDeSejourComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.situationProfessionelle` (SituationProfessionelle): entité SituationProfessionelle +* `extras.majeur.aidantFamilial` (bool): `true` si la personne fait partie des gens du voyage +* `extras.majeur.tempsDeTravail` (TempsDeTravail): entité TempsDeTravail +* `extras.majeur.niveauEtude` (NiveauEtude): entité NiveauEtude +* `extras.majeur.mobilite` (mMbilite): entité Mobilite +* `extras.majeur.permisDeConduire` (bool): `true` si la personne a un permis de conduire +* `extras.majeur.moyenDeTransport` (bool): `true` si la personne a un moyen de transport +* `extras.majeur.infoSocioProComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.entourage` (Entourage): entité Entourage +* `extras.majeur.entourageComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.numeroSecuriteSociale` (texte) +* `extras.majeur.caisseSecuriteSociale` (texte) +* `extras.majeur.pasDeMedecinTraitant` (bool): `true` si la personne n'a pas de médecin traitant +* `extras.majeur.medecinTraitant` (Tiers): entité ThirdParty +* `extras.majeur.medecinTraitantTexteLibre` (texte) +* `extras.majeur.mdph` (texte) +* `extras.majeur.mdphStartDate` (Date) +* `extras.majeur.mdphEndDate` (Date) +* `extras.majeur.mdphComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.aah` (texte) +* `extras.majeur.aahStartDate` (Date) +* `extras.majeur.aahEndDate` (Date) +* `extras.majeur.aahComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.rqth` (texte) +* `extras.majeur.rqthStartDate` (Date) +* `extras.majeur.rqthEndDate` (Date) +* `extras.majeur.rqthComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.pcdh` (texte) +* `extras.majeur.pcdhStartDate` (Date) +* `extras.majeur.pcdhEndDate` (Date) +* `extras.majeur.pcdhComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.adpa` (texte) +* `extras.majeur.adpaStartDate` (Date) +* `extras.majeur.adpaEndDate` (Date) +* `extras.majeur.adpaComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.gir` (texte) +* `extras.majeur.girStartDate` (Date) +* `extras.majeur.girEndDate` (Date) +* `extras.majeur.girComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.infoMedicaleComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.statutLogement` (StatutLogement): entité StatutLogement +* `extras.majeur.statutLogementComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.caisseDeRetraitePrincipale` (texte) +* `extras.majeur.caisseDeRetraiteComment` (Comment): Commentaire (avec la date de la dernière mise à jour) +* `extras.majeur.caissesDeRetraiteComplementaires` (texte): Caisses de retraite complémentaires, séparées par des virgules En outre, si la personne est mineure, on a accès aux champs suivants: -* `enfantConfie` (bool): `true` si enfant confié -* `dossierASE` (texte) -* `autoriteParentale` (texte) -* `autoriteParentaleComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `identificationAutoriteParentale1` (texte) -* `identificationAutoriteParentale2` (texte) -* `autoriteParentale1Date` (Date) -* `autoriteParentale2Date` (Date) -* `retraitAutoriteParentale` (bool): `true` si retraitAutoriteParentale -* `retraitAutoriteParentaleDate` (Date) -* `retraitAutoriteParentaleComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `delegation` (bool): `true` si délégation -* `delegationDate` (Date) -* `delegationComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `delegationThirdParty` (tiers): entité ThirdParty -* `delegationPerson` (person): entité Person -* `tuteur` (texte) -* `tuteurThirdParty` (tiers): entité ThirdParty -* `administrateurAdhoc` (bool): `true` si administrateurAdhoc -* `administrateurAdhocDate` (Date) -* `administrateurAdhocComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `pupilleEtat` (bool): `true` si pupilleEtat -* `pupilleEtatDate` (Date) -* `pupilleComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `tuteurPerson` (person): entité Person -* `enfantEmancipe` (bool): `true` si enfantEmancipe -* `enfantEmancipeDate` (Date) -* `gardeAlternee` (texte) -* `decisionJAF` (bool): `true` si decisionJAF -* `decisionJAFDate` (Date) -* `decisionJAFEnfantConfie` (bool): `true` si decisionJAFEnfantConfie -* `decisionJAFDateEnfantConfie` (Date) -* `fratrieComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `droitDeVisiteComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `infoFamilialeComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `residenceMineur` (texte) -* `derniereVisiteMedicaleDate` (Date) -* `visiteMedicaleText` (texte) -* `prochaineVisiteMedicaleDate` (Date) -* `autresRDV` (texte) -* `infoMedicaleComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `scolarise` (bool): `true` si scolarisé -* `derniereClasseScolaire` (texte) -* `etablissementScolaire` (texte) -* `classeScolaire` (texte) -* `alternance` (bool): `true` si alternance -* `alternanceEntreprise` (texte) -* `enseignantReferant` (texte) -* `scolariteComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `mineurComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `autresIntervenantsComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `dispositifs` (texte) -* `dossierMDPH` (texte) -* `notificationMDPH` (texte) -* `notificationMDPHStartDate` (Date) -* `notificationMDPHEndDate` (Date) -* `dispositifsComment` (Comment): Commentaire (avec la date de la dernire mise à jour) -* `adresseDeRelais` (adresse): liste d'adresses +* `extras.majeur.isNull` (bool): si un dossier "mineur" a été créé +* `extras.mineur.enfantConfie` (bool): `true` si enfant confié +* `extras.mineur.dossierASE` (texte) +* `extras.mineur.autoriteParentale` (texte) +* `extras.mineur.autoriteParentaleComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.identificationAutoriteParentale1` (texte) +* `extras.mineur.identificationAutoriteParentale2` (texte) +* `extras.mineur.autoriteParentale1Date` (Date) +* `extras.mineur.autoriteParentale2Date` (Date) +* `extras.mineur.retraitAutoriteParentale` (bool): `true` si retraitAutoriteParentale +* `extras.mineur.retraitAutoriteParentaleDate` (Date) +* `extras.mineur.retraitAutoriteParentaleComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.delegation` (bool): `true` si délégation +* `extras.mineur.delegationDate` (Date) +* `extras.mineur.delegationComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.delegationThirdParty` (tiers): entité ThirdParty +* `extras.mineur.delegationPerson` (person): entité Person +* `extras.mineur.tuteur` (texte) +* `extras.mineur.tuteurThirdParty` (tiers): entité ThirdParty +* `extras.mineur.administrateurAdhoc` (bool): `true` si administrateurAdhoc +* `extras.mineur.administrateurAdhocDate` (Date) +* `extras.mineur.administrateurAdhocComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.pupilleEtat` (bool): `true` si pupilleEtat +* `extras.mineur.pupilleEtatDate` (Date) +* `extras.mineur.pupilleComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.tuteurPerson` (person): entité Person +* `extras.mineur.enfantEmancipe` (bool): `true` si enfantEmancipe +* `extras.mineur.enfantEmancipeDate` (Date) +* `extras.mineur.gardeAlternee` (bool) +* `extras.mineur.decisionJAF` (bool): `true` si decisionJAF +* `extras.mineur.decisionJAFDate` (Date) +* `extras.mineur.decisionJAFEnfantConfie` (bool): `true` si decisionJAFEnfantConfie +* `extras.mineur.decisionJAFDateEnfantConfie` (Date) +* `extras.mineur.fratrieComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.droitDeVisiteComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.infoFamilialeComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.residenceMineur` (texte) +* `extras.mineur.derniereVisiteMedicaleDate` (Date) +* `extras.mineur.visiteMedicaleText` (texte) +* `extras.mineur.prochaineVisiteMedicaleDate` (Date) +* `extras.mineur.autresRDV` (texte) +* `extras.mineur.infoMedicaleComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.scolarise` (bool): `true` si scolarisé +* `extras.mineur.derniereClasseScolaire` (texte) +* `extras.mineur.etablissementScolaire` (texte) +* `extras.mineur.classeScolaire` (texte) +* `extras.mineur.alternance` (bool): `true` si alternance +* `extras.mineur.alternanceEntreprise` (texte) +* `extras.mineur.enseignantReferant` (texte) +* `extras.mineur.scolariteComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.mineurComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.autresIntervenantsComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.dispositifs` (texte) +* `extras.mineur.dossierMDPH` (texte) +* `extras.mineur.notificationMDPH` (texte) +* `extras.mineur.notificationMDPHStartDate` (Date) +* `extras.mineur.notificationMDPHEndDate` (Date) +* `extras.mineur.dispositifsComment` (Comment): Commentaire (avec la date de la dernire mise à jour) +* `extras.mineur.adresseDeRelais` (adresse): liste d'adresses ::: #### variant `household` @@ -418,6 +439,28 @@ Nom du père: ${personFatherLastName} ${personFatherFirstname} // Dupuis Marcel Téléphone du père: ${personFatherFirstphonenumber} // 01 23 45 67 89 ``` +::: { .vendee } + +### StatutLogement + +* `id` (int): identifiant (utile pour des comparaisons); +* `active` (bool): si le statut est encore utilisé; +* `name` (texte): titre + +### NiveauEtude + +* `id` (int): identifiant (utile pour des comparaisons); +* `active` (bool): si le niveau d'étude est encore utilisé; +* `name` (texte): titre + +### SituationProfessionelle + +* `id` (int): identifiant (utile pour des comparaisons); +* `active` (bool): si la situation professionelle est encore utilisée +* `name` (texte): titre + +::: + ### Civility * `abbreviation` (texte): abbréviation; @@ -602,7 +645,7 @@ Les variables présentent le nom de la relation (`text`), et la personne avec qu * `createdBy` (Date): date de mise à jour; * `createdAt` (User): utilisateur ayant fait la mise à jour; * `createdAutomatically` (bool): `true` si l'action a été créée automatiquement (par exemple, en créant un échange); -* `evaluations` (AccompanyingPeriodEvaluation): liste des évaluations générées +* `evaluations` (AccompanyingPeriodWorkEvaluation): liste des évaluations générées ### SocialAction (type d'action d'accompagnement)