Instructions
-
Review the data fields supported by the Naviance and OneRoster integration. Note the required data field and determine any additional data fields to import for staff or students.
-
Export a users file from your SIS in CSV format with the filename users.csv. Make sure the column headers in your file match the headers listed in the table.
-
Complete the pre-integration preparation steps.
-
Create a ZIP file using the following naming convention: NavianceOneRoster.zip
To import both teachers and staff, the User file must include metadata.title or metadata.positiontitle.
|
Column header |
Requirement |
Details |
|---|---|---|
|
sourceID |
Required |
The unique ID for the user. SourcedId is used in other files and must be unique across all users. Staff associated with multiple schools should have comma separated values |
|
enabledUser |
Required |
Accepted values are true or false. Denotes that the user is an active record, but system access is curtailed according to the local administration rules. |
|
orgSourcedIds |
Required |
The sourceIds of the Orgs to which this user belongs |
|
role |
Required |
Includes the role of users, either student, administrator, or teacher. |
|
username |
Required |
The user’s username. |
|
userIds |
Optional |
The external machine-readable ID for this user. The ID must be accompanied by a type to indicate the nature of the Identifier. The Type and ID values are enclosed in {} with a colon used to separate the values. If more than one userId is needed, use double quotes and separate with commas. |
|
givenName |
Required |
The user’s first name. |
|
familyName |
Required |
The user’s surname. |
|
middleName |
Optional |
The user’s middle name. If more than one, separate them by a space. |
|
identifier |
Optional |
The user’s identifier with a human readable meaning. |
|
|
Optional |
The user’s email. |
|
sms |
Optional |
The user’s SMS address. |
|
agentSourceIds |
Optional |
The sourcedIds of the users to which this user has a relationship. If multiple IDs are required, then use double quotes and separate with commas. |
|
grades |
Optional |
The grades for which a user with the student role is enrolled. The permitted vocabulary is from CEDS, version 5, for the Entry Grade Level element. |
|
password |
Optional |
The user’s password. This may or may not be an encrypted string. If encrypted, the system processing must be aware of the encryption method. |