Aller au contenu principal
Version: v1-alpha

Les datasets

Un dataset est une liste de données statique sous forme de tableau composé de :

  • Une liste de propriétés représentant les colonnes du tableau
  • Une liste de record représentant les lignes du tableau

Créer un dataset

Un dataset peut être créé à partir du formulaire de création en renseignant un code et un libellé.

Les propriétés peuvent être créées ensuite depuis la page du dataset.

Exporter un dataset

Il est possible d'exporter la définition d'un dataset incluant la liste de ses propriétés dans un fichier au format JSON en cliquant sur le bouton Exporter situé dans la page du dataset.

Exemple
{
"code": "COMMUNES",
"label": "Référentiel des communes de France",
"properties": [
{
"code": "PAYS",
"orderIndex": 1,
"label": "Pays",
"type": "STRING",
"showInFilter": true,
"showInTable": true
},
{
"code": "DEPARTEMENT",
"orderIndex": 2,
"label": "Département",
"type": "STRING",
"showInFilter": true,
"showInTable": true
},
{
"code": "COMMUNE",
"orderIndex": 3,
"label": "Commune",
"type": "STRING",
"showInFilter": true,
"showInTable": true
}
]
}

Importer un dataset

Il est également possible d'importer la définition d'un dataset pour le créer. Pour cela, il suffit de coller le JSON ou importer un fichier au format JSON contenant la définition du dataset dans la zone prévue à cet effet.

attention

Le code du dataset doit être unique. Il faudra veiller leur de l'import d'un JSON à ce que le code du dataset présent dans la définition n'existe pas dans RuleShake Referential.

Propriétés

Les propriétés définissent les données que doit inclure le dataset. Chaque propriété est définie par :

  • un code unique par dataset
  • un libelle
  • un type parmi Chaîne, Nombre, Date ou Booléen
  • des indications d'affichage :
    • affichable, si oui la propriété est affichée comme colonne dans le tableau des records
    • filtrable, si oui la propriété est présente dans les filtres du tableau des records
info

La propriété CODE est systématiquement présente dans chaque dataset et permet d'identifier de façon unique chaque record.

Exemple

On peut imaginer un dataset représenté le référentiel des communes de France.

Une version simplifiée serait de définir les propriétés PAYS, DEPARTEMENT et COMMUNE.

Dataset des communes de France
Figure: Dataset des communes de France

Records

Un record est une structure de données qui valorise les propriétés du dataset.

Exemple

Si on reprend l'exemple du référentiel des communes de France, chaque record représenterait une commune :

Records du dataset des communes de France
Figure: Records du dataset des communes de France

Créer un record

Il est possible de créer un record à partir du formulaire de création à ouvrir à partir du menu ACTIONS. Ce formulaire est généré automatiquement à partir de la définition des propriétés du dataset.

Un record peut être à l'état « Désactivé », dans ce cas, on renseigne le code du record qui le remplace. Dans ce cas, lors de la lecture du record désactivé, ce sont les valeurs du record qui le remplace qui seront renvoyées.

Exporter des records

L'ensemble des records peut être exporté sous format CSV ou chaque ligne représente un record.

Exemple
Fichier CSV des records du dataset des communes de France
Figure: Fichier CSV des records du dataset des communes de France

Importer des records

Pour créer des records en masse, il est possible d'importer un fichier CSV avec le même format que le fichier CSV obtenu lors de l'export des records.

Dans le formulaire d'import, on peut choisir entre deux modes d'import :

  • Fusionner : fusionne les records du dataset déjà présents dans RuleShake Referential avec ceux présents dans le CSV. En cas de conflit, c'est-à-dire deux records avec le même code, c'est le record présent dans le CSV qui sera conservé.
  • Remplacer : vide tous les records du dataset dans RuleShake Referential puis importe les records à partir du CSV.

Suppression en masse

Cette fonctionnalité permet de supprimer en masse les records sélectionnés par le filtre dans le tableau des records. Pour cela, il faudrait dans un premier temps filtrer sur les valeurs des propriétés du dataset pour obtenir la liste des records que l'on souhaite supprimer. Ensuite, dans le menu ACTIONS, cliquer que le bouton Activer la suppression des records avec le filtre, le bouton SUPPRIMER LES RECORDS SELECTIONNES PAR LE FILTRE apparaitra.

Classiers

Il est possible de créer un ou plusieurs classiers pour un dataset. Pour plus d'information, veuillez consulter la page Les classiers