Format du fichier de résultat de validation

Transcription

1 CHOUETTE Maintenance, accompagnement et recette de logiciels pour les échanges de données multimodales Format du fichier de résultat de validation Auteurs : Relecteurs Zakaria BOUZIANE, Marc FLORISSON (CityWay) Patrick GENDRE (CEREMA) Résumé : CHOUETTE est un logiciel libre développé à l'initiative du ministère français chargé des transports (et du développement durable) dans le but de faciliter l'échange de données d'offre (théorique) de transport collectif (TC), en s'appuyant pour cela sur la norme NFP 99506, dite Neptune, qui spécifie un profil d'échange XML. Les utilisateurs visés sont les collectivités locales Autorités Organisatrices de Transport (AOT), les exploitants des réseaux TC, ainsi que leurs prestataires (bureaux d'étude ou société de services) et d'autres acteurs tels que services de l'état, éditeurs de logiciels, opérateurs de services d'information, chercheurs... L'application CHOUETTE est disponible sous la forme d'une application WEB destinée à être déployée sur un serveur WEB, et d'une application en ligne de commande. Ce document définit les interfaces externes du serveur IEV Agence française pour l'information multimodale et la billettique Informations sur ce document : Organisme commanditaire : AFIMB Document : Chouette 1/6

2 Titre : Sous-titre : Organismes auteurs CITYWAY Rédacteurs Zakaria BOUZIANE Marc FLORISSON Participants Patrick Gendre, CEREMA Jean Seng, AFIMB Maitre d'ouvrage AFIMB Mots clés : Diffusion : application Chouette, import, export, validation, Neptune, NeTEx, GTFS publique (licence Creative Commons CC-by-nd ) Nombre de pages : Date : Confidentialité : Bibliographie : 6 pages Mars 2015 Non Oui Historique des versions / révisions : Version Date d application Description des changements Auteur /03/15 version initiale Z. BOUZIANE M. FLORISSON Document : Chouette 2/6

3 Table des matières 1Introduction...4 2Documents applicables...4 3Les données du fichier...4 4Le format...4 5Caractéristiques des fichiers CSV Fichier de synthèse des tests Fichier des tests en échec INTRODUCTION Ce document spécifie le format du fichier qui restitue les résultats d'une opération de validation. Ce fichier est accessible depuis l'ihm de l'application Chouette. 2 DOCUMENTS APPLICABLES Ref Titre Contenu Date Version [D01] Liste des tests de validation bi/neptunevalidation/v21/fr/ Catalogue et définitions des tests 21/01/15 02/0 1/15 Auteurs Michel ETIENNE 3 LES DONNEES DU FICHIER Les données sont les mêmes que celles qui apparaissent sur les différentes IHM relatives à une opération de validation. Document : Chouette 3/6

4 Le contenu comme le nom du fichier varient en fonction de la langue utilisée au moment de l'accès à ce fichier sur l'ihm. 4 LE FORMAT Il s'agit d'une archive ZIP qui contient 2 fichiers CSV : un fichier de synthèse des tests un fichier de détail des tests en échec Le nom de l'archive ZIP est formée de la façon suivante : <nom>_<ref_id>_<act_id>_<date>_<random_txt>.zip Le <nom> décrit le type de document et est dépendant de la langue utilisées (français ou anglais) : En français : "resultats_de_validation" En anglais : "compliance_check_results" Le <ref_id> est l'identifiant du référentiel. Le <act_id> est l'identifiant de la tache de validation. La <date> est date de téléchargement du rapport au format YYYYMMJJ. Le <random_txt> est une chaine de caractères générée aliatoirement pour distinguer les différents téléchargemenrts de la même date. Exemple de nom d'archive : resultats_de_validation_1_2_ ze5qun.zip 5 CARACTERISTIQUES DES FICHIERS CSV 5.1. Fichier de synthèse des tests Il s'agit d'un fichier CSV ayant les propriétés suivantes Nom En français : "sommaire_des_tests.csv" Encodage Format Séparateur de champ UTF-8 CSV ';' En anglais : "summary_of_tests.csv" Les lignes sont de 2 sortes : Document : Chouette 4/6

5 une ligne de titres une ligne pour chacun des tests exécutés Le tableau ci-dessous donne dans l'ordre des colonnes CSV, le nom du titre qui apparaît sur la première ligne du fichier ainsi que les contenus pour les lignes suivantes. Ces lignes suivantes sont ordonnées par sévérité, des obligatoires au optionnels, et par status, les na, suivi des nok puis les ok. Nom du titre En français : "Sévérité" En anglais : "Severity" En français :"Statut" En anglais : "Status" En français : "Code" En anglais : "Code" En français : "Titre du test" En anglais : "Test title" En français : "URL" Valeur En français : "Obligatoire" ou "Optionnel" En anglais : "Required" ou "Optional" En français : "na", "nok" ou "ok" En anglais : "na", "nok" ou "ok" Le code du test tel que décrit dans le document Le titre du test tel que spécifié dans le document L'URL de description du test. En anglais : "URL" En français : "Nombre d'erreurs" En anglais : "Number of errors" En français : "Objets en erreur" En anglais : "Objects in violations" Le nombre d'objets en erreurs pour tout test avec un status = "nok". Les identifiants des 10 premiers objets en erreurs pour tout test avec un status = "nok". Les identifiants sont séparés par le caractère espace ' ' Fichier des tests en échec Il s'agit d'un fichier CSV ayant les propriétés suivantes Nom En français : "details_des_erreurs.csv" Encodage Format Séparateur de champ UTF-8 CSV ';' En anglais : "detail_of_errors.csv" Document : Chouette 5/6

6 Les lignes sont de 2 sortes : une ligne de titres une ligne pour chacun des tests exécutés Le tableau ci-dessous donne dans l'ordre des colonnes CSV, le nom du titre qui apparaît sur la première ligne du fichier ainsi que les contenus pour les lignes suivantes. Dans ce deuxième fichier seules les tests avec le status = "nok" seront affichées. Un maximum de 10 objets en erreurs par test seront affichés. Nom du titre En français : "Sévérité" En anglais : "Severity" En français : "Code" En anglais : "Code" En français : "Objet en erreur" Valeur En français : "Obligatoire" ou "Optionnel" En anglais : "Required" ou "Optional" Le code du test tel que décrit dans le document L'identifiants d'un objet en erreur. En anglais : "Error object" En français : "Ressource de l'objet en erreur" En anglais : "Resources of the error object" Dans le cas d'une erreurs dans un objet de la base on affuche ici son URL dans Chouette, et dans le cas d'une erreurs dans un fichier XML Neptune on affiche ici le nom du fichier en erreur et le numéro de la ligne d'erreurs dans ce fichier. En français : "Titre du test" En anglais : "Test title" En français : "Détail" Le titre du test tel que spécifié dans le document Un texte expliquant l'erreur sur cet objet. En anglais : "Detail" Document : Chouette 6/6