Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

If your institution does not have an SIS, or does not wish to synchronize data through Clever, you can manually import all of your class roster information using CSV formatted text files. Engage supports direct data import. The files you must create are: students; teachers; and, classes. There are two forms of these files - a "full" set for initially entering large amounts of data, and an "incremental" or "update" set for entering changes to the data that exists. The formats for these files is as shown below:
Each file is a CSV-formatted file with a header row. In the header, you have to specify which fields you want to insert/update for each of the records. The default for all values is an empty string.




You have three different entities for which you can import/update instances in the database. Below is the format for these:
Student Entity Fields
username (ID, required): username used for logging in
password: password used for authentication
email
first_name
last_name
district
school
birth_date (ISO encoded date)
grade


Teacher Entity Fields
username (ID, required): username used for logging in
password: password used for authentication
email
first_name
last_name
district
school
title


Classes Entity Fields
class_id (ID, required)
owner (required)
district
school
name
description
grade
start_date
end_date
students: a '|' (pipe) - separated list of student usernames

Importing the csv files into the Engage server
The process of importing the data into the Engage server is done through the command line. Either at the Engage VM itself, or remotely, using ssh, you enter the following command sequence: unmigrated-wiki-markup




Code Block
engage-control synchronize_engage --classes <classes.csv> --teachers <teachers.csv> --students <students.csv> \[--full|--incremental\]


Where:


  • --<classes.csv> gives the path to the CSV file that defines the classes to import
  • < teachers.csv> gives the path to the CSV file that defines the teachers to import
  • < students.csv> gives the path to the CSV file that defines the students to import
  • --full or --incremental (default is --full): The full sync is handled so that a record that is in the DB but not in the file is marked as inactive (for later deletion). An incremental sync is just updating or inserting records without touching the ones that are not referenced.

...