Les traitements
Les traitements sont l'unique moyen sur la plateforme de créer des données stockées, diffusables. Ils permettent de transformer, optimiser, modifier les données destinées aux géoservices ou téléversées.
D'un point de vue modèle, c'est une entité processing, commune à toute la plateforme. Chaque datastore aura accès à l'ensemble ou à une partie seulement des traitements disponibles sur la plateforme.
Créer un traitement
Un traitement est décrit par :
- un nom, visible des utilisateurs
- une description, visible des utilisateurs et doit leur permettre de comprendre ce que fait le traitement
- les types de livraison acceptés en entrée. N'en préciser aucun empêchera de mettre en entrée des exécutions de ce traitement des livraisons
- les vérifications que les éventuelles livraisons en entrée des exécutions devront avoir passées avec succès
- les types de donnée stockée acceptés en entrée. N'en préciser aucun empêchera de mettre en entrée des exécutions de ce traitement des données stockées
- le type de la donnée en sortie : soit une type de livraison, soit un type de donnée stockée
- les types possibles du stockages sur lequel le donnée en sortie sera. Le premier type sera celui par défaut.
- une liste de paramètres, un paramètre étant :
- un nom
- une description
- d'éventuelles contraintes
- une obligation ou non
- une valeur par défaut si pas d'obligation
- 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/processings pour enregistrer un nouveau traitement. Cet enregistrement n'a aucun effet sur l'orchestrateur, le job référencé doit exister lors de l'utilisation du traitement par un entrepôt. La configuration doit être en accord avec les attentes et les capacités des scripts du traitement.
Parcourir les traitements
L'API GET /administrator/processings permet de récupérer l'ensemble des traitements (avec pagination) disponibles sur la plateforme. Pour cibler plus précisément les traitements voulus, plusieurs filtres, qui se cumulent, sont possibles :
input_upload_type=[type de livraison]: permet de préciser le type de livraison accepté en entrée. Tous les types par défaut.input_stored_data_type=[type de donnée stockée]: permet de préciser le type de donnée stockée accepté en entrée. Tous les types par défaut.output_upload_type=[type de livraison]: permet de préciser le type de livraison généré en entrée. Tous les types par défaut.output_stored_data_type=[type de donnée stockée]: permet de préciser le type de donnée stockée généré en sortie. Tous les types par défaut.name=%chaîne%: nom complet ou partiel (%remplace au moins un caractère) des traitements voulus.orchestrator_job_name=%chaîne%: nom complet ou partiel (%remplace au moins un caractère) du job orchestrateur correspondant aux traitements voulues.
L'API GET /administrator/processings/{id} permet de récupérer toutes les informations sur un traitement en particulier.
Modifier un traitement
L'API PATCH /administrator/processings/{id} permet de modifier partiellement un traitement, seulement sur ses attributs de nom, de description et de nom du job sur l'orchestrateur.
L'API PUT /administrator/processings/{id} permet de modifier intégralement un traitement, en reprécisant toute sa configuration.
Supprimer un traitement
La suppression d'un traitement (DELETE /administrator/processings/{id}) est très limitée : elle ne peut être faite qu'en l'absence d'exécution de traitement rattachée.
Attribuer les traitements aux entrepôt
Cette manipulation se fait via la modification de l'entrepôt, décrite ici.