Checklist: cai_challenges.csv data file format

[MattTriano]

Requirements for the challenges.csv data file format

Per page 32 of the policy notice and Notices of Changes to the process.

Column Names, Order, and Data Types (dtypes):

1. challenge (dtype: string)
2. challenge_type (dtype: string)
3. challenger (dtype: string)
4. category_code (dtype: string)
5. disposition (dtype: string)
6. challenge_explanation (dtype: string)
7. type (dtype: string)
8. entity_name (dtype: string)
9. entity_number (dtype: integer)
   • test: test_cai_challenges_column_dtypes__entity_number
10. cms_number (dtype: string)
11. frn (dtype: string)
12. location_id (dtype: integer)
    • test: test_cai_challenges_column_dtypes__location_id
13. address_primary (dtype: string)
14. city (dtype: string)
15. state (dtype: string)
16. zip_code (dtype: string)
17. longitude (dtype: string)
18. latitude (dtype: string)
19. explanation (dtype: string)
20. need (dtype: integer)
    • test: test_cai_challenges_column_dtypes__need
21. availability (dtype: integer)
    • test: test_cai_challenges_column_dtypes__availability

• Correct column names
  • test: test_cai_challenges__column_names
• Correct column order
  • test: test_cai_challenges__column_order

Column Content Requirements

• challenge: String with a length between (inclusive) 1 and 50 characters.

  • test: (ToDo: implement data_format-specific test and add link)
  • test: test_ChallengeIdValidator

• challenge_type: Enum; must be in [C, G, Q, R]

  • test: test_cai_challenges_col_content__challenge_type
  • test: test_CAIChallengeType

• category_code: Enum; must be in [X, B, R, D, N, I, T, O]

  • test: (ToDo: implement data_format-specific test and add link)
  • test: test_CAIRationaleNullableValidator

• disposition: Enum; must be in [I, N, A, S, R]

  • test: (ToDo: implement data_format-specific test and add link)
  • test: (ToDo: implement test of constants.DispositionsOfCAIChallenge and add link)

• type: Enum; must be in [S, L, G, H, F, P, C]

  • test: (ToDo: implement data_format-specific test and add link)
  • test: test_CAIType_validator

• location_id: A 10 digit integer $\ge 10^9$ and $\lt 10^{10}$.

  • test: (ToDo: implement data_format-specific test and add link)
  • test: test_BSLLocationIdNullableValidator

• state: Enum; a 2 letter state identifier

  • test: (ToDo: implement data_format-specific test and add link)
  • test: test_State_validator

• zip_code: A zero-padded string of exactly 5 digits.

  • test: (ToDo: implement data_format-specific test and add link)
  • test: test_ZipNullableValidator

• longitude: CRS = EPSG 4326 (aka WGS-84, unprojected and in degrees). Minimal precision of 6 decimal places. (Note: CRS not checked)

  • test: test_cai_challenges_col_content__longitude
  • test: (ToDo: implement test of constants.LongitudeNullableValidator and add link)

• latitude: CRS = EPSG 4326 (aka WGS-84, unprojected and in degrees). Minimal precision of 6 decimal places. (Note: CRS not checked)

  • test: test_cai_challenges_col_content__latitude
  • test: (ToDo: implement test of constants.LatitudeNullableValidator and add link)

• need: Non-negative integer in the reasonable range for a download speed (in Mbps). I think this is 1000 Mbps for every CAI, but if that's correct, I don't know why it would be required.

  • test: (ToDo: implement data_format-specific test and add link)
  • test: test_NonNegativeNumberValidator

• availability: Non-negative integer in the reasonable range for an upload speed (in Mbps).

  • test: (ToDo: implement data_format-specific test and add link)
  • test: test_NonNegativeNumberValidator

Optional

• CMS number: Should identify a healthcare practice (As best I can tell from google, these are 6 or 10 digit numbers, or maybe 13 digits?)

  • test: (ToDo: implement data_format-specific test and add link)
  • test: test_CMSCertificateNullableValidator

• frn: FCC registration number, 10 digits, uniquely identifies registrant with FCC.

  • test: (ToDo: implement data_format-specific test and add link)
  • test: test_FrnNullableValidator

Columns that can be Conditionally Null (and other row-rule checks)

• category_code: Cannot be null if type is in [C, G, R]

  • test: test_cai_challenges_row_rule__category_code_given_challenge_type

• challenge_explanation: Cannot be null if type is in [C, R]

  • test: test_cai_challenge_row_rule__challenge_explanation_given_type

• entity_name: Can only be null when type is in [P]

  • test: test_cai_challenge_row_rule__entity_name_given_type

• location_id: Can only be null if (address_primary, city, zip_code) are all not null, or if (latitude, longitude) are both not null.

• address_primary: Can only be null if location_id is not null, or if (latitude, longitude) are both not null.

  • test: test_cai_challenge_row_rule__location_possibly_determinable

• city: Can only be null if location_id is not null, or if (latitude, longitude) are both not null.

  • test: test_cai_challenge_row_rule__location_possibly_determinable

• zip_code: Can only be null if location_id is not null, or if (latitude, longitude) are both not null.

  • test: test_cai_challenge_row_rule__location_possibly_determinable

• longitude: Can only be null if location_id is not null, or if (address_primary, city, zip_code) are all not null.

  • test: test_cai_challenge_row_rule__location_possibly_determinable

• latitude: Can only be null if location_id is not null, or if (address_primary, city, zip_code) are all not null.

  • test: test_cai_challenge_row_rule__location_possibly_determinable

• explanation: Cannot be null if type is in [C]

  • test_cai_challenges_row_rule__explanation_given_challenge_type

Optional

• CMS number: Cannot be null when type is in [H] (maybe optional?)

  • test: test_cai_challenge_row_rule__cms_number_given_type

• frn: Cannot be null when type is in [S, L, H]

  • test: test_cai_challenge_row_rule__frn_given_type

Multi-File Requirements

• challenger: Must uniquely identify exactly one challenger in the challenger.csv table.

  • test: test_multi_file_validations__cai_challenges_and_challengers

• All CAIs in cai_challenges.csv should either also be in cai.csv (i.e., it was initially identified as a CAI) or should have challenge_type = C (i.e., the challenge identifies this as a CAI missing from the CAI-list).

  • test: (ToDo: implement and add test)

Intentionally noted but not checked by this project

• challenge: Must be unique to a challenge (noted, content not validated beyond type and nullness)
• CMS number: Should be valid and maybe turn up in Medicare lookup tools that allow for search by CNN?
• frn: Should be valid and in the FCC's systems.
• location_id: Must be in the Fabric for that state.
• entity_number: "Mandatory if CAI participates in E-Rate program. Leave empty for CAIs that are neither type S nor L and do not participate in the E-Rate program."