Skip to content

Commit

Permalink
Merge pull request #18 from Chicago/revisions_2020-07
Browse files Browse the repository at this point in the history 
Changes to TNP reporting Manual
  • Loading branch information
@nicklucius
nicklucius committed Jul 20, 2020
2 parents 6b03e41 + 49dddc0 commit 0558136
Show file tree
Hide file tree
Showing 10 changed files with 164 additions and 35 deletions.
13 changes: 13 additions & 0 deletions _docs/communication.md
View file
@@ -0,0 +1,13 @@
---
title: Communication
category: Data Preparation
order: 8
---

## Scope

A record of each push notification or other message sent from the licensee to the licensee's drivers or customers intended to influence the TNP drivers' movement or customers' behavior, exclusive of communication data regarding a customer's trip request and associated response.

## File Format

To better understand congestion and inform planning, the City of Chicago may ask for communication data to determine how TNPs are routing traffic. The format of the requested data will be supplied at the time of the request.
30 changes: 30 additions & 0 deletions _docs/compensation.md
View file
@@ -0,0 +1,30 @@
---
title: Compensation
category: Data Preparation
order: 7
---

## Scope

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.

## File Format

Compensation data must be reported using the following schema and reported with the following `[company]-compensation-[date].csv`.

| Field | Element | Data Type | Required | Description |
|-------|-----------------------------|--------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **NEW** COMP1 | Driver's license number | String | Yes | The driver's license number of the TNP driver for this record. This number must correspond with driver's license number listed in field D2.
| **NEW** COMP2 | Driver's license state | ISO 3166-2 abbreviations | Yes | The state issuing the driver's license that is listed in COMP1. The license number and license state combination should correspond to the fields D2 and D3. |
| **NEW** COMP3 | Total Fares | Numeric | Yes| Total fares from all passenger trips collected over reporting period. |
| **NEW** COMP4 | Hourly Pay | Numeric | Yes| Total of any hourly rate paid to the TNP driver, exclusive of all other compensation during reporting period. |
| **NEW** COMP5 | Trip Pay | Numeric | Yes| Total TNP driver trip pay as reported in the [trips data](/tnp-reporting-manual-draft/trip) (not including tolls or tips and net of fees and taxes taxes) over reporting period. |
| **NEW** COMP6 | Tips | Numeric | Yes| Total amount of tips received from passengers over reporting period. |
| **NEW** COMP7 | Other Compensation | Numeric | Yes| Total value of any other compensation that is not reflected by any other fields in this dataset, including incentives, bonuses and any other payments. |
| **NEW** COMP8 | Vehicle Payment Deduction | Numeric | Yes| Total deductions for pay to cover TNP vehicle payments. |
| **NEW** COMP9 | Gas Deduction | Numeric | Yes| Total deductions from pay to cover gas expenses. |
| **NEW** COMP10 | Cleaning Deduction | Numeric | Yes| Total deductions from pay to cover cleaning fees. |
| **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. |
1 change: 1 addition & 0 deletions _docs/data_quality.md
View file
Expand Up @@ -31,6 +31,7 @@ Errors detected should be fixed before file submission. If it is impossible or u
| 15 | Driver<br>Vehicle | Vehicle and Driver files match | All V8/V9 values have corresponding D2/D3 values. |
| 16 | Trip<br>Vehicle | Trip and Vehicle files match | All T3 values have a corresponding V1 value. |
| 17 | All | Valid data types | All non-string columns contain values valid for the column type. |
| 18 | All | Valid coded values | All columns that permit only a defined set of values contain only those values |

## File Content

Expand Down
14 changes: 9 additions & 5 deletions _docs/driver.md
View file
@@ -1,21 +1,25 @@
---
title: Driver
category: Data Preparation
order: 1
order: 3
---

## Scope

Any eligible driver on the TNP platform must be reported in this file. This includes drivers who could have provided rides in the relevant time period but did not actually do so.
A record of each of the licensee's drivers who is authorized to pick up passengers using the licensee's Internet-enabled application or digital platform. Any eligible driver on the TNP platform must be reported in this file. This includes drivers who could have provided rides in the relevant time period but did not actually do so.

## File Format

Driver data must be reported using the following schema and reported with the following `[company]-driver-[date].csv`.

| Field | Element | Data Type | Required | Description |
|---------|-------------------------|--------------------------|----------------|------------------------------------|
| D1 | Driver Name | String | Yes | Full name of driver |
| D1 | Driver Name | String | Yes | Full name of TNP driver |
| D2 | Driver's license number | String | Yes | Driver's license number |
| D3 | Driver's license state | ISO 3166-2 abbreviations | Yes | State issuing the driver's license |
| D4 | Driver's start date | ISO-8601 date | Yes | Date when driver became eligible to drive for your company |
| D5 | Driver's end date | ISO-8601 date | Yes | The final date the driver was eligible to drive for your company (end of reporting period if still eligible) |
| D4 | Driver's start date | ISO-8601 date | Yes | Date when TNP driver became eligible to drive for your company |
| D5 | Driver's end date | ISO-8601 date | Yes | The final date the TNP driver was eligible to drive for your company (end of reporting period if still eligible) |
| **NEW** D6 | Employee or Independent Contractor | String | Yes | The relationship between the TNP driver and the TNP: Enter W2 for Employee, 1099 for Independent Contractor |
| **NEW** D7 | Inactive Reason | String | Yes | Did the TNP driver initiate their inactive status? Y/N |


22 changes: 22 additions & 0 deletions _docs/location.md
View file
@@ -0,0 +1,22 @@
---
title: Location
category: Data Preparation
order: 6
---

## Scope

For every transportation network vehicle and driver combination, location snapshots captured **every 60 seconds** for all times the driver is in a session, as defined in subsection (b)(4) of [Chapter 9-115 of the Municpal Code of Chicago](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). Each snapshot shall indicate the vehicle's precise location and corresponding date and time.

## File Format

Location data must be reported using the following schema and reported with the following `[company]-location-[date].csv`.

| Field | Element | Data Type | Required | Description |
|-------|-----------------------------|--------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **NEW** L1 | Driver's license number | String | Yes | The driver's license number of the driver for this location. This number must correspond with driver's license number listed in field D2.
| **NEW** L2 | Driver's license state | ISO 3166-2 abbreviations | Yes | The state issuing the driver's license that is listed in L1. The license number and license state combination should correspond to the fields D2 and D3. |
| **NEW** L3 | Vehicle license plate number | String | Yes | The license plate on the car registered for service with your company. |
| **NEW** L4 | Location Date and Time | ISO 8601 | Yes | Date and time of the vehicle location reading. |
| **NEW** L5 | Latitude | String | Yes | Latitude of the vehicle location. Precision at 4 decimal places. |
| **NEW** L6 | Longitude | String | Yes | Longitude of the vehicle location. Precision at 4 decimal places. |
18 changes: 12 additions & 6 deletions _docs/session.md
View file
@@ -1,20 +1,26 @@
---
title: Session
category: Data Preparation
order: 2
order: 4
---

## Scope

All sessions completed during the reporting period. Sessions in progress at the end of the reporting period should be held for the next report.
A record of each TNP driver session on the licensee's Internet-enabled application or digital platform. For purposes of this section, a driver's session begins
when a licensee's driver activates a mode in the licensee's Internet-enabled application or digital platform, signaling the driver's readiness to receive and respond to trip requests. For purposes of this section, a driver's session ends when the driver deactivates the mode and is no longer able to receive and respond to TNP requests.

All sessions completed during the reporting period must be reported in this file. Sessions in progress at the end of the reporting period should be held for the next report.

## File Format

Session data must be reported using the following schema and reported with the following `[company]-session-[date].csv`.

| Field | Element | Data Type | Required | Description |
|-------|-----------------------------|--------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| S1 | Driver's license number | String | Yes | The driver's license number of the driver for this trip. This number must correspond with driver's license number listed in field D1. |
| S2 | Driver's license state | ISO 3166-2 abbreviations | Yes | The state issuing the driver's license that is listed in S1. The license number and license state combination should correspond to the fields D1 and D2. |
| S3 | Session start date and time | ISO 8601 | Yes | The date and time when a driver logs in to the application or otherwise becomes eligible to be hired for a trip for customers. All times must be local time zone and must be noted per ISO 8601 specifications. |
| S4 | Session end date and time | ISO 8601 | Yes | The date and time when a driver logs off the application or otherwise is no longer eligible to provide trips to customers. All times must be local time zone and must be noted per ISO 8601 specifications. |
| S1 | Driver's license number | String | Yes | The driver's license number of the TNP driver for this trip. This number must correspond with driver's license number listed in field D2. |
| S2 | Driver's license state | ISO 3166-2 abbreviations | Yes | The state issuing the driver's license that is listed in S1. The license number and license state combination should correspond to the fields D2 and D3. |
| S3 | Session start date and time | ISO 8601 | Yes | The date and time when a TNP driver logs in to the application or otherwise becomes eligible to be hired for a trip for customers. All times must be local time zone and must be noted per ISO 8601 specifications. |
| S4 | Session end date and time | ISO 8601 | Yes | The date and time when a TNP driver logs off the application or otherwise is no longer eligible to provide trips to customers. All times must be local time zone and must be noted per ISO 8601 specifications. |
| **NEW** S5 | Miles Traveled Total | Numeric | Yes | Total miles traveled during session. |
| **NEW** S6 | Miles Traveled with Passenger | Numeric | Yes | Total miles traveled with a passenger during session. |
| **NEW** S7 | Session End Reason | String | Yes | Indicator of whether or not the TNP driver initiated the end of the session, either by logging off or leaving the service area. Y for driver initiated end of session, N for driver did not initiate end of session. |

0 comments on commit 0558136

Please sign in to comment.