Les vérifications

Afin de limiter au maximum les erreurs lors des traitements ou de la diffusion, des scripts permettent de détecter au plus tôt des défauts dans les données téléversées au sein d'une livraison. Ces scripts sont utilisables sur la plateforme en tant que vérification.

D'un point de vue modèle, c'est une entité check, commune à toute la plateforme. Chaque datastore aura accès à l'ensemble ou à une partie seulement des vérifications disponibles sur la plateforme.

Créer une vérification

Une vérification est décrite par :

• un nom, visible des utilisateurs
• une description, visible des utilisateurs et doit leur permettre de comprendre ce que fait la vérification
• la liste des types de livraison pour lesquels la vérification se lancera automatiquement à leur fermeture, visibles des utilisateurs
• le nom du job sur l'orchestrateur, visible uniquement des administrateurs

Toutes ces informations sont précisées lors de l'appel à l'API POST /administrator/checks pour enregistrer une nouvelle vérification. Cet enregistrement n'a aucun effet sur l'orchestrateur, le job référencé doit exister lors de l'utilisation de la vérification par un entrepôt.

Parcourir les vérifications

L'API GET /administrator/checks permet de récupérer l'ensemble des vérifications (avec pagination) disponibles sur la plateforme. Il est possible de filtrer sur le type de livraison sur lequel la vérification se déclenche automatiquement.

L'API GET /administrator/checks/{id} permet de récupérer toutes les informations sur une vérification en particulier.

Modifier une vérification

L'API PATCH /administrator/checks/{id} permet de modifier partiellement une vérification, en précisant certains de ses 4 attributs.

Supprimer une vérification

La suppression d'une vérification (DELETE /administrator/checks/{id}) est très limitée : elle ne peut être faite qu'en l'absence d'exécution de vérification rattachée.

Attribuer les vérifications aux entrepôt

Cette manipulation se fait via la modification de l'entrepôt, décrite ici.