Restructure mkdocs navigation: split "Document Generation" into "Principes" and "Propriété des Objets".
This commit is contained in:
@@ -0,0 +1,230 @@
|
||||
# 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
|
||||
|
||||
Des exemples sont disponibles [en ligne](https://gitea.champs-libres.be/Chill-project/manuals/src/branch/main/admin/generation-documents-templates).
|
||||
|
||||
|
||||
## Rappel de "l'expérience utilisateur": comment les utilisateurs génèrent un document ?
|
||||
|
||||
Les utilisateurs peuvent générer un document depuis plusieurs contextes du logiciel:
|
||||
|
||||
- les documents du dossier d'usager;
|
||||
- les documents du parcours;
|
||||
- les documents dans les évaluations;
|
||||
- les activités / échanges;
|
||||
- les rendez-vous.
|
||||
|
||||
Chaque contexte peut être dédiée à un usage précis. Par exemple, l'utilisateur peut générer une invitation à un rendez-vous depuis la page "rendez-vous". Depuis les évaluations, un formulaire officiel pourrait être pré-rempli. Et un document récapitulatif du parcours peut être généré dans ses documents.
|
||||
|
||||
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 contexte. 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é.
|
||||
|
||||
## Préparation des documents
|
||||
|
||||
Les documents sont préparés par l'administrateur fonctionnel. Il s'agit d'un document "traitement de texte" (ou tableur, ou présentation).
|
||||
|
||||
Le document est préparé de manière habituelle: le texte y est écrit, le logo de l'association inséré, etc. Ensuite, l'administrateur définit certaines zones qui seront remplacées par des informations qui sont collectées dans le logiciel.
|
||||
|
||||
Le travail de préparation consiste à préciser les endroits où ces informations doivent être insérées: des champs spécifiques.
|
||||
|
||||
::: {.note}
|
||||
|
||||
Le fonctionnement de la génération de document est assez semblable au "publi-postage": des champs sont définis dans le document, et le logiciel de traitement de texte vient les remplacer par ceux provenant d'une base de donnée.
|
||||
|
||||
:::
|
||||
|
||||
## Indiquer un champ dans un document en utilisant Libre Office
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Nature (type) des variables
|
||||
|
||||
Pour chaque contexte où un document est généré, les variables disponibles sont listées [dans la section suivante](#sec:gendoc-champs-documents).
|
||||
|
||||
Chaque variable comporte un type: il peut s'agir de:
|
||||
|
||||
- un nombre;
|
||||
- un texte;
|
||||
- un bouléen (`vrai` ou `faux`)
|
||||
- un objet;
|
||||
- ou une liste d'objets, de nombres, ou de textes.
|
||||
|
||||
Les variables et leur type sont décrites [dans la section suivante](#sec:gendoc-champs-objets). Le type est indiqué entre parenthèse:
|
||||
|
||||
* si le type commence par une majuscule, alors cette variable est un object. Il comporte des sous-champs, et il faut se reporter à la description de l'objet correspondant;
|
||||
* 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).
|
||||
|
||||
### Cas où le contenu d'une variable est vide
|
||||
|
||||
Si une variable est 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.
|
||||
|
||||
### Exemple: la date de naissance d'une personne
|
||||
|
||||
Dans le contexte "personne", les informations de la personne sont disponibles sous le champ `v.person`. Il s'agit d'un objet de type `Person` qui comporte une sous-variable appelée `birthdate`, qui est lui-même disponible dans un objet de type `Date`.
|
||||
|
||||
Les objets `Date` proposent deux sous-champs, qui correspondent au format de la date:
|
||||
|
||||
* 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`;
|
||||
|
||||
Donc, pour insérer la date de naissance, on utilisera les substituants suivants:
|
||||
|
||||
```
|
||||
v.person.birthdate.short
|
||||
|
||||
v.person.birthdate.long
|
||||
```
|
||||
|
||||
Ce qui donnera (pour une personne née le 15 décembre 1980):
|
||||
|
||||
```
|
||||
15/12/1980
|
||||
|
||||
15 décembre 1980
|
||||
```
|
||||
|
||||
Si, par contre, la date de naissance de la personne n'est pas renseignée, deux lignes vides s'afficheront dans le document:
|
||||
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
|
||||
## Paramètres pour l'administrateur fonctionnel
|
||||
|
||||
Pour chaque gabarit, l'administrateur peut activer certaines options. Par exemple:
|
||||
|
||||
* permettre de sélectionner une personne parmi les usagers du parcours;
|
||||
* configurer le libellé qui s'affichera pour l'utilisateur devant l'usager.
|
||||
|
||||
Les options disponibles dépendent du contexte.
|
||||
|
||||
Par exemple, pour un courrier généré dans un contexte "parcours", l'utilisateur pourra choisir un usager du parcours pour un courrier; l'administrateur indiquera qu'il s'agira du "destinataire" du courrier. Tandis que pour un formulaire officiel, l'administrateur configurera un "demandeur" et "co-demandeur", et ce sont ces libellés qui s'afficheront.
|
||||
|
||||
## Variables par contexte
|
||||
|
||||
### Pour tous les contextes { #sec:gendoc-champs-documents }
|
||||
|
||||
#### Variables { #sec:entity-variables-all-context }
|
||||
|
||||
* `creator`: ([User](#sec:entity-user)) le créateur;
|
||||
* `createdAt` ([Date](#sec:entity-date)): la date et l'heure de création;
|
||||
* `createdAtDate` ([Date](#sec:entity-date)): la date de la création (sans l'heure). Utilisable pour indiquer la date d'un courrier, par exemple;
|
||||
* `location` ([Location](#sec:entity-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, les interlocuteurs privilégiés qui sont des usagers (à l'exclusion des tiers), et les personnes ressources associées à un usager concerné du parcours (à l'exclusion des ressources tiers et "texte libre");
|
||||
* un champ "usager 2", qui permet aux utilisateurs de choisir un deuxième usager parmis ceux concernés par le parcours, les interlocuteurs privilégiés qui sont des usagers (à l'exclusion des tiers), et les personnes ressources associées à un usager concerné du parcours (à l'exclusion des ressources tiers et "texte libre");
|
||||
* un champ "usager principal du parcours", qui permet, cette fois, de choisir parmi les usagers concernés par le parcours, les interlocuteurs privilégiés qui sont des usagers (à l'exclusion des tiers), et les personnes ressources associées à un usager concerné du parcours (à l'exclusion des ressources tiers et "texte libre");
|
||||
* un champ "tiers", qui permet de choisir un tiers parmi les tiers "personnes ressources" du parcours, ou le demandeur du parcours (s'il s'agit d'un tiers);
|
||||
|
||||
#### Variables { #sec:entity-variables-accompanying-period }
|
||||
|
||||
Le document présente:
|
||||
|
||||
* une variable `course`, de type [`AccompanyingPeriod`](#sec:entity-accompanyingperiod);
|
||||
* si `usager principal du parcours` est coché, une variable `mainPerson`, de type [`Person`](#sec:entity-user), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 1` est coché, une variable `person1`, de type [Person](#sec:entity-user), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 2` est coché, une variable `person2`, de type [Person](#sec:entity-user), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty), uniquement si l'administrateur fonctionnel l'a configuré.
|
||||
|
||||
### Document générés pour un parcours, contexte "liste des activités"
|
||||
|
||||
Le contexte présente les mêmes variables et paramètre que les documents générés par un parcours.
|
||||
|
||||
La variable suivante est ajoutée:
|
||||
|
||||
* `activities` (liste de [Activity](#sec:entity-activity)): Liste d'activités, variant "light". Aucun filtre n'est appliqué sur les échanges récupérés.
|
||||
|
||||
### Document générés pour une évaluation
|
||||
|
||||
Le document présente:
|
||||
|
||||
* une variable `evaluation` de type [`AccompanyingPeriodWorkEvaluation`](#sec:entity-accompanyingperiodworkevaluation): l'évaluation concernée;
|
||||
* une variable `work` de type [`AccompanyingPeriodWork`](#sec:entity-accompanyingperiodwork): l'action d'accompagnement au sein de laquelle l'évaluation est générée;
|
||||
* une variable `course`, de type [`AccompanyingPeriod`](#sec:entity-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`](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 1` est coché, une variable `person1`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 2` est coché, une variable `person2`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty), uniquement si l'administrateur fonctionnel l'a configuré.
|
||||
|
||||
### Document générés pour un échange
|
||||
|
||||
Le document présente:
|
||||
|
||||
* une variable `activity`, de type [`Activity`](#sec:entity-activity): l'évaluation concernée
|
||||
* une variable `course`, de type [`AccompanyingPeriod`](#sec:entity-accompanyingperiod): le parcours concerné, à condition que l'échange ait été créé dans un contexte parcours
|
||||
* une variable `person`, de type [`Person`](#sec:entity-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 du parcours` est coché, une variable `mainPerson`, de type [`Person`](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 1` est coché, une variable `person1`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 2` est coché, une variable `person2`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
|
||||
### Documents générés dans le dossier d'une personne: contexte "personne basique"
|
||||
|
||||
* une variable `person`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty), uniquement si l'administrateur fonctionnel l'a configuré.
|
||||
|
||||
### Documents générés dans le dossier d'une personne: contexte "personne avec un tiers"
|
||||
|
||||
Ce contexte permet de générer un courrier avec, en paramètre, un tiers.
|
||||
|
||||
Cela peut être utile pour, par exemple, générer un courrier vers un tiers déjà enregistré dans la base de donnée de Chill.
|
||||
|
||||
Les variables disponibles sont les suivantes:
|
||||
|
||||
* une variable `person`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`.
|
||||
* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty);
|
||||
|
||||
### Document générés dans un contexte "rendez-vous"
|
||||
|
||||
Les champs suivant sont disponibles:
|
||||
|
||||
* une variable `calendar` ([Calendar](#sec:entity-calendar)), qui contient les données du rendez-vous;
|
||||
* une variable `mainPerson` ([Person](#sec:entity-person)), la personne principale parmi les personnes participant au rendez-vous. Cette variable n'est présente que si l'administrateur fonctionnel l'a configurée.
|
||||
* une variable `thirdParty` ([ThirdParty](#sec:entity-thirdparty)): un tiers participant au rendez-vous. Cette variable n'est présente que si l'administrateur fonctionnel l'a configurée.
|
||||
|
||||
+52
-284
@@ -1,238 +1,6 @@
|
||||
# Génération de documents
|
||||
# Champs par objet { #sec:gendoc-champs-objets }
|
||||
|
||||
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
|
||||
|
||||
Des exemples sont disponibles [en ligne](https://gitea.champs-libres.be/Chill-project/manuals/src/branch/main/admin/generation-documents-templates).
|
||||
|
||||
|
||||
## Rappel de "l'expérience utilisateur": comment les utilisateurs génèrent un document ?
|
||||
|
||||
Les utilisateurs peuvent générer un document depuis plusieurs contextes du logiciel:
|
||||
|
||||
- les documents du dossier d'usager;
|
||||
- les documents du parcours;
|
||||
- les documents dans les évaluations;
|
||||
- les activités / échanges;
|
||||
- les rendez-vous.
|
||||
|
||||
Chaque contexte peut être dédiée à un usage précis. Par exemple, l'utilisateur peut générer une invitation à un rendez-vous depuis la page "rendez-vous". Depuis les évaluations, un formulaire officiel pourrait être pré-rempli. Et un document récapitulatif du parcours peut être généré dans ses documents.
|
||||
|
||||
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 contexte. 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é.
|
||||
|
||||
## Préparation des documents
|
||||
|
||||
Les documents sont préparés par l'administrateur fonctionnel. Il s'agit d'un document "traitement de texte" (ou tableur, ou présentation).
|
||||
|
||||
Le document est préparé de manière habituelle: le texte y est écrit, le logo de l'association inséré, etc. Ensuite, l'administrateur définit certaines zones qui seront remplacées par des informations qui sont collectées dans le logiciel.
|
||||
|
||||
Le travail de préparation consiste à préciser les endroits où ces informations doivent être insérées: des champs spécifiques.
|
||||
|
||||
::: {.note}
|
||||
|
||||
Le fonctionnement de la génération de document est assez semblable au "publi-postage": des champs sont définis dans le document, et le logiciel de traitement de texte vient les remplacer par ceux provenant d'une base de donnée.
|
||||
|
||||
:::
|
||||
|
||||
## Indiquer un champ dans un document en utilisant Libre Office
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Nature (type) des variables
|
||||
|
||||
Pour chaque contexte où un document est généré, les variables disponibles sont listées [dans la section suivante](#sec:gendoc-champs-documents).
|
||||
|
||||
Chaque variable comporte un type: il peut s'agir de:
|
||||
|
||||
- un nombre;
|
||||
- un texte;
|
||||
- un bouléen (`vrai` ou `faux`)
|
||||
- un objet;
|
||||
- ou une liste d'objets, de nombres, ou de textes.
|
||||
|
||||
Les variables et leur type sont décrites [dans la section suivante](#sec:gendoc-champs-objets). Le type est indiqué entre parenthèse:
|
||||
|
||||
* si le type commence par une majuscule, alors cette variable est un object. Il comporte des sous-champs, et il faut se reporter à la description de l'objet correspondant;
|
||||
* 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).
|
||||
|
||||
### Cas où le contenu d'une variable est vide
|
||||
|
||||
Si une variable est 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.
|
||||
|
||||
### Exemple: la date de naissance d'une personne
|
||||
|
||||
Dans le contexte "personne", les informations de la personne sont disponibles sous le champ `v.person`. Il s'agit d'un objet de type `Person` qui comporte une sous-variable appelée `birthdate`, qui est lui-même disponible dans un objet de type `Date`.
|
||||
|
||||
Les objets `Date` proposent deux sous-champs, qui correspondent au format de la date:
|
||||
|
||||
* 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`;
|
||||
|
||||
Donc, pour insérer la date de naissance, on utilisera les substituants suivants:
|
||||
|
||||
```
|
||||
v.person.birthdate.short
|
||||
|
||||
v.person.birthdate.long
|
||||
```
|
||||
|
||||
Ce qui donnera (pour une personne née le 15 décembre 1980):
|
||||
|
||||
```
|
||||
15/12/1980
|
||||
|
||||
15 décembre 1980
|
||||
```
|
||||
|
||||
Si, par contre, la date de naissance de la personne n'est pas renseignée, deux lignes vides s'afficheront dans le document:
|
||||
|
||||
```
|
||||
|
||||
|
||||
```
|
||||
|
||||
## Paramètres pour l'administrateur fonctionnel
|
||||
|
||||
Pour chaque gabarit, l'administrateur peut activer certaines options. Par exemple:
|
||||
|
||||
* permettre de sélectionner une personne parmi les usagers du parcours;
|
||||
* configurer le libellé qui s'affichera pour l'utilisateur devant l'usager.
|
||||
|
||||
Les options disponibles dépendent du contexte.
|
||||
|
||||
Par exemple, pour un courrier généré dans un contexte "parcours", l'utilisateur pourra choisir un usager du parcours pour un courrier; l'administrateur indiquera qu'il s'agira du "destinataire" du courrier. Tandis que pour un formulaire officiel, l'administrateur configurera un "demandeur" et "co-demandeur", et ce sont ces libellés qui s'afficheront.
|
||||
|
||||
## Variables par contexte
|
||||
|
||||
### Pour tous les contextes { #sec:gendoc-champs-documents }
|
||||
|
||||
#### Variables { #sec:entity-variables-all-context }
|
||||
|
||||
* `creator`: ([User](#sec:entity-user)) le créateur;
|
||||
* `createdAt` ([Date](#sec:entity-date)): la date et l'heure de création;
|
||||
* `createdAtDate` ([Date](#sec:entity-date)): la date de la création (sans l'heure). Utilisable pour indiquer la date d'un courrier, par exemple;
|
||||
* `location` ([Location](#sec:entity-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, les interlocuteurs privilégiés qui sont des usagers (à l'exclusion des tiers), et les personnes ressources associées à un usager concerné du parcours (à l'exclusion des ressources tiers et "texte libre");
|
||||
* un champ "usager 2", qui permet aux utilisateurs de choisir un deuxième usager parmis ceux concernés par le parcours, les interlocuteurs privilégiés qui sont des usagers (à l'exclusion des tiers), et les personnes ressources associées à un usager concerné du parcours (à l'exclusion des ressources tiers et "texte libre");
|
||||
* un champ "usager principal du parcours", qui permet, cette fois, de choisir parmi les usagers concernés par le parcours, les interlocuteurs privilégiés qui sont des usagers (à l'exclusion des tiers), et les personnes ressources associées à un usager concerné du parcours (à l'exclusion des ressources tiers et "texte libre");
|
||||
* un champ "tiers", qui permet de choisir un tiers parmi les tiers "personnes ressources" du parcours, ou le demandeur du parcours (s'il s'agit d'un tiers);
|
||||
|
||||
#### Variables { #sec:entity-variables-accompanying-period }
|
||||
|
||||
Le document présente:
|
||||
|
||||
* une variable `course`, de type [`AccompanyingPeriod`](#sec:entity-accompanyingperiod);
|
||||
* si `usager principal du parcours` est coché, une variable `mainPerson`, de type [`Person`](#sec:entity-user), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 1` est coché, une variable `person1`, de type [Person](#sec:entity-user), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 2` est coché, une variable `person2`, de type [Person](#sec:entity-user), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty), uniquement si l'administrateur fonctionnel l'a configuré.
|
||||
|
||||
### Document générés pour un parcours, contexte "liste des activités"
|
||||
|
||||
Le contexte présente les mêmes variables et paramètre que les documents générés par un parcours.
|
||||
|
||||
La variable suivante est ajoutée:
|
||||
|
||||
* `activities` (liste de [Activity](#sec:entity-activity)): Liste d'activités, variant "light". Aucun filtre n'est appliqué sur les échanges récupérés.
|
||||
|
||||
### Document générés pour une évaluation
|
||||
|
||||
Le document présente:
|
||||
|
||||
* une variable `evaluation` de type [`AccompanyingPeriodWorkEvaluation`](#sec:entity-accompanyingperiodworkevaluation): l'évaluation concernée;
|
||||
* une variable `work` de type [`AccompanyingPeriodWork`](#sec:entity-accompanyingperiodwork): l'action d'accompagnement au sein de laquelle l'évaluation est générée;
|
||||
* une variable `course`, de type [`AccompanyingPeriod`](#sec:entity-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`](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 1` est coché, une variable `person1`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 2` est coché, une variable `person2`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty), uniquement si l'administrateur fonctionnel l'a configuré.
|
||||
|
||||
### Document générés pour un échange
|
||||
|
||||
Le document présente:
|
||||
|
||||
* une variable `activity`, de type [`Activity`](#sec:entity-activity): l'évaluation concernée
|
||||
* une variable `course`, de type [`AccompanyingPeriod`](#sec:entity-accompanyingperiod): le parcours concerné, à condition que l'échange ait été créé dans un contexte parcours
|
||||
* une variable `person`, de type [`Person`](#sec:entity-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 du parcours` est coché, une variable `mainPerson`, de type [`Person`](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 1` est coché, une variable `person1`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* si `usager 2` est coché, une variable `person2`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
|
||||
### Documents générés dans le dossier d'une personne: contexte "personne basique"
|
||||
|
||||
* une variable `person`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`;
|
||||
* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty), uniquement si l'administrateur fonctionnel l'a configuré.
|
||||
|
||||
### Documents générés dans le dossier d'une personne: contexte "personne avec un tiers"
|
||||
|
||||
Ce contexte permet de générer un courrier avec, en paramètre, un tiers.
|
||||
|
||||
Cela peut être utile pour, par exemple, générer un courrier vers un tiers déjà enregistré dans la base de donnée de Chill.
|
||||
|
||||
Les variables disponibles sont les suivantes:
|
||||
|
||||
* une variable `person`, de type [Person](#sec:entity-person), avec les variants `relations`, `household` (ménage) et `budget`.
|
||||
* une variable `thirdParty`, de type [`ThirdParty`](#sec:entity-thirdparty);
|
||||
|
||||
### Document générés dans un contexte "rendez-vous"
|
||||
|
||||
Les champs suivant sont disponibles:
|
||||
|
||||
* une variable `calendar` ([Calendar](#sec:entity-calendar)), qui contient les données du rendez-vous;
|
||||
* une variable `mainPerson` ([Person](#sec:entity-person)), la personne principale parmi les personnes participant au rendez-vous. Cette variable n'est présente que si l'administrateur fonctionnel l'a configurée.
|
||||
* une variable `thirdParty` ([ThirdParty](#sec:entity-thirdparty)): un tiers participant au rendez-vous. Cette variable n'est présente que si l'administrateur fonctionnel l'a configurée.
|
||||
|
||||
## Principes liés au variables
|
||||
|
||||
## Champs par objet { #sec:gendoc-champs-objets }
|
||||
|
||||
### AccompanyingPeriod (Parcours) { #sec:entity-accompanyingperiod }
|
||||
## AccompanyingPeriod (Parcours) { #sec:entity-accompanyingperiod }
|
||||
|
||||
* `id` (texte): l'identifiant du parcours
|
||||
* `type` (texte): toujours égal à `accompanying-course`
|
||||
@@ -279,20 +47,20 @@ Les champs suivant sont disponibles:
|
||||
* `comments` (liste de [AccompanyingPeriodComment](#sec:entity-accompanyingperiodcomment)): liste des commentaires;
|
||||
* `pinnedComment` ([AccompanyingPeriodComment](#sec:entity-accompanyingperiodcomment)): commentaire épinglé;
|
||||
|
||||
### AccompanyingPeriodComment (Commentaire du parcours) { #sec:entity-accompanyingperiodcomment }
|
||||
## AccompanyingPeriodComment (Commentaire du parcours) { #sec:entity-accompanyingperiodcomment }
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `content` (texte): contenu du commentaire
|
||||
* `createdAt` ([Date](#sec:entity-date)): date de création
|
||||
* `creator` ([User](#sec:entity-user)): Créateur du commentaire
|
||||
|
||||
### AccompanyingPeriodOrigin (Origine du parcours) { #sec:entity-accompanyingperiodorigin }
|
||||
## AccompanyingPeriodOrigin (Origine du parcours) { #sec:entity-accompanyingperiodorigin }
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `label` (texte): libellé de l'origine;
|
||||
|
||||
|
||||
### AccompanyingPeriodParticipation (Participation à un parcours) { #sec:entity-accompanyingperiodparticipation }
|
||||
## AccompanyingPeriodParticipation (Participation à un parcours) { #sec:entity-accompanyingperiodparticipation }
|
||||
|
||||
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.
|
||||
|
||||
@@ -302,14 +70,14 @@ Cet objet effectue la jointure entre les parcours et les usagers concernés à u
|
||||
* `endDate` ([Date](#sec:entity-date)): date de fin. Vide si la participation est toujours en cours;
|
||||
|
||||
|
||||
### AccompanyingPeriodResource (Interlocuteur privilégiés dans un parcours) { #sec:entity-accompanyingperiodresource }
|
||||
## AccompanyingPeriodResource (Interlocuteur privilégiés dans un parcours) { #sec:entity-accompanyingperiodresource }
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `person` ([Person](#sec:entity-person)): usager ressource (vide, avec le paramètre `isNull` à `true`, si la ressource est un tiers);
|
||||
* `thirdParty` ([ThirdParty](#sec:entity-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) { #sec:entity-accompanyingperiodwork }
|
||||
## AccompanyingPeriodWork (Action d'accompagnement) { #sec:entity-accompanyingperiodwork }
|
||||
|
||||
* `id` (texte): l'identifiant de l'action;
|
||||
* `note` (texte): la note;
|
||||
@@ -329,7 +97,7 @@ Cet objet effectue la jointure entre les parcours et les usagers concernés à u
|
||||
* `evaluations` ([AccompanyingPeriodWorkEvaluation](#sec:entity-accompanyingperiodworkevaluation)): liste des évaluations générées;
|
||||
* `referrers` (liste de [User](#sec:entity-user)): liste des agents traitants;
|
||||
|
||||
### AccompanyingPeriodWorkEvaluation (évaluation dans une action d'accompagnement) { #sec:entity-accompanyingperiodworkevaluation }
|
||||
## AccompanyingPeriodWorkEvaluation (évaluation dans une action d'accompagnement) { #sec:entity-accompanyingperiodworkevaluation }
|
||||
|
||||
* `id` (texte): l'identifiant de l'évaluation;
|
||||
* `type` (texte): le libellé de l'évaluation;
|
||||
@@ -341,14 +109,14 @@ Cet objet effectue la jointure entre les parcours et les usagers concernés à u
|
||||
* `createdAt` ([Date](#sec:entity-date)): la date de création de l'évaluation;
|
||||
* `evaluation` ([Evaluation](#sec:entity-evaluation)): le type d'évaluation;
|
||||
|
||||
### AccompanyingPeriodWorkGoal (objectifs et résultats d'une action d'accompagnement) { #sec:entity-accompanyingperiodworkgoal }
|
||||
## AccompanyingPeriodWorkGoal (objectifs et résultats d'une action d'accompagnement) { #sec:entity-accompanyingperiodworkgoal }
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `goal` ([Goal](#sec:entity-goal)): objectif d'une action
|
||||
* `results` (liste de [Result](#sec:entity-result)): liste des résultats
|
||||
|
||||
|
||||
### Activity (échange) { #sec:entity-activity }
|
||||
## Activity (échange) { #sec:entity-activity }
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `activityType` ([ActivityType](#sec:entity-activitytype)): Type d'échange
|
||||
@@ -368,7 +136,7 @@ Cet objet effectue la jointure entre les parcours et les usagers concernés à u
|
||||
* `user` ([User](#sec:entity-user)): l'utilisateur pour lequel l'échange a été créé;
|
||||
* `users` (liste de [User](#sec:entity-user)): les utilisateurs qui sont associés à l'échange.
|
||||
|
||||
#### variant `light`
|
||||
### variant `light`
|
||||
|
||||
Un variant `light` est utilisé dans les listes d'`Activity`, comme par exemple pour le contexte "Liste des activités pour un parcours".
|
||||
|
||||
@@ -379,23 +147,23 @@ 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`.
|
||||
|
||||
### ActivityReason (Sujet d'activité) { #sec:entity-activityreason }
|
||||
## ActivityReason (Sujet d'activité) { #sec:entity-activityreason }
|
||||
|
||||
### ActivityType (Type d'activité) { #sec:entity-activitytype }
|
||||
## ActivityType (Type d'activité) { #sec:entity-activitytype }
|
||||
|
||||
Type d'activité.
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `name` (texte): libellé
|
||||
|
||||
### ActivityPresence (Présence à l'échange) { #sec:entity-activitypresence }
|
||||
## ActivityPresence (Présence à l'échange) { #sec:entity-activitypresence }
|
||||
|
||||
Présence à l'échange
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `name` (texte): libellé
|
||||
|
||||
### Address (Une adresse) { #sec:entity-address }
|
||||
## Address (Une adresse) { #sec:entity-address }
|
||||
|
||||
* `address-id` (int): l'identifiant de l'adresse;
|
||||
* `text` (texte): une chaine de caractère représentant l'adresse complète;
|
||||
@@ -421,7 +189,7 @@ line
|
||||
/for
|
||||
```
|
||||
|
||||
### Comment (Commentaire) { #sec:entity-comment }
|
||||
## Comment (Commentaire) { #sec:entity-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:
|
||||
|
||||
@@ -429,7 +197,7 @@ Certains champs commentaire enregistrent également l'utilisateur qui a effectu
|
||||
* `date` ([Date](#sec:entity-date)): la date de la dernière modification;
|
||||
* `user` ([User](#sec:entity-user)): l'utilisateur qui a effectué la dernière modification;
|
||||
|
||||
#### Variant `light`
|
||||
### Variant `light`
|
||||
|
||||
Dans le variant `light`,
|
||||
|
||||
@@ -438,50 +206,50 @@ Dans le variant `light`,
|
||||
|
||||
Seul le champ `comment` est donc disponible.
|
||||
|
||||
### Calendar (Rendez-vous) { #sec:entity-calendar}
|
||||
## Calendar (Rendez-vous) { #sec:entity-calendar}
|
||||
|
||||
* id (int): identifiant
|
||||
|
||||
### Civility (Civilité) { #sec:entity-civility }
|
||||
## Civility (Civilité) { #sec:entity-civility }
|
||||
|
||||
* `abbreviation` (texte): abbréviation;
|
||||
* `id` (int): identifiant (utile pour des comparaisons);
|
||||
* `name` (texte): titre, label de la civilité;
|
||||
|
||||
### ClosingMotive (Motif de cloture) { #sec:entity-closingmotive }
|
||||
## ClosingMotive (Motif de cloture) { #sec:entity-closingmotive }
|
||||
|
||||
* `id` (int): identifiant;
|
||||
* `name` (texte): libellé
|
||||
|
||||
|
||||
### Country (Pays) { #sec:entity-country }
|
||||
## Country (Pays) { #sec:entity-country }
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `name` (texte): nom du pays
|
||||
* `code` (texte): deux lettres du code ISO pays
|
||||
|
||||
### Date (Date) { #sec:entity-date }
|
||||
## Date (Date) { #sec:entity-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;
|
||||
|
||||
### Evaluation (type d'évaluation) { #sec:entity-evaluation }
|
||||
## Evaluation (type d'évaluation) { #sec:entity-evaluation }
|
||||
|
||||
* `id` (texte): l'identifiant du type d'évaluation;
|
||||
* `title` (texte): le titre du type d'évaluation;
|
||||
|
||||
### Goal (objectif d'une action) { #sec:entity-goal }
|
||||
## Goal (objectif d'une action) { #sec:entity-goal }
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `title` (texte): le titre du résultat
|
||||
|
||||
### GenderEntity (Genre) { #sec:entity-genderentity }
|
||||
## GenderEntity (Genre) { #sec:entity-genderentity }
|
||||
|
||||
* `label` (texte): label du genre;
|
||||
* `id` (int): identifiant (utile pour des comparaisons);
|
||||
* `genderTranslation` (texte): utilisation grammaticale;
|
||||
|
||||
### Household (Ménage) { #sec:entity-household }
|
||||
## Household (Ménage) { #sec:entity-household }
|
||||
|
||||
|
||||
* `id` (int): l'identifiant du ménage;
|
||||
@@ -492,7 +260,7 @@ Seul le champ `comment` est donc disponible.
|
||||
* `waitingForBirth` (bool): `true` si une naissance est attendue;
|
||||
* `waitingForBirthDate` ([Date](#sec:entity-date)): date de la naissance attendue;
|
||||
|
||||
### HouseholdComposition { #sec:entity-householdcomposition }
|
||||
## HouseholdComposition { #sec:entity-householdcomposition }
|
||||
|
||||
La composition du ménage entre deux dates. Cette entité associe une `HouseholdCompositionType` avec une date de début et une date de fin
|
||||
|
||||
@@ -502,12 +270,12 @@ La composition du ménage entre deux dates. Cette entité associe une `Household
|
||||
* `numberOfChildren` (int): nombre d'enfants
|
||||
* `householdCompositionType` ([HouseholdCompositionType](#sec:entity-householdcompositiontype)): Type de composition choisie, entre deux dates
|
||||
|
||||
### HouseholdCompositionType { #sec:entity-householdcompositiontype }
|
||||
## HouseholdCompositionType { #sec:entity-householdcompositiontype }
|
||||
|
||||
* `id` (int): L'identifiant du type de composition
|
||||
* `label` (texte): Le libellé de la composition
|
||||
|
||||
### HouseholdMember (Membre d'un ménage) { #sec:entity-householdmember }
|
||||
## HouseholdMember (Membre d'un ménage) { #sec:entity-householdmember }
|
||||
|
||||
* `comment` (texte): texte du commentaire;
|
||||
* `id` (int): identifiant de la participation au ménage;
|
||||
@@ -517,12 +285,12 @@ La composition du ménage entre deux dates. Cette entité associe une `Household
|
||||
* `position` ([HouseholdPosition](#sec:entity-householdposition)): la position du membre dans le ménage;
|
||||
* `startDate` ([Date](#sec:entity-date)): date de début de participation au ménage;
|
||||
|
||||
### HouseholdPosition (Position du membre dans le ménage) { #sec:entity-householdposition }
|
||||
## HouseholdPosition (Position du membre dans le ménage) { #sec:entity-householdposition }
|
||||
|
||||
* `id` (int): identifiant de la position;
|
||||
* `label` (texte): label de la position dans le ménage;
|
||||
|
||||
### Location (lieu) { #sec:entity-location }
|
||||
## Location (lieu) { #sec:entity-location }
|
||||
|
||||
* `id` (int): identifant;
|
||||
* `name` (texte): nom;
|
||||
@@ -532,12 +300,12 @@ La composition du ménage entre deux dates. Cette entité associe une `Household
|
||||
* `email` (email): email
|
||||
* `locationType` ([LocationType](#sec:entity-locationtype)): le type de lieu
|
||||
|
||||
### LocationType (type de lieu) { #sec:entity-locationtype }
|
||||
## LocationType (type de lieu) { #sec:entity-locationtype }
|
||||
|
||||
* `id` (int): identifant;
|
||||
* `title` (texte): titre du type de lieu;
|
||||
|
||||
### Person (Personne, usager) { #sec:entity-person }
|
||||
## Person (Personne, usager) { #sec:entity-person }
|
||||
|
||||
* `id` (texte): Identifiant du dossier usager;
|
||||
* `isNull` (bool): `true` si le dossier usager est vide;
|
||||
@@ -567,15 +335,15 @@ La composition du ménage entre deux dates. Cette entité associe une `Household
|
||||
|
||||
**Note**: La clé `gender` est dépréciée. Merci d'utiliser `GenderEntity`.
|
||||
|
||||
#### variant `household`
|
||||
### variant `household`
|
||||
|
||||
* `household` ([Household](#sec:entity-household)): le ménage actuel de l'usager;
|
||||
|
||||
#### variant `relations`
|
||||
### variant `relations`
|
||||
|
||||
* `relations` (liste de [Relationship](#sec:entity-relationship)): les relations (filiations) de l'usager;
|
||||
|
||||
#### variant `budget`
|
||||
### variant `budget`
|
||||
|
||||
Le budget des usagers et de leur ménage est accessible de manière synthétisée: la somme globale de chaque "ligne" de budget est effectuée et disponible pour l'inclusion.
|
||||
|
||||
@@ -583,7 +351,7 @@ Chaque "ligne" dépend de la configuration de votre instance.
|
||||
|
||||
Toutes les lignes de budget possibles sont toujours présentes. Il est possible d'ajouter une condition dans le document pour n'afficher que les lignes ayant une somme supérieure à zéro.
|
||||
|
||||
##### Attributs pour une `Ligne de budget`
|
||||
#### Attributs pour une `Ligne de budget`
|
||||
|
||||
Pour chaque ligne, les informations suivantes sont disponibles:
|
||||
|
||||
@@ -591,7 +359,7 @@ Pour chaque ligne, les informations suivantes sont disponibles:
|
||||
* `label` (texte): le libellé de cette ligne dans l'interface;
|
||||
* `comment` (texte): les commentaires des lignes du budget de même type. Tous les commentaires sont concaténés les uns à la suite des autres, et séparés par le caractère `|`.
|
||||
|
||||
##### Méthode de globalisation de chaque ligne
|
||||
#### Méthode de globalisation de chaque ligne
|
||||
|
||||
Pour chaque ligne de budget, la somme de toutes les lignes de budget du même type est disponible. Ainsi, si une entrée dans les ressources permet de saisir une charge "frais de communication téléphonique":
|
||||
|
||||
@@ -607,7 +375,7 @@ Le calcul du caractère actif d'une ligne est effectué comme suit:
|
||||
* la date de début est antérieure à la date de génération du document;
|
||||
* la date de fin est vide, ou postérieure à la date de génération du document.
|
||||
|
||||
##### Attributs supplémentaire avec le variant `budget`:
|
||||
#### Attributs supplémentaire avec le variant `budget`:
|
||||
|
||||
Les attributs suivants sont disponibles, pour chaque objet `Person` qui a un variant `budget`:
|
||||
|
||||
@@ -616,7 +384,7 @@ 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;
|
||||
|
||||
### PersonResource (Ressources associée à l'usager) { #sec:entity-personresource }
|
||||
## PersonResource (Ressources associée à l'usager) { #sec:entity-personresource }
|
||||
|
||||
Pour rappel, les ressources peuvent être:
|
||||
|
||||
@@ -633,18 +401,18 @@ Pour rappel, les ressources peuvent être:
|
||||
* `person` ([Person](#sec:entity-person)): l'usager, quand la ressources liée à un autre usager
|
||||
* `resourceKind` (texte): un discriminateur qui permet de vérifier si la ressources est lié à un usager (alors égal à `person`, un tiers (`thirdparty`) ou un texte libre (`freetext`). A utiliser dans les conditions dans les documents.
|
||||
|
||||
### PersonResourceKind (Type de personne ressource) { #sec:entity-personresourcekind }
|
||||
## PersonResourceKind (Type de personne ressource) { #sec:entity-personresourcekind }
|
||||
|
||||
* `id` (int)
|
||||
* `title` (texte)
|
||||
|
||||
### Postcode (Code Postal) { #sec:entity-postcode }
|
||||
## Postcode (Code Postal) { #sec:entity-postcode }
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `name` (texte): localité
|
||||
* `code` (texte): code postal
|
||||
|
||||
### Relationship (relations (filiations) entre usagers) { #sec:entity-relationship }
|
||||
## Relationship (relations (filiations) entre usagers) { #sec:entity-relationship }
|
||||
|
||||
Pour faciliter l'usager, les relations sont toujours représentée à partir d'un usager d'origine.
|
||||
|
||||
@@ -659,25 +427,25 @@ Les variables présentent le nom de la relation (`text`), et la personne avec qu
|
||||
|
||||
**Note**: la différence entre `fromPerson` et `toPerson` est arbitraire.
|
||||
|
||||
### Result (résultat d'une action) { #sec:entity-result }
|
||||
## Result (résultat d'une action) { #sec:entity-result }
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `title` (texte): le titre du résultat
|
||||
|
||||
### Scope (service) { #sec:entity-scope }
|
||||
## Scope (service) { #sec:entity-scope }
|
||||
|
||||
### SocialAction (type d'action d'accompagnement) { #sec:entity-socialaction }
|
||||
## SocialAction (type d'action d'accompagnement) { #sec:entity-socialaction }
|
||||
|
||||
* `id` (texte): identifiant
|
||||
* `text` (texte): texte, avec les parents inclus, séparés par un ` > `;
|
||||
* `title`: titre du type d'action, sans les parents;
|
||||
|
||||
### SocialIssue (problématique sociale) {#sec:entity-socialissue}
|
||||
## SocialIssue (problématique sociale) {#sec:entity-socialissue}
|
||||
|
||||
* `name`: le nom de la problématique seule
|
||||
* `text`: le nom de la problématique et des problématiques parentes
|
||||
|
||||
### ThirdParty (Tiers) { #sec:entity-thirdparty }
|
||||
## ThirdParty (Tiers) { #sec:entity-thirdparty }
|
||||
|
||||
* `id` (int): identifiant du tiers;
|
||||
* `acronym` (text): acronyme;
|
||||
@@ -702,19 +470,19 @@ Les variables présentent le nom de la relation (`text`), et la personne avec qu
|
||||
* `child` lorsuq'il s'agit d'un contact d'une personne morale
|
||||
* `contact` lorsqu'il s'agit d'une personne **physique** (à ne pas confondre avec un contact d'une personne morale)
|
||||
|
||||
### ThirdPartyCategory (catégorie de tiers) { #sec:entity-thirdpartycategory }
|
||||
## ThirdPartyCategory (catégorie de tiers) { #sec:entity-thirdpartycategory }
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `name` (texte)
|
||||
|
||||
|
||||
### ThirdPartyProfession (profession du tiers) { #sec:entity-thirdpartyprofession }
|
||||
## ThirdPartyProfession (profession du tiers) { #sec:entity-thirdpartyprofession }
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `name` (texte)
|
||||
|
||||
|
||||
### User (Utilisateur) { #sec:entity-user }
|
||||
## User (Utilisateur) { #sec:entity-user }
|
||||
|
||||
* `id` (int): identifant
|
||||
* `type` (texte): vaut toujours `user`
|
||||
@@ -728,7 +496,7 @@ Les variables présentent le nom de la relation (`text`), et la personne avec qu
|
||||
* `main-location` ([Location](#sec:entity-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](#sec:entity-civility)): la civilité de l'utilisateur;
|
||||
|
||||
### UserJob (Métier) { #sec:entity-userjob }
|
||||
## UserJob (Métier) { #sec:entity-userjob }
|
||||
|
||||
* `id` (int): identifiant
|
||||
* `label` (texte): nom du métier
|
||||
+3
-1
@@ -12,7 +12,9 @@ theme:
|
||||
nav:
|
||||
- Accueil: index.md
|
||||
- Élements à configurer: configuration-chill-big-picture.md
|
||||
- Génération de document: generation-documents.md
|
||||
- Génération de document:
|
||||
Principes: generation-documents/index.md
|
||||
Propriété des objets: generation-documents/properties.md
|
||||
- Gestion des droits: gestion-des-droits.md
|
||||
- Personnalisation du logiciel: personalize-chill.md
|
||||
hooks:
|
||||
|
||||
Reference in New Issue
Block a user