From 2de3999a4367902811f203b3fc1e1a9f10c02abc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julien=20Fastr=C3=A9?= Date: Wed, 26 Jan 2022 23:44:24 +0100 Subject: [PATCH] documentation for docgen in activity --- admin/generation-documents.md | 45 +++++++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/admin/generation-documents.md b/admin/generation-documents.md index c81d261..351fc7e 100644 --- a/admin/generation-documents.md +++ b/admin/generation-documents.md @@ -126,6 +126,20 @@ Le document présente: * 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 + +Il est possible également d'injecter des dossiers d'usagers, parmi ceux associé au parcours: + +* une variable `person`, de type `Person`: la personne concernée, à condition que l'échange ait été créée dans un contexte d'usager. +* 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. @@ -181,6 +195,7 @@ ${courseStartDateShort} // 15/01/2021 * `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 @@ -203,6 +218,32 @@ ${courseStartDateShort} // 15/01/2021 * `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 @@ -425,8 +466,8 @@ Les variables présentent le nom de la relation (`text`), et la personne avec qu * `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` (Date): date de mise à jour; -* `updatedAt` (User): utilisateur ayant fait la mise à jour; +* `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;