| Table of Contents |
|---|
Introduction
Ce document s’inscrit dans le programme de modernisation du Back-Office SIM. Celui-ci vise à mettre en œuvre une nouvelle chaîne de collecte et de distribution des données des données Information Voyageur en Île-de- France.
...
Note : La gestion des données correspondances étant encore en cours d'élaboration, certains éléments seront précisés dans une prochaine version de ce document.
Types de publications
La publication des fichiers depuis le BO s’effectuera par API (protocole RESTful). Les mécanismes sont détaillés dans le chapitre Interface de publication.
...
Contrairement à l'Export Offre IDF, cet Export ne contient qu'un fichier reprenant les données du Référentiel Lignes.
Règles et restrictions
Tableaux d’attributs
Les tableaux d’attributs dans les chapitres suivants précisent pour chaque objet NeTEx publié, la description et le traitement attaché à chacun des attributs de l’objet. Les tableaux sont constitués de 4 colonnes :
...
Pour les attributs ayant une cardinalité commençant par "0:" (attribut non obligatoire), la balise ne sera présente en publication que si la valeur est renseignée.
Règle d’exploitation des informations NeTEx
Les couleurs utilisées dans les tableaux permettent de mettre en valeur les objets et attributs renseignés ou non lors de la publication par le BO Offre Théorique.
...
Information (donnée ou objet) non publiée : l’information est citée et si nécessaire, une interprétation de son absence est proposée.
Donnée ou objet publié : l’information est publiée ; toutefois, si elle est optionnelle, elle n’est présente que si elle est valorisée. Sauf mention contraire, les valeurs par défaut proposées par NeTEx ou le Profil seront toujours renseignées.
Delivery et Frames
Cadres de version ou frames
Les cadres de version sont de 2 types :
...
Chaque fichier XML respecte les règles de format du Profil IDF ; ils sont donc tous composés d’un objet racine de type ‘PublicationDelivery’. Cet objet contient ensuite les cadres de versions qui sont structurés comme indiqué dans le chapitre ‘PublicationDelivery’.
PublicationDelivery
Données caractérisant l’objet PublicationDelivery :
Donnée | Type | Cardinalité | Description |
version | xsd:NMTOKEN | 1:1 | Version du profil : 1.04:FR1-NETEX-x.y-z Avec : x.y : version du profil NETEX z : version du Back Office Île-de-France Mobilités |
PublicationTimestamp | xsd:dateTime | 1:1 | Date/heure de production du fichier format : AAAA-MM-JJThh:mm:ssZ |
ParticipantRef | ParticipantCodeType | 1:1 | Référence du BO IDFM : FR1-OFFRE |
dataObjects | dataObjectsRel Structure | 1:1 | CompositeFrame de type :
ou GeneralFrame de type :
|
Entités abstraites et héritage
NeTEx définit une hiérarchie d’objets et certains attributs des objets publiés sont issus de ces héritages. Afin de simplifier la lecture des attributs relatifs à chaque objet intervenant dans la publication, les attributs issus d’un héritage ne sont rappelés seulement s’ils sont présents dans la publication de l’objet considéré.
...
Si l'attribut hérité n'est pas obligatoire, il n'est pas rappelé dans les tableaux suivants.
Règles de syntaxe des références
Pour certains attributs, il est attendu des références à des objets dits ‘internes’ (l’objet référencé doit être défini dans le même fichier XML) ou à des objets ‘externes’ (l’objet référencé est présent dans un autre fichier du jeu de données ou dans une autre source de données comme par exemple dans le Référentiel Arrêts).
...
[ID ZDEP] : Identifiant de la Zone d'Embarquement Particulière dans le Référentiel Arrêts
Organisation des publications
FICHIERS OFFRE : Les exports Offre sont au format NETEX et se présentent sous la forme d’un ensemble de fichiers réunis au sein d’une archive ZIP.
...
sont remplacés par des ‘souligné’.
Contenu des publications
Chaque fichier xml contient des données relatives à un ou plusieurs cadres de version :
...
Ce fichier est publié uniquement dans l'Export Offre IDF.
Modélisation des données métier échangées
Les données sont échangées selon la norme NeTEx et s'appuient sur le Profil d’échange IDF défini par Île-de-France Mobilités. Les schémas suivant présentent les objets publiés par BO Offre Théorique.
...
NETEX_ARRET_IDF (raccourci de FR1:TypeOfFrame:NETEX_ARRET_IDF:)
NETEX_IDF (raccourci de FR1:TypeOfFrame:NETEX_IDF:)
...
Données NeTEx publiées
Les données caractérisant les cadres de version de chaque fichier (illustrés en vert et en orange dans les schémas Contenu des publications) sont précisées dans les chapitres suivants.
Données d’offre
Les frames suivantes sont publiées aussi bien pour l’offre complète que pour une offre par ligne.
Fichier commun.xml
Organisation et hiérarchie du cadre de version
...
Donnée | Type | Cardinalité | Description |
(E) id | ObjectIdType | 1:1 | FR1:OrganisationalUnit:[Id technique]: |
(EIV) version | VersionIdType | 1:1 | Version fixé à any |
Name | MultilingualString | 0:1 | Nom de l’organisation |
TypeOfOrganisationPartRef | TypeOfOrganisationPartRef | 0:1 1:1 | FR1_Organisation |
Fichier calendriers.xml
Organisation et hiérarchie du cadre de version :
...
Donnée | Type | Cardinalité | Commentaire | |
(E) id | ObjectIdType | 1:1 | [CODESPACE]:DayTypeAssignment:[Id technique]:LOC | |
(EIV) version | VersionIdType | 1:1 | Version fixé à any | |
order | xsd :integer | 1:1 | Sans signification, forcé à 0 | |
OperatingPeriodRef | OperatingPeriodRef | 0:1 | Référence interne à une OPERATING PERIOD | |
Date | xsd:Date | 0:1 | Date calendaire (exemple : « 2017-08-28 « ) | |
DayTypeRef | DayTypeRef | 1:1 | Référence le DAY TYPE (Type de jour) concerné (référence interne). | |
isAvailable | boolean | 0:1 | Cet attribut n’est renseigné que si la valeur est ‘False’ : celle-ci Il permet d'exprimer des exceptions s’il est positionné à false (ex : sauf le 1er avril) ou des ajouts s’il est positionné à true. L’emploi de ce booléen est utilisé uniquement pour les assignements sur des dates calendaires et non sur périodes. | |
...
Note : Dans les fichiers publiés, un calendrier (DAYTYPE) ne peut être entièrement une "exception" (que des dates avec IsAvailable=False). Si un tel calendrier est fourni en entrée du BO Offre, alors le système combine ce calendrier "exceptions" avec un autre calendrier pour n'en produire qu'un seul.
Fichier offre_[ID Ligne C]_[Nom Ligne C].xml
Organisation et hiérarchie du cadre de version
...
Donnée | Type | Cardinalité BO OT | Description et traitement BO Offre Théorique |
(EIV) version | VersionIdType | 1:1 | Version fixé à “any“ |
ScheduledStopPointRef | ScheduledStopPointRef | 1:1 | Référence interne au SCHEDULED STOP POINT (Point d'Arrêt Planifié) |
QuayRef | QuayRef | 1:1 | Référence externe à la Zone d'Embarquement (ZDEP) du Référentiel Arrêts |
VehicleJourneyRef | VehicleJourneyRef | 1:n | Référence interne à la course (celle-ci doit être déclarée dans la frame NETEX_HORAIRE du même fichier) |
Fichier ligne(s).xml
Note : Le Référentiel Lignes propose déjà une sortie Web-services actuellement. Celle-ci va évoluer dans le cadre du projet de Refonte Back Office. Le document DINT-LIGNE_publication_1.7.2.docx décrit ces évolutions (nouveaux objets et nouvelle structuration).
...
Les frames présentes dans ce fichier, dans le cadre de version NETEX_IDF, correspondront à la structuration du web-service Référentiel Lignes (version évoluée). Elles ne sont pas décrites dans ce document.
Fichier arrets.xml
Note : Le Référentiel Arrêts propose déjà une sortie Web-services actuellement. Celle-ci va évoluer dans le cadre du projet de Refonte Back Office. Le document présentant cette nouvelle version des web-services Référentiel Arrêts est en cours de rédaction.
...
Les entités restituées sont celles déclarées actives. A la marge, des entités inactives encore référencées dans les données d'offre peuvent aussi être indiquées dans ce fichier. Toutefois des contrôles seront mis en place dans le Référentiel Arrêts pour ne permettre la désactivation d'un arrêt (ZDEP) que si celui-ci n'est plus référencé dans l'offre publié. Cela permettra de limiter ce genre de cas.
Annexes
Workflow du Back Office Offre Théorique
Le BO Offre Théorique a vocation à assembler les données d’offre théorique provenant de plusieurs sources. Lors des processus de traitement des données entre leur arrivée dans le BO Offre (par import ou par création directe) et leur publication, le système est amené à réaliser certaines modifications :
...
Note : Il est prévu également un sytème de publication "urgente" où certains utilisateurs habilités pourront demander une publication "immédiate" (dans la journée).
Différences entre les données importées/saisies dans le BO Offre et celles exportées
Fichier -> Jeu de données
...