Newer
Older
_JSON & YAML data extracted from OpenFisca-France-with-indirect-taxation source code (parameters, variables, etc)_
These data are extracted from [OpenFisca-France-with-indirect-taxation source code](https://git.leximpact.dev/leximpact/openfisca-france-with-indirect-taxation) using [OpenFisca JSON Model](https://git.leximpact.dev/leximpact/openfisca-json-model) tools.
1. [Mettre en préprod les changements](#mettre-en-préprod-les-changements)
2. [Ajouter / modifier des variables dans le fichier customizations.json](#ajouter--modifier-des-variables-dans-le-fichier-customizationsjson)
Dorine Lambinet
committed
## 1. Mettre en Préprod les changements
Pour mettre en préprod les changements apportés dans ce dépôt, et pour permettre de les voir en local sur socio-fiscal-ui, il faut :
1. Merger la branche qui apporte les changements
2. Cliquer sur "Build" dans le menu à gauche, puis sur "Pipelines"
3. Cliquer sur "Run Pipeline", une page s'ouvre, rester sur la branche Master, lancer le processus.
Une fois toutes les pipelines passées au vert, les changements sont en préprod. ⚠️ Ne pas cliquer sur les boutons "Play" dans le schémas des pipelines, ça peut lancer une mise en prod ... !
Dorine Lambinet
committed
## 2. Ajouter / modifier des variables dans le fichier customizations.json
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
Le fichier `customizations.json` permet d'apporter des modifications aux variables extraites directement d'OpenFisca, qui se trouvent dans le fichier `decomposition_extracted.json`.
### Modifier les labels, ajouter un short_label
```json
"ircantec_employeur": {
"label": "Cotisation employeur à l'institution de retraite complémentaire des agents non-titulaires de l'État et des collectivités publiques (Ircantec)",
"short_label": "Cotis. retraite complémentaire non-titulaires (Ircantec)",
}
```
### Ajouter une description
La description est composée :
- `href` : Lien vers un site externe de référence
- `note` : Texte de la description
- `title` : Titre de la référence
- une date, date à laquelle le lien fourni a été visité. Si pas de lien `title` ni `href`, alors mettre `0001-01-01`
```json
"description": {
"2021-07-27": [
{
"href": "https://www.urssaf.fr/portail/home/employeur/calculer-les-cotisations/les-taux-de-cotisations/la-cotisation-vieillesse.html",
"note": "Cette cotisation est une des deux fractions de la cotisation employeur de l'assurance vieillesse. Cette dernière finance une part du régime de retraite de base des salariés du secteur privé et des non-titulaires de la fonction publique. (L'autre part étant financée par les cotisations salariales). \nOn parle de fraction déplafonnée car le montant de cette part de la cotisation est basé sur la rémunération totale.",
"title": "Urssaf.fr"
}
]
}
```
### Ajouter une référence législative
La référence est composée :
- `href` : Lien vers la référence législative
- `title` : Titre de la référence
- une date : toujours laisser `0001-01-01`
```json
"reference": {
"0001-01-01": [
{
"href": "https://www.legifrance.gouv.fr/codes/section_lc/LEGITEXT000006073189/LEGISCTA000006141693/#LEGISCTA000006141693",
"title": "Articles L821-1 à L821-8 du Code de la sécurité sociale"
}
]
}
```
### Ajouter des variables enfants
Le fichier `customizations.json` permet aussi de changer les enfants d'une variable. Il vaut mieux faire cette opération dans OpenFisca cependant :
```json
"children": [
{
"name": "revenu_disponible"
},
{
"name": "taxes_tous_carburants"
}
],
```
### Ajouter des variables liées
Ces variables apparaitront dans la vue focus dispositif au côté de la variable sélectionnée.
Par exemple, le nombre de part de quotient familial par rapport à l'impôt sur le revenu :
```json
"linked_other_variables": [
"nbptr",
Dorine Lambinet
committed
### Cacher des variables dans un waterfall en particulier
Dorine Lambinet
committed
Cela est fait pour le waterfall "taxes carburants" où les enfants de niveau de vie sont cachés :
```json
"options": {
"waterfall": [
"disponible_to_disponible_apres_taxes_carburant"
],
"then": {
"children": null
}
}
```
## 3. Afficher/cacher la variable selon les caractéristiques du cas type
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
Le tableau options permet d'indiquer quand une variable doit être affichée.
Par exemple, il permet de cacher la réduction générale de cotisations employeur pour les agents publics, afin de l'afficher uniquement pour les actifs salariés :
```json
"options": {
"activite": "actif",
"categorie_salarie": ["prive_cadre", "prive_non_cadre"],
"else": {
"hidden": true
}
}
```
Il est possible d'utiliser n'importe quelle variable de cas type pour paramétrer ce choix :
```json
"options": {
"nombre_litres_essence_sp95": true,
"nombre_litres_essence_sp95_e10": true,
"nombre_litres_essence_sp98": true,
"nombre_litres_gazole_b7": true,
"nombre_litres_gazole_b10": true,
"nombre_litres_gpl_carburant": true,
"else": {
"hidden": true
}
}
```
### Modifier la liste des paramètres
Les formules OpenFisca ne permettent pas toujours d'afficher tous les paramètres utiles, ou bien affichent des paramètres obsolètes.
Quand on ajoute un `main_parameters`, la liste est figée et dans l'ordre indiqué :
```json
"main_parameters": [
"prestations_sociales.solidarite_insertion.autre_solidarite.aefa"
],
```
⚠️ L'ordre des `main_parameters` mis dans la liste n'a AUCUN impact sur l'ordre d'affichage des paramètres dans l'UI. L'ordre d'affichage dépend de l'arbre des paramètres openfisca (ordre des dossier dans OpenFisca).
💡 Les main_parameters sont utilisés par `formula.parameters` dans le simulateur socio-fiscal.
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
### Ne pas afficher une variable
Pour ne pas afficher une variable dans la feuille de paie, quelque soit la situation, il faut ajouter le champ `"hidden": true`
```json
"hidden": true,
```
### Indiquer la validité d'une variable
#### La variable est obsolète
Indiquer que la variable est obsolète avec `"obsolote"` et éventuellement la cacher avec le champ `"hidden"` :
```json
"hidden": true,
"obsolete": true
```
#### La variable est obsolète
```json
"last_value_still_valid_on": "2022-07-11"
```
### Ajouter une variable qui ne fait pas partie d'OpenFisca
Il peut parfois être nécessaire de créer une variable dans la feuille de paie, qui n'existe pas dans OpenFisca. Il faut le spécifier dans le fichier json :
```json
"virtual": true,
### Ajouter une nouvelle information qui n'existe pas encore
C'est possible, mais il faut changer les validateurs de l'openfisca-json-model, (écrire à Emmanuel).
## Ajouter un cas type
⚠️ Les caractéristiques d'un cas type doivent UNIQUEMENT être des variables d'entrée et non des formules. Autrement, le modèle OpenFisca aligne tous les cas types sur la formule du cas type concerné.
> Par exemple : Si on entre le salaire imposable (Formule) dans un cas type au lieu du salaire de base (variable d'entrée). Le salaire de base ne sera plus pris en compte pour les autres cas types.
### Paramétrer le salaire de base sur la valeur du Smic
Pour que les cas types restent à jour dans le temps, leur salaire est configuré par rapport au smic.
Pour un cas type au Smic :
```json
"salaire_de_base": {
"year - 2": "Math.round(smic)",
"year - 1": "Math.round(smic)",
"year": "Math.round(smic)"
}
```
Pour un cas type à 4,5 Smic :
```json
"salaire_de_base": {
"year - 2": "Math.round(smic * 4.5)",
"year - 1": "Math.round(smic * 4.5)",
"year": "Math.round(smic * 4.5)"
},
```