/
framework

framework

 

Current version for framework is:   v1.5   (last changed Jul 28, 2022)

Content

This document is part of NeTEx Nordic Profile and describes common components and generic concepts used for public transport data exchange in the NeTEx format.

Frames

Frames are used for logical grouping of different NeTEx concepts:

  • General Frame - frame for an unstructured description of NeTEx-objects. Not used in the Nordic profile.

  • Resource Frame - frame for common objects, i.e. organisations, responsibilities, equipments etc.

  • Site Frame - frame for information regarding stop places and places of interest.

  • Service Frame - frame for information regarding networks lines, routes, planned stops etc.

  • Service Calendar Frame - frame for defining calendar-information - types of days, operating days, and their relations etc.

  • Timetable Frame - frame for describing the actual journeys, such as calendar references, departure times, and waiting times etc.prop

  • Vehicle Schedule Frame - frame for vehicle usage planning with vehicle information, equipment and blocks.

  • Fare Frame - frame for fare definitions and price information including products and sales offers.

  • Sales Transaction Frame - frame for data on customer-related sales/purchases and consumption of acquired rights.

  • Infrastructure Frame - frame for information about infrastructure - garages, roads, intersections etc. Not used in the Nordic profile.

There is an additional Composite Frame, which can be used to group other frames, as long as they have identical ValidityCondition (implicitly inherited from CompositeFrame). There are no requirements regarding order or dependency between frames.

Data conditions

All objects in the profile should be defined with as much generality as possible, and at the highest possible hierarchic level. This is particularly true for:

  • ValidityCondition / ValidBetween

  • FrameDefaults

  • Codespace

Where more specific instances deviate from the general definition at a higher level in the hierarchy, an overruling definition can be set further down the hierarchy.

FrameDefaults

Used to define common values. The following elements are permitted:

Element

Type

Description

Element

Type

Description

DefaultCodespaceRef

CodespaceRef

Reference to the default codespace.

DefaultDataSourceRef

DataSourceRef

Reference to the default data source.

DefaultLocale

Locale

Default locale description

DefaultLocationSystem

xsd:normalizedString

Default geographic coordinate system. If defined it should be “EPSG:4326”.

NOTE: The national journey planner and stop place registry requires coordinates in the WGS84 EPSG:4326 format.

DefaultSystemOfUnits

xsd:normalizedString

Default unit should be SiMetres.

DefaultCurrency

CurrencyType

Three letter currency code according to ISO 4217. For example NOK or SEK.

Codespace

The codespace is used to ensure that objects defined in the frame remain unique even when they are consolidated with data from other data sources. Each codespace is a URL with a unique three-letter code and a description.

Codespace example
<Codespace> <Xmlns>RUT</Xmlns> <XmlnsUrl>http://www.entur.org/ns/rut</XmlnsUrl> <Description>Ruter</Description> </Codespace>

The codespaces are assigned to each new data provider by Entur. This ensures the uniqueness of data sources. Contact Entur to be assigned a codespace.

Specific components

Listed here is the structure for each frame, and which objects are expected to appear in them.

ResourceFrame

ResourceFrame < DataManagedObject < EntityInVersion < Entity

ResourceFrame < DataManagedObject < EntityInVersion < Entity

Name

Type

Cardinality

Description

dataSources

DataSource

0: *

Container for DataSource objects

typesOfValue

TypeOfValue

0: *

Container for TypeOfValue objects

organisations

Organisation

0: *

Container for Organisation objects

groupsOfOperators

GroupOfOperators

0: *

Container for GroupOfOperators objects

equipments

Equipment

0: *

Container for Equipment objects

vehicleTypes

VehicleType

0: *

Container for VehicleType objects

vehicles

Vehicle

0: *

Container for Vehicle objects

groupsOfEntities

frameGeneralGroupOfEntities ?

0: *

Container for GeneralGroupOfEntities objects

SiteFrame

SiteFrame < DataManagedObject < EntityInVersion < Entity

SiteFrame < DataManagedObject < EntityInVersion < Entity

Name

Type

Cardinality

Description

topographicPlaces

TopographicPlace

0: *

Container for TopographicPlace objects

addresses

Address

0: *

Container for Address objects

accesses

Access ?

0: *

Container for Access objects

groupsOfStopPlaces

GroupOfStopPlaces

0: *

Container for GroupOfStopPlaces objects

stopPlaces

StopPlace

0: *

Container for StopPlace objects

flexibleStopPlaces

FlexibleStopPlace

0: *

Container for FlexibleStopPlace objects

pointsOfInterest

PointOfInterest

0: *

Container for PointOfInterest objects

parkings

Parking

0: *

Container for Parking objects

navigationPaths

NavigationPath

0: *

Container for NavigationPath objects

pathLinks

PathLink

0: *

Container for PathLink objects

tariffZones

TariffZone

0: *

Container for TariffZone objects

groupsOfTariffZones

GroupOfTariffZones

0: *

Container for GroupOfTariffZones objects

siteFacilitySets

SiteFacilitySet

0: *

Container for SiteFacilitySet objects

ServiceFrame

ServiceFrame < DataManagedObject < EntityInVersion < Entity

ServiceFrame < DataManagedObject < EntityInVersion < Entity

Name

Type

Cardinality

Description

Network

Network 

0: 1

Network objects

additionalNetworks

Network 

0: *

Container for additional Network objects

routePoints

RoutePoint

0: *

Container for RoutePoint objects

routes

Route

0: *

Container for Route objects

commonSections

CommonSection

0: *

Container for CommonSection objects

lines

Line

0: *

Container for Line objects

groupsOfLines

GroupOfLines

0: *

Container for GroupOfLines objects

destinationDisplays

DestinationDisplay

0: *

Container for DestinationDisplay objects

scheduledStopPoints

ScheduledStopPoint

0: *

Container for ScheduledStopPoint objects

servicePatterns

ServicePattern

0: *

Container for ServicePattern objects

connections

Connection

0: *

Container for Connection objects

stopAssignments

StopAssignment

0: *

Container for StopAssignment objects

timingPoints

TimingPoint

0: *

Container for TimingPoint objects

timingLinks

TimingLink

0: *

Container for TimingLink objects

journeyPatterns

JourneyPattern

0: *

Container for JourneyPattern objects

serviceExclusions

ServiceExclusion

0: *

Container for ServiceExclusion objects

notices

Notice

0: *

Container for Notice objects

noticeAssignments

NoticeAssignment

0: *

Container for NoticeAssignment objects

ServiceCalendarFrame

ServiceCalendarFrame < DataManagedObject < EntityInVersion < Entity

ServiceCalendarFrame < DataManagedObject < EntityInVersion < Entity

Name

Type

Cardinality

Description

ServiceCalendar

ServiceCalendar 

0: 1

ServiceCalendar objects

dayTypes

DayType

0: *

Container for DayType objects

timebands

Timeband

0: *

Container for Timeband objects

operatingDays

OperatingDay

0: *

Container for OperatingDay objects

operatingPeriods

OperatingPeriod

0: *

Container for OperatingPeriod objects

dayTypeAssignments

DayTypeAssignment

0: *

Container for DayTypeAssignment objects

TimetableFrame

TimetableFrame < DataManagedObject < EntityInVersion < Entity

TimetableFrame < DataManagedObject < EntityInVersion < Entity

Name

Type

Cardinality

Description

bookingTimes

AvailabilityCondition

0: * 

Container for AvailabilityCondition objects to describe flexible lines

vehicleJourneys

Journey

0: *

Container for the following types:

frequencyGroups

HeadwayJourneyGroup

0: *

Container for HeadwayJourneyGroup objects

groupsOfServices

GroupOfServices

0: *

Container for GroupOfServices objects

trainNumbers

TrainNumber

0: *

Container for TrainNumbers objects

journeyPartCouples

JourneyPartCouple

0: *

Container for JourneyPartCouple objects

coupledJourneys

CoupledJourney

0: *

Container for CoupledJourney objects

serviceFacilitySets

ServiceFacilitySet

0: *

Container for ServiceFacilitySet objects

flexibleServiceProperties

FlexibleServiceProperties

0: *

Container for FlexibleServiceProperties objects

journeyMeetings

JourneyMeeting

0: *

Container for JourneyMeeting objects

journeyInterchanges

ServiceJourneyInterchange

0: *

Container for ServiceJourneyInterchange  objects

notices

Notice

0: *

Container for Notice objects

noticeAssignments

NoticeAssignment

0: *

Container for NoticeAssignment objects

VehicleScheduleFrame

VehicleScheduleFrame < DataManagedObject < EntityInVersion < Entity

VehicleScheduleFrame < DataManagedObject < EntityInVersion < Entity

Name

 

Type

Cardinality

Beskrivelse

blocks

 

Block

0: *

Container for Block objects

FareFrame

To be finalized

FareFrame < DataManagedObject < EntityInVersion < Entity

FareFrame < DataManagedObject < EntityInVersion < Entity

XML-type

Navn

Datatype

Cardinality

Description

element

PricingParameterSet

PricingParameterSet

0: 1

Parameters governing the calculation of fares (pricing, limiting and discounting rules)

element

geographicalUnits

GeographicalUnit

0: *

Container for (list of) GeographicalUnits

Geographical pricing calculation parameters, applicable for TEN/FEN if exchanged as NeTEx?

element

geographicalIntervals

GeographicalInterval

0: *

Container for (list of) GeographicalIntervals

element

geographicalStructureFactors

GeographicalStructureFactor

0: *

Container for (list of) GeographicalStructureFactors

element

timeIntervals

TimeInterval

0: *

Container for (list of) TimeIntervals

element

distanceMatrixElements

DistanceMatrixElement

0: *

Container for (list of) DistanceMatrixElements

element

qualityStructureFactors

QualityStructureFactor

0: *

Container for (list of) QualityStructureFactors

element

fareStructureElements

FareStructureElement

0: *

Container for (list of) FareStructureElements

element

validableElements

ValidableElement

0: *

Container for (list of) ValidableElements

element

usageParameters

UsageParameter

0: *

Container for (list of) UsageParameters

element

fareProducts

FareProduct

0: *

Container for (list of) FareProducts

element

fareTables

FareTable

0: *

Container for (list of) FareTables

element

priceGroups

PriceGroup

0: *

Container for (list of) PriceGroups

element

distributionChannels

DistributionChannel

0: *

Container for (list of) DistributionChannels

element

groupsOfDistributionChannels

GroupOfDistributionChannels

0: *

Container for group(s) of DistributionChannels

element

fulfilmentMethods

FulfilmentMethod

0: *

Container for (list of) of FulfilmentMethods

element

typesOfTravelDocuments

TypeOfTravelDocument

0: *

Container for (list of) TypeOfTravelDocuments

element

salesOfferPackages

SalesOfferPackages

0: *

Container for (list of) SalesOfferPackages

element

groupsOfSalesOfferPackages

GroupOfSalesOfferPackages

0: *

Container for group(s) of SalesOfferPackages

element

distributionAssignments

DistributionAssignment

0: *

Container for (list of) DistributionAssignments

element

groupsOfDistributionAssignments

GroupOfDistributionAssignments

0: *

Container for group(s) of DistributionAssignments

SalesTransactionFrame

SalesTransactionFrame < DataManagedObject < EntityInVersion < Entity

SalesTransactionFrame < DataManagedObject < EntityInVersion < Entity

XML-type

Name

Datatype

Cardinality

Description

element

customers