Overview
This guide should be used to create your CSV files for new Cloud Connect implementations. It may be useful in other scenarios, however the SIS Import Definitions is the source of truth for data feed import guidelines. This explains the CSV file requirements for import and for SS&E usage, along with required format, valid values, references, associations, and descriptions.
Important Notes
Dates
Dates must be formatted as date and time with offset in order to import properly. Acceptable examples (EST):
- "2027-01-01T00:00:00-05:00"
- "2027-01-01T00:00:00-05"
- "2027-01-01T05:00:00+0000"
- "2027-01-01T05:00:00.000Z"
SFTP Frequency
During implementation, send all files at least daily. After implementation, you may choose to limit to listed frequency.
Implementation Feeds
Specific data is required or recommended in implementation, but not all feeds and fields are included. If your campus has specific data needs or key data points not represented here, please talk to your Technical Consultant about how to add that data.
CSV Files vs. Data Feeds
The data in your csv files will be used to create the SS&E data feeds. Some files may be used in multiple feeds, and some feeds may be comprised of multiple files. You only need to provide the CSV files below, not the feeds.
Priority 4 CSV Files
Priority 4 Feeds
For reference only
- academicLevel
- highSchool
- hold
- personHighSchool
- personHold
- personStudentType
- personTag
- studentType
Definitions
highSchool
File: high_school/high_school.csv
Description: This feed creates a list of all high schools to support the personHighSchool relationship feed.
Feeds: highSchool
SFTP Frequency: monthly/quarterly
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | ID referenced in: personHighSchool | Unique system identifier for the high school. |
| 1 | ceebCode | N | N | Official CEEB code for the high school. | |
| 2 | name | Y | Y | Format: concatenate Name (City, State) | Name of the high school. Note: Include city, state in the name for usability. |
| 3 | addressLine1 | N | N | Street address for the school. | |
| 4 | addressLine2 | N | N | Street address for the school. | |
| 5 | city | N | N | City where the school is located. | |
| 6 | state | N | N | Format: State Abbreviation. Ex: TX | State where the school is located. |
| 7 | zipCode | N | N | Postal code for the school. |
Recommendations
- Typically includes all valid high schools in the US, often around 40,000 records.
personHighSchool
File: person_high_school/person_high_school.csv
Description: Links students to their prior high schools.
Feeds: personHighSchool
SFTP Frequency: weekly
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for the person high school record. | |
| 1 | personId | Y | Y | Must match: person.id | The person ID associated with the record. |
| 2 | highSchoolId | Y | Y | Must match: highSchool.id | ID for the associated high school. |
| 3 | startDate | N | N | Format: Date and Time with Offset. See Dates. | Start date of high school attendance. |
| 4 | endDate | N | N | Format: Date and Time with Offset. See Dates. | End date of high school attendance. |
| 5 | gpa | N | N | Format: whole or decimal number. | GPA earned at the high school. This is typically used for Nursing, Pre-Health, and other programs that require a high school GPA. |
personHold
File: person_hold/person_hold.csv
Description: Records administrative holds applied to a student's record.
Feeds: personHold, hold
SFTP Frequency: weekly
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for the hold record. | |
| 1 | personId | Y | Y | Must match: person.id | The person ID associated with the hold record. |
| 2 | startDate | Y | Y | Format: Date and Time with Offset. See Dates. | Date the hold began. |
| 3 | endDate | N | N | Format: Date and Time with Offset. See Dates. | Date the hold ended. |
| 4 | holdId | Y | Y | ID of associated hold. Id and name must match 1:1. | |
| 5 | holdName | Y | Y | Name of associated hold. Id and name must match 1:1. |
personStudentType
File: person_student_type/person_student_type.csv
Description: Maps students to specific enrollment classification types.
Feeds: personStudentType, studentType
SFTP Frequency: weekly
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for person student type record. | |
| 1 | personId | Y | Y | Must match: person.id | The person ID associated with the student type record. |
| 2 | studentTypeId | Y | Y | ID of associated student type. Id and name must match 1:1. | |
| 3 | studentTypeName | Y | Y | Name of associated student type. Id and name must match 1:1. | |
| 4 | startDate | Y | Y | Format: Date and Time with Offset. See Dates. | Date the student type was assigned to the student. |
| 5 | endDate | N | Y | Format: Date and Time with Offset. See Dates. | Date the student type was removed from the student. End dates must be applied in order for student types to be removed from the student. |
personTag
File: person_tag/person_tag.csv
Description: Assigns tags to student records for grouping and segmentation. Can be used as custom fields for data that is not being imported in other feeds. You will likely build several tags. Use the following format options depending on the type of data you have.
Feeds: personTag
SFTP Frequency: daily
Recommendations
- tagId must match the Source System Id of a tag record in SS&E. Tags can be created in SS&E Admin or via the tag datafeed. See Data Feed Guide: Tags for more information.
Option 1: Single Tag
File: personTagName/person_tag_name.csv
Description: Anyone in this file will be tagged. Anyone who is not in this file will be marked active=false and the tag will be removed.
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | personId | Y | Y | Must match: person.id | The person ID associated with the person tag record. |
Option 2: Tag Set
File: personTagSetName/person_tag_set_name.csv
Description: Anyone in this file will be tagged with the corresponding tag. Anyone without a tag association will be marked active=false and the tag will be removed.
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | personId | Y | Y | Must match: person.id | The person ID associated with the person tag record. |
| 1 | tagId | Y | Y | Must match: tag.id | ID of associated tag. tagId must match the Source System Id of a tag record in SS&E. |
Option 3: Tag Set with Dates
File: personTagSetName/person_tag_set_name.csv
Description: Anyone in this file within the date range will be tagged with the corresponding tag. Anyone without an active tag association will be marked active=false and the tag will be removed.
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | personId | Y | Y | Must match: person.id | The person ID associated with the person tag record. |
| 1 | tagId | Y | Y | Must match: tag.id | ID of associated tag. tagId must match the Source System Id of a tag record in SS&E. |
| 2 | startDate | Y | Y | Format: Date and Time with Offset. See Dates. | When the tag should be assigned to the student. |
| 3 | endDate | Y | Y | Format: Date and Time with Offset. See Dates. | When the tag should be removed from the student. |