continue documentation for variables
This commit is contained in:
parent
8272791e7b
commit
cb47265e16
|
|
@ -70,6 +70,8 @@ job=Assistant social
|
|||
|
||||
## Variables disponibles par document
|
||||
|
||||
Lorsqu'une variable n'est pas de type "texte", ses champs sont complétés par ceux décrits [dans la section suivante](#sec:gendoc-champs-objets).
|
||||
|
||||
### Pour chaque document
|
||||
|
||||
* `creator`: (User) le créateur;
|
||||
|
|
@ -80,20 +82,63 @@ job=Assistant social
|
|||
|
||||
Le document hérite de toutes les variables disponibles pour chaque document, à laquelle vient s'ajouter la variable suivante et tout ses champs:
|
||||
|
||||
* `course` (Parcours)
|
||||
* `courseId` (texte): l'identifiant du parcours
|
||||
* `courseStartDate` (texte): la date de confirmation du parcours (vide si le parcours est à l'état brouillon);
|
||||
* `courseEndDate` (texte): la date de fin du parcours (vide si le parcours n'est pas clotûré);
|
||||
* `courseEnd` (texte): la mention "clotûré" si le parcours est clotûré;
|
||||
* `courseStatus` (texte): contient la mention "En file active", "Archivé", ou est vide si le parcours n'a aucun de deux statuts;
|
||||
* `courseRef`: (User): le référent du parcours;
|
||||
* `courseLocation` (Adresse): l'adresse de localisation du parcours
|
||||
* `coursePersonLocation` (Person): l'utilisateur qui localise le parcours (s'il y en a un, peut être vide);
|
||||
* `courseTitulaire1` (Person): le premier titulaire du parcours, déterminé comme étant le plus âgé parmi les personnes qui sont titulaires d'un ménage;
|
||||
* `courseTitulaire2` (Person): le second titulaire du parcours, déterminé comme étant le deuxième plus âgé parmi les personnes qui sont titulaires d'un ménage;
|
||||
* `courseEmergency` (texte): la chaine "Urgent" si le parcours est urgent, chaine vide sinon;
|
||||
* `courseConfidential` (texte): "Confidentiel" si le parcours est confidentiel, chaine vide sinon;
|
||||
* `courseOrigin` (texte): l'appellation de l'origine du parcours;
|
||||
* `courseClosingMotive` (texte): l'appellation du motif de clotûre du parcours;
|
||||
|
||||
Les titulaires 1 et 2 sont déterminés par leur âge de cette manière:
|
||||
|
||||
1. Parmi toutes les personnes associées au parcours au moment de la génération du document, le logiciel sélectionne tout ceux qui sont actuellement titulaire d'un ménage;
|
||||
2. Les deux plus âgés sont choisis dans cette liste. Le plus âgé sera le `titulaire1`, et le suivant sera le `titulaire2`
|
||||
|
||||
Par ailleurs, les listes suivantes sont disponibles:
|
||||
|
||||
* `coursePersons` (liste de Person): une liste des personnes du parcours
|
||||
|
||||
Par ailleurs, pour chaque personne membre de la liste, deux champs sont ajoutés et indiquent le lien de parenté avec le titulaire 1 et le titulaire 2 (à condition que ce lien soit effectivement renseigné).
|
||||
|
||||
* `courseRequestor` (liste de Person ou ThirdParty): le demandeur. Peut être vide.
|
||||
* `courseResources` (liste de Person ou ThirdParty): une liste des interlocuteurs privilégiés
|
||||
* `courseSocialIssues` (liste de SocialIssues): la liste des problématiques d'accompagnement
|
||||
|
||||
Exemple d'utilisation:
|
||||
|
||||
```
|
||||
Le parcours a débuté le ${courseStartDateLong} et s'est clotûré le ${courseEndDateLong}.
|
||||
|
||||
Le référent est ${courseRefUsername}.
|
||||
|
||||
Participants au parcours:
|
||||
|
||||
+--------------------------+---------------------------+-------------------------------+
|
||||
| Nom | Prénom | Date de naissance |
|
||||
+==========================+===========================+===============================+
|
||||
| ${coursePersonsLastName} | ${coursePersonsFirstname} | ${coursePersonsBirthdateLong} |
|
||||
+--------------------------+---------------------------+-------------------------------+
|
||||
|
||||
```
|
||||
|
||||
### Document générés pour une action d'accompagnement
|
||||
|
||||
Le document hérite de toutes les variables et listes disponibles pour les document "générés par un parcours". De plus, les variables suivantes s'ajoutent:
|
||||
|
||||
* `work` (Action d'accompagnement), et tout ses sous-champs;
|
||||
* `workId` (texte): l'identifiant de l'action;
|
||||
* `workNote` (texte): la note;
|
||||
* `workCreateDate` (Date): la date de création de l'action;
|
||||
* `workStartDate` (Date): la date de début de l'action (vide si inexistant)
|
||||
* `workEndDate` (Date): la date de début de l'action (vide si inexistant)
|
||||
* `workHandlingThirdParty` (ThirdParty): le tiers traitant
|
||||
|
||||
Les listes suivantes sont disponibles:
|
||||
|
||||
|
|
@ -107,9 +152,28 @@ Les listes suivantes sont disponibles:
|
|||
|
||||
Le document hérite des variables et listes disponibles pour les documents "Action d'accompagnement", auxquelles viennent s'ajouter la variable `evaluation`:
|
||||
|
||||
* `evaluation`: Evaluation
|
||||
* `evaluationId` (texte): l'identifiant de l'évaluation;
|
||||
* `evaluationType` (texte): le libellé de l'évaluation;
|
||||
* `evaluationStartDate` (Date): la date de début de l'évaluation;
|
||||
* `evaluationEndDate` (Date) la date de fin de l'évaluation;
|
||||
* `evaluationMaxDate` (Date): la date d'échéance de l'évaluation;
|
||||
* `evaluationComment` (texte): le commentaire de l'évaluation;
|
||||
* `evaluationCreatedBy` (User): le créateur de l'évaluation;
|
||||
* `evaluationCreatedAt` (Date): la date de création de l'évaluation;
|
||||
|
||||
## Champs par objet
|
||||
## 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
|
||||
```
|
||||
|
||||
### Date
|
||||
|
||||
|
|
@ -134,10 +198,24 @@ Le document hérite des variables et listes disponibles pour les documents "Acti
|
|||
* `memo` (texte): le mémo
|
||||
* `numberOfChildren` (texte): le nombre d'enfants
|
||||
* `currentAddress` (Adresse): l'adresse actuelle
|
||||
* `mother` (Person): les champs de la mère de la personne, si elle est renseignée dans le module "filiation";
|
||||
* `father` (Person): les champs du père de la personne, s'il est renseigné dans le module "filiation";
|
||||
|
||||
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
|
||||
|
||||
```
|
||||
|
||||
### ThirdParty
|
||||
|
||||
TODO avec Mathieu
|
||||
TODO
|
||||
|
||||
### Adresse
|
||||
|
||||
|
|
@ -161,38 +239,4 @@ TODO avec Mathieu
|
|||
* `email` (texte)
|
||||
* `service` (texte): service principal
|
||||
|
||||
### Parcours
|
||||
|
||||
* `id` (texte): l'identifiant du parcours
|
||||
* `startDate` (texte): la date de confirmation du parcours (vide si le parcours est à l'état brouillon);
|
||||
* `endDate` (texte): la date de fin du parcours (vide si le parcours n'est pas clotûré);
|
||||
* `end` (texte): la mention "clotûré" si le parcours est clotûré;
|
||||
* `status` (texte): contient la mention "En file active", "Archivé", ou est vide si le parcours n'a aucun de deux statuts;
|
||||
* `ref`: (User): le référent du parcours;
|
||||
* `location` (Adresse): l'adresse de localisation du parcours
|
||||
* `personLocation` (Person): l'utilisateur qui localise le parcours (s'il y en a un, peut être vide);
|
||||
* `emergency` (texte): la chaine "Urgent" si le parcours est urgent, chaine vide sinon;
|
||||
* `confidential` (texte): "Confidentiel" si le parcours est confidentiel, chaine vide sinon;
|
||||
* `origin` (texte): l'appellation de l'origine du parcours;
|
||||
* `closingMotive` (texte): l'appellation du motif de clotûre du parcours;
|
||||
|
||||
### Action d'accompagnement
|
||||
|
||||
* `id` (texte): l'identifiant de l'action;
|
||||
* `note` (texte): la note;
|
||||
* `createDate` (Date): la date de création de l'action;
|
||||
* `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)
|
||||
* `handlingThirdParty` (ThirdParty): le tiers traitant
|
||||
|
||||
### Evaluation
|
||||
|
||||
* `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;
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue