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 5 CSV Files
- building
- courseSectionScheduleElement
- location
- major
- note
- personAddress
- personApplication
- personFafsa
- personFinancialAid
- personFinancialAidAward
- subscription
- tag
- testScore
- transcriptCourseAttendance
Priority 5 Feeds
For reference only
- addressType
- applicationType
- building
- courseSectionDeliveryMethod
- courseSectionScheduleElement
- location
- major
- note
- noteType
- personAddress
- personApplication
- personFafsa
- personFinancialAid
- personFinancialAidAward
- subscription
- tag
- test
- testScore
- testType
- transcriptCourseAttendance
Note: It is very uncommon to implement all Priority 5 feeds. Your implementation team will help determine which feeds will meet your implementation project goals. Refer to your Data Sheet for the list of feeds your team is implementing and create only those CSV files.
Definitions
building
File: building.csv
Description: Buildings at the institution.
Feeds: building
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: courseSection | Unique identifier for each building record. |
| 1 | code | Y | Y | Building acronym or code. | |
| 2 | name | Y | Y | Name of building. | |
| 3 | addressLine1 | N | N | First line of address. | |
| 4 | addressLine2 | N | N | Second line of address. | |
| 5 | city | N | N | City for address. | |
| 6 | state | N | N | Acronym or full name of state. | |
| 7 | zipCode | N | N | Zipcode of address. | |
| 8 | latitude | N | N | Latitude value. Required for location-based attendance. | |
| 9 | longitude | N | N | Longitude value. Required for location-based attendance. | |
| 10 | locationId | N | N | Must match: location.id | Foreign key to the location table. |
courseSectionScheduleElement
File: course_section_schedule_element.csv
Description: Detailed meeting schedule for course sections.
Feeds: courseSectionScheduleElement
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 each course section schedule record. | |
| 1 | buildingId | N | N | Must match: building.id | The ID for the associated building where meetings are held. |
| 2 | room | N | N | The room where this class will meet. | |
| 3 | meetingType | Y | Y | The type of meeting. Ex: CLASS, LECTURE, LAB. Use "CLASS" as default value | |
| 4 | startTimeHours24 | Y | Y | Format: number between 0 and 23 | The numeric hour value for start time. 24-hour based. |
| 5 | startTimeMinutes24 | Y | Y | Format: number between 0 and 59 | The numeric minute value for start time. |
| 6 | endTimeHours24 | Y | Y | Format: number between 0 and 23 | The numeric hour value for end time. 24-hour based. |
| 7 | endTimeMinutes24 | Y | Y | Format: number between 0 and 59 | The numeric minute value for end time. |
| 8 | instructorId | N | N | Must match: person.id | The ID of the instructor. |
| 9 | effectiveDate | N | N | Format: Date and Time with Offset. See Dates. | The first date of this meeting schedule. |
| 10 | expirationDate | N | N | Format: Date and Time with Offset. See Dates. | The end date of this meeting schedule. |
| 11 | monday | Y | Y | Valid values: true, false | Whether the schedule meets on Monday. |
| 12 | tuesday | Y | Y | Valid values: true, false | Whether the schedule meets on Tuesday. |
| 13 | wednesday | Y | Y | Valid values: true, false | Whether the schedule meets on Wednesday. |
| 14 | thursday | Y | Y | Valid values: true, false | Whether the schedule meets on Thursday. |
| 15 | friday | Y | Y | Valid values: true, false | Whether the schedule meets on Friday. |
| 16 | saturday | Y | Y | Valid values: true, false | Whether the schedule meets on Saturday. |
| 17 | sunday | Y | Y | Valid values: true, false | Whether the schedule meets on Sunday. |
| 18 | courseSectionId | Y | Y | Must match: courseSection.id | The ID of the associated course section. |
Recommendations
- This feed can be used to import multiple/secondary instructors to a courseSection. This will create additional schedule records in SS&E.
location
File: location.csv
Description: Locations/Campuses of the institution.
Feeds: location
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: building, courseSection, person, personDegreeProgram, personLocation | Unique identifier for each location record. |
| 1 | name | Y | Y | The name of the location. |
Recommendations
- Import as few campuses/locations as needed, where referenced in other feeds.
major
File: major.csv
Description: Holds major lookup data.
Feeds: major
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: personDegreeProgram, transcript, transcriptDegree | Unique identifier for each major record. |
| 1 | acronym | Y | Y | Format: Max length: 25 characters. | Acronym for the major. Ex: BIO, CS, ENG |
| 2 | name | Y | Y | Name of the major. |
Recommendations
- Major is only necessary if programs can have different majors. If programs have designated majors, use program only.
note
File: note.csv
Description: Notes from another system, typically the SIS.
Feeds: note, noteType
SFTP Frequency: daily
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for each note record. | |
| 1 | personId | Y | Y | Must match: person.id | The student the note is in reference to |
| 2 | note | Y | Y | The text of the note. | |
| 3 | createdDate | Y | Y | Format: Date and Time with Offset. See Dates. | The date the note was created. |
| 4 | createdByPersonId | Y | Y | Must match: person.id | The author of the note. If the person is not in SS&E, use a generic user from the SIS or the SS&E system user. |
| 5 | noteTypeId | N | N | ID of associated note type. Id and name must match 1:1. | |
| 6 | noteTypeName | N | N | Name of associated note type. Id and name must match 1:1. |
Recommendations
- noteTypeId must match a valid note type record in SS&E. Note types can be created in SS&E Admin or via the noteType datafeed.
- It is recommended to limit the number of note types imported from the SIS or another system so there are fewer note types to maintain in SS&E.
personAddress
File: person_address.csv
Description: Address information for students.
Feeds: personAddress, addressType
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 each address record. This can match the personId for easy address management. | |
| 1 | personId | Y | Y | Must match: person.id | The ID of the associated person. |
| 2 | active | Y | Y | Valid values: true, false | Whether this address is active. |
| 3 | addressLine1 | N | Y | First line of address. | |
| 4 | addressLine2 | N | N | Second line of address. | |
| 5 | city | N | Y | City for address. | |
| 6 | state | N | Y | State for address. | |
| 7 | zipCode | N | Y | Zipcode of address. | |
| 8 | typeId | Y | Y | ID of associated address type. Id and name must match 1:1. | |
| 9 | typeName | Y | Y | Name of associated address type. Id and name must match 1:1. |
Recommendations
- Do not include addresses for faculty/staff except campus/office addresses.
- See Data Feed Guide: Phone and Address for more information.
- Unless multiple addresses are needed, it is recommended to import a single, preferred address per person. This allows addresses to be overwritten with a generic address if a student later becomes a faculty/staff member.
personApplication
File: person_application.csv
Description: Applications submitted by prospective students.
Feeds: personApplication
SFTP Frequency: daily
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for each application record. | |
| 1 | personId | Y | Y | Must match: person.id | The ID of the associated person. |
| 2 | completedDate | N | Y | Format: Date and Time with Offset. See Dates. | Date the application was submitted or completed. |
| 3 | programId | N | N | Must match: program.id | The ID of the associated program. |
| 4 | startAcademicCalendarId | N | N | Must match: academicCalendar.id | The ID of the associated academic calendar. |
| 5 | personApplicationStatusId | N | N | Valid values: AVISO.COMPLETED, AVISO.INPROGRESS, AVISO.NONE, AVISO.NEW, AVISO.CANCELLED, AVISO.INCOMPLETE | The current application status. |
Recommendations
- If custom application statuses are desired, discuss with your Watermark Technical Consultant.
personFafsa
File: person_fafsa.csv
Description: General FAFSA information for students.
Feeds: personFafsa
SFTP Frequency: daily
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for each FAFSA record. | |
| 1 | personId | Y | Y | Must match: person.id | The ID of the associated person. |
| 2 | academicYear | Y | Y | The award year of the FAFSA record. | |
| 3 | submissionDate | N | N | Format: Date and Time with Offset. See Dates. | The date the FAFSA was submitted. |
| 4 | institutionPosition | N | N | Format: integer between 1 and 10 | Based on rankings from IFAF_TITLEIV_1, IFAF_TITLEIV_2, IFAF_TITLEIV_3, etc. |
| 5 | adjustedGrossIncome | N | N | Adjusted gross income amount. | |
| 6 | parentAdjustedGrossIncome | N | N | Parental adjusted gross income amount. | |
| 7 | expectedFamilyContribution | N | N | Format: integer | Expected family contribution amount. |
| 8 | maritalStatusId | N | N | Valid values: SINGLE, MARRIED_REMARRIED, SEPARATED, DIVORCED_WIDOWED | Student's marital status. |
| 9 | parentMaritalStatusId | N | N | Valid values: MARRIED_REMARRIED, NEVER_MARRIED, DIVORCED_SEPARATED, UNMARRIED_BOTH_PARENTS_LIVING_TOGETHER, WIDOWED | Parent's marital status. |
| 10 | dependentStatusId | N | N | Valid values: DEPENDENT, INDEPENDENT, PROVISIONAL_INDEPENDENT, REJECTED_DEPENDENT, REJECTED_INDEPENDENT | Student's dependency status. |
| 11 | dependentsOtherThanSpouse | N | N | Valid values: true, false | Indicates if dependents other than spouse exist. |
personFinancialAid
File: person_financial_aid.csv
Description: Financial aid information for students.
Feeds: personFinancialAid
SFTP Frequency: daily
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for each financial aid record. | |
| 1 | personId | Y | Y | Must match: person.id | The ID of the associated person. |
| 2 | awardYear | Y | Y | The academic award year. | |
| 3 | fafsaReceivedDate | N | N | Format: Date and Time with Offset. See Dates. | Date the FAFSA was received. |
| 4 | fafsaRenewalReceivedDate | N | N | Format: Date and Time with Offset. See Dates. | Date the FAFSA renewal was received. |
| 5 | awardPackageSentDate | N | N | Format: Date and Time with Offset. See Dates. | Date the award package was sent. |
| 6 | awardPackageAcceptedDate | N | N | Format: Date and Time with Offset. See Dates. | Date the award package was accepted. |
| 7 | selectedForVerification | N | N | Valid values: true, false | Indicates if selected for verification. |
| 8 | masterPromissoryNoteComplete | N | N | Valid values: true, false | Indicates if master promissory note is complete. |
| 9 | masterPromissoryNoteCompleteDate | N | N | Format: Date and Time with Offset. See Dates. | Date master promissory note was completed. |
| 10 | entranceCounselingCompleteDate | N | N | Format: Date and Time with Offset. See Dates. | Date entrance counseling was completed. |
| 11 | verificationCompleteDate | N | N | Format: Date and Time with Offset. See Dates. | Date verification was completed. |
| 12 | enrollmentFileCompleteDate | N | N | Format: Date and Time with Offset. See Dates. | Date enrollment file was completed. |
| 13 | financialAidComplete | N | N | Valid values: true, false | Indicates if financial aid is complete. |
| 14 | financialAidCompleteDate | N | N | Format: Date and Time with Offset. See Dates. | Date financial aid was completed. |
| 15 | awardAmount | N | Y | Format: whole or decimal number without comma separator | Total financial aid award amount for the year. |
| 16 | satisfactoryAcademicProgressId | N | Y | Valid values: GOOD_STANDING, WARNING, PROBATION, ACADEMIC_PLAN, TERMINATION | Satisfactory academic progress status. |
| 17 | disbursementAmountTotal | N | N | Format: whole or decimal number without comma separator | Total amount of disbursed funds. |
| 18 | disbursementAmountTotalDate | N | N | Format: Date and Time with Offset. See Dates. | Date total amount was disbursed. |
personFinancialAidAward
File: person_financial_aid_award.csv
Description: Financial aid awards granted to students.
Feeds: personFinancialAidAward
SFTP Frequency: daily
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for each financial aid award record. | |
| 1 | personId | Y | Y | Must match: person.id | The ID of the associated person. |
| 2 | awardYear | Y | Y | The award year. | |
| 3 | awardType | Y | Y | The type of financial aid award. Ex: FPELL, ATH-BBALL | |
| 4 | awardCategory | Y | Y | The category of financial aid award. Ex: PELL, ATHLETICS | |
| 5 | awardAmount | N | N | The financial aid award amount. | |
| 6 | status | N | N | The current status of the award. Ex: Accepted, Offered | |
| 7 | statusDate | N | N | Format: Date and Time with Offset. See Dates. | Date of the last status change. |
subscription
File: subscription.csv
Description: Follower relationships between a student and staff member.
Feeds: subscription
SFTP Frequency: daily
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for each subscription record. | |
| 1 | subscribeePersonId | Y | Y | Must match: person.id | The ID of the associated student. |
| 2 | subscriberPersonId | Y | Y | Must match: person.id | The ID of the associated person. |
| 3 | startDate | Y | Y | Format: Date and Time with Offset. See Dates. | The date the follower begins following the student. |
| 4 | endDate | N | N | Format: Date and Time with Offset. See Dates. | The date the follower stops following the student. |
| 5 | subscriptionLabelId | Y | Y | Must match: Subscription Label Source System Id | The type of subscription/follower relationship. This must match the Source System Id of a Subscription Label in SS&E. |
Recommendations
- A valid subscription label record must exist in SS&E in order to assign followers to students. Subscription labels can be created in SS&E Admin.
tag
File: tag.csv
Description: List of tags from the SIS.
Feeds: tag
SFTP Frequency: weekly
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | ID referenced in: personTag | Unique identifier for each tag record. |
| 1 | name | Y | Y | The name of the tag. |
Feed Recommendations
- A valid tag record must exist in SS&E in order to assign tags to students. Tags can be created in SS&E Admin or via the tag datafeed. See Data Feed Guide: Tags for more information.
- Only import tags via the tag feed if there are too many to create manually or if more tags will be automatically added over time.
testScore
File: test_score.csv
Description: Test scores to import from a third party system, typically the SIS.
Feeds: testScore, test, testType
SFTP Frequency: daily
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for each test score record. | |
| 1 | personId | Y | Y | Must match: person.id | The ID of the associated person. |
| 2 | testDate | Y | Y | Format: Date and Time with Offset. See Dates. | The date the test was taken. |
| 3 | score | Y | Y | The score obtained by the student. | |
| 4 | testId | Y | Y |
ID of associated test. Id and name must match 1:1. Ex: SAT, ACT, COMP |
|
| 5 | testName | Y | Y | Name of associated test. Id and name must match 1:1. Ex: SAT, ACT, Compass | |
| 6 | testTypeId | Y | Y | ID of associated test type. Id and name must match 1:1. Ex: SATREAD, ACTMATH | |
| 7 | testTypeName | Y | Y | Name of associated test type. Id and name must match 1:1. Ex: SAT Reading, ACT Math |
transcriptCourseAttendance
File: transcript_course_attendance.csv
Description: Records attendance for a transcript course.
Feeds: transcriptCourseAttendance
SFTP Frequency: daily
| Position | Column Name | Required for Import | Required for System Use | Format, Valid Values, Associations, References | Description |
| 0 | id | Y | Y | Unique identifier for each attendance record. Recommended to include the personId and transcriptCourseId within the ID. | |
| 1 | attendanceDate | Y | Y | Format: Date and Time with Offset. See Dates. | The date of the attendance of the student. |
| 2 | attendanceType | Y | Y | Valid values: ABSENT, PRESENT, UNKNOWN, ENTRY, CANCELLED, TARDY, EXCUSED, NO_ENTRY | The attendance status recorded. |
| 3 | transcriptCourseId | Y | Y | Must match: transcriptCourse.id | The ID of the associated transcript course (enrollment) record. |
| 4 | meetingType | N | Y | The type of meeting. | |
| 5 | courseSectionMeetingId | Y | Y | Must match: courseSectionScheduleElement.id | The ID of the associated course section meeting record. |