SDS V1 CSV 文件格式
重要
SDS (经典) 转换客户:并非所有字段都支持将数据引入基于 v1 格式的新 SDS 体验。 你会发现它们已在“必需”列下的“SDS v1 CSV 文件格式”中记录,因为数据不受支持。
重要
此外,通过的 成绩 值和 课程主题 值必须与相应的值列表保持一致 , (ENUM) 代码。 如果需要,请使用 “管理值列表” 展开 “成绩 值 ”和“课程主题” ,以支持默认情况下不支持的代码值。
可以使用 SDS V1 格式的 CSV (逗号分隔值) 文件,将学校信息系统 (SIS) 与Office 365同步。 使用 SDS V1 CSV 文件格式引入以下数据类别,可以照亮用于预配的核心 SDS 功能。 它还有助于增强 Microsoft 365 产品和功能的体验。
如果使用 SDS V1 格式,则必须对文件设置适当的格式。 上传文件,具体命名如下所述。 列标题区分大小写。 CSV 文件必须采用 UTF-8 格式且符合 RFC。 此外,我们不接受传入数据中的换行符。 若要查看和下载 SDS V1 CSV 文件的示例集, 请参阅 SDS GitHub 存储库。
重要
在创建入站流期间进行初始上传后,无论在可选文件中是否进行了数据更改,都需要始终为后续上传提供相同的文件集。 如果不这样做,系统将确定记录不再处于活动状态,并按此类方式对其进行标记。
必需:必须先选择下面列出的三个文件,然后才能继续。 如果只管理用户,而不管理类,则只需提供这些文件。
school.csv
student.csv
teacher.csv
可选/必需:如果仅管理用户,则不需要。 如果同时管理课堂和课堂注册,则需要提供下面列出的三个文件以及上述三个文件。 如果不是,请不要选择任何具有这些名称的文件。
section.csv
studentenrollment.csv
teacherroster.csv
可选:这些操作不需要继续,但可能会增强体验。 如果选择了以下文件之一,还必须选择另一个文件才能继续。
user.csv
guardianrelationship.csv (要求用户和学生记录来生成联系人关联。)
每个 CSV 文件都必须包含“必需”下标有“是”的字段的数据,指出“否”的字段为“可选”数据。 标记为“必需”的字段标头必须存在于提供的文件中,否则它们不会被接受。 如果未传递相应的可选数据,则标记为“可选”的字段标头不需要存在于文件中。
具有“数据类型”列中标记的已定义枚举值的字段具有一组它们支持的特定值。 枚举字段支持的默认值集 请参阅默认值列表。
school.csv
字段 | 是否必需? | 示例 | 数据类型 |
---|---|---|---|
SIS ID | 是 | 456789 | 唯一 ID |
名称 | 是 | Contoso 高中 | String |
学校 NCES_ID | 否 | 456789 | String |
学校编号 | 不支持数据 | ||
低年级 | 不支持数据 | ||
高年级 | 不支持数据 | ||
状态 ID | 不支持数据 | ||
校长 SIS ID | 不支持数据 | ||
主体名称 | 不支持数据 | ||
校长备用电子邮件 | 不支持数据 | ||
地址 | 不支持数据 | ||
市/县 | 不支持数据 | ||
状态 | 不支持数据 | ||
Zip | 不支持数据 | ||
国家/地区 | 不支持数据 | ||
Phone | 不支持数据 | ||
区域 | 不支持数据 |
- 列出的所有组织都将设置为组织类型“school”。
student.csv
字段 | 是否必需? | 示例 | 数据类型 |
---|---|---|---|
SIS ID | 是 | 123456 | 唯一 ID |
学校 SIS ID | 是 | 456789 | 唯一 ID |
用户名 | 是 | jsmith@contoso.edu | String |
名字 | 是 (仅当创建用户) | John | String |
姓氏 | 是 (仅当创建用户) | Smith | String |
中间名 | 否 | 威廉 | String |
备用电子邮件 | 否 | jsmith@contoso.edu | 电子邮件 |
学生编号 | 否 | 123456 | String |
年级 | 否 | 8 | 枚举 |
出生日期 | 否 | 2009-12-19 | 日期 |
状态 | 不支持数据 | ||
Password | 不支持数据 | ||
毕业年份 | 不支持数据 | ||
状态 ID | 不支持数据 |
- 需要使用“学校 SIS ID”字段引用关联的学校。 这会对 school.csv 文件产生依赖项。
- 列出的所有用户都将设置为角色类型“student”。
- 应以ISO8601格式提供日期值。
- 年级级别 ENUM 的传入值上缺少前导零“0”(例如“1”)将与定义的值列表 (ENUM) “01”匹配,并将存储为“01”。
teacher.csv
字段 | 是否必需? | 示例 | 数据类型 |
---|---|---|---|
SIS ID | 是 | 654321 | 唯一 ID |
学校 SIS ID | 是 | 456789 | 唯一 ID |
用户名 | 是 | jcook@contoso.edu | String |
名字 | 是 (仅当创建用户) | 珍 | String |
姓氏 | 是 (仅当创建用户) | 煮 | String |
中间名 | 否 | 梅瑞狄斯 | String |
教师编号 | 否 | 654321 | String |
年级 | 否 | 8 | 枚举 |
备用电子邮件 | 否 | jcook@contoso.edu | 电子邮件 |
状态 | 不支持数据 | ||
Password | 不支持数据 | ||
标题 | 不支持数据 | ||
状态 ID | 不支持数据 | ||
资格 | 不支持数据 |
- 需要使用“学校 SIS ID”字段引用关联的学校。 这会对 school.csv 文件产生依赖项。
- 列出的所有用户都将设置为角色类型“teacher”。
- 年级级别 ENUM 的传入值上缺少前导零“0”(例如“1”)将与定义的值列表 (ENUM) “01”匹配,并将存储为“01”。
section.csv
字段 | 是否必需? | 示例 | 数据类型 |
---|---|---|---|
SIS ID | 是 | 334455 | 唯一 ID |
学校 SIS ID | 是 | 456789 | 唯一 ID |
节名称 | 是 | 第 1 阶段 - 世界历史 | String |
学科编号 | 否 | 334466 | String |
课程 SIS ID | 否 | 123456789 | 唯一 ID |
课程名称 | 否 | 世界历史 10 | String |
课程编号 | 否 | 123456789 | String |
课程说明 | 否 | 世界历史 | String |
课程主题 | 否 | 54999 | 枚举 |
学期 SIS ID | 不支持数据 | ||
学期名称 | 不支持数据 | ||
学期开始日期 | 不支持数据 | ||
学期结束日期 | 不支持数据 | ||
状态 | 不支持数据 | ||
Periods | 不支持数据 |
- 需要使用“学校 SIS ID”字段引用关联的学校。 这会对 school.csv 文件产生依赖项。
- 如果需要术语信息,建议迁移到 SDS v2.1 CSV 格式 ,同时提供 academicSessions.csv 文件。
studentenrollment.csv
字段 | 是否必需? | 示例 | 数据类型 |
---|---|---|---|
节 SIS ID | 是 | 334455 | 唯一 ID |
SIS ID | 是 | 123456 | 唯一 ID |
- 这需要使用“Section SIS ID”字段引用关联的节。 这会对 section.csv 文件产生依赖项。
- 这需要使用“SIS ID”字段引用关联用户。 这会对 student.csv 文件产生依赖项。
teacherroster.csv
字段 | 是否必需? | 示例 | 数据类型 |
---|---|---|---|
节 SIS ID | 是 | 334455 | 唯一 ID |
SIS ID | 是 | 654321 | 唯一 ID |
- 这需要使用“Section SIS ID”字段引用关联的节。 这会对 section.csv 文件产生依赖项。
- 这需要使用“SIS ID”字段引用关联用户。 这会对 teacher.csv 文件产生依赖项。
user.csv
字段 | 是否必需? | 示例 | 数据类型 |
---|---|---|---|
电子邮件 | 是 | jsmith@outlook.com | 电子邮件 |
名字 | 是 | John | String |
姓氏 | 是 | Smith | String |
Phone | 否 | +1234567890 | Phone |
SIS ID | 否 | P_123456 | 唯一 ID |
- 如果同时同步联系人关系 (监护人) ,则必须在 user.csv 中包含他们的记录。
- 应根据 E.164 标准设置电话字段的格式,其中使用加号字符并按电话号码成功,或者更确切地说,加号字符后跟国家/地区代码、区号、电话前缀和行号。
guardianrelationship.csv
字段 | 是否必需? | 示例 | 数据类型 |
---|---|---|---|
SIS ID | 是 | 123456 | 唯一 ID |
电子邮件 | 是 | jsmith@outlook.com | 电子邮件 |
Role | 否 | Parent | 枚举 |
- 如果同时同步联系人关系 (监护人) ,则必须在 user.csv 中包含他们的记录。
- 这需要使用“Email”字段引用关联用户。 这会对 user.csv 文件产生依赖项。
- 这需要使用“SIS ID”字段引用关联用户。 这会对 student.csv 文件产生依赖项。
- 如果未提供 Role 值,则关系值默认为“userContact”。