Skip to content
This repository has been archived by the owner on Dec 9, 2019. It is now read-only.

Latest commit

 

History

History
34 lines (21 loc) · 2.52 KB

README.md

File metadata and controls

34 lines (21 loc) · 2.52 KB
Raw

RailroadPM.org Participant Kit

Railroad participants can use the information and examples in this repo for integrating with the RailroadPM.org site.

This should help to make data collection and submission activities go smoothly by providing options for automated machine-to-machine electronic data interchange (EDI).

Accept Invitation to Participate

This kit provides guidance on submitting weekly reports to RailroadPM.org. However, you must have received an email invitation to participate, and you must have responded to the email and registered your credentials (username/email and password) before proceeding.

Two Options

Once you have accepted the invitation to participate and your email address and password have been registered in the system, you have two options for electronically submitting weekly railroad performance reports.

Option One - Admin Automation

The first option, Admin Automation, is recommended for most participants. This option involves:

  1. Identifying a computer on your network suitable for running an electronic data interchange (EDI) process on a weekly basis, and installing Node.js (LTS version 8.x) on that computer. This option supports the following operating systems:
    • Mac OS 10.9+ (Mavericks+)
    • Linux Ubuntu 12.04+, Fedora 21, Debian 8
    • Windows 7+
  2. Identifying a folder on the computer and placing your latest weekly report file in that folder for processing each week.
  3. Each week, running a script provided in this kit to upload the weekly report data to the RailroadPM.org system.

That's it. Further technical details are provided in the README file found in the AdminAutomationExample folder of this kit.

Option Two - REST APIs

The second option, calling the RailroadPM REST APIs, offers more flexibility and control over the interchange of data. It supports any operating system and any programming language capable of issuing calls to a REST API endpoint. But this option requires a much greater technical understanding and a software development effort.

Due to the wide variety of platforms and languages that can be used to implement this option, this kit does not attempt to provide a working example of this approach. However, further details, including an outline of the steps required (pseudocode) are provided in the README file found in the APIs folder of this kit.