DataStore : Différence entre versions
| (35 révisions intermédiaires par le même utilisateur non affichées) | |||
| Ligne 1 : | Ligne 1 : | ||
<h1 id="datastore">DataStore</h1> | <h1 id="datastore">DataStore</h1> | ||
| − | <p>Le Datastore est l’endroit où toutes les variables utilisées ailleurs dans le | + | <h2 id="contexte">Contexte</h2> |
| + | <p>Le Datastore est l’endroit où toutes les variables utilisées ailleurs dans le [[Fichier de Paramétrage]] doivent être déclarées.</p> | ||
<p>C’est en quelque sorte un “dépôt” de variables.</p> | <p>C’est en quelque sorte un “dépôt” de variables.</p> | ||
| − | <p>Le Datastore doit donc être le miroir des autres feuilles du | + | <p>Le Datastore doit donc être le miroir des autres feuilles du [[Fichier de Paramétrage]].</p> |
| − | <p> | + | <p>Il faut obligatoirement définir pour chaque variable : un ID et un type.</p> |
| − | On peut définir, facultativement, un contrôle d’intégrité et | + | <p> On peut définir, facultativement, un contrôle d’intégrité et un commentaire.</p> |
<h2 id="id-de-la-variable">Id de la variable</h2> | <h2 id="id-de-la-variable">Id de la variable</h2> | ||
<p>La colonne “Id de la variable” permet de déclarer auprès du système le nom de la variable qu’on définit.</p> | <p>La colonne “Id de la variable” permet de déclarer auprès du système le nom de la variable qu’on définit.</p> | ||
| − | <p> | + | <p><b>Aspects syntaxiques</b></p> |
| + | <p>Les variables doivent être nommées en respectant certaines règles :</p> | ||
<ul> | <ul> | ||
<li>Le nom de la variable doit être en majuscules</li> | <li>Le nom de la variable doit être en majuscules</li> | ||
| Ligne 14 : | Ligne 16 : | ||
</ul> | </ul> | ||
<p>Exemples : | <p>Exemples : | ||
| − | [[Fichier: | + | [[Fichier:Identification des parties - datastore.png|450px|vignette|néant|Un DataStore classique]] |
Cette colonne doit impérativement être remplie.</p> | Cette colonne doit impérativement être remplie.</p> | ||
<h2 id="type">Type</h2> | <h2 id="type">Type</h2> | ||
| + | <h3 id="principe">Principe</h2> | ||
<p>Il s'agit ici d'indiquer quel type d'information sera stockée dans la variable en question.</p> | <p>Il s'agit ici d'indiquer quel type d'information sera stockée dans la variable en question.</p> | ||
<ul> | <ul> | ||
| − | <li>String : une [https://fr.wikipedia.org/wiki/Cha%C3%AEne_de_caract%C3%A8res chaîne de caractères]</li> | + | <li><code>String</code> : une [https://fr.wikipedia.org/wiki/Cha%C3%AEne_de_caract%C3%A8res chaîne de caractères]</li> |
| − | <li>Numeric : un nombre</li> | + | <li><code>Numeric</code> : un nombre</li> |
| − | <li>Date : une date</li> | + | <li><code>Date</code> : une date</li> |
| − | <li>File : un fichier</li> | + | <li><code>File</code> : un fichier</li> |
| − | <li>List : | + | <li><code>List</code> : à utiliser lorsque la variable a vocation à articuler des [[Repeaters]] ou des [[Boucles]] (se reporter aux sections correspondantes). Ou bien lorsque la variable a vocation à stocker un [[Fields-Form/Multiple-choices|Multiple-choices]].</li> |
</ul> | </ul> | ||
| + | <h3 id="corresp">Cohérence entre le [[Fields-Form]] et le DataStore</h2> | ||
<p>Il faut être attentif à bien faire coïncider le type dans le [[Fields-Form]] et le type dans le DataStore.</p> | <p>Il faut être attentif à bien faire coïncider le type dans le [[Fields-Form]] et le type dans le DataStore.</p> | ||
<p>Pour cela, on peut se reporter au tableau de compatibilité ci-après : | <p>Pour cela, on peut se reporter au tableau de compatibilité ci-après : | ||
| Ligne 31 : | Ligne 35 : | ||
<p>Cette colonne doit impérativement être remplie. </p> | <p>Cette colonne doit impérativement être remplie. </p> | ||
<h2 id="contr-le-d-int-grit-">Contrôle d’intégrité</h2> | <h2 id="contr-le-d-int-grit-">Contrôle d’intégrité</h2> | ||
| − | <p>Pour exercer un contrôle plus précis sur la phase d’input, le système peut effectuer des “contrôles d’intégrité” sur les variables : c’est-à-dire vérifier la conformité de ce que rentre l’utilisateur final par rapport à des règles définies dans le DataStore.</p> | + | <h3 id="introduction">Introduction</h3> |
| + | <h4 id="pres">Présentation générale</h4> | ||
| + | <p>Pour exercer un contrôle plus précis sur la phase d’input, c'est-à-dire sur le [[Fields-Form|questionnaire]], le système peut effectuer des “contrôles d’intégrité” sur les variables : c’est-à-dire vérifier la conformité de ce que rentre l’utilisateur final par rapport à des règles définies dans le DataStore.</p> | ||
<p>Les contrôles à effectuer sont paramétrables et dépendent du type de variable : </p> | <p>Les contrôles à effectuer sont paramétrables et dépendent du type de variable : </p> | ||
<p> | <p> | ||
| − | [[Fichier: | + | [[Fichier:Integrite2.png|thumb|néant|700px|Les contrôles d'intégrité]] |
</p> | </p> | ||
| − | |||
| − | |||
<p>Remplir cette colonne est facultatif.</p> | <p>Remplir cette colonne est facultatif.</p> | ||
| + | <h4 id="desc">Description des contrôles</h4> | ||
| + | <h5 id="ctrl_strings">Contrôles pour les variables de type <b>String</b></h5> | ||
| + | <p><code>maxlength:</code>: permet de définir un nombre de caractères maximum lors de la saisie.</p> | ||
| + | <p><code>minlength:</code>: permet de définir un nombre de caractères minimum lors de la saisie.</p> | ||
| + | <p><code>choices:</code>: permet de contrôler que le [[Fields-Form]] enregistre bien un des choix mentionné.</p> | ||
| + | <p><code>source:</code>: permet de contrôler que le [[Fields-Form]] aille bien chercher une valeur dans la [[Fields-Form#Choices|Choice-List]] qui est choisie. </p> | ||
| + | <h5 id="ctrl_number">Contrôles pour les variables de type <b>Numeric</b> et <b>Date</b></h5> | ||
| + | <p><code>min:</code>: permet de définir un nombre minimum (ou une date minimum) lors de la saisie.</p> | ||
| + | <p><code>max:</code>: permet de définir un nombre maximum (ou une date maximum) lors de la saisie.</p> | ||
| + | <h5 id="ctrl_number">Contrôles pour les variables de type <b>File</b></h5> | ||
| + | <p><code>extension:</code>: permet de définir les type de fichier autorisés.</p> | ||
| + | <h3 id="ex">Exemples dans un [[Fichier de Paramétrage]]</h3> | ||
| + | <p> | ||
| + | [[Fichier:Intégrités complet.png|900px|vignette|néant|Un DataStore paramétré avec plusieurs contrôles d'intégrité]] | ||
| + | </p> | ||
| + | <p><b>Explications de l'exemple</b></p> | ||
| + | <p>La variable <code>ACHETEUR_CIVILITE</code> ne pourra recevoir que deux valeurs : M. ou Mme.</p> | ||
| + | <p>La variable <code>ACHETEUR_NOM</code> sera limitée à 64 caractères</p> | ||
| + | <p>La variable <code>ACHETEUR_PRENOM</code> devra contenir au minimum 2 caractères</p> | ||
| + | <p>La variable <code>ACHETEUR_PAYS</code> devra contenir les choix issus d'une [[Fields-Form#Choices|Choice-List]] nommée "pays" (voir [[Fields-Form#Choices|la section correspondante]] du Wiki)</p> | ||
| + | <p>La variable <code>ACHETEUR_MONTANT_ACHATS_HT</code> devra valoir au moins 0</p> | ||
| + | <p>La variable <code>ACHETEUR_DATE_ACHATS</code> devra au minimum valoir la date du 1er janvier 2015 et au maximum la date du jour.</p> | ||
| + | <p>La variable <code>ACHETEUR_CARTE_ID</code> n'acceptera que des fichiers ayant l'extension : png, pdf, jpg, ou bien jpeg</p> | ||
| + | <p>La variable <code>PRODUIT_REF</code> devra contenir au minimum 6 caractères et au maximum 6 caractères</p> | ||
| + | <p>La variable <code>PRODUIT_PRIX_HT</code> devra valoir au minimum 0 et au maximum 10</p> | ||
<h2 id="commentaires">Commentaires</h2> | <h2 id="commentaires">Commentaires</h2> | ||
<p>Celui qui paramètre peut écrire ici toute instruction/remarque utile pour comprendre la manière dont il a construit le datastore et l’organisation des variables.</p> | <p>Celui qui paramètre peut écrire ici toute instruction/remarque utile pour comprendre la manière dont il a construit le datastore et l’organisation des variables.</p> | ||
<p>Remplir cette colonne est facultatif.</p> | <p>Remplir cette colonne est facultatif.</p> | ||
Version actuelle datée du 27 août 2020 à 11:47
Sommaire
DataStore
Contexte
Le Datastore est l’endroit où toutes les variables utilisées ailleurs dans le Fichier de Paramétrage doivent être déclarées.
C’est en quelque sorte un “dépôt” de variables.
Le Datastore doit donc être le miroir des autres feuilles du Fichier de Paramétrage.
Il faut obligatoirement définir pour chaque variable : un ID et un type.
On peut définir, facultativement, un contrôle d’intégrité et un commentaire.
Id de la variable
La colonne “Id de la variable” permet de déclarer auprès du système le nom de la variable qu’on définit.
Aspects syntaxiques
Les variables doivent être nommées en respectant certaines règles :
- Le nom de la variable doit être en majuscules
- Les espaces ne sont pas autorisés, on préférera les tirets du bas qui eux sont autorisés : _
- Les accents & et caractères spéciaux ne sont pas non plus autorisés.
Exemples :
Cette colonne doit impérativement être remplie.
Type
Principe
Il s'agit ici d'indiquer quel type d'information sera stockée dans la variable en question.
String: une chaîne de caractèresNumeric: un nombreDate: une dateFile: un fichierList: à utiliser lorsque la variable a vocation à articuler des Repeaters ou des Boucles (se reporter aux sections correspondantes). Ou bien lorsque la variable a vocation à stocker un Multiple-choices.
Cohérence entre le Fields-Form et le DataStore
Il faut être attentif à bien faire coïncider le type dans le Fields-Form et le type dans le DataStore.
Pour cela, on peut se reporter au tableau de compatibilité ci-après :
Cette colonne doit impérativement être remplie.
Contrôle d’intégrité
Introduction
Présentation générale
Pour exercer un contrôle plus précis sur la phase d’input, c'est-à-dire sur le questionnaire, le système peut effectuer des “contrôles d’intégrité” sur les variables : c’est-à-dire vérifier la conformité de ce que rentre l’utilisateur final par rapport à des règles définies dans le DataStore.
Les contrôles à effectuer sont paramétrables et dépendent du type de variable :
Remplir cette colonne est facultatif.
Description des contrôles
Contrôles pour les variables de type String
maxlength:: permet de définir un nombre de caractères maximum lors de la saisie.
minlength:: permet de définir un nombre de caractères minimum lors de la saisie.
choices:: permet de contrôler que le Fields-Form enregistre bien un des choix mentionné.
source:: permet de contrôler que le Fields-Form aille bien chercher une valeur dans la Choice-List qui est choisie.
Contrôles pour les variables de type Numeric et Date
min:: permet de définir un nombre minimum (ou une date minimum) lors de la saisie.
max:: permet de définir un nombre maximum (ou une date maximum) lors de la saisie.
Contrôles pour les variables de type File
extension:: permet de définir les type de fichier autorisés.
Exemples dans un Fichier de Paramétrage
Explications de l'exemple
La variable ACHETEUR_CIVILITE ne pourra recevoir que deux valeurs : M. ou Mme.
La variable ACHETEUR_NOM sera limitée à 64 caractères
La variable ACHETEUR_PRENOM devra contenir au minimum 2 caractères
La variable ACHETEUR_PAYS devra contenir les choix issus d'une Choice-List nommée "pays" (voir la section correspondante du Wiki)
La variable ACHETEUR_MONTANT_ACHATS_HT devra valoir au moins 0
La variable ACHETEUR_DATE_ACHATS devra au minimum valoir la date du 1er janvier 2015 et au maximum la date du jour.
La variable ACHETEUR_CARTE_ID n'acceptera que des fichiers ayant l'extension : png, pdf, jpg, ou bien jpeg
La variable PRODUIT_REF devra contenir au minimum 6 caractères et au maximum 6 caractères
La variable PRODUIT_PRIX_HT devra valoir au minimum 0 et au maximum 10
Commentaires
Celui qui paramètre peut écrire ici toute instruction/remarque utile pour comprendre la manière dont il a construit le datastore et l’organisation des variables.
Remplir cette colonne est facultatif.
