Home > Site Administrators > Help And References > Manage User Accounts > SIS Sync Client > 1. Prerequisites for using the SIS Sync Client

1. Prerequisites for using the SIS Sync Client


Before you can use the SIS Sync Client to manage your users, there is a small amount of prep work that needs to be completed, similar to using the bulk user user management feature within the eChalk application.


I. Specify an external ID for each school within your district 


Every school or district that you wish to manage using the bulk tools requires an external ID that is unique within your school system. This is often the Building ID from your SIS, but you can choose whatever you’d like so long as no two schools have the same ID.


Where To Go 


To set this external ID for each building, navigate to the school or district you wish to manage, click on Settings.



What To Do 


  1. Click on Settings.
  2. Click on Edit.
  3. Add or update the external ID so that it matches the building ID or other identifier for the school or district.
  4. Click Update.


II. Ensure that each user has an Employee or Student ID  



Every user that you wish to manage via bulk management MUST have an employee ID or student ID supplied in their profile. This ID must be unique within your school system. If you created these users without them, you will have to update them manually, one account at a time, in order to add their IDs.  Any account without an Employee ID/Student ID cannot be managed by the bulk management tools. 


Where To Go 


To set the Employee ID/Student ID for an account, navigate to the school or district you wish to manage, click on Members > User Admin.



What To Do 


  1. Search for the user and check the box next to their name.
  2. Click Edit User Info.
  3. Enter their unique identifier in the EmployeeID/StudentID box.
  4. Hit Save Changes.


III. Ensure that your SIS can export in the following column field formats


If your SIS cannot export data with the following fields, you will need to specify the use of our column header mapper plugin:


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 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’


Questions? Contact your site administrator or eChalk Support at support@echalk.com.

Last modified


This page has no custom tags.


This page has no classifications.