Next step is to set up your SIS to export user data to a folder on the workstation. If your SIS has a feature to export user data regularly on a scheduled basis, please use that tool to set up a regular export. If not, you may need to use a task scheduling tool to automate this part of the process.
Once you have a folder setup on the workstation that receives regular user data exports from the SIS, navigate to that folder, copy and save the folder path (i.e. c:\users\jjones\Desktop\SIS Export). You will need to reference this folder path in the client properties file as the folder that our SIS Sync Client will monitor for any user data to be uploaded.
If possible, please configure your user list to export all the below fields and data for your users into a CSV file:
|Field Name (All field headers must exist in form)||Description|
|first_name||First name of the user|
|middle_name||Middle name of the user (not required)|
|last_name||Last name of the user|
|Email address of the user|
|custom_id||Employee ID/Student ID of the user. This must be unique to that user and is used to identify which account to make changes to|
|school_district_external_id||The external ID of the school or district that the user belongs to|
|user_type||User type must be one of the following: ‘Teacher’, ‘Staff’, ‘Administrator’ or ‘Student’|
|position||This will be applied to any Teacher, Staff,
Administrator type accounts only. This is ignored for students. (not required)
|grade||This will be applied for students only and ignored for all other user types. If not supplied for a student, they will be listed as ‘Unspecified’. Grade must be one of the following: 'Unspecified', ‘PreK’,
‘K’, ‘1’, ‘2’, ‘3’, ‘4’, ‘5’, ‘6’, ‘7’, ‘8’, ‘9’, ‘10’,
‘11’, ‘12’ or 'Other'
|status||Status must be ‘Active’ or ‘Disabled’|
If you are unable to export these column headers, you will need to specify the use of our column header mapper plugin in the client properties file, specify any fields that differ from the above and map it to the corresponding eChalk format for the fields. You can refer to steps 7 and 8 here for how to map the fields that differ in the client properties file.