SDS V2.1 CSV ファイル形式
SDS V2.1 形式の CSV (コンマ区切り値) ファイルを使用して、学校情報システム (SIS) をOffice 365と同期できます。 SDS V2.1 CSV ファイル形式を使用してデータ カテゴリを取り込むため、プロビジョニング用のコア SDS 機能を明るくすることができます。 また、Microsoft 365 の製品と機能のエクスペリエンスを強化するのにも役立ちます。 SDS V2.1 CSV ファイル形式は、引き続きサポートされるデータ カテゴリを拡張します。
SDS V2.1形式を使用している場合は、ファイルを適切にフォーマットする必要があります。 詳細とまったく同じ名前のファイルをアップロードします。 列ヘッダーでは、大文字と小文字が区別されます。 CSV ファイルは UTF-8 形式で、RFC に準拠している必要があります。 また、受信データの改行は受け付けられません。 SDS V2.1 CSV ファイルのサンプル セットを確認してダウンロードするには、 SDS GitHub リポジトリを参照してください。
重要
受信フローの作成時に最初にアップロードした後は、オプションのファイルで行われたデータの変更に関係なく、後続のアップロードに同じファイルセットを常に指定する必要があります。 そうでない場合は、レコードがアクティブでなくなったとシステムによって判断され、そのようにマークされます。
必須: 次の 3 つのファイルを指定する必要があります。 クラスではなくユーザーのみを管理している場合は、これらのファイルのみを指定する必要があります。
orgs.csv
users.csv
roles.csv
省略可能/必須: ユーザーのみを管理している場合、次の 2 つのファイルは必要ありません。 クラスとクラスの登録も管理している場合は、上記の 3 つのファイルと共に、以下に示す 2 つのファイルを指定する必要があります。
classes.csv
enrollments.csv
省略可能: 次のファイルは省略可能であり、エクスペリエンスを強化するために使用されます。 上記のファイルに以下のメモに基づくデータ参照がない限り、これらのファイルは必要ありません。
academicSessions.csv (roles.csv、classes.csv、または courses.csv に学術セッション データが含まれている場合は、データを処理するときにエラー メッセージを回避するために、対応するデータを指定する必要があります)。
courses.csv (classes.csv データにコースへのリンクが含まれている場合は、データを処理するときにエラー メッセージを回避するために、対応するデータを指定する必要があります)。
demographics.csv
userFlags.csv
relationships.csv
各 CSV ファイルには、[必須] の [はい] と書き込まれたフィールドのデータが含まれている必要があります。"いいえ" と書き込まれたフィールドは "省略可能" のデータです。 "必須" としてマークされたフィールド ヘッダーは、指定されたファイルに存在する必要があります。または、受け入れられません。 "省略可能" としてマークされたフィールド ヘッダーは、対応する省略可能なデータを渡さない場合、ファイルに存在する必要はありません。
[データ型] 列でマークされている定義済みの列挙値を持つフィールドには、サポートされている特定の値のセットがあります。 Enum フィールドでサポートされている既定値のセットについては 、「値の既定の一覧」を参照してください。
orgs.csv
| フィールド | 必須 | 例 | データ型 |
|---|---|---|---|
| sourcedId | はい | 10001 | 一意な ID |
| name | はい | 工学部 | String |
| type | はい | カレッジ | 列挙 |
| parentSourcedId | いいえ | 10000 | 一意な ID |
users.csv
| フィールド | 必須 | 例 | データ型 |
|---|---|---|---|
| sourcedId | はい | 14001 | 一意な ID |
| username | はい | cbeane@domain.com | String |
| familyName | はい (ユーザーを作成する場合のみ) | クレイグ | String |
| givenName | はい (ユーザーを作成する場合のみ) | ビーン | String |
| activeDirectoryMatchId | いいえ | craig.beane@domain.com | String |
| メール | いいえ | cbeane@domain.com | 電子メール |
| phone | いいえ | +1234567890 | Phone |
| sms | いいえ | +1234567890 | Phone |
| userNumber | いいえ | 14001 | String |
- "一致しないユーザーの作成" オプションを使用する場合は、familyName と givenName がユーザーに必要です。
- familyName、givenName、および電子メールは、relationships.csv で連絡先関係の役割を持つユーザーの "学生の連絡先の関連付け" のオプションを使用する場合は、ユーザーに必要です。 スタッフであるだけでなく、連絡先でもあるユーザーは、プライベート メール アドレスに関連付けられた連絡先ユーザー レコードを含む 2 つのユーザー レコードを一覧表示することをお勧めします。
- プラス記号が使用され、電話番号によって成功する E.164 標準に基づいて、電話と SMS のフィールドの書式が設定されることを想定しています。または、プラス記号の後に国コード、市域コード、電話番号、および行番号が続きます。
- password は、新しいユーザーを作成するための既定のパスワードを指定するために使用されなくなりました。
roles.csv
| フィールド | 必須 | 例 | データ型 |
|---|---|---|---|
| userSourcedId | はい | 14001 | 一意な ID |
| orgSourcedId | はい | 10001 | 一意な ID |
| role | はい | student | 列挙 |
| sessionSourcedId | いいえ | FS2021 | 一意な ID |
| grade | いいえ | PS1 | 列挙 |
| isPrimary | いいえ | true | ブール型 |
| roleStartDate | いいえ | 2020-08-24 | Date |
| roleEndDate | いいえ | 2020-12-11 | Date |
- 'userSourcedId' フィールドを使用して、関連付けられているユーザーへの参照が必要です。 これにより、users.csv ファイルへの依存関係が生成されます。
- 'orgSourcedId' フィールドを使用して、関連付けられている組織への参照が必要です。 これにより、orgs.csv ファイルへの依存関係が生成されます。
- 渡された場合: "sessionSourcedId" フィールドを使用して、関連付けられている用語 (アカデミック セッション) への参照が必要です。 これにより、academicSessions.csv ファイルへの依存関係が生成されます。
- isPrimary は、このロールがその組織のプライマリ (true) またはセカンダリ (false) ロールであるかどうかを示します。複数のロールを渡す場合、同じユーザーと同じ組織に対して、各組織に対して 1 つのプライマリ ロールのみが (true) に設定されている必要があります。
- ISO8601形式で指定する日付値。
- グレード レベル ENUM の受信値に先頭のゼロ '0' が見つからない (例: '1') は、定義された値のリスト (ENUM) '01' と一致し、'01' として格納されます。
classes.csv
| フィールド | 必須 | 例 | データ型 |
|---|---|---|---|
| sourcedId | はい | 12001 | 一意な ID |
| orgSourcedId | はい | 10001 | 一意な ID |
| title | はい | コンピューター サイエンス 101 | String |
| sessionSourcedIds | いいえ | FS2021 | 一意の ID[] |
| courseSourcedId | いいえ | C12001 | 一意な ID |
| code | いいえ | 12001 | String |
- これには、'orgSourcedId' フィールドを使用して、関連付けられている学校 (org) への参照が必要です。 これにより、orgs.csv ファイルへの依存関係が生成されます。
- 渡された場合: "sessionSourcedIds" フィールドを使用して、関連付けられている用語 (アカデミック セッション) への参照が必要です。 これにより、academicSessions.csv ファイルへの依存関係が生成されます。
- 渡された場合: クラスが同じ学年の複数のセッション (秋学期や春学期など) に関連付けられている場合は、レコード上のセッションに両方の sourcedId を指定できます。 値は、引用符で囲まれ、コンマで区切られた値を持つ単一の文字列に結合する必要があります。
- 複数の sessionSourcedIds への関連付けは、Data Lake にのみ格納されます。
- セッション ID の Microsoft 365 グループ拡張属性では、複数の関連付けがサポートされていません。
- 渡された場合: 'courseSourcedId' フィールドを使用して、関連付けられているコースへの参照が必要です。 これにより、courses.csv ファイルへの依存関係が生成されます。
enrollments.csv
| フィールド | 必須 | 例 | データ型 |
|---|---|---|---|
| classSourcedId | はい | 12001 | 一意な ID |
| userSourcedId | はい | 14001 | 一意な ID |
| role | はい | student | 列挙 |
- これには、'classSourcedId' フィールドを使用して、関連付けられているクラスへの参照が必要です。 これにより、classes.csv ファイルへの依存関係が生成されます。
- これには、'userSourcedId' フィールドを使用して、関連付けられているユーザーへの参照が必要です。 これにより、users.csv ファイルへの依存関係が生成されます。
academicSessions.csv
| 提出 | 必須 | 例 | データ型 |
|---|---|---|---|
| sourcedId | はい | FS2021 | 一意な ID |
| title | はい | 秋学期 | String |
| type | はい | 学期 | 列挙 |
| schoolYear | はい | 2021 | 列挙 |
| startDate | はい | 2020-08-24 | Date |
| endDate | はい | 2020-12-11 | Date |
- 日付値がISO8601形式で指定されることを想定しています。
courses.csv
| フィールド | 必須 | 例 | データ型 |
|---|---|---|---|
| sourcedId | はい | C12001 | 一意な ID |
| orgSourcedId | はい | 10001 | 一意な ID |
| title | はい | コンピューター サイエンス 101 | String |
| code | いいえ | CS101 | String |
| schoolYearSourcedId | いいえ | Y2021 | 一意な ID |
| subject | いいえ | 10 | 列挙 |
| grade | いいえ | 学部 | 列挙 |
- これには、orgSourcedId フィールドを使用して、関連付けられているorganization (org) への参照が必要です。 これにより、orgs.csv ファイルへの依存関係が生成されます。
- 渡された場合: これには、型が schoolYear である 'schoolYearSourcedId' フィールドを使用して、関連するアカデミック セッション年レコードへの参照が必要です。 これにより、academicSessions.csv ファイルへの依存関係が生成されます。
- グレード レベル ENUM の受信値に先頭のゼロ '0' が見つからない (例: '1') は、定義された値のリスト (ENUM) '01' と一致し、'01' として格納されます。
relationships.csv
| フィールド | 必須 | 例 | データ型 |
|---|---|---|---|
| userSourcedId | はい | 14001 | 一意な ID |
| relationshipUserSourcedId | はい | P14001 | 一意な ID |
| relationshipRole | はい | 後見人 | 列挙 |
- 連絡先関係 (ガーディアン) も同期している場合は、それらのレコードを users.csv に含める必要があります。
- これには、'userSourcedId' フィールドを使用して、関連付けられているユーザーへの参照が必要です。 これにより、users.csv ファイルへの依存関係が生成されます。
- これには、"relationshipUserSourcedId" フィールドを使用して、関連付けられているユーザーへの参照が必要です。 これにより、users.csv ファイルへの依存関係が生成されます。
- さらに、連絡先関係ロールを持つユーザーには familyName、givenName、および電子メールが必要です。
demographics.csv
| フィールド | 必須 | 例 | データ型 |
|---|---|---|---|
| userSourcedId | はい | 14001 | 一意な ID |
| 性 | いいえ | 男性 | 列挙 |
| birthDate | いいえ | 2001-07-20 | Date |
| birthCity | いいえ | Woodenville | String |
| birthState | いいえ | WA | 列挙 |
| birthCountry | いいえ | 米国 | String |
| ethnicityCodes | いいえ | hispanicOrLatinoEthnicity | Enum[] |
| raceCodes | いいえ | demographicRaceTwoOrMoreRaces | Enum[] |
- これには、'userSourcedId' フィールドを使用して、関連付けられているユーザーへの参照が必要です。 これにより、users.csv ファイルへの依存関係が生成されます。
- 'raceCodes' への複数の値マッピングは、引用符で囲まれ、コンマで区切られた値を持つ 1 つの文字列に結合する必要があります。
userFlags.csv
| フィールド | 必須 | 例 | データ型 |
|---|---|---|---|
| userSourcedId | はい | 14001 | 一意な ID |
| flag | はい | lep | 列挙 |
- これには、'userSourcedId' フィールドを使用して、関連付けられているユーザーへの参照が必要です。 これにより、users.csv ファイルへの依存関係が生成されます。