適用於 School Data Sync 的 CSV 檔案CSV files for School Data Sync

您可以使用 CSV (逗號分隔值) 檔案與 School Data Sync (SDS),同步處理學校資訊系統 (SIS) 與 Office 365。如果您使用這個方法,您將需要六個個別的 CSV 檔案以設定 SDS 中的同步處理設定檔。本主題說明 CSV 檔案及其必要格式。You can use CSV (comma separated value) files with School Data Sync (SDS) to synchronize your School Information System (SIS) with Office 365. If you use this method, you'll need six separate CSV files to set up the synchronization profile within SDS. This topic describes the CSV files and their required formatting.

適用於 School Data Sync 的必要 CSV 檔案Required CSV files for School Data Sync

當使用 CSV 檔案設定 SDS 時,系統管理員必須編譯六個個別的 CSV 檔案,其中包含下述的所有必要屬性。您也可以在六個 CSV 檔案中包含任何選擇性屬性。如需如何在 SDS 中使用 CSV 檔案設定同步設定檔的詳細步驟,請參閱如何使用 CSV 檔案部署 School Data Sync。如需一組 CSV 檔案的範例,該檔案包含範例資料與適當屬性值和格式,請參閱 SDS GitHub 存放庫When configuring SDS using CSV files, administrators must compile six individual CSV files containing all the required attributes detailed below. You may also include any of the optional attributes in the six CSV files as well. For detailed steps for how to setup a sync profile with CSV files in SDS, see How to deploy School Data Sync by using CSV files. For a sample set of CSV files which includes sample data with the appropriate attribute values and formatting, see the SDS GitHub Repository.

CSV 檔案的必要屬性會根據在 SDS 同步處理設定檔設定精靈期間選取的同步處理設定檔選項而有所不同。此外,如果您的 Office 365 租用戶是在英國,六個 CSV 檔案有一些獨特需求,以及它們包含的必要屬性。如需英國需求的詳細資訊,請參閱本文件上的英國 CSV 檔案章節,或者請參閱位於 SDS GitHub 存放庫的英國範例檔案。The required attributes for the CSV files will vary based on the sync profile options selected during the SDS sync profile setup wizard. Also, if your Office 365 tenant is based in the UK, there are some unique requirements for the six CSV files and the required attributes they contain. See the UK CSV Files section of this doc for more detail on the UK requirements, or see the UK Sample files located on the SDS GitHub Repository.

注意

請確定您的 CSV 檔案不包含無效字元。此外,CSV 檔案不能包含超過 500000 個資料列的資料。如果超過 500K 個資料列,您必須將額外的資料列分成另外一組 6 個 CSV 檔案,並建立其他同步處理設定檔來上傳並同步處理它們。Make sure your CSV files don't contain invalid characters. Also, CSV files must not contain more than 500,000 rows of data. If you exceed 500K rows, you must split the additional rows into another set of 6 CSV Files, and create an additional sync profile to upload and sync them.

六個必要的 CSV 檔案是:The six required CSV files are:

注意

這些 CSV 檔案必須具有與顯示一樣的名稱,而且都包含在本機電腦上的相同資料夾或目錄內。這個目錄中不應該有其他檔案存在。此外,針對每個 CSV 檔案在下方顯示的每個屬性名稱,將會在個別的每個 CSV 檔案中設定成標頭。These CSV files must be named exactly as shown, and all be contained within the same folder or directory on the local machine. No other files should exist in this directory. Also, each attribute name shown below for each CSV file will be configured as a header, within each of the respective CSV files.

所有 CSV 檔案都必須包含在相同目錄中

School.csvSchool.csv

School.csv 檔案必須包含這些必要屬性。這些是建立及同步處理 SDS 內學校所需的最小必要屬性。如果未包含這些屬性,檔案可能無法上傳或學校無法正確建立或同步處理,而且後續錯誤將會包含在同步處理設定檔錯誤報告中。The School.csv file must contain these required attributes. These are the minimum required attributes required to create and synchronize a School within SDS. If you do not include these attributes, the file may fail to upload or the school will not create or sync properly, and a subsequent error will be included within the sync profile error report.

  • SIS ID - 學校的 SIS 識別碼。SIS ID- SIS ID of the School.

  • 名稱 - 學校的名稱。Name- Name of the School.

School.csv 的選用屬性Optional attributes for School.csv

School.csv 檔案可能包含任何這些選用屬性。當設定您的同步處理設定檔時,您可以新增下列任何選用屬性,但是每個選取的屬性接著必須包含在對應 CSV 檔案中,作為資料行標頭。這些屬性都必須完全符合以下所述的名稱,包括拼字、大小寫和語法。雖然 SDS 不需要這些欄位,運用 SDS 同步處理資料的任何應用程式可能會使用這些屬性。請務必包括所需的任何/所有屬性,以獲得最佳的應用程式體驗。對於在其各自的應用程式中使用其中哪個屬性的詳細資訊,請洽詢應用程式廠商。您永遠可以視需要在稍後編輯和新增選用屬性到 SDS 中的同步處理設定檔。The School.csv file may contain any of these optional attributes. When setting up your sync profile you can add any of the optional attributes below but each attribute selected must then be included in the corresponding CSV file as a column header. These attributes must match exactly the names detailed below including spelling, capitalization, and syntax. While SDS doesn't require these fields, any applications that leverage SDS synchronized data may use these attributes. Be sure to include any/all attributes needed for an optimal app experience. Ask the app vendor for details on which of these attributes are used within their respective application. You can always edit and add optional attributes to a sync profile in SDS at a later time, if needed.

  • 學校號碼School Number

  • 學校 NCES_IDSchool NCES_ID

  • 縣/市 IDState ID

  • 低年級Grade Low

  • 高年級Grade High

  • 校長 SIS IDPrincipal SIS ID

  • 校長姓名Principal Name

  • 校長次要電子郵件Principal Secondary Email

  • 地址Address

  • 鄉/鎮/市/區City

  • 縣/市State

  • 國家/地區Country

  • 郵遞區號Zip

  • 電話Phone

  • 區域Zone

在 SDS 同步處理設定檔設定精靈的以下螢幕擷取畫面中,顯示為灰色的屬性是必要屬性,顯示的其餘屬性是選用屬性。In the screenshot below from the SDS sync profile setup wizard, the greyed out attributes are required and the remaining attributes shown are optional.

Section.csvSection.csv

Section.csv 檔案必須包含這些必要屬性。這些是建立及同步處理 SDS 內區段所需的最小必要屬性。如果未包含這些屬性,檔案可能無法上傳或區段無法正確建立或同步處理,而且後續錯誤將會包含在同步處理設定檔錯誤報告中。The Section.csv file must contain these required attributes. These are the minimum required attributes required to create and synchronize a Section within SDS. If you do not include these attributes, the file may fail to upload or the Section will not create or sync properly, and a subsequent error will be included within the sync profile error report.

  • SIS ID - 區段的 SIS 識別碼。SIS ID- SIS ID of the Section.

  • School SIS ID - 學校的 SIS 識別碼。School SIS ID- SIS ID of the School.

  • Section Name - 區段的名稱。Section Name- Name of the Section.

Section.csv 的選用屬性Optional attributes for Section.csv

Section.csv 檔案可能包含任何這些選用屬性。當設定您的同步處理設定檔時,您可以新增下列任何選用屬性,但是每個選取的屬性接著必須包含在對應 CSV 檔案中,作為資料行標頭。這些屬性都必須完全符合以下所述的名稱,包括拼字、大小寫和語法。雖然 SDS 不需要這些欄位,運用 SDS 同步處理資料的任何應用程式可能會使用這些屬性。請務必包括所需的任何/所有屬性,以獲得最佳的應用程式體驗。對於在其各自的應用程式中使用其中哪個屬性的詳細資訊,請洽詢應用程式廠商。您永遠可以視需要在稍後編輯和新增選用屬性到 SDS 中的同步處理設定檔。The Section.csv file may contain any of these optional attributes. When setting up your sync profile you can add any of the optional attributes below but each attribute selected must then be included in the corresponding CSV file as a column header. These attributes must match exactly the names detailed below including spelling, capitalization, and syntax. While SDS doesn't require these fields, any applications that leverage SDS synchronized data may use these attributes. Be sure to include any/all attributes needed for an optimal app experience. Ask the app vendor for details on which of these attributes are used within their respective application. You can always edit and add optional attributes to a sync profile in SDS at a later time, if needed.

  • 區段號碼Section Number

  • 條款 SIS IDTerm SIS ID

  • 條款名稱Term Name

  • 條款開始日期Term StartDate

  • 條款結束日期Term EndDate

  • 課程 SIS IDCourse SIS ID

  • 課程名稱Course Name

  • 課程號碼Course Number

  • 課程說明Course Description

  • 課程主題Course Subject

  • 期間Periods

  • 狀態Status

在 SDS 同步處理設定檔設定精靈的以下螢幕擷取畫面中,顯示為灰色的屬性是必要屬性,顯示的其餘屬性是選用屬性。In the screenshot below from the SDS sync profile setup wizard, the greyed out attributes are required and the remaining attributes shown are optional.

Student.csvStudent.csv

Student.csv 檔案必須包含這些必要屬性。這些是建立及同步處理 SDS 內學生所需的最小必要屬性。如果未包含這些屬性,檔案可能無法上傳或學生無法正確建立或同步處理,而且後續錯誤將會包含在同步處理設定檔錯誤報告中。The Student.csv file must contain these required attributes. These are the minimum required attributes required to create and synchronize a Student within SDS. If you do not include these attributes, the file may fail to upload or the Student will not create or sync properly, and a subsequent error will be included within the sync profile error report.

  • SIS ID - 學生的 SIS 識別碼。SIS ID- SIS ID of the Student.

  • School SIS ID - 學校的 SIS 識別碼School SIS ID- SIS ID of the School

  • Username - 學生的使用者名稱Username - Username of the student

如果您在 SDS 同步處理設定檔設定精靈期間選取 [建立與同步處理新的使用者]**** 選項,以下 3 個屬性也是必要屬性。如果您選擇 [同步處理現有的使用者]*,這 3 個屬性不是必要屬性,SDS 無法在 Azure 中覆寫這些屬性,它們已經存在於使用者物件上。If you selected the *Create and Sync New Users option during the SDS sync profile setup wizard, the 3 attributes below are also required. If you chose Sync Existing Users, these 3 attributes are not required, and SDS cannot overwrite these attributes in Azure which will already be present on the user object.

  • First Name - 學生的名字。First Name- First name of the Student.

  • Last Name - 學生的姓氏。Last Name- Last Name of the Student.

  • Password - 學生的密碼。密碼必須遵守 Azure AD 使用者帳戶密碼原則Password- Password for the Student. Passwords must adhere to Azure AD user account password policy.

Student.csv 的選用屬性Optional attributes for Student.csv

Student.csv 檔案可能包含任何這些選用屬性。當設定您的同步處理設定檔時,您可以新增下列任何選用屬性,但是每個選取的屬性接著必須包含在對應 CSV 檔案中,作為資料行標頭。這些屬性都必須完全符合以下所述的名稱,包括拼字、大小寫和語法。雖然 SDS 不需要這些欄位,運用 SDS 同步處理資料的任何應用程式可能會使用這些屬性。請務必包括所需的任何/所有屬性,以獲得最佳的應用程式體驗。對於在其各自的應用程式中使用其中哪個屬性的詳細資訊,請洽詢應用程式廠商。您永遠可以視需要在稍後編輯和新增選用屬性到 SDS 中的同步處理設定檔。The Student.csv file may contain any of these optional attributes. When setting up your sync profile you can add any of the optional attributes below but each attribute selected must then be included in the corresponding CSV file as a column header. These attributes must match exactly the names detailed below including spelling, capitalization, and syntax. While SDS doesn't require these fields, any applications that leverage SDS synchronized data may use these attributes. Be sure to include any/all attributes needed for an optimal app experience. Ask the app vendor for details on which of these attributes are used within their respective application. You can always edit and add optional attributes to a sync profile in SDS at a later time, if needed.

  • 縣/市 IDState ID

  • 次要電子郵件Secondary Email

  • 學生號碼Student Number

  • 年級Grade

  • 狀態Status

  • 郵寄地址Mailing Address

  • 郵寄鄉/鎮/市/區Mailing City

  • 郵寄州/省Mailing State

  • 郵寄郵遞區號Mailing Zip

  • 郵寄緯度Mailing Latitude

  • 郵寄經度Mailing Longitude

  • 郵寄國家/地區Mailing Country

  • 居住地址Residence Address

  • 居住鄉/鎮/市/區Residence City

  • 居住州/省Residence State

  • 居住地郵遞區號Residence Zip

  • 居住地緯度Residence Latitude

  • 居住地經度Residence Longitude

  • 居住國家/地區Residence Country

  • 性別Gender

  • 出生日期Birthdate

  • ELL 狀態ELL Status

  • 美國聯邦所認可的族裔FederalRace

  • 畢業年份Graduation Year

在 SDS 同步處理設定檔設定精靈的以下螢幕擷取畫面中,顯示為灰色的屬性是必要屬性,顯示的其餘屬性是選用屬性。In the screenshot below from the SDS sync profile setup wizard, the greyed out attributes are required and the remaining attributes shown are optional.

Teacher.csvTeacher.csv

Teacher.csv 檔案必須包含這些必要屬性。這些是建立及同步處理 SDS 內教師所需的最小必要屬性。如果未包含這些屬性,檔案可能無法上傳或教師無法正確建立或同步處理,而且後續錯誤將會包含在同步處理設定檔錯誤報告中。The Teacher.csv file must contain these required attributes. These are the minimum required attributes required to create and synchronize a Teacher within SDS. If you do not include these attributes, the file may fail to upload or the Teacher will not create or sync properly, and a subsequent error will be included within the sync profile error report.

  • SIS ID - 教師的 SIS 識別碼。SIS ID- SIS ID of the Teacher.

  • School SIS ID - 學校的 SIS 識別碼。School SIS ID- SIS ID of the School.

  • Username - 教師的使用者名稱Username - Username of the Teacher

如果您在 SDS 同步處理設定檔設定精靈期間選取 [建立與同步處理新的使用者]**** 選項,以下 3 個屬性也是必要屬性。如果您選擇 [同步處理現有的使用者]*,這 3 個屬性不是必要屬性,SDS 無法在 Azure 中覆寫這些屬性,它們已經存在於使用者物件上。If you selected the *Create and Sync New Users option during the SDS sync profile setup wizard, the 3 attributes below are also required. If you chose Sync Existing Users, these 3 attributes are not required, and SDS cannot overwrite these attributes in Azure which will already be present on the user object.

  • First Name - 教師的名字。First Name- First Name of the Teacher.

  • Last Name - 教師的姓氏。Last Name -Last Name of the Teacher

  • Password - 教師的密碼。密碼必須遵守 Azure AD 使用者帳戶密碼原則Password- Password for the Teacher. Passwords must adhere to Azure AD user account password policy.

Teacher.csv 的選用屬性Optional attributes for Teacher.csv

Teacher.csv 檔案可能包含任何這些選用屬性。當設定您的同步處理設定檔時,您可以新增下列任何選用屬性,但是每個選取的屬性接著必須包含在對應 CSV 檔案中,作為資料行標頭。這些屬性都必須完全符合以下所述的名稱,包括拼字、大小寫和語法。雖然 SDS 不需要這些欄位,運用 SDS 同步處理資料的任何應用程式可能會使用這些屬性。請務必包括所需的任何/所有屬性,以獲得最佳的應用程式體驗。對於在其各自的應用程式中使用其中哪個屬性的詳細資訊,請洽詢應用程式廠商。您永遠可以視需要在稍後編輯和新增選用屬性到 SDS 中的同步處理設定檔。The Teacher.csv file may contain any of these optional attributes. When setting up your sync profile you can add any of the optional attributes below but each attribute selected must then be included in the corresponding CSV file as a column header. These attributes must match exactly the names detailed below including spelling, capitalization, and syntax. While SDS doesn't require these fields, any applications that leverage SDS synchronized data may use these attributes. Be sure to include any/all attributes needed for an optimal app experience. Ask the app vendor for details on which of these attributes are used within their respective application. You can always edit and add optional attributes to a sync profile in SDS at a later time, if needed.

  • 縣/市 IDState ID

  • 教師號碼Teacher Number

  • 狀態Status

  • 次要電子郵件Secondary Email

  • 職稱Title

  • 資格Qualification

在 SDS 同步處理設定檔設定精靈的以下螢幕擷取畫面中,顯示為灰色的屬性是必要屬性,顯示為藍色的其餘屬性是選用屬性。In the screenshot below from the SDS sync profile setup wizard, the greyed out attributes are required and the remaining attributes shown in blue are optional.

StudentEnrollment.csvStudentEnrollment.csv

StudentEnrollment.csv 檔案必須包含這些必要屬性。這些是將學生新增至 SDS 內區段所需的最小必要屬性。如果未包含這些屬性,檔案可能無法上傳或 Studentenrollment 對應無法正確建立或同步處理,而且後續錯誤將會包含在同步處理設定檔錯誤報告中。The StudentEnrollment.csv file must contain these required attributes. These are the minimum required attributes needed to add a student to a section within SDS. If you do not include these attributes, the file may fail to upload or the Studentenrollment mapping will not create or sync properly, and a subsequent error will be included within the sync profile error report.

  • Section SIS ID - 區段的 SIS 識別碼。Section SIS ID- SIS ID of the Section.

  • SIS ID - 學生的 SIS 識別碼。SIS ID- SIS ID of the Student.

TeacherRoster.csvTeacherRoster.csv

TeacherRoster.csv 檔案必須包含這些必要屬性。這些是將教師新增至 SDS 內區段所需的最小必要屬性。如果未包含這些屬性,檔案可能無法上傳或 TeacherRoster 對應無法正確建立或同步處理,而且後續錯誤將會包含在同步處理設定檔錯誤報告中。The TeacherRoster.csv file must contain these required attributes. These are the minimum required attributes needed to add a Teacher to a Section within SDS. If you do not include these attributes, the file may fail to upload or the TeacherRoster mapping will not create or sync properly, and a subsequent error will be included within the sync profile error report.

  • Section SIS ID - 區段的 SIS 識別碼。Section SIS ID- SIS ID of the Section.

  • SIS ID - 教師的 SIS 識別碼。SIS ID- SIS ID of the Teacher.

英國 CSV 檔案UK CSV Files

如果使用位於英國之 Office 365 租用戶適用的 CSV 檔案啟用 School Data Sync,在上述的必要屬性與英國的 CSV 檔案必要屬性之間有一些差異。以下摘要詳述英國的 CSV 檔案之所有必要屬性。上述所有選用屬性在英國結構描述底下維持相同。If enabling School Data Sync using CSV files for an Office 365 tenant based in the UK, there are a few differences between the required attributes noted above, and the required attributes for the UK based CSV files. The summary below details all the required attributes for UK based CSV files. All optional attributes noted above remain the same under the UK schema.

School.csvSchool.csv

  • DfE number - 學校的 DfE 號碼DfE number - DfE Number of the School

  • Name - 學校的名稱Name - Name of the School

Section.csvSection.csv

  • ID - 區段的識別碼ID - ID of the Section

  • School DfE number - 學校的 DfE 號碼School DfE number - DfE Number of the School

  • Section Name - 區段的名稱Section Name - Name of the Section

Student.csvStudent.csv

  • ID - 學生的識別碼ID - ID of the Student

  • School DfE number - 學校的 DfE 號碼School DfE number - DfE Number of the School

  • Username - 學生的使用者名稱Username - Username of the Student

Teacher.csvTeacher.csv

  • ID - 教師的識別碼ID - ID of the Teacher

  • School DfE number - 學校的 DfE 號碼School DfE number - DfE Number of the School

  • Username - 教師的使用者名稱Username - Username of the Teacher

StudentEnrollment.csvStudentEnrollment.csv

  • Section ID - 區段的識別碼Section ID - ID of the Section

  • ID - 教師的 SIS 識別碼ID - SIS ID of the Teacher

TeacherRoster.csvTeacherRoster.csv

  • Section ID - 區段的識別碼Section ID - ID of the Section

  • ID - 教師的識別碼ID - ID of the Teacher

School Data Sync 的概觀Overview of School Data Sync

如何使用 CSV 檔案部署 School Data SyncHow to deploy School Data Sync by using CSV files