Microsoft School Data Sync API v2.1

Microsoft School Data Sync (SDS) Integration Details

*Data Gateway Directory

This is the folder location in which the .csv files will be saved.

This will need to be set up by your schools IT staff and can either be:

• A local folder on your TASS web server, e.g. C:\SDS

• A shared network location, e.g. \\server\SDS

If your school uses TASS Cloud, please submit a Technical Services Support Ticket to have this directory created for you.

Include Timetabled Classes Only

Check this box to prevent the .csv files from including subject classes that have not been timetabled.

Enable SDS

Tick this checkbox to enable the Microsoft SDS CSV program to run at regular intervals (once every day) via a scheduled task. 

Untick to prevent Scheduled Tasks from generating CSV files.

The default run time is 1:20AM.  During this run, the program will build all required CSV files, then place the files into the required ‘Data Gateway Directory’ defined above.

Org.csv Options

*Org SIS ID

Enter a unique identifier to identify your school or TASS company within your Office 365 tenancy.

If you're configuring SDS for multiple companies, ensure each company has a unique SIS ID.

Classes.csv Options

*Classes SIS ID Field Order

This field is used to determine how Classes are created (i.e. Office 365 'Groups' and their members).

For example, if you nominate 'Year Group' and 'Subject Code', a Section (Group) will be created for all students and teachers, across all classes for each Year Group and Subject Code.

If you require your Classes (groups) to be broken-down further by Class, make sure you select an option that includes Class.

If your school does not run a unitised timetable, you must select an option that includes 'Year Group'.

To include Subject data in the sync, the 'Include in Data Sync' option must be set to 'Yes' on the 'Subjects' tab in TASS.web program Student Admin > Student Records > Setup Information > Student Records Setup.

*Classes Term Method

Use this field to determine whether Classes (Groups) will be created for the current ‘Year’ or ‘Year and Semester’.

*Classes Term Year

Must be the same as the current Timetable Year.

Classes Term Semester/Term

(This is a *mandatory field if ‘Classes Term Method’ is set to ‘Year and Semester’)

Must be the same as the current Timetable Semester/Term.

This field must be populated if you've selected 'Year and Semester' as the 'Section Term Method'.

The ‘Semester/Term’ component of this field name may differ based on terminology set up by your school in TASS.web program Student Admin > Student Records > Setup Information > Student Records Setup.

*Classes Term Start Date

If the ‘Classes Term Method' section is set to 'Year', enter the first day of the school year.

If the ‘Classes Term Method' section’ is set to 'Year and Semester', enter the first day of the current Timetable Semester/Term.

*Classes Term End Date

If the ‘Classes Term Method' section is set to 'Year', enter the last day of the school year.

If the ‘Classes Term Method' section is set to 'Year and Semester', enter the last day of the current Timetable Semester/Term.

Include Timetables

Use the drop-down list to select which timetables you wish to include.

Only Timetables from the ‘Year’ or ‘Year and Semester’ selected above will be displayed.

This is a multi-select field. Holding down the 'Shift' key while clicking on your options enables a range selection, holding down the 'Ctrl' key allows individual selection of additional fields.

Users.csv Options

*Student SIS ID Field

This field is used to determine how individual students are identified in the .csv files that are generated. If you are unsure, select 'Student Code'.

If LDAP data is missing, a yellow alert icon will appear.  Click on the hyperlinked text next to the icon for more information.

*Student Username Field

This field is used to identify a student in Office 365. If you are unsure, select 'Email Address'.

If LDAP or Email Address data is missing, a yellow alert icon will appear.  Click on the hyperlinked text next to the icon for more information.

Include Students in Years

Use the drop-down list to select which Year Levels to include.

This is a multi-select field. Holding down the 'Shift' key while clicking on your options enables a range selection, holding down the 'Ctrl' key allows individual selection of additional fields.

Include Students in Campuses

Use the drop-down list to select which Campuses to include.

This is a multi-select field. Holding down the 'Shift' key while clicking on your options enables a range selection, holding down the 'Ctrl' key allows individual selection of additional fields.

*Teacher SIS ID Field

This field is used to determine how individual teachers are identified in the .csv files that are generated. If you are unsure, select 'Employee Code'.

*Teacher Username Field

This field is used to identify a teacher in Office 365. If you are unsure, select 'Email Address'.

Relationships.csv Options

Enable creation of Parent and Guardian relationship files

Tick this checkbox to enable ‘Relationships.csv’ to be created.  

Communication Type for Parent/Guardian Email

(This is a *mandatory field if the ‘Enable creation of Parent and Guardian relationship files’ checkbox is ticked)

Use the drop-down list to select which Parent/Guardian Email Address to use.

If Parent Email Address data is missing, a yellow alert icon will appear.  Click on the hyperlinked text next to the icon for more information.

Permission 

View 

Add 

Edit 

Delete 

 --- Microsoft SDS

X 

X