forked from Chill-project/manuals
607 lines
27 KiB
Markdown
607 lines
27 KiB
Markdown
|
|
# Génération de documents
|
|
|
|
L'administrateur fonctionnel prépare la génération des documents.
|
|
|
|
Cela consiste à configurer le gabarit et ses éventuelles options via l'interface d'administration. Pour chaque gabarit, un document est joint et contient des "zones substituantes", qui permettent d'insérer des informations issues de Chill.
|
|
|
|
Seuls les documents suivants peuvent être utilisés:
|
|
|
|
* .odt (LibreOffice Writer);
|
|
* .ods
|
|
* .odp
|
|
|
|
## Rappel du parcours des utilisateurs
|
|
|
|
Lors de la génération de document, les utilisateurs parcourrent trois étapes, dont l'un est optionnelle:
|
|
|
|
1. Étape optionnelle: un formulaire demande des précisions à l'utilisateur.
|
|
|
|
Il peut s'agir, par exemple, de préciser les destinataires du document, de choisir un signataire, etc.
|
|
|
|
Ce formulaire est soit:
|
|
|
|
* natif au nœud. Dans ce cas, il apparait systématiquement ou dans certaines conditions;
|
|
* configuré par l'admnistrateur fonctionnel parmi des options disponibles;
|
|
|
|
2. le document est effectivement généré en arrière-plan. Cela peut nécessiter éventuellement quelques secondes;
|
|
3. le document est ouvert pour édition dans un éditeur en ligne. L'enregistrement est automatique. Lorsqu'ils ferment l'éditeur **depuis l'interface de l'éditeur**, l'utilisateur est redirigé vers l'interface de Chill, généralement la page de génération du document.
|
|
|
|
Notez que, pour que la redirection soit effective, l'utilisateur doit fermer **dans l'interface de l'éditeur**: fermer la fenêtre ou l'onglet fait perdre les informations de redirection - cependant, le document est normalement enregistré.
|
|
|
|
## Syntaxe de génération d'un document
|
|
|
|
Les documents sont préparés par l'administrateur fonctionnel.
|
|
|
|
## Indiquer un champ dans un document
|
|
|
|
Aux endroits où cela est nécessaire, l'administrateur indique un "champ substituant".
|
|
|
|
Cela est accessible via le menu "Insertion > Renvoi...", puis choisir l'onglet "Fonction", "Substituant", "Texte", et indiquer la valeur du champ.
|
|
|
|
La valeur à indiquer dans le champ "substituant" est à déduire des informations ci-dessous.
|
|
|
|
## Principes liés au variables
|
|
|
|
### Nommage de variables
|
|
|
|
TODO
|
|
|
|
#### Exemple: application aux objets "date"
|
|
|
|
Les dates sont disponibles dans deux formats:
|
|
|
|
* le format "court", ou dd/mm/yyyy (par exemple, 15/06/1980, 18/08/2021, …). Ce format est accessible par le champ `short`;
|
|
* le format "long": 15 juin 1980, 18 août 2021, … Ce format est accessible par le champ `long`;
|
|
|
|
lorsqu'une date est disponible, il est donc possible d'avoir accès à son format en précisant sa chaine de caractère. Exemple avec la date de naissance de la personne:
|
|
|
|
```
|
|
personBirthdateShort=15/06/1980
|
|
personBirthdateLong=15 juin 1980
|
|
```
|
|
|
|
|
|
### Cas où une variable est optionnelle
|
|
|
|
Lorsqu'une variable est optionnelle, si sa valeur est inconnue ou vide, alors tout ses champs apparaissent avec une chaine de caractère vide.
|
|
|
|
L'arbre des variables est toujours identique, sur toute la profondeur de celles-ci. L'administrateur est garanti qu'un champ existera, même si sa valeur n'est pas présente dans la base de donnée.
|
|
|
|
## Variables disponibles par document
|
|
|
|
Pour chaque contexte où un document est généré, les variables disponibles sont listées [dans la section suivante](#sec:gendoc-champs-documents). Le type des variables est indiqué.
|
|
|
|
Les variables pour chaque type sont décrites [dans la section suivante](#sec:gendoc-champs-objets):
|
|
|
|
* si le type commence par une majuscule, alors cette variable comporte des sous-champs, et il faut se reporter à la description des variables pour ce type;
|
|
* si le type commence par une minuscule, alors cette variable peut être utilisée directement dans le document:
|
|
|
|
* s'il s'agit d'un booléen (`bool`), le champ peut être utilisé dans des tests;
|
|
* les champs `text` et `int` peuvent faire l'objet de test sur l'égalité;
|
|
* les champs de type `int` peuvent faire l'objet de comparaison sur l'ordre de grandeur (par exemple, le champs `age` des objets de type `Person` peut être filtré `> 18` ou `< 18` pour distinguer les adultes des enfants).
|
|
|
|
### Pour chaque document { #sec:gendoc:champs-documents }
|
|
|
|
#### Paramètres pour l'administrateur fonctionnel
|
|
|
|
Les administrateurs fonctionnels peuvent activer les paramètres suivants:
|
|
|
|
* un champ "lieu", qui permettra de choisir parmi les lieux pré-enregistrés. Le lieu pré-sélectionné sera celui choisi par l'utilisateur;
|
|
|
|
#### Variables
|
|
|
|
* `creator`: (User) le créateur;
|
|
* `createdAt` (Date): la date de création;
|
|
* `location` (Location): le lieu sélectionné par le créateur, au moment de la génération **ou** celui choisi par l'étape 1.
|
|
|
|
### Document générés pour un parcours
|
|
|
|
#### Paramètres pour l'administrateur fonctionnel
|
|
|
|
Les administrateurs fonctionnels peuvent activer les paramètres suivants:
|
|
|
|
* un champ "usager 1", qui permet ensuite à l'utilisateur de choisir un usager parmi ceux concernés par le parcours;
|
|
* un champ "usager 2", qui permet aux utilisateurs de choisir un deuxième usager parmis ceux concernés par le parcours;
|
|
* un champ "usager principal du parcours", qui permet, cette fois, de choisir parmi les usagers concernés par le parcours, mais également parmi les interlocuteurs privilégiés, ou le demandeur du parcours.
|
|
|
|
#### Variables
|
|
|
|
Le document présente:
|
|
|
|
* une variable `course`, de type `AccompanyingPeriod`;
|
|
* Si `usager principal du parcours` est coché, une variable `mainPerson`, de type `Person`, avec les variants `relations` et `household` (ménage);
|
|
* si `usager 1` est coché, une variable `person1`, de type Person, avec les variants `relations` et `household` (ménage);
|
|
* si `usager 2` est coché, une variable `person2`, de type Person, avec les variants `relations` et `household` (ménage);
|
|
|
|
|
|
### Document générés pour une évaluation
|
|
|
|
Le document présente:
|
|
|
|
* une variable `evaluation` de type `AccompanyingPeriodWorkEvaluation`: l'évaluation concernée;
|
|
* une variable `work` de type `AccompanyingPeriodWork`: l'action d'accompagnement au sein de laquelle l'évaluation est générée;
|
|
* une variable `course`, de type `AccompanyingPeriod`: le parcours au sein duquel l'évaluation est générée;
|
|
* Si `usager principal du parcours` est coché, une variable `mainPerson`, de type `Person`, avec les variants `relations` et `household` (ménage);
|
|
* si `usager 1` est coché, une variable `person1`, de type Person, avec les variants `relations` et `household` (ménage);
|
|
* si `usager 2` est coché, une variable `person2`, de type Person, avec les variants `relations` et `household` (ménage);
|
|
|
|
### Document générés pour un échange
|
|
|
|
Le document présente:
|
|
|
|
* une variable `activity`, de type `Activity`: l'évaluation concernée
|
|
* une variable `course`, de type `AccompanyingPeriod`: le parcours concerné, à condition que l'échange ait été créé dans un contexte parcours
|
|
* une variable `person`, de type `Person`: la personne concernée, à condition que l'échange ait été créée dans un contexte d'usager.
|
|
|
|
Il est possible également d'injecter des dossiers d'usagers, parmi ceux associés **à l'échange** (l'utilisateur peut choisir parmis les usagers de l'échange, et pas les usagers concernés du parcours).
|
|
|
|
* Si `usager principal` est coché, une variable `mainPerson`, de type `Person`, avec les variants `relations` et `household` (ménage);
|
|
* si `usager 1` est coché, une variable `person1`, de type Person, avec les variants `relations` et `household` (ménage);
|
|
* si `usager 2` est coché, une variable `person2`, de type Person, avec les variants `relations` et `household` (ménage);
|
|
|
|
## Champs par objet { #sec:gendoc-champs-objets }
|
|
|
|
Les champs ci-dessous étendent les variables disponibles dans les documents.
|
|
|
|
Par exemple, le document généré à partir d'un parcours présente la variable `startDate` qui contient la date de début du parcours. Ce champ peut être exploité de la manière suivante:
|
|
|
|
```
|
|
${courseStartDateLong} // 15 janvier 2021
|
|
|
|
ou dans la forme courte:
|
|
|
|
${courseStartDateShort} // 15/01/2021
|
|
```
|
|
|
|
### AccompanyingPeriod
|
|
|
|
* `id` (texte): l'identifiant du parcours
|
|
* `type` (texte): toujours égal à `accompanying_course`
|
|
* `isNull`: (bool) renvoie `true` si est une entité nulle (toutes les variables sont vides);
|
|
* `closingDate` (Date): date de clotûre;
|
|
* `confidential` (bool): `true` si confidentiel;
|
|
* `confidentialText` (texte): "Confidentiel" si le parcours est confidentiel, texte vide sinon;
|
|
* `createdAt` (Date): date de création;
|
|
* `createdBy` (User): utilisateur ayant créé le parcours;
|
|
* `emergency` (bool): `true` si parcours en urgence;
|
|
* `emergencyText` (texte): "Urgent" si le parcours est urgent, texte vide sinon;
|
|
* `openingDate` (texte): la date de confirmation du parcours;
|
|
* `origin` (AccompanyingPeriodOrigin): l'origine du parcours;
|
|
* `originText` (texte): Le titre de l'origine, directement utilisable dans le document;
|
|
* `participations` (liste de AccompanyingPeriodParticipation): les participations du parcours, actuelles **et anciennes**;
|
|
* `currentParticipations` (liste de AccompanyingPeriodParticipation): les participations actuelles du parcours;
|
|
* `requestorAnonymous` (bool): `true` si le demandeur du parcours est anonyme;
|
|
* `hasRequestor` (bool): `true` si le parcours a un demandeur (il peut être un tiers ou une personne);
|
|
* `requestorKind` (texte): `person` si le demandeur est une personne, `thirdparty` si c'est un tiers;
|
|
* `requestorPerson` (Person): demandeur, si le demandeur est une personne;
|
|
* `hasRequestorPerson` (bool): `true` si le demandeur est une personne;
|
|
* `requestorThirdParty` (ThirdParty): demandeur, si le demandeur est un tiers;
|
|
* `hasRequestorThirdParty` (bool): `true` si le demandeur est un tiers;
|
|
* `resources` (liste de AccompanyingPeriodResource): les ressources du parcours;
|
|
* `scopes` (liste de Scope): services associés au parcours;
|
|
* `scopesText` (texte): titre des services associés au parcours, séparés par une virgule;
|
|
* `socialIssues` (liste de SocialIssues): problématiques sociales associées au parcours;
|
|
* `socialIssuesText` (texte): Liste des problématiques sociales, séparées par une virgule;
|
|
* `intensity` (texte): texte traduit de l'intensité: "ponctuel" ou "régulier";
|
|
* `step` (texte): texte traduit de l'étape du parcours: "Brouillon", ou "En cours";
|
|
* `isClosed` (bool): `true` si le parcours est fermé (la date de clotûre est renseignée);
|
|
* `closingMotiveText` (texte): titre du motif de clotûre;
|
|
* `ref` (User): référent du parcours;
|
|
* `hasRef` (bool): `true` si un référent est désigné;
|
|
* `hasLocation` (bool): `true` si un parcours a une localisation;
|
|
* `hasLocationPerson` (bool): `true` si un parcours a une localisation auprès d'un personne. `false` si c'est une localisation temporaire;
|
|
* `location` (Adresse): l'adresse de localisation du parcours
|
|
* `locationPerson` (Person): l'utilisateur qui localise le parcours (s'il y en a un, peut être vide);
|
|
* `administrativeLocation` (Location): localisation administrative du parcours;
|
|
* `hasAdministrativeLocation` (bool): `true` si une localisation administrative est définie;
|
|
* `works` (liste de AccompanyingPeriodWork): liste des actions d'accompagnement créées dans le cadre de ce parcours
|
|
|
|
|
|
### AccompanyingPeriodParticipation
|
|
|
|
* `id` (int): identifiant
|
|
* `person` (Person): usager associé au parcours;
|
|
* `startDate` (Date): date de début;
|
|
* `endDate` (Date): date de fin. Vide si la participation est toujours en cours;
|
|
|
|
|
|
### AccompanyingPeriodResource
|
|
|
|
* `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);
|
|
|
|
|
|
### AccompanyingPeriodOrigin
|
|
|
|
* `id` (int): identifiant;
|
|
* `label` (texte): libellé de l'origine;
|
|
|
|
### Activity (échange)
|
|
|
|
* `id` (int): identifiant;
|
|
* `activityType` (ActivityType): Type d'échange
|
|
* `attendee` (ActivityPresence): Présence à l'échange
|
|
* `comment` (Comment): Commentaire (avec la date de la dernière mise à jour)
|
|
* `date` (Date): Date de l'échange
|
|
* `durationTimeMinute` (int): Durée de l'échange, en minutes
|
|
* `emergency` (bool): True si en urgence
|
|
* `location` (Location): Lieu de l'échange
|
|
* `reasons` (liste de ActivityReason): Sujets de l'échange (pas utilisé en Vendée)
|
|
* `scope` (Scope): Service (pas utilisé en Vendée)
|
|
* `sentReceived (text): sera `received` si reçu, et `sent` si envoyé;
|
|
* `socialActions` (liste de SocialAction): liste d'actions sociales associées
|
|
* `socialIssues` (liste de SocialIssue): liste de problématiques sociales associées
|
|
* `thirdParties` (liste de ThirdParty): liste de tiers associés
|
|
* `travelTimeMinute` (int): durée du trajet en minutes
|
|
* `user` (User): l'utilisateur pour lequel l'échange a été créé;
|
|
* `users` (liste de Users): les utilisateurs qui sont associés à l'échange.
|
|
|
|
### ActivityPrésence
|
|
|
|
Présence à l'échange
|
|
|
|
* `id` (int): identifiant;
|
|
* `name` (texte): libellé
|
|
|
|
### 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;
|
|
|
|
### Person
|
|
|
|
* `id` (texte): Identifiant du dossier usager;
|
|
* `isNull` (bool): `true` si le dossier usager est vide;
|
|
* `civility` (Civility): Civilité
|
|
* `firstName` (texte): Prénom
|
|
* `lastName` (texte): Nom
|
|
* `altNames` (texte): noms supplémentaire (nom de naissance, …)
|
|
* `text` (texte): représentation du nom, prénom, et noms alternatifs: prénom, nom, et noms alternatifs.
|
|
* `birthdate` (Date)
|
|
* `age`: (int) age de la personne;
|
|
* `deathdate` (Date)
|
|
* `gender` (texte): genre (texte traduit);
|
|
* `maritalStatus` (texte): représentation textuelle de l'état civil;
|
|
* `maritalStatusDate` (Date): date à la quelle le statut de l'état civil a été mis à jour;
|
|
* `email` (texte): adresse email
|
|
* `firstPhoneNumber` (texte): soit le numéro de mobile s'il existe, soit le numéro fixe s'il existe, sinon vide;
|
|
* `fixPhoneNumber` (texte): le numéro de téléphone fixe;
|
|
* `mobilePhoneNumber` (texte): le numéro de téléphone portable;
|
|
* `nationality` (texte): nationalité (nom du pays);
|
|
* `placeOfBirth (texte): le lieu de naissance
|
|
* `memo` (texte): le mémo
|
|
* `numberOfChildren` (texte): le nombre d'enfants
|
|
* `address` (Adresse): l'adresse actuelle
|
|
|
|
::: { .vendee }
|
|
* `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;
|
|
* `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` (mobilite): 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é tiers
|
|
* `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)
|
|
|
|
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é tiers
|
|
* `delegationPerson` (person): entité person
|
|
* `tuteur` (texte)
|
|
* `tuteurThirdParty` (tiers): entité tiers
|
|
* `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)
|
|
:::
|
|
|
|
#### variant `household`
|
|
|
|
* `household` (Household): le ménage actuel de l'usager;
|
|
|
|
#### variant `relations`
|
|
|
|
* `relations` (liste de Relationship): les relations (filiations) de l'usager;
|
|
|
|
#### 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
|
|
```
|
|
|
|
### Civility
|
|
|
|
* `abbreviation` (texte): abbréviation;
|
|
* `id` (int): identifiant (utile pour des comparaisons);
|
|
* `name` (texte): titre, label de la civilité;
|
|
|
|
|
|
### 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;
|
|
|
|
### ThirdParty
|
|
|
|
* `id` (int): identifiant du tiers;
|
|
* `acronym` (text): acronyme;
|
|
* `address` (Adress): adresse du tiers
|
|
* `categories` (liste de ThirdPartyCategory): liste des catégories;
|
|
* `civility` (Civility): civilité
|
|
* `contactDataAnonymous` (bool): `true` si le tiers est anonyme;
|
|
* `email` (texte): email;
|
|
* `name` (texte): nom du tiers;
|
|
* `nameCompany` (texte): nom du tiers personne morale;
|
|
* `parent` (ThirdParty): tiers parent (pour les contacts)
|
|
* `profession` (ThirdPartyProfession)
|
|
* `telephone` (texte): numéro de téléphone du tiers
|
|
|
|
### ThirdPartyCategory (catégorie de tiers)
|
|
|
|
TODO
|
|
|
|
### ThirdPartyProfession (profession du tiers)
|
|
|
|
TODO
|
|
|
|
### 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);
|
|
|
|
### 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 }
|
|
|
|
* `id` (int): identifant
|
|
* `type` (texte): vaut toujours `user`
|
|
* `username` (texte): le login
|
|
* `email` (texte): l'email de l'utilisateur
|
|
* `text` (texte): le libellé complet de l'utilisateur (avec son métier et son service entre parenthèse);
|
|
* `label` (texte): le libellé de l'utilisateur, tel qu'il est enregistré par l'administrateur fonctionnel
|
|
* `main_scope` (Scope): service principal
|
|
* `user_job` (texte): métier principal
|
|
* `current_location` (Location): lieu de l'utilisateur, celui actuellement choisi par l'utilisateur par le menu "utilisateur";
|
|
|
|
### Location (lieu)
|
|
|
|
* `id` (int): identifant;
|
|
* `name` (texte): nom;
|
|
* `adress` (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` (AccompanyingPeriodEvaluation): liste des évaluations générées
|
|
|
|
### 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
|