admin/docgen: ré-ordonne les objets par ordre alphabétique + uniquement les objets pour toutes les instances
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
This commit is contained in:
parent
ca7a42af0b
commit
81610bcf52
GPG Key ID:
BDE2190974723FCB
|
|
@ -226,7 +226,7 @@ Les champs suivant sont disponibles:
|
|||
|
||||
## Champs par objet { #sec:gendoc-champs-objets }
|
||||
|
||||
### AccompanyingPeriod
|
||||
### AccompanyingPeriod (Parcours)
|
||||
|
||||
* `id` (texte): l'identifiant du parcours
|
||||
* `type` (texte): toujours égal à `accompanying_course`
|
||||
|
|
@ -272,20 +272,22 @@ Les champs suivant sont disponibles:
|
|||
* `comments` (liste de AccompanyingPeriodComment): liste des commentaires;
|
||||
* `pinnedComment` (AccompanyingPeriodComment): commentaire épinglé;
|
||||
|
||||
### AccompanyingPeriodComment
|
||||
### AccompanyingPeriodComment (Commentaire du parcours)
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `content` (texte): contenu du commentaire
|
||||
* `createdAt` (Date): date de création
|
||||
* `creator` (User): Créateur du commentaire
|
||||
|
||||
### AccompanyingPeriodOrigin
|
||||
### AccompanyingPeriodOrigin (Origine du parcours)
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `label` (texte): libellé de l'origine;
|
||||
|
||||
|
||||
### AccompanyingPeriodParticipation
|
||||
### AccompanyingPeriodParticipation (Participation à un parcours)
|
||||
|
||||
Cet objet effectue la jointure entre les parcours et les usagers concernés à un parcours. Elle permet d'avoir accès à des informations supplémentaires, comme la date de début et l'éventuelle date de fin de la participation à un parcours.
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `person` (Person): usager associé au parcours;
|
||||
|
|
@ -293,13 +295,51 @@ Les champs suivant sont disponibles:
|
|||
* `endDate` (Date): date de fin. Vide si la participation est toujours en cours;
|
||||
|
||||
|
||||
### AccompanyingPeriodResource
|
||||
### AccompanyingPeriodResource (Interlocuteur privilégiés dans un parcours)
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `person` (Person): usager ressource (vide, avec le paramètre `isNull` à `true`, si la ressource est un tiers);
|
||||
* `thirdParty` (ThirdParty): tiers ressource (vide, avec le paramètre `isNull` à `true`, si la ressource est une personne);
|
||||
* `comment` (texte): commentaire associé à la personne ressource.
|
||||
|
||||
### AccompanyingPeriodWork (Action d'accompagnement)
|
||||
|
||||
* `id` (texte): l'identifiant de l'action;
|
||||
* `note` (texte): la note;
|
||||
* `persons` (liste de Person): liste des usagers concernés par l'action
|
||||
* `results` (liste de Result): liste des résultats directement associé au parcours (résultats sans objectifs)
|
||||
* `socialAction` (SocialAction): type d'action sociale;
|
||||
* `startDate` (Date): la date de début de l'action (vide si inexistant)
|
||||
* `endDate` (Date): la date de début de l'action (vide si inexistant)
|
||||
* `thirdParties` (liste de ThirdParty): les tiers associés à l'action comme tiers intervenants;
|
||||
* `updatedBy` (User): utilisateur ayant fait la mise à jour;
|
||||
* `updatedAt` (Date): date de mise à jour;
|
||||
* `handlingThierParty` (ThirdParty): tiers traitant;
|
||||
* `goals` (AccompanyingPeriodWorkGoal): objectifs
|
||||
* `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` (AccompanyingPeriodWorkEvaluation): liste des évaluations générées;
|
||||
* `referrers` (liste de User): liste des agents traitants;
|
||||
|
||||
### AccompanyingPeriodWorkEvaluation (évaluation dans une action d'accompagnement)
|
||||
|
||||
* `id` (texte): l'identifiant de l'évaluation;
|
||||
* `type` (texte): le libellé de l'évaluation;
|
||||
* `startDate` (Date): la date de début de l'évaluation;
|
||||
* `endDate` (Date) la date de fin de l'évaluation;
|
||||
* `maxDate` (Date): la date d'échéance de l'évaluation;
|
||||
* `comment` (texte): le commentaire de l'évaluation;
|
||||
* `createdBy` (User): le créateur de l'évaluation;
|
||||
* `createdAt` (Date): la date de création de l'évaluation;
|
||||
* `evaluation` (Evaluation): le type d'évaluation;
|
||||
|
||||
### AccompanyingPeriodWorkGoal (objectifs et résultats d'une action d'accompagnement)
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `goal` (Goal): objectif d'une action
|
||||
* `results` (liste de Result): liste des résultats
|
||||
|
||||
|
||||
### Activity (échange)
|
||||
|
||||
|
|
@ -332,38 +372,136 @@ Ce variant comporte les mêmes attributs, avec les différences suivantes:
|
|||
* le champ `reasons` n'est pas présent;
|
||||
* le champ `comment` est également présenté avec le variant `light`.
|
||||
|
||||
### ActivityType
|
||||
### ActivityType (Type d'activité)
|
||||
|
||||
Type d'activité.
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `name` (texte): libellé
|
||||
|
||||
### ActivityPresence
|
||||
### ActivityPresence (Présence à l'échange)
|
||||
|
||||
Présence à l'échange
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `name` (texte): libellé
|
||||
|
||||
### ClosingMotive
|
||||
### Address (Une adresse)
|
||||
|
||||
* `address_id` (int): l'identifiant de l'adresse;
|
||||
* `text` (texte): une chaine de caractère représentant l'adresse complète;
|
||||
* `street` (texte): le nom de la rue (exemple: "RUE DES ÉGLANTIERS");
|
||||
* `streetNumber` (texte): le numéro de police;
|
||||
* `postcode` (PostCode): le code postal;
|
||||
* `country` (Country): le pays de l'adresse;
|
||||
* `floor` (texte): l'étage;
|
||||
* `corridor` (texte): le couloir;
|
||||
* `flat` (texte): l'appartement;
|
||||
* `buildingName` (texte): le nom du bâtiment / résidence;
|
||||
* `distribution` (texte): service particulier de distribution;
|
||||
* `extra` (texte): champs extras
|
||||
* `validFrom` (Date): date de début de validité;
|
||||
* `validTo` (Date): date de fin de validité (vide si toujours valide);
|
||||
* `lines` (liste de texte): les lignes de l'adresses, comme elles devraient être formatées dans une adresses
|
||||
|
||||
Il est possible de représenter l'adresse au format postal en effectuant une boucle sur les lignes. Par exemple, pour l'adresse d'une personne (chaque ligne est un "renvoi > substituant" dans l'exemple ci-dessous):
|
||||
|
||||
```
|
||||
for each="line in v.person.address.lines
|
||||
line
|
||||
/for
|
||||
```
|
||||
|
||||
### Comment (Commentaire)
|
||||
|
||||
Certains champs commentaire enregistrent également l'utilisateur qui a effectué la dernière mise à jour, et la date de celle-ci, en plus du commentaire en tant que tel. Ces champs ont les attributs suivants:
|
||||
|
||||
* `comment` (texte): le commentaire en tant que tel;
|
||||
* `date` (Date): la date de la dernière modification;
|
||||
* `user` (User): l'utilisateur qui a effectué la dernière modification;
|
||||
|
||||
#### Variant `light`
|
||||
|
||||
Dans le variant `light`,
|
||||
|
||||
* le champ `date` n'est pas présent;
|
||||
* le champ `user` n'est pas présent.
|
||||
|
||||
Seul le champ `comment` est donc disponible.
|
||||
|
||||
|
||||
### Civility (Civilité)
|
||||
|
||||
* `abbreviation` (texte): abbréviation;
|
||||
* `id` (int): identifiant (utile pour des comparaisons);
|
||||
* `name` (texte): titre, label de la civilité;
|
||||
|
||||
### ClosingMotive (Motif de cloture)
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `name` (texte): libellé
|
||||
|
||||
|
||||
### Date
|
||||
### Country (Pays)
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `name` (texte): nom du pays
|
||||
* `code` (texte): deux lettres du code ISO pays
|
||||
|
||||
### Date (Date)
|
||||
|
||||
* `short` (texte): la date au format dd/mm/yyyy, vide si la date est absente;
|
||||
* `long` (texte): la date au format jour mois années: 15 août 1980, vide si al date est absente;
|
||||
|
||||
### NiveauEtude
|
||||
### Evaluation (type d'évaluation)
|
||||
|
||||
* `id` (int): identifiant (utile pour des comparaisons);
|
||||
* `active` (bool): si le niveau d'étude est encore utilisé;
|
||||
* `name` (texte): titre
|
||||
* `id` (texte): l'identifiant du type d'évaluation;
|
||||
* `title` (texte): le titre du type d'évaluation;
|
||||
|
||||
### Person
|
||||
### Goal (objectif d'une action)
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `title` (texte): le titre du résultat
|
||||
|
||||
### Household (Ménage)
|
||||
|
||||
|
||||
* `id` (int): l'identifiant du ménage;
|
||||
* `members` (liste de HouseholdMember): liste des membres du ménages;
|
||||
* `waitingForBirth` (bool): `true` si une naissance est attendue;
|
||||
* `waitingForBirthDate` (Date): date de la naissance attendue;
|
||||
|
||||
### HouseholdMember (Membre d'un ménage)
|
||||
|
||||
* `comment` (texte): texte du commentaire;
|
||||
* `id` (int): identifiant de la participation au ménage;
|
||||
* `endDate` (Date): date de fin de participation au ménage;
|
||||
* `holder` (bool): `true` si le participant est titulaire;
|
||||
* `person` (Person): l'usager qui est membre du ménage;
|
||||
* `position` (HouseholdPosition): la position du membre dans le ménage;
|
||||
* `startDate` (Date): date de début de participation au ménage;
|
||||
|
||||
### HouseholdPosition (Position du membre dans le ménage)
|
||||
|
||||
* `id` (int): identifiant de la position;
|
||||
* `label` (texte): label de la position dans le ménage;
|
||||
|
||||
### Location (lieu)
|
||||
|
||||
* `id` (int): identifant;
|
||||
* `name` (texte): nom;
|
||||
* `address` (Address): adresse du lieu;
|
||||
* `phonenumber1` (texte): numéro de téléphone;
|
||||
* `phonenumber2` (texte): numéro de téléphone;
|
||||
* `email` (email): email
|
||||
* `locationType` (LocationType): le type de lieu
|
||||
|
||||
### LocationType (type de lieu)
|
||||
|
||||
* `id` (int): identifant;
|
||||
* `title` (texte): titre du type de lieu;
|
||||
|
||||
### Person (Personne, usager)
|
||||
|
||||
* `id` (texte): Identifiant du dossier usager;
|
||||
* `isNull` (bool): `true` si le dossier usager est vide;
|
||||
|
|
@ -390,150 +528,6 @@ Présence à l'échange
|
|||
* `address` (Adresse): l'adresse actuelle
|
||||
* `resources` (PersonResource): les personnes ressources, ajoutées depuis le dossier de l'usager.
|
||||
|
||||
::: { .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;
|
||||
* `mutuelle` (texte): le nom de la mutuelle
|
||||
* `doctor` (ThirdParty): le médecin traitant;
|
||||
* `situationProf` (texte): la situation professionnelle;
|
||||
* `situationProfDate` (Date): date de la situation professionnelle;
|
||||
|
||||
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.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.caisseDeRetraiteComplementaire` (liste de texte): les caisses de retraite complémentaires, en liste de texte;
|
||||
* `extras.majeur.caissesDeRetraiteComplementairesText` (texte): les caisses de retraite complémentaires, dans un seul champ texte, séparé par des virgules;
|
||||
En outre, si la personne est mineure, on a accès aux champs suivants:
|
||||
|
||||
* `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.autoriteParentaleFr` (texte)
|
||||
* `extras.mineur.autoriteParentaleComment` (Comment): Commentaire (avec la date de la dernire mise à jour)
|
||||
* `extras.mineur.identificationAutoriteParentale1Fr` (texte)
|
||||
* `extras.mineur.identificationAutoriteParentale2Fr` (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.delegationBool` (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.tuteurBool` (bool): TRUE si tuteur
|
||||
* `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`
|
||||
|
||||
* `household` (Household): le ménage actuel de l'usager;
|
||||
|
|
@ -583,20 +577,6 @@ Les attributs suivants sont disponibles, pour chaque objet `Person` qui a un var
|
|||
* `budget.household.resources.<clé du type de ligne de budget>` (Ligne de budget): une ligne de budget pour la ressource dont la clé est indiquée par `<clé du type de ligne de budget>`. La liste des clés est à obtenir auprès de l'administrateur technique. Les lignes de budget de tous les usagers actuels du ménages sont globalisées, ainsi que les lignes de budget associées directement au dossier ménage;
|
||||
* `budget.household.charges.<clé du type de ligne de budget>` (Ligne de budget): une ligne de budget pour la charge dont la clé est indiquée par `<clé du type de ligne de budget>`. La liste des clés est à obtenir auprès de l'administrateur technique. Les lignes de budget de tous les usagers actuels du ménages sont globalisées, ainsi que les lignes de budget associées directement au dossier ménage;
|
||||
|
||||
|
||||
|
||||
#### Exemple d'utilisation
|
||||
|
||||
```
|
||||
Nom de la personne: ${personLastname} // Dupuis
|
||||
Prénom de la personne: ${personFirstname} // Gérard
|
||||
Date de naissance: ${personBirthdateLong} // le 7 juillet 1974
|
||||
Nom du père: ${personFatherLastName} ${personFatherFirstname} // Dupuis Marcel
|
||||
Téléphone du père: ${personFatherFirstphonenumber} // 01 23 45 67 89
|
||||
```
|
||||
|
||||
::: { .vendee }
|
||||
|
||||
### PersonResource (Ressources associée à l'usager)
|
||||
|
||||
Pour rappel, les ressources peuvent être:
|
||||
|
|
@ -619,70 +599,45 @@ Pour rappel, les ressources peuvent être:
|
|||
* `id` (int)
|
||||
* `title` (texte)
|
||||
|
||||
### StatutLogement
|
||||
### Postcode (Code Postal)
|
||||
|
||||
* `id` (int): identifiant (utile pour des comparaisons);
|
||||
* `active` (bool): si le statut est encore utilisé;
|
||||
* `name` (texte): titre
|
||||
* `id` (int): identifiant
|
||||
* `name` (texte): localité
|
||||
* `code` (texte): code postal
|
||||
|
||||
### Relationship (relations (filiations) entre usagers)
|
||||
|
||||
Pour faciliter l'usager, les relations sont toujours représentée à partir d'un usager d'origine.
|
||||
|
||||
Les variables présentent le nom de la relation (`text`), et la personne avec qui la relation est formée (`opposite`).
|
||||
|
||||
* `id` (int): identifant;
|
||||
* `fromPerson` (Person): personne d'origine;
|
||||
* `toPerson` (Person): personne de destination;
|
||||
* `text` (texte): le titre ou le titre inversé de la `Relation`, selon l'usager d'origine;
|
||||
* `opposite` (Person): l'usager avec qui la relation est formée;
|
||||
* `relationId` (int): identifiant du lien de filiation;
|
||||
|
||||
**Note**: la différence entre `fromPerson` et `toPerson` est arbitraire.
|
||||
|
||||
### Result (résultat d'une action)
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `title` (texte): le titre du résultat
|
||||
|
||||
|
||||
### SituationProfessionelle
|
||||
### SocialAction (type d'action d'accompagnement)
|
||||
|
||||
* `id` (int): identifiant (utile pour des comparaisons);
|
||||
* `active` (bool): si la situation professionelle est encore utilisée
|
||||
* `name` (texte): titre
|
||||
* `id` (texte): identifiant
|
||||
* `text` (texte): texte, avec les parents inclus, séparés par un ` > `;
|
||||
* `title`: titre du type d'action, sans les parents;
|
||||
|
||||
:::
|
||||
### Social Issue (problématique sociale)
|
||||
|
||||
### Civility
|
||||
* `name`: le nom de la problématique seule
|
||||
* `text`: le nom de la problématique et des problématiques parentes
|
||||
|
||||
* `abbreviation` (texte): abbréviation;
|
||||
* `id` (int): identifiant (utile pour des comparaisons);
|
||||
* `name` (texte): titre, label de la civilité;
|
||||
|
||||
::: { .vendee }
|
||||
### Entourage
|
||||
|
||||
* `person` (person): entité Person
|
||||
* `thirdParty` (tiers): entité ThirdParty
|
||||
* `text` (texte)
|
||||
* `comment` (comment): Commentaire (avec la date de la dernire mise à jour)
|
||||
* `aidantProche` (bool): `true` si aidantProche
|
||||
|
||||
:::
|
||||
|
||||
### Household
|
||||
|
||||
|
||||
* `id` (int): l'identifiant du ménage;
|
||||
* `members` (liste de HouseholdMember): liste des membres du ménages;
|
||||
* `waitingForBirth` (bool): `true` si une naissance est attendue;
|
||||
* `waitingForBirthDate` (Date): date de la naissance attendue;
|
||||
|
||||
### HouseholdMember
|
||||
|
||||
* `comment` (texte): texte du commentaire;
|
||||
* `id` (int): identifiant de la participation au ménage;
|
||||
* `endDate` (Date): date de fin de participation au ménage;
|
||||
* `holder` (bool): `true` si le participant est titulaire;
|
||||
* `person` (Person): l'usager qui est membre du ménage;
|
||||
* `position` (HouseholdPosition): la position du membre dans le ménage;
|
||||
* `startDate` (Date): date de début de participation au ménage;
|
||||
|
||||
### HouseholdPosition
|
||||
|
||||
* `id` (int): identifiant de la position;
|
||||
* `label` (texte): label de la position dans le ménage;
|
||||
|
||||
|
||||
::: { .vendee }
|
||||
### Mobilite, NiveauEtude, SituationProfessionelle, StatutLogement, TempsDeTravail, TitreDeSejour
|
||||
|
||||
* `active` (bool): `true` si active
|
||||
* `name` (texte)
|
||||
:::
|
||||
|
||||
### ThirdParty
|
||||
### ThirdParty (Tiers)
|
||||
|
||||
* `id` (int): identifiant du tiers;
|
||||
* `acronym` (text): acronyme;
|
||||
|
|
@ -718,46 +673,8 @@ Pour rappel, les ressources peuvent être:
|
|||
* `id` (int): identifiant
|
||||
* `name` (texte)
|
||||
|
||||
### Adresse
|
||||
|
||||
* `address_id` (int): l'identifiant de l'adresse;
|
||||
* `text` (texte): une chaine de caractère représentant l'adresse complète;
|
||||
* `street` (texte): le nom de la rue (exemple: "RUE DES ÉGLANTIERS");
|
||||
* `streetNumber` (texte): le numéro de police;
|
||||
* `postcode` (PostCode): le code postal;
|
||||
* `country` (Country): le pays de l'adresse;
|
||||
* `floor` (texte): l'étage;
|
||||
* `corridor` (texte): le couloir;
|
||||
* `flat` (texte): l'appartement;
|
||||
* `buildingName` (texte): le nom du bâtiment / résidence;
|
||||
* `distribution` (texte): service particulier de distribution;
|
||||
* `extra` (texte): champs extras
|
||||
* `validFrom` (Date): date de début de validité;
|
||||
* `validTo` (Date): date de fin de validité (vide si toujours valide);
|
||||
* `lines` (liste de texte): les lignes de l'adresses, comme elles devraient être formatées dans une adresses
|
||||
|
||||
Il est possible de représenter l'adresse au format postal en effectuant une boucle sur les lignes. Par exemple, pour l'adresse d'une personne (chaque ligne est un "renvoi > substituant" dans l'exemple ci-dessous):
|
||||
|
||||
```
|
||||
for each="line in v.person.address.lines
|
||||
line
|
||||
/for
|
||||
```
|
||||
|
||||
### Postcode
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `name` (texte): localité
|
||||
* `code` (texte): code postal
|
||||
|
||||
### Country
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `name` (texte): nom du pays
|
||||
* `code` (texte): deux lettres du code ISO pays
|
||||
|
||||
|
||||
### User { #sec:gendoc-var-user }
|
||||
### User (Utilisateur) { #sec:gendoc-var-user }
|
||||
|
||||
* `id` (int): identifant
|
||||
* `type` (texte): vaut toujours `user`
|
||||
|
|
@ -771,121 +688,7 @@ line
|
|||
* `main_location` (Location): localisation de l'utilisateur définie par l'administrateur fonctionnel (parfois appelé "résidence administrative"). L'utilisateur ne peut pas la modifier lui-même;
|
||||
* `civility` (Civility): la civilité de l'utilisateur;
|
||||
|
||||
### UserJob
|
||||
### UserJob (Métier)
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `label` (texte): nom du métier
|
||||
|
||||
|
||||
### Location (lieu)
|
||||
|
||||
* `id` (int): identifant;
|
||||
* `name` (texte): nom;
|
||||
* `address` (Address): adresse du lieu;
|
||||
* `phonenumber1` (texte): numéro de téléphone;
|
||||
* `phonenumber2` (texte): numéro de téléphone;
|
||||
* `email` (email): email
|
||||
* `locationType` (LocationType): le type de lieu
|
||||
|
||||
### LocationType (type de lieu)
|
||||
|
||||
* `id` (int): identifant;
|
||||
* `title` (texte): titre du type de lieu;
|
||||
|
||||
|
||||
### Social Issue (problématique sociale)
|
||||
|
||||
* `name`: le nom de la problématique seule
|
||||
* `text`: le nom de la problématique et des problématiques parentes
|
||||
|
||||
### Relationship (relations (filiations) entre usagers)
|
||||
|
||||
Pour faciliter l'usager, les relations sont toujours représentée à partir d'un usager d'origine.
|
||||
|
||||
Les variables présentent le nom de la relation (`text`), et la personne avec qui la relation est formée (`opposite`).
|
||||
|
||||
* `id` (int): identifant;
|
||||
* `fromPerson` (Person): personne d'origine;
|
||||
* `toPerson` (Person): personne de destination;
|
||||
* `text` (texte): le titre ou le titre inversé de la `Relation`, selon l'usager d'origine;
|
||||
* `opposite` (Person): l'usager avec qui la relation est formée;
|
||||
* `relationId` (int): identifiant du lien de filiation;
|
||||
|
||||
**Note**: la différence entre `fromPerson` et `toPerson` est arbitraire.
|
||||
|
||||
### AccompanyingPeriodWorkEvaluation (évaluation dans une action d'accompagnement)
|
||||
|
||||
* `id` (texte): l'identifiant de l'évaluation;
|
||||
* `type` (texte): le libellé de l'évaluation;
|
||||
* `startDate` (Date): la date de début de l'évaluation;
|
||||
* `endDate` (Date) la date de fin de l'évaluation;
|
||||
* `maxDate` (Date): la date d'échéance de l'évaluation;
|
||||
* `comment` (texte): le commentaire de l'évaluation;
|
||||
* `createdBy` (User): le créateur de l'évaluation;
|
||||
* `createdAt` (Date): la date de création de l'évaluation;
|
||||
* `evaluation` (Evaluation): le type d'évaluation;
|
||||
|
||||
### Evaluation (type d'évaluation)
|
||||
|
||||
* `id` (texte): l'identifiant du type d'évaluation;
|
||||
* `title` (texte): le titre du type d'évaluation;
|
||||
|
||||
### AccompanyingPeriodWork (Action d'accompagnement)
|
||||
|
||||
* `id` (texte): l'identifiant de l'action;
|
||||
* `note` (texte): la note;
|
||||
* `persons` (liste de Person): liste des usagers concernés par l'action
|
||||
* `results` (liste de Result): liste des résultats directement associé au parcours (résultats sans objectifs)
|
||||
* `socialAction` (SocialAction): type d'action sociale;
|
||||
* `startDate` (Date): la date de début de l'action (vide si inexistant)
|
||||
* `endDate` (Date): la date de début de l'action (vide si inexistant)
|
||||
* `thirdParties` (liste de ThirdParty): les tiers associés à l'action comme tiers intervenants;
|
||||
* `updatedBy` (User): utilisateur ayant fait la mise à jour;
|
||||
* `updatedAt` (Date): date de mise à jour;
|
||||
* `handlingThierParty` (ThirdParty): tiers traitant;
|
||||
* `goals` (AccompanyingPeriodWorkGoal): objectifs
|
||||
* `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` (AccompanyingPeriodWorkEvaluation): liste des évaluations générées;
|
||||
* `referrers` (liste de User): liste des agents traitants;
|
||||
|
||||
### SocialAction (type d'action d'accompagnement)
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `text` (texte): texte, avec les parents inclus, séparés par un ` > `;
|
||||
* `title`: titre du type d'action, sans les parents;
|
||||
|
||||
### Result (résultat d'une action)
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `title` (texte): le titre du résultat
|
||||
|
||||
### Goal (objectif d'une action)
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `title` (texte): le titre du résultat
|
||||
|
||||
### AccompanyingPeriodWorkGoal (objectifs et résultats d'une action d'accompagnement)
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `goal` (Goal): objectif d'une action
|
||||
* `results` (liste de Result): liste des résultats
|
||||
|
||||
### Comment
|
||||
|
||||
Certains champs commentaire enregistrent également l'utilisateur qui a effectué la dernière mise à jour, et la date de celle-ci, en plus du commentaire en tant que tel. Ces champs ont les attributs suivants:
|
||||
|
||||
* `comment` (texte): le commentaire en tant que tel;
|
||||
* `date` (Date): la date de la dernière modification;
|
||||
* `user` (User): l'utilisateur qui a effectué la dernière modification;
|
||||
|
||||
#### Variant `light`
|
||||
|
||||
Dans le variant `light`,
|
||||
|
||||
* le champ `date` n'est pas présent;
|
||||
* le champ `user` n'est pas présent.
|
||||
|
||||
Seul le champ `comment` est donc disponible.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue