SIS Import Definitions (for Views and CSV Files)

Overview

The following article lists all data feeds and fields that can be used to import SIS data into SS&E.

To learn when to refer to this article, click here.

  • When a value is not required, fields may be populated with null/" "/left empty if there is no data importing for the field from the SIS system. 
  • When a field is required, it must be populated with a valid value.
      • If for some reason the required field is undefined, eg. is not set up in the SIS source data, the field must be populated with the number zero. 
      • If the field is required to match an ID/value from another file, this must match an existing value and cannot import with null or be populated with zero.
      • For example, if an academic calendar year is importing with null this will fail on the SIS Import process.  If the year is truly undefined, sending 0000 will not cause an import error and resolve the missing data on a required field.
  • In addition, each data feed includes a primary key Id column.
      • The Id field/column represents a unique value that gets translated to SS&E as the "src system id" that is used to update records in SS&E instead of creating new ones.
      • The only requirement for the Source System Id/Primary key/Id value is that it must be guaranteed as unique for each datafeed/record.
      • Many times, this Id is a combination of values imported on other columns that together create a unique identifier. For example, on the Person Financial Aid Indicator data feed, you may use a combination of the financial aid indicator id, person id, and term id to create a unique Id, which can be similarly done on other data feeds.
      • For additional questions about creating a unique source system Id, please reach out to SS&E Support.
  • If a CSV file is uploaded to the Connect server that is not referenced in the Accelerate Configuration, eg. is not used to import data into SS&E, then it will be ignored and can/should be removed from the Connect server.
      • In order to view the Accelerate Configuration Admin page in your SS&E system, replace yourInstitution in the above link. For more information about fixing a broken link, click here.
      • Every data feed will display on the right/Parent side while some/all data feeds may display on the left/Child side. If a Child configuration is found, it will be used instead of the Parent configuration.
      • To search for a file in order to check if it's being used, click on each side and select Ctrl + F, then type in the file name you're searching for to see if it's being used. 2023-12-19 09_06_40-Connect2 Configuration — Mozilla Firefox.png

SIS Data Deletion Integration

Click here to see data feed actions and view which data feeds may integrate data deletion with the SIS.

Click here to learn more about SIS Data Deletion Integration via All Ids.

Click here for SIS Integration Troubleshooting steps.

See the Data Feed Guide: SIS Integration for formatting details and recommendations for each data integration Connect Method.

Academic Calendar

File: academic_calendar.csv

View:

Description: The academic calendar file holds term information.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 academicYear Y Ex: "2010", "2012", etc.
3 startDate Y The start date of the term.
Format: YYYY-MM-DD HH:MM:SS
4 endDate Y The end date of the term.
Format: YYYY-MM-DD HH:MM:SS
5 registrationStartDate N The date when registration opens.
Format: YYYY-MM-DD HH:MM:SS
6 registrationEndDate N The date when registration closes.
Format: YYYY-MM-DD HH:MM:SS
7 registrationReminderDate N

The date to send out a registration reminder alert for this term.
Format: YYYY-MM-DD HH:MM:SS

8 paymentDueDate N The date that payment of balance must be made to the institution for this term.
Format: YYYY-MM-DD HH:MM:SS
9 paymentReminderDate N The date to send out a payment reminder alert for this term.
Format: YYYY-MM-DD HH:MM:SS
10 academicTerm Y The type of term; Fall, Summer, Spring
Options: FALL, WINTER, SPRING, SUMMER or TRANSFER 
11 name N The name of the term.

 

 

Academic Level

File: academic_level.csv

Description: This stream holds academic level lookup data. It is referenced from Person Degree Program.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 acronym Y Ex: "CU", "CE", "UG", "GR"
3 name Y Ex: "Curriculum", "Continuing Education", "Undergraduate", "Graduate"

 

 

Address Type

File: address_type.csv

Description: Address types to be loaded from the SIS.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the address type.
Ex: Home, Work, etc. 

 

 

Admit Status

File: admit_status.csv

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the Admit Status

 

 

Application Type

File: application_type.csv

Description: Application types to be loaded from the SIS.

Default Pull Frequency: Every 6 hours.

Position
Name
Type
Required
Description
1 id varchar(64) Y Primary key of source system.*Relates to Person Application
2 name varchar(100) Y

The name of the Application type.

Examples are: Physical, Digital etc.

3 visible boolean Y

Whether the application type should be shown in SS&E. "true" or "false".

 

 

Area Of Study

File: area_study.csv

Description: Area Of Study information from the SIS.

Default Pull Frequency: Every 6 hours.

Position

Name

Type

Required

Description

1

id

varchar(64)

Y

The unique identifier for this area of study.

2

name

varchar(512)

Y

The name of the area of study eg. “Math Minor”.

3

code

varchar(64)

N

The code or shortname for the area of study.

4

areaOfStudyTypeId

varchar(64)

Y

The associated area of study type for this area of study. Must match a record in the area of study type database table; one of 'maj', 'min', 'con', 'spe'.

5

active

boolean

Y

Whether or not this area of study is actively being used. "true" or "false".

 

 

Building

File: building.csv

Description: Building information from the SIS.

Default Pull Frequency: Every 6 hours.

Release Date/Version: Since: 2.12

Where Is It Used: Location-Based Attendance, Course Section Administration

Position
Name
Required
Description
1 id Y Primary key of source system.
2 code Y Building code.
3 name Y

Name of building. This can be on/off campus.

4 addressLine1 N First line of address
5 addressLine2 N Second line of address
6 city N City for address
7 state N Acronym or full name of state.
8 zipCode N Zipcode of address.
9 latitude N Latitude value (required for Geofencing/Location Based Attendance)
10 longitude N Longitude value (required for Geofencing/Location Based Attendance)
11 locationId N Must match Location.id. Will be null for buildings that are not on a specific campus/location.


Course

File: course.csv

Description: The course file holds core course information, most of which is found in the course catalog.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 department Y

Department ID of the teaching department. Ex: MTH, BUS, etc. 

Must match department.id value.

3 name Y Name of the course
4 creditValue Y Number of credits the course is worth.
Ex: 2.5 or 3 
5 description N Description of course, typically from course catalog.
6 code Y Ex: ACC-149
7 effectiveDate Y The date the course was first active at the institution.
Format: YYYY-MM-DD HH:MM:SS
8 expirationDate N The date the course was no longer active at the institution. The expirationDate must be after the effectiveDate if it is provided.
Format: YYYY-MM-DD HH:MM:SS
9 developmental Y Whether this course is a developmental course. "true" or "false".

 

 

Course Equivalency

File: course_equivalency.csv

Description: Holds course equivalency mappings for an institution.  These are used to supplement the degree audit process within SS&E.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 courseId Y

Course to create an equivalency with. Must match Course.id.

3 equivalentCourseId Y Course that is equivalent. Must match Course.id
4 effectiveDate Y The date the equivalency began (took effect).
Format: YYYY-MM-DD HH:MM:SS
5 expirationDate N The date the equivalency was no longer in effect.
Format: YYYY-MM-DD HH:MM:SS

 

 

Course Offering

File: course_offering.csv

Description: The course offering file holds information for future course offerings.  

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system. This is used when importing course offering data from an external source through the SIS Import.
2 courseId Y The course being offered. Must match course.id.
3 academicCalendarId Y The academic calendar (term) when the course is offered. Must match academic_calendar.id.

Course Section

File: course_section.csv

Description: The course section holds the course sections that exist for a particular academic calendar.  A Course Section record may, or may not, have children Course Section Schedule Element records.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 section Y Section number. - Max length = 10 characters
3 startDate N Date the section first meets. This may/may not differ from the academic_calendar.start_date. Will differ in cases where a section doesn't run the entire term. Format: YYYY-MM-DD HH:MM:SS
4 endDate N Date the section last meets. This may/may not differ from the academic_calendar.end_date. Will differ in cases where a section doesn't run the entire term. Format: YYYY-MM-DD HH:MM:SS
5 online Y Whether this course section is an online section offering. "true" or "false".
6 distance Y Whether this course section is a distance course. "true" or "false"
7 courseId Y Must match course.id
8 academicCalendarId Y Must match academic_calendar.id
9 instructorPersonId N The instructor of the course. Must match person.id
10 selfPaced Y Whether this course section is a self-paced section offering. "true" or "false".`
11 locationId N The location/campus where this course section is offered. Must match Location.id.
12 status Y The status of the section. "ACTIVE" and "CANCELLED" are currently supported. "ACTIVE" is used as the default if no value is provided.
13 censusDate N

The date that an enrollment in this course section is officially reported

Format: YYYY-MM-DD HH:MM:SS

14 withdrawByDate N

The last date to withdraw from the course section

Format: YYYY-MM-DD HH:MM:SS

15 courseSectionDeliveryMethodId N

Must match course_section_delivery_method.id

16 totalContactHours N

Total Contact Hours for this course section for reporting and auditing 

17 classCountAfterCensus N

Total count of participants after the census date for the course section.

 

 

Course Section Delivery Method

File: course_section_delivery_method.csv

Description: Represents the available Course Section Delivery Methods for an institution.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 deliveryMethod Y

Primary name of the course section delivery method to create

Course Section Schedule Element

File: course_section_schedule_element.csv

Description: The course section schedule element holds course section schedules for a course section.  Note that a Course Section does not require a Course Section Schedule Element record to exist.

Default Pull Frequency: Every 6 hours.

Since: 2.12

Position
Name
Required
Description
1 id Y Primary key of source system.
2 buildingId N Building where course section is held. Must match building.id ((required for Geofencing/Location Based Attendance)
3 room N The room where this class will meet.
4 meetingType Y What type of meeting. "LECTURE", "LAB", or others. Free form. Use "CLASS" as default value if null or empty from SIS.
5 startTimeHours24 Y

The numeric hour value for start time. Twenty-four hour based.

Note: If your element does not have a start time use "0" (zero)

6 startTimeMinutes24 Y

The numeric minute value for start time.

Note: If your element does not have a start time use "0" (zero)

7 endTimeHours24 Y

The numeric hour value for end time. Twenty-four hour based.

Note: If your element does not have an end time use "0" (zero)

8 endTimeMinutes24 Y

The numeric minute value for end time.

Note: If your element does not have an end time use "0" (zero)

9 instructorId N The instructor of the course. Must match an existing person.id. Can be used to import a secondary instructor(s) if multiple instructors are teaching the same course section ID. If no value is sent, will default to CourseSection.instructor.
10 effectiveDate N The first date of this meeting. If null, will assume the CourseSection.startDate as the first meeting date. Format: YYYY-MM-DD HH:MM:SS
11 expirationDate N The end date of this meeting. If null, will assume the CourseSection.endDate as the last meeting date. Format: YYYY-MM-DD HH:MM:SS
12 monday Y Does this meeting meet on Monday. "true" or "false".
13 tuesday Y Does this meeting meet on Tuesday. "true" or "false".
14 wednesday Y Does this meeting meet on Wednesday. "true" or "false".
15 thursday Y Does this meeting meet on Thursday. "true" or "false".
16 friday Y Does this meeting meet on Friday. "true" or "false".
17 saturday Y Does this meeting meet on Saturday. "true" or "false".
18 sunday Y Does this meeting meet on Sunday. "true" or "false".
19 courseSectionId Y The course section this meeting schedule is associated with. Must match CourseSection.id.

Curriculum

File: curriculum.csv

Description: The curriculum term information.

Default Pull Frequency: Every 6 hours.

Position

Name

Type

Required

Description

1

id

varchar(64)

Y

The unique identifier for this curriculum.

2

startTermId

varchar(64)

Y

The term in which the student began this curriculum. Must match a record in the academic calendar data feed.

3

endTermId

varchar(64)

Y

The term in which the student finished/ended this curriculum. Must match a record in the academic calendar data feed.

4

active

boolean

Y

Whether or not the curriculum is currently active (ongoing). "true" or "false".

Curriculum Area Of Study

File: curriculum_area_study.csv>p?

Description: The curriculum and area of study information.

Default Pull Frequency: Every 6 hours.

Position

Name

Type

Required

Description

1

id

varchar(64)

Y

The unique identifier for this curriculum area of study.

2

curriculumId

varchar(64)

Y

The curriculum that this area of study is in. Must match a record in the Curriculum data feed.

3

areaOfStudyId

varchar(64)

Y

The area of study that is being included in the curriculum. Must match a record in the AreaOfStudy data feed.

4

rank

numeric

Y

The rank within the other areas of study for the same area of study type.

For example, the first minor would have rank 1, the first concentration would have rank 1. The second minor and concentration would both have rank 2. 

 

 

Degree

File: degree.csv

Description: The degrees offered at the institution.

Default Pull Frequency: Every 6 hours.

Position
Name
Type
Required
Description
1 id varchar(64) Y Primary key of source system.
2 acronym varchar(10) Y The acronym of the degree.
Ex: "BA"
3 name varhcar(100) Y

The name of the degree.
Ex: "Bachelor of Arts" 

 

Degree Program

File: degree_program.csv

Description: The degree program combinations offered at the institution.

Default Pull Frequency: Every 6 hours.
 

Position
Name
Required
Description
1 id Y Primary key of source system.
2 academicCalendarId Y Must match AcademicCalendar.id
3 degreeId Y

The degree to be obtained.

Must match Degree.id

4 programId Y

The program to be earned.

Must match Program.id

 

Department

File: department.csv
Description: The departments of study at the institution.  These departments are typically referenced by courses offered.
Default Pull Frequency: Every 6 hours.
Position
Name
Required
Description
1 id Y Primary key of source system.
2 acronym Y The acronym of the department.
Ex: "CJ"
3 name Y The name of the department.
Ex: "Criminal Justice" 
4 active Y Whether the department is currently active. Values are "true" or "false".

 

Financial Aid Indicator

File: financial_aid_indicator.csv

Description: An indicator for financial aid imported from the SIS. 

Default Pull Frequency: Every 6 hours.

Position
Name
Type
Required
Version
Description
1 id varchar(64) Y 7.14.0 Primary key of source system.
2 value varchar(15) Y 7.14.0 A financial aid "value" defined by the institution.
3 description varchar Y 7.14.0

A description for the financial aid value.

4 active boolean Y 7.14.0 Whether the financial aid indicator is currently active.
Values are "true" or "false".

*The financial aid indicator column is used on the North Carolina Attendance Report to represent a student attendance status in a specific course.

High School

File: high_school.csv

Description: High Schools to be loaded from the SIS.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 ceebCode N

The institution's CEEB Code.

3 name Y The name of the high school.
4 addressLine1 N  
5 addressLine2 N  
6 city N  
7 state N  
8 zipCode N  

 

High School Graduation Type

File: high_school_graduation_type.csv

Suggested Build Frequency: Daily

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the High School Graduation Type

 

High School Transcript Status

File: high_school_transcript_status.csv

Suggested Build Frequency: Daily

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the High School Transcript Status

 

High School Transcript Type

File: high_school_transcript_type.csv

Suggested Build Frequency: Daily

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the High School Transcript Type

 

Hold

File: hold.csv

Description: Holds defined by the institution.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y

Primary key of source system.

hold srcSystemId has a size constraint of 64 characters.

2 name Y

The name of the hold.

The hold name has a size constraint of 255 characters.

 

Institution Transcript Course Status

File: institution_transcript_course_status.csv

Description: Transcript course statuses defined by the institution.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Version
Description
1 id Y 7.14.0

Primary key of source system.

2 name Y 7.14.0

The name of the institutional transcript course status.

3 active Y 7.14.0

Whether the institutional transcript course status is active.

Values are "true" or false".

 

Location

File: location.csv

Description: Locations/Campuses of the institution

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the location.

 

Major

File: major.csv

Description: This stream holds major lookup data.

References: Major Id is linked to from the Person Degree Program, Transcript, and Transcript Degree data feeds.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 acronym Y

Acronym for the major.

Max 25 characters

3 name Y Description of the major.

 

Note

File: note.csv

Description: Notes to import from a third party system, typically the SIS.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.

Recommend appending the institutionPersonId for ease of research/debugging.

Format: -

Example: "P000054569-2458"

2 personId Y The person who the note will be assigned to. This must match the id column of the person file.
3 note Y

The text of the note.

4 createdDate Y Format: YYYY-MM-DD HH:MM:SS. If no createdDate is provided, January 1st of the current year will be used.
5 createdByPersonId Y The person who created the note. This must match the id column of the person file.
6 noteTypeId N

The note type from the SIS. Must match NoteType.srcSystemId. If not provided, will be set to General Advising.

 

Note Type

File: note_type.csv

Description: Note types of the institution

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the note type.

 

Person

File: person.csv

Description: Holds person demographic information. The Person feed is used to create all people, regardless of role, who will be using or engaged through your Student Success & Engagement system. All other person feeds, such as Person Address and Transcript, are based on users provided in this file.

Default Pull Frequency: Every 6 hours.

Position
Name
Type
Required
Version
Description
1 id varchar(64) Y 2.0 Primary key of source system.
2 username varchar(25) N 2.0 Username that the student or staff logs in with. This could be an email address or institutional username.
3 firstName varchar(50) Y 2.0 The first name of the person.
4 middleName varchar(50) N 2.0 The middle name of the person.
5 lastName varchar(50) Y 2.0 The last name of the person.
6 nickname varchar(50) N 2.0 The nickname of the person. 
7 gender char(1) N 2.0

Recommended for Students only. Do not include for users who only have roles like Faculty and Staff.

"M" or "F" or "U"

8 birthDate char(10) N 2.0

Recommended for Students only. Do not include for users who only have roles like Faculty and Staff.

Format: YYYY-MM-DD

9 emailAddress varchar(100) N 2.0

Organizational email address of the person

Note: This should be the user's school/institution email address. (The email address your institution provides to the user)

This email address is potentially used to match the user for SSO authentication depending on your authentication configuration and may also be used to match the user in your LMS.

10 enabled boolean Y 2.0

"true" or "false"

Setting this to false will inactivate the user in SS&E Administration, but does not remove them from filters, etc. in the UI. See Inactive Users/Archiving a Person Record for more information. 

11 role varchar N 2.0

Role Setting Options:

  • RECOMMENDED: Matches an Integration ID of a role created in SS&E (case-sensitive!). Default Integration IDs look like "ROLE_STUDENT", "ROLE_FACULTY", "ROLE_ADVISOR", etc.
  • Is left empty. When empty, the person roles are assigned manually by an administrator within Student Success & Engagement

See the Data Feed Guide: Roles article for guidance on setting up roles in implementation.

Important Notes:

12 institutionPersonId varchar(25) Y 2.0 Unique identifier to the institution. Typically called the student id.
13 advisorId varchar(64) N 2.0

Must match person.id field for another record if provided. The assigned advisor must have an advisor role.

(See †† footnote)

14 balanceDue numeric(19,2) Y 2.0

Recommended for Students only. Do not include for users who only have roles like Faculty and Staff.

Balance due on the student's account. This drives the financial alert within SS&E. Typically total due minus any financial aid and payments.

15 currentIntent varchar(100) N 2.0

The current intent of the student for attending college. Must be one of the following:

ASSOCIATE_FOR_JOB

ASSOCIATE_FOR_TRANSFER

BACHELOR_DEGREE

CERTIFICATE

PERSONAL_INTEREST

TRAINING_FOR_CAREER

TRANSFER_PRIOR_DEGREE

UNKNOWN

16 coachId varchar(64) N 2.4

Must match person.id field for another record if provided. The assigned advisor must have an advisor role.

(See †† footnote)

17 locationId varchar(64) N 2.5 Primary campus/location a student is affiliated with. Must match Location.srcSystemId.
18 ethnicityId varchar(64) N 2.5

Recommended for Students only. Do not include for users who only have roles like Faculty and Staff.

The ethnicity identifier for the student. Must match Ethnicity.integrationId.
If present, valid values are: HISPANIC, NON_HISPANIC

19 raceId varchar(64) N 2.5

Recommended for Students only. Do not include for users who only have roles like Faculty and Staff.

The race identifier for the student. Much match Race.integrationId.
If present, valid values are: WHITE, BLACK_AFRICAN_AMERICAN, ASIAN,AMERICAN_INDIAN_ALASKA_NATIVE, NATIVE_HAWAIIAN_OTHER_PACIFIC_ISLANDER. 

20 secondaryEmailAddress varchar(100) N 2.8

Recommended for Students only. Do not include for users who only have roles like Faculty and Staff.

Personal email address of the person

Note: This can be any email address. In general it is NOT the email address supplied to the user by your institution.

21 alternateInstitutionPersonId varchar(100) N 3.0 A secondary identifier, typically for the student, at the institution.

22

advisorSubscriptionLabel varchar N 5.1.12

A label to add to the subscription record that is created between the person and the advisor (if an advisor is provided).

23

coachSubscriptionLabel varchar N 5.1.12

A label to add to the subscription record that is created between the person and the coach (if a coach is provided).

24

initialPersonId varchar N 5.1.12

 

25

veteranTypeId varchar N 6.65.0

DEPRECATED: The veteran type identifier for the person has been deprecated in favor of PersonVeteranType which allows for a many to one relationship. And VeteranType data feed, which can be provided by the institution.

26

veteran boolean N 6.43.0

Recommended for Students only. Do not include for users who only have roles like Faculty and Staff.

Whether or not this person a veteran. "true" or "false"

27

firstGeneration boolean N 6.43.0

Recommended for Students only. Do not include for users who only have roles like Faculty and Staff.

Whether or not this person is a first generation college student. "true" or "false"

28

personType varchar N/Y 7.0

Note: Once importing person types is enabled in Application Administration, this field is required and must be populated with a valid person type on all person data feed records.

Person type(s) are assigned to a person record**.

Currently, SS&E supports the following Person Types*:

    1 - Student

    2 - Prospect

    3 - Applicant

    4 - Staff

    5 - Faculty

For multiple person types, separate with "::" (For ex., "student::staff" or "staff::faculty::student").

*The database stores person type in a one digit numeric format based on the translations listed above.

**Person Types can also be manually added or removed via People Administration Bulk Actions.

See the Data Feed Guide: Person Types article for guidance and examples of personType logic.

29

 sisManaged      

The default value "True" will allow automated integration of prospect data.

 

†† Advisors and Success Coaches assigned via the SIS Import can be removed from the UI by passing in a null value ONLY IF the Applications Administration setting allowSuccessTeamRemoval is set to True. For new clients, this setting defaults to "true" so that advisors and success coaches who were assigned via the SIS import can also be removed with the SIS import. Primary advisors/success coaches who were not assigned via the SIS import will not be removed by blank/null values importing on the SIS Person import.

 

Person Academic Plan

File: person_academic_plan.csv

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 personId Y The student that this plan is for. This must match Person.id.
3 status Y

Linked to AcademicPlanStatus in Engage. Must be one of the following:

  • APPROVED
  • NEW
  • PENDING_ADVISOR
  • PENDING_STUDENT
4 createdByPersonId Y The id of the person who created the plan. This must match Person.id.
5 modifiedByPersonId Y The id of the person who last modified the plan. This must match Person.id.
6 createdDate Y Date the plan was created
7 modifiedDate Y Date the plan was last modified.

 

Person Academic Plan Course

File: person_academic_plan_course.csv

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 academicPlanId Y The academic plan that this is for. Must match PersonAcademicPlan.id.
3 academicCalendarId Y

The academic calendar for which this course is planned. Must match academicCalendar.id.

4 courseId Y The course that is planned. Must match course.id.
5 createdByPersonId Y The id of the person who added this course to the plan. This must match Person.id.
6 effectiveDate Y Date the course becomes effective on the plan.

 

Person Address

File: person_address.csv

Description: Address information from the SIS. Recommended for Students only. Do not include for users who only have roles like Faculty and Staff.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 personId Y The person who the address will be assigned to. This must match Person.id.
3 active Y

"true" or "false"

4 addressLine1 Y First line of address
5 addressLine2 N Second line of address
6 city Y City for address
7 state Y Acronym or full name of state.
8 zipCode Y Zipcode of address.
9 typeId Y Type of address. Must match AddressType.id.
10 current Y Is this the current residential address for the person. "true" or "false".
11 permanent Y Is this the permanent residential address for the person. "true" or "false".

 

Person Application

File: person_application.csv

Description: Application information for a Student from the SIS.

Default Pull Frequency: Every 6 hours.

Position
Name
Type
Required
Description
1 id varchar(64) Y Primary key of source system.
2 personId varchar(64) Y The person who the address will be assigned to. This must match Person.id.
3 startDate char(19) N

The date a hardcopy (or submission) of an application has been submitted.
Format: YYYY-MM-DD HH:MM:SS

4 completedDate char(19) N The date the application was completed. This is the date the application is official with all supplemental materials submitted to the institution.
Format: YYYY-MM-DD HH:MM:SS
5 programId varchar(64) N The major/program the student wishes to apply into.
Must match Program.id if provided.
6 startAcademicCalendarId varchar(64) N The term the student wishes to start at the college.
Must match AcademicCalendar.id if provided.
7 personApplicationStatusId varchar(64) N

The current status of the application.

Must be one of:

AVISO.COMPLETED
AVISO.INPROGRESS
AVISO.NONE
AVISO.NEW
AVISO.CANCELLED
AVISO.INCOMPLETE

OR A valid ID from the Person Application Status feed

8 personApplicationStatusDate datetime N

The current status date of the application.

Format: YYYY-MM-DD

9 initialPersonId varchar(64) N  
10 initialId varchar(64) N  
11 applicationTypeId varchar(64) N

The application type associated with this application.

This value must match the ApplicationType.id if provided.

12 applicationTypeDate datetime N*

The date that the given Application Type was associated with the application.

*A value must be provided if an applicationTypeId is set.

13 studentLoadIntentId   N

The Student Load Intent associated with this application. Viewed on Person Application student_load_id.

14 residencyStatusId   N

The Residency Status associated with this application.

15 admitStatusId   N

The Admit Status associated with this application.

16 applicationFinancialAidIntentFlag   N

"true" or "false"

Y = Yes and N = No may be mapped to true/false.

17 applicationFinancialAidSubmitDate   N

The submit date of the financial aid for this application.

18 applicationStudentTypeId   N

The Student Type associated with this application. Viewed on Person Application student_type_id.

 

Person Application Location

File: person_application_location.csv

Suggested build frequency: Every 6 hours

Position
Name
Required
Description
1 id Y Primary key of source system.
2 personApplicationId Y

The id of the associated PersonApplication

3 locationId Y

The id of the associated Location

 

Person Application Status

File: person_application_status.csv

Description: Custom statuses for Person Application entries.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y Name of the application status
3 description Y

Description of the application status

4 badgeColor Y

Must be one of:

  • danger
  • light
  • primary
  • secondary
  • success
  • warning

 

Person Degree Program

File: person_degree_program.csv

Description: Person Degree information from the SIS.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 personId Y The person to whom the degree will be assigned. This must match Person.id.
3 degreeProgramId Y

The degree earned, or being earned, by the Person. Must match DegreeProgram.id.

4 majorId N The major of the student. Must match Major.id.
5 academicLevelId N The academic level of this credential being earned. Must match AcademicLevel.id.
4 startDate Y

Program of study start date. Format must be YYYY-MM-DD.

Required based on import error observation.

5 endDate N Program of study end date. Format must be YYYY-MM-DD.
6 locationId N The location of the program of study. Must match Location.id.
7 status N The status from the source system. Typically this will represent Active, Pending, Cancelled, or others.
8 statusDate N The status date of this record. Format must be YYYY-MM-DD.

 

Person FAFSA

File: person_fafsa.csv

Description: FAFSA submission information for a student.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 personId Y

The person who the ISIR record is associated with. This must match Person.id.

3

academicYear

Y

Four digit year of the academic year.

Colleague: IFAF_IMPORT_YEAR 
PowerFaids: stu_award_year.award_year_token 

4 submissionDate N

The date the ISIR was submitted.

Format: YYYY-MM-DD HH:MM:SS

Colleague: IFAF_DATE_SIGN 
PowerFaids:  

5 institutionPosition N

Where this institution fell in the student's preferred college listing. Null if not among the 10.

Colleague: Write a function to compare this insts FAFSA identifier against the ISIR fields of: IFAF_TITLEIV_1, IFAF_TITLEIV_2, IFAF_TITLEIV_3, IFAF_TITLEIV_4, IFAF_TITLEIV_5, IFAF_TITLEIV_6, IFAF_TITLEIV_7, IFAF_TITLEIV_8, IFAF_TITLEIV_9, IFAF_TITLEIV_10.

6 adjustedGrossIncome N

Student's adjusted gross income.

Colleague: IFAF_S_AGI 

7 parentAdjustedGrossIncome N

Parent's adjusted gross income.

Colleague: IFAF_P_AGI 

8 expectedFamilyContribution N

Expected family contribution.

Colleague: IFAF_PRI_EFC or ICRES_PRI_EFC

9 maritalStatusId N

Marital status of student.

Colleague: IFAF_S_MARITAL_ST

Values will be: SINGLE, MARRIED_REMARRIED, SEPARATED, DIVORCED_WIDOWED 
Must match MaritalStatus.integrationId 

10 parentMaritalStatusId N

Marital status of parents.
Colleague: IFAF_P_MARITAL_ST

Values will be: MARRIED_REMARRIED, NEVER_MARRIED, DIVORCED_SEPARATED, UNMARRIED_BOTH_PARENTS_LIVING_TOGETHER, WIDOWED
Must match MaritalStatus.integrationId 

11 dependentStatusId N Whether the student is a dependent.

Colleague: ICRES_DEPENDENCY

Values will be: DEPENDENT, INDEPENDENT, REJECTED_DEPENDENT, REJECTED_INDEPENDENT 
Must match DependentStatus.integrationId 
12 dependentsOtherThanSpouse N Does student have any dependents? "true" or "false".

Colleague: IFAF_DEPEND_CHILDREN 

 

Person Financial Aid

File: person_financial_aid.csv

Description: Holds student financial aid information.

Default Pull Frequency: Every 6 hours.

*Colleague creates a new data source for every financial aid year so this may need to be updated in the Informer reports or SQL Queries when connecting to the source data via views.

For more information, click here.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 personId Y Person whom the financial aid data applies.
3 awardYear Y Four digit year of the award year.
4 fafsaReceivedDate N Date the institution has received the FAFSA (ISIR).
Format: YYYY-MM-DD 
5

fafsaRenewalReceivedDate

N Format: YYYY-MM-DD
6 awardPackageSentDate N Date the award is complete and sent to the student or available for the student to review.
Format: YYYY-MM-DD
7 awardPackageAcceptedDate N Date the award is accepted by the student.
Format: YYYY-MM-DD
8 selectedForVerification N Was the student selected for verification?
"true" or "false"
9 masterPromissoryNoteComplete N "true" or "false" or ""
10 masterPromissoryNoteCompleteDate N Format: YYYY-MM-DD
11 entranceCounselingCompleteDate N Format: YYYY-MM-DD
12 verificationCompleteDate N Verification information has been received and processed/completed by financial aid.
Format: YYYY-MM-DD
13 enrollmentFileCompleteDate N All final official admissions related documents have been completed allowing for financial aid to be disbursed.
Format: YYYY-MM-DD
14 financialAidComplete N All necessary financial aid items have been received and ready for disbursement.
"true" or "false" or ""
15 financialAidCompleteDate N Format: YYYY-MM-DD
16 awardAmount N Format: #####.##
17 satisfactoryAcademicProgressId N Standard valid values are GOOD_STANDING, WARNING, PROBATION, ACADEMIC_PLAN, TERMINATION. Other values may be supported, but require discussion between the Institution and SS&E staff. In most cases, the SAP ID should match the SAP value (name). Otherwise, it may require Professional Services to match the values displayed on the UI with the data import.
18 tuition N The cost of tuition at the institution.
19

roomAndBoard

N

The cost of room and board.

20

disbursementAmountTotal

N

The dollar amount of disbursement associated with this person financial aid record.

21

disbursementAmountTotalDate

N

The date of the disbursement associated with this person financial aid record.

 

Person Financial Aid Award

Export file: person_financial_aid_award.csv

*Colleague creates a new data source for every financial aid year so this may need to be updated in the Informer reports or SQL Queries when connecting to the source data via views.

For more information, click here.

Position
Name
Required
Version
Description
1 id Y 2.12 Primary key of source system.
2 personId Y 2.12

Anonymized identifier for the student.

3 awardYear Y 2.12

The award year for this financial aid record. Ex - 2014

4 awardType Y 2.12 The award type. Ex - FPELL
5 awardCategory Y 2.12 The award category. Ex - PELL
6

awardAmount

N 2.12

The award amount.

7 status N 4.02 Status of Award Ex: Accepted, Offered
8 statusDate N 4.02

Date of status change.

Format: YYYY-MM-DD

 

Person Financial Aid Indicator

File: person_financial_aid_indicator.csv

Position
Name
Required
Version
Description
1 id Y 7.14.0 Primary key of source system.
2 personFinancialAidId Y* 7.14.0

*EXACTLY ONE of personFinancialAidId, personTermFinancialAidId, or personFinancialAidAwardId is to be used. If populated, must match personFinancialAid.id.

3 personTermFinancialAidId Y* 7.14.0

*EXACTLY ONE of personFinancialAidId, personTermFinancialAidId, or personFinancialAidAwardId is to be used. If populated, must match personTermFinancialAid.id.

4 personFinancialAidAwardId Y* 7.14.0 *EXACTLY ONE of personFinancialAidId, personTermFinancialAidId, or personFinancialAidAwardId is to be used. If populated, must match personFinancialAidAward.id.
5 financialAidIndicatorId Y 7.14.0 Must match a financialAidIndicator.id.
6

startDate

N 7.14.0

The date this starts to apply.

7 endDate N 7.14.0 The date this stops to apply.

 

Person High School

File: person_high_school.csv

Description: High Schools attended, or being currently attended, by a student.

Position
Name
Required
Description
1 id Y Primary key of source system
2 personId Y FK to person table
3 highSchoolId Y FK to high school table
4 startDate N Start date of high school attendance. Format of YYYY-MM-DD HH:MM:SS
5 endDate N End date of high school attendance. Format of YYYY-MM-DD HH:MM:SS
6 gpa N High School GPA
7 creditsEarned N The credit earned in High School
8 highSchoolTranscriptDate N The date of the High School transcript
9 highSchoolTranscriptStatusId N The status of the High School transcript. Must match highSchoolTranscriptStatus.id.
10 highSchoolTranscriptTypeId N The type of the High School transcript. Must match highSchoolTranscriptType.id.
11 yearAttendedStart N The year the student began attending
12 yearAttendedEnd N The year the student stopped attending
13 rankPosition N The student's rank
14 rankClassSize N The student's class size
15 highSchoolGraduationTypeId N

The High School Graduation Type associated with this student's Person High School. Must match highSchoolGraduationType.id.

 

Person Hold

File: person_hold.csv

Description: Student holds at the institution.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y

Primary key of source system.

Person Hold srcSystemId has a size constraint of 64 characters.

2 personId Y The person who the hold will be assigned to. This must match Person.id.
3 startDate Y

Start date of hold on student record.

Format: YYYY-MM-DD HH:MM:SS

4 endDate N

End date of hold on student record.

Format: YYYY-MM-DD HH:MM:SS

5 holdId Y

Must match Hold.id

holdId has a size constraint of 64 characters.

 

Person Location

File: person_location.csv

Description: History of locations.

Position
Name
Required
Description
1 id Y id
2 personId Y Foreign key to the person table. Must match Person.id.
3 locationId Y Foreign key to the location table. Must match Location.id.
4 startDate Y Start date of location. Format of YYYY-MM-DD HH:MM:SS
5 endDate N End date of location. Format of YYYY-MM-DD HH:MM:SS

 

Person Phone

File: person_phone.csv

Description: Phone information from the SIS. Recommended for Students only. Do not include for users who only have roles like Faculty and Staff.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 personId Y The person who the phone will be assigned to. This must match Person.id.
3 active Y

"true" or "false"
Because Person Phone integrates data deletion via All Ids, this value will change automatically when the record is deleted/un-deleted via All Ids or manual deletion

4 primary Y "true" or "false". Identifies this phone number as being the primary phone.
5 number Y

Phone number including area code if available. Non-number characters are removed on import.

6 extension N Phone number extension.
7 typeId Y

The type of phone number. Business, mobile, etc. Must match PhoneType.id.

 

Person Student Type

File: person_student_type.csv

Description: History of student types associated with a person.

Position
Name
Required
Description
1 id Y Primary key of source system (must be unique)
2 personId Y FK to person table
3 studentTypeId Y FK to student type table
4 startDate Y Start date for the person student type. Must be in the format of YYYY-MM-DD.
5 endDate N End date for the person student type. Must be in the format of YYYY-MM-DD.

 

Person Tag

File: person_tag.csv

Description: Tag information from the SIS or generated within the Connector.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 personId Y The person who the phone will be assigned to. This must match Person.id.
3 active Y

"true" or "false"

Tags with Active=True display on the UI. Tags imported with Active=False are removed from the UI.

4 tagId Y

Must match Tag.integrationId

There can be only ONE record for a specific tag/person. For more information about data-baked tags imported on the Person Tag data feed, click here.

 

Person Term Financial Aid

File: person_term_financial_aid.csv

Description: Person Term Financial Aid information.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Version
Description
1 id Y 7.14.0 Primary key of source system.
2 personId Y 7.14.0 The person who the financial aid term is associated with. This must match Person.id.
3 academicCalendarId Y 7.14.0

The financial aid term. Must match an existing AcademicCalendar.id.

 

Person Veteran Type

File: person_veteran_type.csv

Description: Represents the relationship between a person record and one or many veteran type records.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 personId Y

Person to create this person veteran type for. Must match Person.id.

3 veteranTypeId Y

VeteranType to create this person veteran type for. Must match VeteranType.id.

 

Phone Type

File: phone_type.csv

Description: Phone types to be loaded from the SIS.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the phone type.
Ex: Home, Mobile, etc.

Prerequisite Course

File: prerequisite_course.csv

Description: A course component to a pre-requisite group.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 can_be_taken_concurrently Y

Can this course be taken concurrently with the group's course to satisfy this rule.

"true" or "false"

3 minimum_credit Y The minimum credit required to satisfy this prerequisite.
4 minimum_grade Y The minimum grade required to satisfy this prerequisite.
5 prerequisite_group_id Y

The group that this prerequisite rule is associated with.

Must match PrerequisiteGroup.id

6 course_id Y

The course that this rule references.

Must match Course.id

 

Prerequisite Group

File: prerequisite_group.csv

Description: Represents the top-level container/group that will include courses, test, or permission prerequisite entries in other files.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 course_id Y

Course to create this prerequisite group for. Must match Course.id.

 

Prerequisite Permission

File: prerequisite_permission.csv

Description: A permission component to a pre-requisite group.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 prerequisite_group_id Y

The group that this prerequisite rule is associated with.

Must match PrerequisiteGroup.id

3 person_id Y

The person that must give permission to meet this rule.

Must match Person.id

 

Prerequisite Test

File: prerequisite_test.csv

Description: A test component to a pre-requisite group.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 prerequisite_group_id Y

The group that this prerequisite rule is associated with.

Must match PrerequisiteGroup.id

3 test_id Y

The test that must be taken to meet this rule.

Must match Test.id

4 test_type_id Y

The test type that must be taken to meet this rule.

Must match TestType.id

5 minimum_score Y

The minimum score that must be earned to meet this rule.

 

Program

File: program.csv

Description: The programs offered at the institution.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 acronym Y

The acronym of the program.
Ex: "ACCT"

Max 25 character

3 name Y

The name of the program.
Ex: "Accounting"

4 active N

Whether or not the program is active. Ex. "true", "false"

 

Residency Status

File: residency_status.csv

Suggested Build Frequency: Daily

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the Residency Status

 

Student Load Intent

File: student_load_intent.csv

Suggested Build Frequency: Daily

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the Student Load Intent

 

Student Type 

File: student_type.csv

Description: Type of student. This list is defined the institution (student types are listed on the student profile and used for filtering), but will need to be mapped to the following student populations for Predict: Student Populations like Post Sec, Post Bach, HighSchool, ConEd, Special, NT Post Sec.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 acronym Y Acronym of the student type. Max length = 10 characters
3 name Y

The name of the student type.

 

Subscription

File name: subscription.csv

Description: Defines relationships between a student and staff member.

Position
Name
Required
Description
1 id Y Primary key of the subscription relationship. Often times this will simply be the concatenation of the subscribeePersonId and the subscriberPersonId.
2 subscribeePersonId Y Person whom is being subscribed to. Must match Person.id.
3 subscriberPersonId Y Person whom is subscribing to the student. Must match Person.id.
4 startDate Y

Start date of relationship. Format of YYYY-MM-DD HH:MM:SS

This date must be in the past.

5 endDate N

End date of relationship. Format of YYYY-MM-DD HH:MM:SS

This date must be in the past.

6 typeId N Must be one of "PRIMARY_ADVISOR", "PRIMARY_COACH" or "STAFF". The term of "STAFF" represents a following relationship.
7 subscriptionLabelId Y The label that describes the relationship between subscriber and subscribee. This identifier will match the Source System Id value of the Subscription Label in SS&E.

 

Tag

File: tag.csv

Description: Tags to be loaded from the SIS or external source.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

The name of the tag. Will be shown in the UI.

 

Test

File: test.csv

Description: The standardized tests taken by students and typically recorded in the institution's SIS.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 acronym Y The acronym of the test.
Ex: "COMP"
3 name Y

The name of the test.
Ex: "Compass" 

 

Test Score

File: test_score.csv

Description: Test scores to import from a third party system, typically the SIS.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y

Primary key of source system.

Recommend appending the institutionPersonId for ease of research/debugging.

Format: -

Example: "P000054527-COMPGEOM2012370000"

2 personId Y Student for whom the test was recorded.
3

testDate

Y The date the test was taken. Format: YYYY-MM-DD HH:MM:SS
4 score Y

The test score obtained by the student.

5 testId Y Must match lookup table Test.
6 testTypeId Y Must match lookup table Test Type (previously subtestId).

 

Test Type

File: test_type.csv

Description: The test types recorded at the institution.

Note: This is still referenced as "subtest" in many places but will be converted completely to testType in future releases.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 acronym Y The acronym of the test.
Ex: "ALG"
3 name Y

The name of the test.
Ex: "Algebra" 

 

Transcript

File: transcript.csv

Description: The high-level transcript work of a student. SS&E supports one transcript per person.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system. Should usually match the person.id as there can only be one transcript per person.
2 cumulativeGpa N The student's overall cumulative GPA.
3 cumulativeGpaCredits N

The student's overall cumulative credits earned that apply to the GPA.

4 primaryMajorGpa N The student's GPA in their primary program of study.
5 primaryDegreeProgramId N The student's primary degree program being earned.
Must match degree_program.id. 
6 secondaryDegreeProgramId N The student's secondary degree program being earned.
Must match degree_program.id. 
7 personId Y Person to whom this transcript record is associated with.
Must match person.id. 
8 highSchoolCeebCode N The CEEB code of the high school attended by the student.
9 highSchoolGpa N The GPA earned by the student in high school.
10 highSchoolTranscriptReceivedDate N The date the institution received the student's high school transcript.
Format: YYYY-MM-DD HH:MM:SS
11 previousCollegeGpa N The student's GPA at a previously attended post-secondary institution.
12 previousCollegeTranscriptReceivedDate N

The date of the most recent transcript received from a previous college.

Format: YYYY-MM-DD HH:MM:SS
13 cumulativeCreditHoursEarned N

The student's cumulative credit hours at the source institution, even those that do not count toward the GPA.

14 primaryMajorCreditHoursEarned N The credits earned in the student's primary program of study.
15 primaryMajorId N Student's primary major. Will match Major.id.
16 secondaryMajorId N Student's secondary major. Will match Major.id.

17

primaryCurriculumId

N

The linkage to the curriculum that contains the students’ primary areas of study (primary major and associated studies). Must match an entry in the curriculum data feed.

18

secondaryCurriculumId

N

The linkage to the curriculum that contains the students’ secondary areas of study (secondary major and associated studies). Must match an entry in the curriculum data feed.

19

tertiaryCurriculumId

N

The linkage to the curriculum that contains the students’ tertiary areas of study (secondary major and associated studies). Must match an entry in the curriculum data feed.

20

anticipatedGraduationDate

N

The date the student is expected to graduate.

 

 

Transcript Course

File: transcript_course.csv

Description: Transcript coursework for the student.

Default Pull Frequency: Every 15 minutes.

Position
Name
Required
Description
1 id Y

Primary key of source system.

Recommend appending the institutionPersonId for ease of research/debugging.

Format: -

Example: "P000031691-348761"

2 creditAttempted Y The credit attempted for this course.
3 creditEarned Y The credit earned for this course.
4 midtermGrade N

The midterm grade earned in this course.

5 finalGrade N The final grade earned in this course.
6 courseSectionId Y The course section for this transcript course. Must match course_section.id.
7 transcriptId Y The transcript id for this transcript course. Must match transcript.id
8 transcriptCourseStatusId Y

Must be one of:

  • REGISTERED
  • DROPPED
  • WAITLISTED
  • WITHDRAW-IN-PROGRESS
  • WITHDRAWN
  • DELETED
  • CANCELLED
  • UNKNOWN
9 registeredDate N

The date the student registered for the course.

Format: YYYY-MM-DD HH:MM:SS

10 droppedDate N

The date the student dropped the course.

Format: YYYY-MM-DD HH:MM:SS

11 qualityPointsEarned P The number of quality points the student has earned by way of this course.
12 overrideCourseName N The name of the course if it differs from what is represented through the linkage to Course.name. This field may be used when incoming transfer coursework is recorded at the institution with a name different from the course name at the local institution or when aggregation of course credits occurs which drives generic naming conventions.
13 finalGradeDate N The date of applying the finalGrade.
14 lastAttendedDate N

The date the student last attended this course_section.

This value is optionally provided by an instructor from their SIS Grading Module and when present is only used in Reporting.

15 institutionTranscriptCourseStatusId N

The institutional transcript course status that the transcript course record is associated with. Must match InstitutionTranscriptCourseStatus.id. Currently only used on Reporting.

16 institutionTranscriptCourseStatusDate N

The date of the institutional transcript course status. This date is not used or displayed on the UI.

Note: P = Helpful for Predict

See the Data Feed Guide: Transfer Credits for guidance on how to set up transfer credits and other credit for SS&E.

 

Transcript Course Attendance

File: transcript_course_attendance.csv

Description: Records attendance for a transcript course.

Default Pull Frequency: Every 15 minutes.

Position
Name
Required
Description
1 id Y

Primary key of source system.

Recommend appending the institutionPersonId for ease of research/debugging.

Format: -

Example: "P000000060-2010SUMMERIIIEMS106LECT5020106220000"

2 attendanceDate Y

The date of the attendance of the student. Note that this may differ from the date the actual attendance record was added to the source system.

Format: YYYY-MM-DD

3 attendanceType Y

"ABSENT", "PRESENT", "UNKNOWN", 'ENTRY', 'CANCELLED', 'TARDY', 'EXCUSED', 'NO_ENTRY'

4 transcriptCourseId Y Link to transcript course this attendance record is associated with. Must match TranscriptCourse.id.
5 meetingType N Whether this attendance record is from a Lab, Lecture, etc. Must match CourseSectionScheduleElement.meetingType for attendance records to match in SS&E.
6 courseSectionMeetingId Y Links the attendance record to the course section schedule the attendance record is associated with. Must match an existing CourseSectionScheduleElement.id.

 

Transcript Course Status History

File: transcript_course_status_history.csv

Description: Registration status history over time for a given transcriptCourse (enrollment) record.

Default Pull Frequency: 4:30am, 10:30am, 4:30pm, 10:30pm

Position
Name
Required
Description
1 id Y

Primary key of source system. May also be a derived composite key using the transcriptCourseId and the statusDate.

2 transcriptCourseId Y The transcript course this record belongs to. Must match transcriptCourse.id.
3 transcriptCourseStatusId Y

The transcript course status. 

Must be one of:

  • REGISTERED
  • DROPPED
  • WAITLISTED
  • WITHDRAW-IN-PROGRESS
  • WITHDRAWN
  • DELETED
  • CANCELLED
  • UNKNOWN
4 status N

The status value of the source system, typically the SIS.

5 statusDate N The status date when the status value began.

 

Transcript Degree

File: transcript_degree.csv

Description: Degrees earned by a student at an institution.  If a student has not earned a degree, they should not appear in this file.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y

Primary key of source system.

Recommend appending the institutionPersonId for ease of research/debugging.

Format: -

Example: "P000031691-348761"

2 personId Y Person whom earned the degree. Must match person.id.
3 degreeId N

Degree earned. Must match Degree.id.

4 programId Y Program earned. Must match Program.id.
5 name Y Degree Name/Title.
6 graduationDate Y

Date the award was earned by the student. Format: YYYY-MM-DD HH:MM:SS

Use the date the item was awarded and not the date of a graduation or other ceremony.

7 majorId N Major associated with this award. Must match Major.id.

 

Veteran Type

File: veteran_type.csv

Description: Represents the available Veteran Types for an institution.

Default Pull Frequency: Every 6 hours.

Position
Name
Required
Description
1 id Y Primary key of source system.
2 name Y

VeteranType name to create.

3 description Y

VeteranType description to create

4 integrationId Y

VeteranType integration id or code to create

 

 

Deprecated Data Feeds

The following data feeds were deprecated as these functions are instead done manually in Academic Plan Administration:

  • degreeProgramCategory 
  • degreeProgramRequirement 
  • degreeProgramRequirementCategory 
  • degreeProgramRequirementCompletionLookup 
  • degreeProgramRequirementCourse 
Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more
How to Contact Support
There are many ways to reach out! Click here for our support options.
Watermark Academy
Click to access the Watermark Academy for consultation, training, and implementation companion courses.