Product: Roster Server
Audience: ClassLink Administrator
The following article will guide you through the process of modifying your data in Roster Server in order to begin using the SDS Custom Export template.
First, a preprocessor needs to be set up which will create the desired metadata fields. To do this:
1. Head over to the Preprocessor section and create a new config or edit an existing one to have metadata fields desired from the following list.
A list of all the files needed and their optional metadata fields and their descriptions:
Student.csv
| SDS Field: | OR Mapping: | NOTES: |
| SIS ID | users.sourcedId | REQUIRED |
| School SIS ID | orgs.sourcedId | REQUIRED |
| Username | users.username | REQUIRED |
| Password | users.password | OPTIONAL |
| First Name | users.givenName | OPTIONAL |
| Last Name | users.familyName | OPTIONAL |
| Middle Name | users.middleName | OPTIONAL |
| Secondary Email | users.email | OPTIONAL |
| Student Number | users.`metadata.SDS_Student_Number` | OPTIONAL |
| Grade | users.grades | OPTIONAL |
| State ID | users.`metadata.SDS_State_ID` | OPTIONAL |
| Status | users.status | OPTIONAL |
| Birthdate | demographics.birthDate | OPTIONAL |
| Graduation Year | users.`metadata.yearOfGraduation` | OPTIONAL |
Teacher.csv
| SDS Field: | OR Mapping: | NOTES: |
| SIS ID | users.sourcedId | REQUIRED |
| School SIS ID | orgs.sourcedId | REQUIRED |
| Username | users.username | REQUIRED |
| Password | users.password | OPTIONAL |
| First Name | users.givenName | OPTIONAL |
| Last Name | users.familyName | OPTIONAL |
| Middle Name | users.middleName | OPTIONAL |
| Secondary Email | users.email | OPTIONAL |
| Teacher Number | users.`metadata.SDS_Teacher_Number` | OPTIONAL |
| State ID | users.`metadata.SDS_State_ID` | OPTIONAL |
| Status | users.status | OPTIONAL |
| Title | users.`metadata.SDS_Title` | OPTIONAL |
| Qualification | users.`metadata.SDS_Qualification` | OPTIONAL |
School.csv
| SDS Field: | OR Mapping: | NOTES: |
| SIS ID | orgs.sourcedId | REQUIRED |
| Name | orgs.name | REQUIRED |
| School Number | orgs.`metadata.SDS_School_Number` | OPTIONAL |
| School NCES_ID | orgs.`metadata.SDS_School_NCES_ID` | OPTIONAL |
| Grade Low | orgs.`metadata.SDS_Grade_Low` | OPTIONAL |
| Grade High | orgs.`metadata.SDS_Grade_High` | OPTIONAL |
| State ID | orgs.`metadata.SDS_State_ID` | OPTIONAL |
| Principal SIS ID | orgs.`metadata.SDS_Principal_SIS_ID` | OPTIONAL |
| Principal Name | users.givenName + ' ' + users.familyName | OPTIONAL |
| Principal Secondary Email | users.email | OPTIONAL |
| Address | orgs.`metadata.address1` + ' ' + orgs.`metadata.address2` | OPTIONAL |
| City | orgs.`metadata.city` | OPTIONAL |
| State | orgs.`metadata.state` | OPTIONAL |
| Zip | orgs.`metadata.postCode` | OPTIONAL |
| Country | OPTIONAL | |
| Phone | orgs.`metadata.SDS_Phone` | OPTIONAL |
| Zone | orgs.`metadata.SDS_Zone` | OPTIONAL |
Section.csv
| SDS Field: | OR Mapping: | NOTES: |
| SIS ID | classes.sourcedId | REQUIRED |
| School SIS ID | orgs.sourcedId | REQUIRED |
| Section Name | classes.`metadata.SDS_Section_Name` |
Uses classes.title if metadata field is null REQUIRED |
| Section Number | OPTIONAL | |
| Term SIS ID | academicSessions.sourcedId | OPTIONAL |
| Term Name | academicSessions.title | OPTIONAL |
| Term StartDate | academicSessions.startDate | OPTIONAL |
| Term EndDate | academicSessions.endDate | OPTIONAL |
| Course SIS ID | courses.sourcedId | OPTIONAL |
| Course Name | courses.title | OPTIONAL |
| Course Number | OPTIONAL | |
| Course Description | courses.`metadata.SDS_Course_Description` | OPTIONAL |
| Course Subject | courses.subjects | OPTIONAL |
| Periods | classes.periods | OPTIONAL |
| Status | classes.status | OPTIONAL |
StudentEnrollment.csv
| SDS Field: | OR Mapping: | NOTES: |
| Section SIS ID | classes.sourcedId | REQUIRED |
| SIS ID | users.sourcedId | REQUIRED |
TeacherRoster.csv
| SDS Field: | OR Mapping: | NOTES: |
| Section SIS ID | classes.sourcedId | REQUIRED |
| SIS ID | users.sourcedId | REQUIRED |
Note: For full details on setting up you SDS Data please click HERE.
2. Next, head over to the Imports page and run an import so that the new metadata fields are visible.
3. After importing is complete, we need to add the app of your choice and choose permissions for it.
Note: Make sure to enable demographics in your permissions.
4. After your app permissions are set, go to the Apps page and enable metadata fields in the app we are exporting.
To do this, click on the action menu of your app and choose Filter Fields
In Filter Fields Enable the metadata fields you want by clicking the check mark next to each one. Do this for all the sections.
5. In the Server Details and Authentication Details sections, enter the server details provided by the vendor.
6. Under File Details, specify SDS Custom as your template
7. Enter the Schedule Details.
8. Also in Schedule Details, switch the toggle to Enabled in order for the transfer to take place.
9. Click Save.
10. Click Send Now to initiate the transfer.
