Use the table below to format your users.csv file. Each row in the users.csv file represents one user. You can view an example of the users.csv file in CSV form or the users.csv file in spreadsheet form.
Blue rows denote required fields.
|Field Header||Quaver Requires?||Format (max chars)||Description/Guidance|
|sourcedId||yes||string (75)||The primary key. This value should assign a unique ID to each user. User sourcedIds will be used in other files to reference each unique user listed here. This value must be unique for every row in this file.|
|status||no||string (0)||Leave this field blank. This should appear as two consecutive commas in the .csv file: ,,|
|dateLastModified||no||date (0)||Leave this field blank. This should appear as two consecutive commas in the .csv file: ,,|
|orgSourcedIds||no||string (75)||The sourcedId of the organization(s) to which this user belongs. This value must reference a sourcedId in the orgs.csv file. Typically the user will only belong to one organization, but if the user belongs to multiple organizations you may list multiple values separated by commas and enclose the entire set with double quotes. For Example: “123456, 654321”.|
|role||yes||string (13)||Describes the role of the user within the institution. Each value MUST be one of the following: teacher | student | parent | guardian | relative | aide | administrator|
|username||no*||string (50)||This is usually the user’s district username. This value will not have any bearing on the username used to access the Quaver site.|
|userId||no*||string (200)||External machine readable ID (for example, LDAP, id, LTI id) for this user, to be used if the sourcedId should not be used.|
|givenName||yes||string (30)||User’s first name. This value is used to identify students in the teacher’s grade book.|
|familyName||yes||string (50)||User’s last name. This value is used to identify students in the teacher’s grade book.|
|identifier||no||string (200)||Identifier for the user with a human readable meaning.|
|no*||string (240)||Email address for the user. We will not send advertisements to this address. We will only send critical communications regarding the account.|
|sms||no||string (20)||SMS address for the user.|
|phone||no||string (20)||Phone number for the user.|
|agents||no||string (200)||sourcedIds of the users to which this user has a relationship. (In most cases this will be for indicating parental relationships.) If this user has a relationship to multiple other users, you may list multiple values separated by commas and enclose the entire set with double quotes. For example: “123456, 654321” .|
*These fields are not required unless they contain unique values that match the incoming SSO attribute value for that user. An incoming SSO user must be matched to a user in the users.csv file. The SSO attribute value can match the sourcedId, username, userId, or email value in the users.csv file.