How do I format CSV files to upload SIS data in a Gauge account?

Document created by Canvas Doc Team Employee on Jan 16, 2019Last modified by Canvas Doc Team Employee on May 2, 2019
Version 6Show Document
  • View in full screen mode

Gauge allows you to manually update SIS data in your account using CSV files. The following CSV files are supported: users.csv, sections.csv, enrollments.csv, and change_sis_id.csv. To upload to a Gauge account, these files must be zipped together in an unencrypted file containing a flat list of CSVs.

Each CSV file is symbiotic with another and tells Canvas how to manage all information for the account. The change_sis_id.csv file is always imported first.

CSV File Format

In order to bulk upload data into Canvas, you must create one or more CSV text files. CSV files can be generated by many programs. Student Information Systems (SIS) often have a method for generating reports in CSV format that can be modified to fit the format Gauge requires.

If you do not know how to save a file in a CSV format, please check the documentation for the program you are using to create your CSV file (e.g., Excel).

CSV Field Formatting

The first row of the CSV file 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. (e.g., James "Jim" Anderson should be formatted as "James ""Jim"" Anderson".)

All text should be UTF-8 encoded.

users.csv

CSV Fields:

  • user_id*:  A unique identifier used to reference users in the enrollments table. This identifier must not change for the user, and must be globally unique. In the user interface, this is called the SIS ID.
  • full_name*: Full name of the user.
  • email*:  The email address of the user.
  • status*:  Mark as active to add a user or deleted to remove an existing user. When a user is deleted, it will delete the login tied to the sis_id. If the login is the last one, all of the users enrollments will also be deleted and they won't be able to log in to the school's account.
  • Custom properties: Custom properties can be added to the users.csv to reflect student demographic data. Common custom properties include grade, gender, race, ethnicity, DOB, student number, etc. To add a custom property, the column heading format is property:PropertyName.

 * = Required Field

Users CSV Example

  Users CSV Example

sections.csv

CSV Fields:

  • section_id*:  A unique identifier used to reference sections in the enrollments data. This identifier must not change for the section, and must be globally unique. In the user interface, this is called the SIS ID.
  • name*:  The name of the section.
  • status*:  Mark as active to create a section or deleted to remove an existing section.
  • Custom properties: Custom properties can be added to the sections.csv, such as subject, course name, etc. To add a custom property, the column heading format is property:PropertyName.

* = Required Field

Sections CSV Example

Sections CSV Example

enrollments.csv

Required Field*

  • user_id*:  The user identifier from users.csv, required to identify user.
  • role*:  Can be set to student or teacher.
  • section_id*: The section identifier from sections.csv, if none is specified the default section for the course will be used.
  • status*: Mark as active to enroll a user in a course and deleted to remove a user from a course.

* = Required Field

Enrollments CSV Example

Enrollments CSV Example

change_sis_id.csv

Required Field*

  • old_id*: The current sis_id of the object that should be changed.
  • new_id*: The desired sis_id of the object.
  • type*: This is the type of object. Type can be section or user.

* = Required Field

Change SIS ID CSV Example

Change SIS ID CSV Example
You are here
Table of Contents > Admins > How do I format CSV files to upload SIS data in a Gauge account?

Attachments

    Outcomes