CircleIn CSV Import Files - V1

CircleIn uses imported CSV data to link your students, faculty and admin to their appropriate courses. This data is passed as standard CSV.

Version 1

Standard CSV rules apply:

  • The first row will be interpreted as a header defining the ordering of your columns. This header row is mandatory.
  • Fields that contain a comma must be surrounded by double-quotes.
  • Fields that contain double-quotes must also be surrounded by double-quotes, with the internal double-quotes doubled. Example: Chevy “The Man” Chase would be included in the CSV as “Chevy ““The Man”” Chase”.
  • All text should be UTF-8 encoded.

In addition, the following CircleIn-specific rules also apply:

  • The name, case, and order of the columns is important. Please use the same header column names and formatting shown in the templates.
  • Unknown columns are not allowed
  • Empty columns and rows are not allowed
  • Date fields must use one of the following formats:
    • YYYY-mm-dd
    • YYYY.mm.dd
    • YYYY/mm/dd
    • mm-dd-YYYY
    • mm.dd.YYYY
    • mm/dd/YYYY

Courses.csv

Field Name Data Type Required Description
Unique Course/Section Identifier text ✓ This is the unique identifier for the course. This unique identifier must be globally unique and should not change. This value, along with the `Term` column should form a globally unique identifier. The enrollments.csv will reference this value.
Term text ✓ A string representing the term the course is attached to.
Session text ✓ This can be used to indicate the session that the course belongs to.
Subject/Department text ✓ This would indicate the department or academic unit offering the course.
Catalog Number text ✓ This is the course number
Section Name text ✓ This is the section name
Full Course Name text ✓ The full Course Name
Enrollment Count integer ✓ Leave this field as 0. Will be deprecated
Term Length integer ✓ Leave this field as 0. Will be deprecated
Start Date date ✓ The start date of the course. Do not include a time stamp. Time stamp defaults to 00:00 of the institution’s timezone (beginning of the day).
End Date date ✓ The start date of the course. Do not include a time stamp. Time stamp defaults to 00:00 of the institution’s timezone (beginning of the day).
Status enum ✓ Available, Deleted

Sample CSV:

Unique Course/Section Identifier,Term,Session,Subject/Department,Catalog Number,Section Name,Full Course Name,Enrollment Count,Term Length,Start Date,End Date,Status
202105-6038,202105,I,ART,222,1,Graphic Arts 1,0,0,05.24.2021,07.02.2021,Available

Enrollments.csv

Schema, info here.

Field Name Data Type Required Description
Unique Course/Section Identifier text ✓ This is the unique identifier for the course in which to enroll this user
Term text ✓ Should match the term of the course in which this enrollment is placed
Role enum ✓ All roles are case-sensitive.
Standard Role labels
Student
Student, student
Teacher
teacher,faculty,tutor
Tutor
  • Tutor
  • tutor
  • Peer Leader
  • Peer Tutor
  • SI Leader
  • Tutor
  • Orientation Leader
  • Summer Bridge Program Leader
  • FYE Leader
  • School Leader
  • Student Leader
Unique User Identifier text ✓ The unique identifier for the user. This identifier is used to match users when using Single Sign On (i.e. SAML). If `First Name`, `Last Name`, `Email` are ommitted from a record (recommended) then this links to a user created via `Users.csv` files.
First Name text The user’s first name
Last Name text The user’s last name
Email text The user’s email address. This must be unique
Status enum ✓ Active, Deleted

Sample CSV

Unique Course/Section Identifier,Term,Role,Unique User Identifier,First Name,Last Name,Email,Status
202105-6038,202105,student,500098043,Laurel,Artz,l_artz@example.edu,Active
202105-6038,202105,student,500043003,Cassin,Blombidy,c_blombidy@example.edu,Active

Update ID’s CSV

This CSV allows you to make changes to the main identifiers of the courses and enrollments CSVs - Unique Course/Section Identifier and Unique User Identifier. It is recommended to only use this CSV when making a transition to a new setup, or correcting an error with the initial setup. After making these changes the enrollments and courses CSV IDs will need to match the updated values in new_id.

Field Name Data Type Required Description
old_id text ✓ The current ID in CircleIn’s database to be changed.
new_id text ✓ The updated ID that will be used moving forward. This must be unique.
obj_type text ✓ Course, User

This defines which ID you wish to target.

Automating SIS Imports

Upon successful validation of the initial CSV files during the implementation phase, automated imports will be enabled. From then on, any file uploaded to CircleIn’s system (via SFTP by default) will be processed automatically.