Data Import Specifications

Introduction

myAvail Data Import

Why does this feature exist:

• Converts the data from your scheduling package to a format that is usable by the myAvail software
• This generic import allows our customers to easily switch between the major fixed route scheduling solutions on the market
• Using a proprietary validation methodology, agency staff are able to perform schedule changes completely independently
• This is the same toolset used by our internal services staff for those schedule changes where you may like support from our team of professional schedulers and planners

Scheduling package vendors Avail supports integrations for:

• Hastus
• CSched
• TMS
• VPR
• Trapeze
• Remix
• Optibus

Two import specification standards:

• Basic – this is utilized by the majority of scheduling vendors and provides the basic data required to import schedule data in the myAvail software
  • This will support the operation of the CAD/AVL Dispatch solution, in-vehicle solution and Real-time Public Information System (myStop)
• Advanced – this standard provides all of the same functionality as basic but also supports:
  • KML import for route traces
  • Operator Run Pay details for myAvail Operator Timekeeping
  • Two way interface for actual data returned to the scheduling/planning software

Basic Schedule Data Import

Overview

This document defines the schedule data interface between a fixed route scheduling system and Avail Technologies myAvail CAD/AVL system. The interface consists of a set of files that is created by the scheduling system and read by the myAvail system. This document defines the contents of each of those files.

File Formats

All files are XML files. Each file is a valid XML document. The subsequent chapters in this document define the contents of each file.

The name of each file contains the date on which the file was created, in the format YYYYMMDD followed by a string that describes the contents of the file, e.g.20101128_Stops.xml. The file name for each file type is defined in the chapter for that file.

The root XML element for each file is <SchedFile>

All elements specified below are included, even if the element is empty.

Data Formats and Units

All dates are in the format YYYYMMDD.

All times are seconds past midnight. For times greater than 24:00 (i.e. times past midnight that are considered part of the previous operating day) the seconds past midnight time is greater than 86400 (24*3600).

All distances are in feet.

All latitude and longitude values are in decimal degrees. Boolean values are 1 for True and 0 for False.

Schedule File

Overview

The Schedule file contains information about this schedule version. Filename: YYYYMMDD_Schedule.xml

File Content

Example XML:

File contains one Schedule element

Services File

Overview

The Service Level file contains information about the service levels contained in this schedule. Filename: YYYYMMDD_Services.xml

File Content

Example XML:

File contains one Service element for each service level.

Import Notes

Import will create service level number as a one up number. Import will use ShortName as Description

Calendar File

Overview

The Calendar file contains information about what service level is operated on each day within the schedule date range. Filename: YYYYMMDD_Calendar.xml

File Content

Example XML:

File contains one Day element for each date in the date range specified by the FromDate and ToDate values in the Schedule file, including the From Date and To Date.

Import Notes

Import will fill in any dates from ToDate to the end of the year with the NoService service level.

Stops File

Overview

The stops file contains information about each stop in the system. Only physical stop points are included in this file. Node only points are not included. All stops will have a valid latitude and longitude value, i.e. all stops must be geo-coded before being exported.

Filename: YYYYMMDD_Stops.xml

File Content

Example XML:

File contains one Stop element for each stop in the system. Stops that are unused in the current schedule but are still valid stops in the system should be included in this file.

Import Notes

Import will set StopPoint flag to true for all stops.

Routes File

Overview

The Routes file contains information about each route in the system. Route information is only included once per route even if the route operates in multiple service levels.

Filename: YYYYMMDD_Routes.xml

File Content

Example XML:

File contains one Route element for each route in the system. Stops in all patterns and service levels are included as RouteStop elements. Stops in the RouteDirection element are ordered in pattern order across all patterns in that direction as appropriate.

Routes that are not included in this schedule should not be included in this file even if they are still active in the scheduling system.

Import Notes

Import will have the ability to use either the RouteNumber or the RouteName as the myAvail route report label. However, if the RouteName value is used it will be truncated to 15 characters.

Route IVRName will be entered through DataPoint and will not be overwritten by import.

Patterns File

Overview

The Patterns file contains information about each pattern in each route in the system. Filename: YYYYMMDD_Patterns.xml

File Content

Example XML:

File contains one pattern element for each pattern in each route in the schedule. Only patterns that are used in this schedule are included. If the pattern contains a mid-trip layover, this will be represented by including the stop where the layover occurs twice in a row in the pattern. Trips that use this pattern will also contain this stop twice in a row, with the time on the first stop representing the time that the bus arrives at the layover point and the time on the second stop representing the time that the bus leaves the layover point. Deadhead patterns are included in this file with a RouteRecordId that begin with a minus sign (e.g., -22).

Import Notes

myAvail Pattern name will be created by concatenating ShortName with Service Level Number and Direction. Example: OB01-2I. OB01 is the pattern ShortName. 2 is the service level number assigned by the import to the service level designated by the ServicesRecordId. I is the Direction.

If Description is empty, Pattern Name will be used for Pattern Description. If InternetName is empty, InternalSignText will be used for InternetName.

IVR Name will be entered through DataPoint and will not be overwritten by the import.

Trips File

Overview

The Trips file contains information about each trip of each route in the system. Filename: YYYYMMDD_Trips.xml

File Content

Example XML:

File contains one Trip element for each trip in the system. Only trips that are part of this schedule are included. See the Patterns File section for a description of how mid-trip layovers are represented. Deadhead trips are included in this file with a RouteRecordId that begins with a minus sign (e.g., -44).

Import Notes

myAvail trip farebox ID will be calculated by the import as the start time of the trip.

myAvail trip report label will be calculated by the import as Farebox ID-Direction. Example: 730-I

Import will only store trip information that is unique. For example, for Route 1, if there is a 730-I trip on weekday service and a 730-I trip on Saturday service, only one 730-I trip for Route 1 will be stored in the trip info table.

Import will verify that a time is provided for each stop in the pattern and that the time does not go backwards when the stops are in pattern order.  It will also verify that a time is not provided for a stop that is not in the pattern.

Import will check time offsets for each trip using the same pattern and if it finds a different set of offsets it will create a new pattern.

Import will check the headsign code and announce code for each trip using the same pattern and if it finds a different set of codes it will create a new pattern.

For deadhead trips, the HeadsignCode and the ExternalAnnCode may be left empty, and the import will default appropriate codes for this condition (e.g., a HeadsignCode that indicates ‘Out of Service’).

Runs File

Overview

The runs file contains information about each run in the system. Filename: YYYYMMDD_Runs.xml

File Content

Example XML:

File contains one Run element for each run in the system.

Import Notes

If Description is empty then Run Number will be used for the description in myAvail.

Blocks File

Overview

The blocks file contains information about each block in the system. Filename: YYYYMMDD_Blocks.xml

File Content

Example XML:

File contains one Block element for each block in the system.

Import Notes

If Description is empty then Block  Number will be used for the description in OmniPoint.

Drivers File (Optional)

Overview

The drivers file contains information about each driver in the system. Filename: YYYYMMDD_Drivers.xml

File Content

Example XML:

File contains one Driver element for each driver in the system.

Import Notes

OmniPoint Driver Report Label will be the same as their badge number.

Trace Files (Optional)

Overview

If available, route trace data can be exported in Google KML format, one file per route.

Advanced Schedule Data Import

Calendar file

The Calendar file contains information about what service level is operated on each day within the schedule date range.

Example XML:

Table 4.1 – Calendar

Date records are sorted by the attributes Date and

CrewSchedulingUnit/VehicleSchedulingUnit.

Node file - ddmmyyyy.NDE.XML

This file includes only the stops used by trips included in the submitted schedule.

Stop records are sorted by the attribute Identifier.

Place file - ddmmyyyy.PLC.XML

This file describes places used by vehicle schedules referred to by the Calendar file. Places are used mainly to define timing points in the network definition.

Stops located at timing points must reference these timing points. For other stops, the reference is optional. Reference places are used to create a relation between places usually when places are close to each other. Reference places are used to simplify some displays and reports, and to avoid duplication of information when defining deadhead or travel information.

Main place pattern for route – ddmmyyyy.PPAT.XML

This file lists places in the Main Place Pattern for each different route and direction covered by trips in the schedule. If a route and direction has no Main Place Pattern, a record is generated with the route identifier, direction text and direction code.

Main place pattern records are sorted by the attributes Route and Direction.

Itinerary file – ddmmyyyy.NET.XML

This file describes itineraries between stops. Different itineraries can exist between two stops: a base off­service itinerary, a base in­service itinerary and variant specific itineraries.

Route file - ddmmyyyy.RTE.XML

This file describes routes used by vehicle schedules referred to by the Calendar file.

Trip pattern file – ddmmyyyy.PAT.XML

This file includes the stops of the trip patterns used by the trips included in the vehicle schedules referred to by the Calendar file. Certain stops may be associated with timing points.

For each trip pattern, there is one record for each stop. These are ordered according to the itinerary. Note that the installation settings for the transit agency determine availability of information for trip pattern detail records.

Trip pattern records are sorted by the attributes Route, Identifier and sequence of stops in the trip pattern.

Display code file - ddmmyyyy.VDC.XML

This file describes vehicle display codes used in vehicle schedules referred to by the Calendar file.

Vehicle Schedules

Block file - ddmmyyyy.BLK.XML

This file describes the blocks for each vehicle schedules referred to by the calendar file.

Trip file - ddmmyyyy.TRP.XML

This file includes all trips used in vehicle schedules referred to by the Calendar file.

Crew Schedules

Crew Schedule file - ddmmyyyy.CRW.XML

This file describes the planned crew schedules referred to by the Calendar file.

Shapes

Shape file - Shapes.XML

This file describes itineraries used by trip patterns assigned to trips of the vehicle schedules referred to by the Calendar file.