Merge pull request #23 from Chicago/revisions_gh-pages_final_check_20…

…20-10

Clarifications and proofreading fixes.

_docs/compensation.md

@@ -8,6 +8,8 @@ order: 7
 
 A record of each of the licensee's drivers who is paid an hourly rate, and any other record needed to capture actual TNP driver pay information that is not reflected in licensee's hourly rate compensation records.
 
+TNP companies may apply different compensation schemes. Therefore, some columns may be 0 for all records because those elements are not used.
+
 ## File Format
 
 Compensation data must be reported using the following schema and reported with the following `[company]-compensation-[date].csv`.
@@ -27,4 +29,4 @@ Compensation data must be reported using the following schema and reported with
 | **NEW** COMP11	| Other Deduction | Numeric | Yes| Total deductions from pay for other expenses. |
 | **NEW** COMP12	| Driver Net Pay | Numeric | Yes| Total TNP driver net pay including bonus payments and subtracting deductions. |
 | **NEW** COMP13    | Report Period Start Date | ISO 8601 | Yes | Start date of reporting period for pay/incentives/deductions. |
-| **NEW** COMP14    | Report Period End Date | ISO 8601 | Yes | Start date of reporting period for pay/incentives/deductions. |
+| **NEW** COMP14    | Report Period End Date | ISO 8601 | Yes | End date of reporting period for pay/incentives/deductions. |

_docs/data_quality.md

@@ -10,6 +10,8 @@ TNPs should check all files for data quality before submission and verify that t
 
 Errors detected should be fixed before file submission. If it is impossible or unreasonably difficult to fix the errors, TNPs should inform BACP of the nature and degree (such as number of records affected) of the known errors in a file.
 
+This page does not yet cover the most recent changes to the other pages in this reporting manual. TNPs should follow the spirit of the specific items below -- checking all data for accuracy and consistency -- in reporting new or changed columns/files.
+
 ## File Format
 
 | Standard # | File(s)   | Standard                             | Test                                                |

_docs/trip.md

@@ -34,12 +34,12 @@ Trip data must be reported using the following schema and reported with the foll
 | **NEW** T18| Fare End Latitude 			 | Numeric							   | Yes      | Latitude where the TNP driver indicated the passenger was dropped off. Precision at 4 decimal places. |
 | **NEW** T19| Fare End Longitude			 | Numeric							   | Yes      | Longitude where the TNP driver indicated the passenger was dropped off. Precision at 4 decimal places. |
 | **NEW** T20| Tolls						 | Numeric							   | Yes      | Road, bridge, and other tolls charged to the customer. |
-| **NEW** T21| Government Taxes	and Fees		 | Numeric							   | Yes      | Government taxes and fees charged to the customer. |
-| **NEW** T22| TNP Fees			     | Numeric							   | Yes      | TNP fees charged to the customer. |
+| **NEW** T21| Government Taxes	and Fees		 | Numeric							   | Yes      | Amount assessed to the customer due to a requirement from any level of government, other than tolls, which are reported in T20. |
+| **NEW** T22| TNP Fees			     | Numeric							   | Yes      | Amount of fees charged to the customer by the TNP itself. A fare is not considered a fee.|
 | **NEW** T23| Trip ID 						 | String							   | Yes      | Unique identifier for each trip. | 
-| **NEW** T24| Number of Passengers			 | Numeric							   | Yes      | The number of passengers associated with this trip ID that were transported by the TNP vehicle . |
+| **NEW** T24| Number of Passengers			 | Numeric							   | Yes      | The number of passengers associated with this trip ID that were transported by the TNP vehicle. Leave blank if not collected or unknown. |
 | **NEW** T25| On Scene Date and Time		 | ISO 8601							   | Yes      | Date and time when TNP driver arrived at the pick-up location |
 | **NEW** T26| Driver Trip Pay 			 	 | Numeric							   | Yes      | Total TNP driver pay if the driver was compensated on a per-trip basis for the trip (not including tolls or tips and net of fees and taxes). Otherwise, include compensation in [compensation data](/tnp-reporting-manual-draft/compensation). |
 | **NEW** T27| Shared Trip Match			 | String							   | Yes      | Did the passenger share the TNP vehicle with another passenger who booked separately at any point during the trip? (Y/N) |
-| **NEW** T28| Time in Transit Outside Chicago | Numeric						   | Yes	  | For trips that begin outside, end outside, or otherwise leave Chicago, the trip time in seconds spent outside of city boundaries. |
-| **NEW** T29| Miles Traveled Chicago 		 | Numeric						       | Yes	  | For trips that begin outside, end outside, or otherwise leave Chicago, the trip distance spent outside of city boundaries. |
+| **NEW** T28| Time in Transit Chicago | Numeric						   | Yes	  | Time in seconds traveled within Chicago. For trips entirely within Chicago, this should equal the difference between T6 and T4. For trips that begin outside, end outside, or otherwise leave Chicago, this should exclude the trip time spent outside of city boundaries. |
+| **NEW** T29| Miles Traveled Chicago 		 | Numeric						       | Yes	  | Miles traveled within Chicago. For trips entirely within Chicago, this should match T8. For trips that begin outside, end outside, or otherwise leave Chicago, this should exclude the trip distance spent outside of city boundaries. |

_docs/trip_request.md

@@ -18,7 +18,7 @@ Trip Request data must be reported using the following schema and reported with
 | **NEW** R2 | Method                		 | String            				   | Yes      | Booking method for passenger. 1 for Smartphone app, 2 for Website, 3 for Phone call, and 4 for Other.   | 
 | **NEW** R3 | Initiation Date and time		 | ISO 8601                            | Yes      | Date and time when passenger requested to be picked up.  | 
 | **NEW** R4| Requested Mode                  | String 							   | Yes      | Indicate one of the following values: 1) shared, 2) private, 3) WAV.    |
-| **NEW** R5| Number of Passengers          | Numeric							   | Yes      | The number of passengers that were indicated by the customer when the trip was requested.   |
+| **NEW** R5| Number of Passengers          | Numeric							   | Yes      | The number of passengers that were indicated by the customer when the trip was requested. Leave blank if not indicated or unknown.   |
 | **NEW** R6| Outcome                       | Numeric							   | Yes      | Indicator for the outcome of the e-hail request. 1 for Completed Trip - The passenger was picked up, 2 for No Accepts - There request was not accepted, either because there were no TNP drivers available or no available driver accepted the request, 3 for Passenger Canceled - The passenger canceled the request either before or after it was accepted by a TNP driver, 4 for Passenger No Show - The trip was canceled because the passenger was not at the pickup location, 5 for Driver Canceled - A TNP driver accepted the request but then canceled the trip and no other TNP vehicle was dispatched.   |
-| **NEW** R7| Trip Price Quote Private Ride          | Numeric							   | Yes      | The price of the trip that was offered for a private, non-shared ride through the TNP's most used non-shared product   |
-| **NEW** R8| Trip Price Quote Shared Ride          | Numeric							   | Yes      | The price of the trip that was offered for a shared ride through the TNP's most used shared product   |
+| **NEW** R7| Trip Price Quote Private Ride          | Numeric							   | Yes      | The price of the trip that was offered for a private, non-shared ride through the TNP's most used non-shared product. If no quote was given, leave blank.   |
+| **NEW** R8| Trip Price Quote Shared Ride          | Numeric							   | Yes      | The price of the trip that was offered for a shared ride through the TNP's most used shared product. If no quote was given, leave blank.   |

index.md

@@ -2,7 +2,7 @@
 title: Overview
 ---
 
-This manual is effective as of August 10, 2020. The information in this site, along with all prior versions of this manual, is stored at [GitHub](https://github.com/Chicago/tnp-reporting-manual/releases).
+This manual is effective as of August 10, 2020*. The information in this site, along with all prior versions of this manual, is stored at [GitHub](https://github.com/Chicago/tnp-reporting-manual/releases).
 
 As part of its licensing process for Transportation Network Providers (sometimes called Ride-hail Providers), Chicago requires the companies to report on their activities monthly. These requirements are set forth in [Chapter 9-115](http://library.amlegal.com/nxt/gateway.dll/Illinois/chicago_il/title9vehiclestrafficandrailtransportati/chapter9-115transportationnetworkprovide?f=templates$fn=default.htm$3.0$vid=amlegal:chicago_il$anc=JD_Ch.9-115) of the Municipal Code of Chicago and [Rule TNP2.02](https://www.cityofchicago.org/content/dam/city/depts/bacp/rulesandregs/TNPRulesAmendedeffJan12017.pdf) issued by the Department of Business Affairs & Consumer Protection.
 
@@ -12,7 +12,7 @@ For TNP matters relating to anything other than data reporting, please e-mail [B
 
 ## Submission Deadlines
 
-Below are the deadlines required to have all required files, with the exception of location and communication data, submitted to the City of Chicago.
+Below are the deadlines to have all required files (exceptions listed below the table) submitted to the City of Chicago.
 
 |   Due Date   | Beginning Date |   End Date   |
 |--------------|----------------|--------------|
@@ -29,6 +29,7 @@ Below are the deadlines required to have all required files, with the exception
 | November 21   | October 1         | October 31 |
 | December 21   | November 1         | November 30 |
 
+Unless stated otherwise, for all files and fields unavailable or unknown values should be left blank. The number 0 should be used only when the value is known to be 0, not as an indicator of missing data. N/A or similar should not be used unless it is the actual text value of the field or the instructions specifically say to use it.
 
 The trip request, location, and communication files are not required to be submitted on a regular basis, and shall be submitted as requested by the City. 
 
@@ -43,3 +44,7 @@ Submit at least five separate CSV files with the following naming convention, wh
 ```
 
 Five files should be submitted monthly, consisting of one each for [trips](trip), [drivers](driver), [sessions](session), [vehicles](vehicle), and [compensation](compensation). TNPs will receive separate communications if a file should be submitted for [trip requests](trip_request), [locations](location), or [communications](communication).
+
+---
+
+*The following fields were updated on October 16, 2020 to clarify data descriptions:  COMP14, T21, T22, T24, T28, T29, R5, R7, and R8.