SS&E - CSV Requirements: Priority 2 & 3

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 2 & 3 CSV Files

Priority 2 & 3 Feeds

For reference only

  • degree
  • degreeProgram
  • personDegreeProgram
  • personPhone
  • phoneType
  • program
  • transcriptDegree

Definitions

degree

File: degree/degree.csv

Description: Degrees offered at the institution. 

Feeds: degree

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: degreeProgram, transcriptDegree Unique identifier for each degree record.
1 acronym Y Y   The acronym of the degree. Can be the same as the ID.
Ex: BA, AS
2 name Y Y   The name of the degree.
Ex: Bachelor of Arts, Associate of Science

Recommendations

program

File: program/program.csv

Description: The programs offered at the institution. 

Feeds: program

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: degreeProgram, personApplication, transcriptDegree Unique identifier for each program record.
1 acronym Y Y   The acronym of the program. Can be the same as the ID.
Ex: ACCT
2 name Y Y   The name of the program.
Ex: Accounting
3 active N N Valid values: true, false Indicates if the program is active.

Recommendations

personDegreeProgram

File: personDegreeProgram/person_degree_program.csv

Description: The programs a student is or was enrolled in. Includes programs starting soon, completed, or cancelled. This functions as the student’s program history. 

Feeds: personDegreeProgram, degreeProgram, transcript, academicLevel

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 person degree program record.
1 personId Y Y Must match: person.id The ID for the associated person.
2 degreeId Y Y Must match: degree.id The ID for the associated degree.
3 programId Y Y Must match: program.id The ID for the associated program.
4 academicCalendarId Y Y Must match: academicCalendar.id The ID for the associated academic calendar. This should be the student’s start term in the program.
5 majorId N N Must match: major.id The ID for the associated major.
6 academicLevelId N Y   The ID for the academic level. Id and name must match 1:1.
7 academicLevelName N Y   The name of the academic level. Id and name must match 1:1.
8 startDate Y Y Format: Date and Time with Offset. See Dates. Program of study start date.
9 endDate N Y Format: Date and Time with Offset. See Dates. Program of study end date.
10 status N Y   The status of the student’s enrollment in the program.
11 programRank N Y Format: integer beginning at 1 The rank of the degreeProgram for the student. Primary program should be 1, secondary should be 2, etc. This will be used for the student’s primary and secondary program for filtering.
This ranking can be customized if special logic is needed to assign for primary/secondary programs. 

Recommendations

personPhone

File: personPhone/person_phone.csv

Description: Student phone information, primarily for use in SMS/texting feature. 

Feeds: personPhone, phoneType

SFTP Frequency: daily/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 phone record.
1 personId Y Y Must match: person.id The ID for the associated person.
Do not include personal phones for staff/faculty. Office phones only.
2 active Y Y Valid values: true, false Indicates if the phone record is active.
3 primary Y Y Valid values: true, false Indicates if this is the primary phone number.
4 number Y Y Format: 10 digits or less. Phone number including area code. 
Non-number characters are stripped out.
Only US phones may be imported. International phones are not supported for import or SMS.
5 extension N N   Phone number extension for office phones.
6 typeId Y Y   The ID for the phone type.
Ex: CELL, PREFERRED, SMS, OFFICE
7 smsOptIn N N Valid values: true, false A boolean value to indicate if the student has opted in to receive SMS text messages on this number.

Recommendations

  • Do not include phones for faculty/staff except campus/office phones. 
  • See Data Feed Guide: Phone and Address for more information.
  • Only US phones may be imported. International phones are not supported for import or SMS.

transcriptDegree

File: transcriptDegree/transcript_degree.csv

Description: Completed degrees or credentials earned by a student. 

Feeds: transcriptDegree

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 degree or credential record.
1 personId Y Y Must match: person.id The ID for the associated person.
2 degreeId N N Must match: degree.id The ID for the associated degree.
3 programId Y Y Must match: program.id The ID for the associated program.
4 name Y Y   The name of the degree or credential.
5 graduationDate Y Y Format: Date and Time with Offset. See Dates. The date the award was earned.
6 majorId N N Must match: major.id The ID for the associated major.

Recommendations

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

How to Contact Support
There are many ways to reach out! Click the icon above for our support options.
Watermark Academy
Click the icon above to access the Watermark Academy for consultation, training, and implementation companion courses.
Customer Community
Can’t find the answer? Ask fellow users how they’re making the most of Watermark in our Community!