The run import process allows users to add new runs, and their associated stops, via two XLSX files. Two file templates are provided at the end of this document as attached files.
Creating Your XLSX File
Run File
When creating the files know that run name, dispatch type and frequency combine to form the unique keys for each run. Consequently, these fields must match within both files for a given run, and it’s associated stops, to be imported successfully.
It is important to note that the effective start date values in the run file must be a date in the future.
Field | Accepted Values | Description | Is Required? |
Customer name | Alphanumeric | The Customer-name value must match one of the customers being served by the location. | Yes |
External Run ID | Alphanumeric | Represents the ID of the run in the source system, if pulled from an external routing software | No |
Run name / identifier | Alphanumeric | Name of the run | Yes |
Dispatch type | AM MID PM | Specify dispatch type | Yes |
Days of the week | MTWRFSU | Day(s) of the week the run is active | Yes |
Effective start date | MM/DD/YYYY | Run start date | Yes |
Effective end date | MM/DD/YYYY | Run end date | Yes |
Monitor count | Numeric | Number of monitors required | No |
Source system name | Alphanumeric | Free text; the name of your fleet management system if applicable | No |
Stop File
Know that in the stop file for all the non-school stops either the fields for Latitude and Longitude, or the fields for Address, City, State and Zip are required. Also, for the “school” stops the school names must match exactly to those that already exist within the software.
Lastly, ensure that all stops are present in the stop file as every time an import of the stops is processed the existing stops in the system will be deleted.
Note: The run import process can also be used to update stop times for existing runs by simply re-importing the original run file with an updated stop file.
Field | Accepted Values | Description | Is Required? |
External Run ID | Alphanumeric | Only required if external run id is being used in the run import file | No |
Customer name | Alphanumeric | The Customer-name value must match one of the customers being served by the location. | Yes |
Run name / identifier | Alphanumeric | Name of the run | Yes |
Run Dispatch type | AM MID PM | Specify dispatch type | Yes |
Run Days of the week | MTWRFSU | Day(s) of the week the run is active | Yes |
External Stop ID | Alphanumeric | Represents the ID of the stop in the source system, if pulled from an external routing software | No |
Stop name / identifier | Alphanumeric | Name of the stop | Yes |
Stop type | stop school | Specify the type of stop | Yes |
Stop time | HH:MM AM/PM | Time of stop | Yes |
Street address or intersection | Alphanumeric | Location details of the stop | Yes/No |
City | Alphanumeric | Location details of the stop | Yes/No |
State | Full state name | Must be a valid state in the U.S. | Yes/No |
Zip | Numerical | 5-digit code | Yes/No |
Latitude | Any valid latitude value | Location details of the stop | Yes/No |
Longitude | Any valid longitude value | Location details of the stop | Yes/No |
Importing Your XLSX File
To import runs, follow the steps below:
- Navigate to Operations > Runs.
- Select Import Runs (see screenshot below).
3. The pop-out screen for “Import Runs” will appear. Select the files to be imported.
4. Specify whether or not to have any runs not present in the file be deleted during the import process, before pressing submit. If you are not sure what this means, leave this as ‘No’, which is the default option.
5. After you click submit, the system will perform various validations on the file and appropriate error messages will be displayed if there are any issues with the file. For the import to go through all records in both the Run and Stop files must pass all validations.
6. If you encounter validation errors, please correct the file(s) and re-submit. If you have any questions about correcting these errors, please take a screenshot, and send the screenshot, as well as your XLSX files to support@bytecurve.com for further assistance
7. If all validations are successful, the file will be queued up for processing and you will see a message stating that you can check the status of a pending import by navigating to Admin > Dispatch Notification.
After the import is complete, the system will add an entry to the Dispatch Notification screen indicating the status of your import. You will need to check this screen for status updates, the system will not send you any notification message upon completion of your import.
