IMS Final Release

IMS Global Logo

IMS OneRoster®: CSVテーブル

IMS最終リリース
Version 1.1

発行日: 2017年4月17日
最新版: http://www.imsglobal.org/lis/

知的財産権と配布に関するお知らせ

この文書の受信者は、この文書に記載された仕様書のいずれかの実装によって侵害される可能性があることを認識したうえで、関連するすべての特許のクレームまたはその他の知的財産権の通知をコメント付きで提出するよう、またサポートを提供するように要求されています。

IMSは、本書に記載されている技術の実装や使用に関係すると主張される可能性がある知的財産やその他の権利、あるいはそういう権利の元でのライセンスがどの程度まで利用できるのかりょうできないのか、という有効性または範囲に関して、いかなる立場も取りません; また、そうした権利を特定するために取り組みを代表していません。 IMS仕様の権利に関するIMSの手順の情報は、 http://www.imsglobal.org/ipr/imsipr_policyFinal.pdfのIMS知的財産権のウェブページで見つけることができます。

Copyright © 2017 IMS Global Learning Consortium. 無断転載・複製を禁止します。

製品やサービスを開発するために、この仕様書を使用するには、IMSのウェブサイト http://www.imsglobal.org/speclicense.htmlにあるIMSとのライセンスに則っています。

提案の要求の必要に応じて、この文書からの抜粋を使用するすべての当事者に許可されます。

上記の制限は永続的なものであり、IMSまたはその後継または譲受人によって取り消されることはありません。

この仕様は、いかなる保証もなく提供されています、特に、非侵害のいかなる保証をはっきりと否定しています。この仕様の利用については、実装者自身の責任で行われ、コンソーシアム、そのメンバーまたは提出者のいずれも、直接的または間接的に、この仕様の利用から生じるいかなる性質の損害についても、実装者または第三者に対して、いかなる責任を持つものではありません。

公共の貢献、コメントや質問はここに掲載することができます。 http://www.imsglobal.org/forums/ims-glc-public-forums-and-resources/learning-information-services-oneroster-public-forum.

商標情報 http://www.imsglobal.org/copyright.html

MSのロゴとOneRosterは、米国および/またはその他の国において、IMS Global Learning Consortium, Inc..の商標です。
ドキュメント名: IMS OneRoster® v1.1 CSV Tables

改訂: 2017年4月17日

目次

1. はじめに

1.1. OneRoster概要

1.2. コンテキスト

1.3. 本文書の構成

1.4. 参照サイト

1.5. 命名規則

2. CSV概要

2.1. データバインド

2.2. CSVファイルの交換

2.3. V1.0とV1.1との互換性

2.4. バルク/デルタの動作の制約

3. CSVフォーマット

3.1. manifest.csv

3.2. academicSessions.csv

3.3. categories.csv

3.4. classes.csv

3.5. classResources.csv

3.6. courseResources.csv

3.7. courses.csv

3.8. demographics.csv

3.9. enrollments.csv

3.10. lineItems.csv

3.11. orgs.csv

3.12. resources.csv

3.13. results.csv

3.14. users.csv

付録A - ファイル依存関係マトリックス

本ドキュメントに関する情報

協力者のリスト

改訂履歴

 

1.               はじめに

1.1.          OneRoster概要

Learning Information Services (LIS)は、IMS Globalによって開発された標準です[LIS、13]。 LIS標準は、異なる教育システム間で(人、コース、登録数や成績について)学生のデータの交換に対応しています。 K-12コミュニティのニーズに対応するために、IMSはLISコアプロファイルから派生した[LIS、11]を作成しました。それは、K12により適切にするために、LISデータモデルを狭くして、K-12用の成績転送の周りの機能を広げるために、カンマで分かれた値(CSV)のファイルフォーマットを、学習ツールに名簿情報を提供したい人のために提供します。

この文書では、OneRosterデータモデルの、CSVファイルセットでの交換方法の説明が含まれています。 このバインディングは、CSVファイルの形式と内容に対応しています。CSVファイルがエンドシステム間で交換される方法については、定義していません。

1.2.          コンテキスト

この文書は、オリジナルのOneRoster仕様[OneRoster、15A]の進化形である添付のOneRoster v1.1のデータモデル[OneRoster、17A]詳細の定義とともにに使用しなければなりません。 CSV binding V1.1とV1.0 の間の技術的な変更点は次のとおりです。

a)       「manifest」CSVファイルが導入されました。

b)       「lineitem」CSVファイルは、データモデル内のlineitemの機能と交換するために導入されました。

c)       「result」のCSVファイルは、データモデル内のresultの機能と交換するために導入されました。

d)       「categories」CSVファイルは、データモデル内のcategoryの機能と交換するために導入されました。

e)       「resources」のCSVファイルは、データモデル内の新しいresources機能のために導入されました。

f)        「classResources」ファイルは、クラスに割り当てられたリソースを識別するために導入されました。

g)       「courseResources」ファイルは、コースに割り当てられたリソースを識別するために導入されました。

h)       メタデータ/拡張データモデルの特徴の位置は、CSVファイルに固定されています。 したがって、OR 1.0(「orgs」と「cources」のCSVファイルの中にある)の明示的に定義されたメタデータフィールドのすべてが削除されました。

i)        ベースクラスの「ステータス」フィールドにある一覧は、「inactive」なトークンの削除があったり、ステータス値が使用される方法について明確になっています。

j)        ファイルのセットは、zipファイルとして交換する必要があります。 パッケージに含まれるファイルの数は、転送のためのデータの一貫性の要件によって異なります。

k)       完全なデータモデルの説明[OneRoster、17a】は、属性の変更、すなわち追加、名前の変更、多数の変更およびデータタイプのリフレッシュのセットとしてレビューされるべきです。

また、結合されている文書の中で行われた編集の改善、明確化、修正の数があります。 他のドキュメントの変更は以下のとおりです。

a)       「Conformance Testing(適合性試験)」は、「OneRoster 1.1 Conformance and Certification」文書[OneRoster、17C]に移動しました。

b)       「ベストプラクティス」セクションは、「OneRoster 1.1のベストプラクティスと実装ガイド」、[OneRoster、17b]に移動しました。

1.3.          本書の構成

このドキュメントの残りの部分の構成は次のとおりです。

2. CSV 概要

OneRosterのためにCSVバインディングの構造の概要。

3. CSVフォーマット

OneRoster用CSVファイルのデータの詳細なフォーマット。

付録A - 依存関係のマトリックス

CSVファイルをベースにして一括処理のやり取りを行う際のファイルの依存関係の説明。

1.4.          参照サイト

[LIS, 11]

IMS Learning Information Services v2.0の学習システム: プロファイル概要v1.0、M.FeldsteinとC.Smythe、 IMS Global、2011年12月。

[LIS, 13]

IMS Learning Information Services v2.0 概要、 C.Smythe、 IMS Global、2013年7月。

[LTI, 10]

IMS Learning Tools Interoperability (LTI) v1.0、 S.Vickers、 IMS Global、2010年5月。

[OneRoster, 15a]

OneRoster 仕様 v1.0、 P.Nicholls、 IMS Global、2015年7月。

[OneRoster, 15b]

OneRoster Conformance v1.0、 L.Mattson、 IMS Global、2015年7月。

[OneRoster, 17a]

OneRoster 仕様 v1.1、 P.Nicholls と C.Smythe、 バージョン1.1、最終リリース、 IMS Global、2017年4月。

[OneRoster, 17b]

OneRoster v1.1ベストプラクティスと実装ガイド、 C.Smythe と P.Nicholls、 バージョン1.1、最終リリース、IMS Global、2017年4月。

[OneRoster, 17c]

OneRoster v1.1 Conformance and Certification、 L.Mattson と C.Smythe、 バージョン1.1、最終リリース、IMS Global、2017年4月。

[RFC1951]

収縮圧縮データフォーマット仕様 1.3、 P.Deutsch、 RFC 1951、 IETF、1996年5月。

[RFC3629]

UTF-8: ISO 10646の変換フォーマット、 F.Yergeau、 RFC 3629、 IETF、2003年11月。

[RFC4180]

カンマ区切り(CSV)ファイルのための共通フォーマットとMIMEタイプ、 Y.Shafranovich、 RFC 4180、 IETF、2005年10月。

1.5.          命名規則

API Application Programming Interface(アプリケーションプログラミングインタフェース)
BOM Beginning of Message
CEDS Common Education Data Standards
CSV Comma Separated Values
GUID Globally Unique Identifier(グローバル一意識別子)
IETF Internet Engineering Task Force(インターネット技術特別調査委員会)
LDAP Lightweight Directory Access Protocol(ライトウェイト ディレクトリ アクセス プロトコル)
LIS Learning Information Services
LMS Learning Management System(学習管理システム)
LOR Learning Object Repository
LTI Learning Tools Interoperability
RFC Request For Comment(リクエスト フォー コメンツ)
UTF Unicode Transformation Format

2.               CSV概要

2.1.          データバインド

多くの学区では、現在、ツールプロバイダやLMS / LORベンダーに「.CSV」形式のファイルで学生の情報を提供しています。 ベンダーと名簿情報の交換するためにCSVファイルを使用し続ける必要があり、それらの学区のために、セクション3のテーブルで定義されたフォーマットが使用されるべきです。このフォーマットは、OneRoster [OneRoster、17A]標準のデータモデルに対応しています。学区は、このドキュメントで概説されているCSV形式で14(14)までのファイルを用意することにより、クラス名簿/ gradebooksをアップロードすることができます。 名簿/ gradebooksは、インポートとエクスポートの両方のために利用できます。ファイルのセットの概要について表2.1に示しています。

表2.1 CSVファイルの概要。

csvファイル名

Req

説明

manifest.csv

Yes

制御ファイル。 マニフェストは、バージョン(1.1などのセット)と、このデータセットで供給されているファイルのリストが含まれています。
新しいファイルは、V1.1で追加されました。

academicSessions.csv

No

データファイル。 「アカデミックセッション」のデータモデルコンテンツ。
データモデルは、V1.1に改訂されました。

categories.csv

No

データファイル。 lineItemsのセットの定義。
新しいファイルは、V1.1で追加されました。

classResources.csv

No

データファイル。 クラスに割り当てられたリソースのセット。
新しいファイルは、V1.1で追加されました。

classes.csv

No

データファイル. 「classes」データモデルの内容。
データモデルは、V1.1で改訂されました。

courseResourses.csv

No

データファイル。 コースに割り当てられたリソースのセット。
新しいファイルは、V1.1で追加されました。

courses.csv

No

データファイル。 「courses」データモデルの内容。
データモデルは、V1.1で改訂されました。

demographics.csv

No

データファイル。 「demographics」データモデルの内容。
データモデルは、V1.1で改訂されました。

enrollments.csv

No

データファイル。 「enrollments」データモデルの内容。
Dデータモデルは、V1.1で改訂されました。

lineItems.csv

No

データファイル。 lineItemsのセット。
新しいファイルは、V1.1で追加されました。

orgs.csv

No

データファイル。 「orgs」データモデルの内容。

results.csv

No

データファイル。 resultsのセット。
新しいファイルは、V1.1で追加されました。

resources.csv

No

データファイル。 「resorurces」データモデルの内容。
新しいファイルは、V1.1で追加されました。

users.csv

No

データファイル。 「users」データモデルの内容。
データモデルは、V1.1で改訂されました。

キー:

  • CSV File Name - CSVファイルの名前
  • Req - (YesまたはNo)CSVファイルが供給されなければならないか否かを示します。
  • Description - ファイルの内容の声明。
  • 網掛けの行は、V1.1リリースで追加されたファイルのためのものです。

データが交換された場合、1-14 CSVファイルが存在します。 交換は、「manifest.csv」ファイルを含まなければなりません。 「manifest.csv」だけが供給されたときのケースは、全く更新が発生していないことを示すために使用されます。 多くても、14個のCSVファイルが交換されます。すなわち、それぞれのデータのCSVファイルは1個よりも多いことはありません。 ファイルのセットが一括処理するためのものである場合、それらは意味的に一致していなければなりません。すなわち、ファイル内で参照されているすべてのオブジェクトは同じ、またはzipパッケージ内の他のファイルのいずれかの一つで定義する必要があります(ファイルの依存関係のこのセットの詳細については、付録Aを参照してください)。

2.2.          CSVファイルの交換

V1.1用のCSVファイルはzipファイルとして交換されます。 含まれるファイルは、ルートレベルでなければなりません。すなわち、それらが入っているディレクトリ内に含まれてはいけません。 zipファイルの名前には何の制約はありませんが、「ZIP」のファイル拡張子を持っている必要があります。 圧縮は、RFC 1951 [RFC1951]に準拠する必要があります。

2.3.          V1.0とV1.1との互換性

V1.0とV1.1の両方に準拠したデータセットをインポートするシステムには、次のアルゴリズムを使用して区別する必要があります。

a)       「manifest.csv」ファイルが存在する場合は、データセットはV1.1に準拠します。(これはファイルセットの残りの部分がOneRoster 1.0定義に準拠し、適切なエラーメッセージが生成され、それに続くプロセスは実装に依存するということを想定しなければなりません。) マニフェストファイルには、マニフェストファイルに添付しなければならないCSVファイルのリストが含まれています。 供給されたファイルのセットが、マニフェスト内のファイルのリストと異なる場合、インポートエラーが報告されるべきであり、システムは、実装によって定義されるようにデータを処理することが許されます。

b)       「manifest.csv」ファイルが存在しない場合、通常操作では、データセットは、V1.0に準拠しています。 7つのデータファイルは、すなわち、データモデルごとに1つのファイルを供給しなければなりません(V1.1で導入された新しいCSVデータファイルのいずれかがあってはいけません)。 ファイルが見つからない場合は、エラーが報告されるべきであり、システムは、実装によって定義されたデータを処理することを許可されています。 「manifest.csv」ファイルが欠落していて、ファイルセットがOneRoster 1.1に準拠している場合は、適切なエラーメッセージが生成されるべきであり、その後の処理は実装に依存します。

2.4.          バルク/デルタの動作の制約

レコードの存在と管理は、バルクおよびデルタ処理オプションを介して制御されます。 レコードは、4つの可能な状態にすることができます。

         'No Record' - レコードが作成されていないか、レコードは存在したが、システムがレコードを削除した場合、それが以前に割り当てられたsourcedIdを回復することはできません。

         'Record[-]' - レコードが作成され、sourcedIdを割り当てられたが、それがまだ起動されていません。

         'Record[Active]' - レコードステータスが「アクティブ」に設定されています。

         'Record[ToBeDeleted]' - レコードステータスに「tobedeleted」が設定されています。

それぞれの状態には、トランジッションイベントの4つの可能なタイプがあります。

         'B[-]' - バルク転送が発生し、既存のレコード(sourcedIdと1)はそれらのファイルには表示されません。

         'B[S]' - バルク転送が発生し、そのレコードが新しいファイルセットに現れます。

         'D[A]' - デルタ転送が発生し、そのレコードのステータスが「アクティブ」として設定されています。

         'D[D]' - デルタ転送が発生し、そのレコードのステータスが「tobedeleted」として設定されています。

「システムがレコードを削除した」というトランジッションは、レコードが、「レコード[ToBeDeleted]」の状態にあるときにのみ可能です。 このシステムがレコードを削除するトランジッション用(この削除アクションと実装に依存している「tobedeleted」として設定されているレコードとの間の時間の長さ)。

サービスプロバイダのレコードの作成および管理のための状態図を図2.1に示されています。

図2.1 - サービスプロバイダにおけるバルク/デルタ処理を使用してレコードを管理するための状態図。

OneRosterサービスコンシューマーは、これらの4つの状態のそれぞれのレコードのために、「HTTP GET」リクエストを発行することができます。 そのような読み出し要求が行われると、要求は、次のペイロードになります。

         'No Record' - 404レスポンスが返される単一レコード要求の場合

         'Record[-]' - レコードは空の「状態」フィールドと空の「dateLastModified」フィールドで返されます。

         'Record[Active]' - レコードがレコードが最後に変更された時に「アクティブ」の「状態」フィールドの値と「dateLastModified」フィールドにセットして返されます。

         'Record[ToBeDeleted]' - レコードがレコードが最後に変更された時に「tobedeleted」の「状態」フィールドの値と「dateLastModified」フィールドセットで返されます。

3.               CSVフォーマット

データファイルのそれぞれのファイル形式は、キャリッジ・リターンがフィールド内で許可されていない追加制限付きのRFC 4180[RFC 4180]で特定されているカンマ区切り(CSV)フォーマットです。 コンマとダブルクォートを含むフィールドは、ダブルクォートで囲む必要があります。 ダブルクォートは、フィールドを囲むために使用する場合は、そのフィールド内で登場するダブルクォートは、別のダブルクォートをその前に付けて逃げる必要があります。

CSVファイルはUTF-8でエンコード[RFC3629]しなければなりません。 プロセッサをインポートすると、BOM(バイトオーダーマーク)のプレフィックスを容認し、それらを無視しなければなりません。 BOM付きUTF-8でエンコードされたファイルには、BOMは、ファイルの先頭に3バイトのシーケンス「EF BB BF」で表示されます。 存在する場合、CSVのヘッダは、ファイルの4バイト目から始まります。存在しない場合は、CSVのヘッダは、ファイルの1バイト目から開始されます。

その他の重要なポイントは以下のとおりです。

         CSVファイル内のすべてのヘッダ名とコンテンツ値は大文字と小文字で区別されます。 間違った場合には、適合性失格という結果になり、検出されたエラーとして記録されるべきです。

         各ファイルのヘッダー行が必要です。

         ファイルのヘッダフィールドは以下の表に定義されているのと同じ順序で指定する必要があります。 メタデータの拡張フィールドが使用されている場合は、それらは、列の最後のセットとして、仕様で定義されたデータフィールドの右に追加する必要があります。 これは、定義されたデータフィールドの順序にかかわらず、存在するか否かのメタデータフィールドは固定されたままであることを確実にします。

         ヘッダーフィールド名は、ファイルの中でユニークな名前を付ける必要があります。

         データ行が含まれていないファイルは、許可されていません。

         すべてのフィールドが、オプションで、一覧のトークンセットを定義されている場合、データが供給されていないことを示すために許可されているNULL /ブランク(すなわち、ブランク値””)の値になります。

         すべての文字列ベースのデータタイプのサポートは、少なくとも255の最大長は実装によってサポートされている必要があります。 255以上の文字列の長さが使用されている場合、システムは、適合性に失敗しないが、文字列の一部を失う可能性があります。

データモデル[OneRosterは、17A]から、同じ値のカラムヘッダーにマッピングする場合、以下の特別な規則が適用されます。

         (データ型GUIDRefを使用して)データモデル内のオブジェクトを参照するとき、ネームはにSourcedIdを使用して、例えば、「org」から「orgSourceID」に拡張されます。

         データモデル内のオブジェクトのセットを参照するとき、(RFC 4180に従って)対応するカラムヘッダーの下に、クオートで囲まれたカンマ区切りリストへマッピングされます。

         クラスとコースデータモデル内のリソースへの参照がマッピングされていません。

CSVのインポート/エクスポートは、次の2つの方法、バルクおよびデルタのいずれかで動作するように想定されています。

         BULK処理では、CSVファイルは、「dateLastModified」と「ステータス」フィールドの値を含めることはできません。 すなわち、行ごとに、これらのフィールドのいずれかにデータが存在しないででしょう。 インポートシステムは、すべてのデータの参照バージョンとして、このインカムデータを表示する必要があります。 すなわち、以前にインポートされたレコードが、このバルクのcsvファイルに表示されない場合は、その後、インポートシステムは、バルクファイルがインポート処理を行った時間に「dateLastModified」の値を「tobedeleted」としてレコードに内部的にマークを付ける必要があります。 もしレコードが、その後、将来のバルクファイルに表示される場合には、それらのレコードを更新し、アクティブにする必要があります。 バルクファイルのセットが作成されると、それらは意味的に完了しなければなりません。つまり、他のオブジェクトが参照するすべてのオブジェクトは、対応するソースのCSVファイルで定義され、manifest.csvファイルに含まれなければなりません。

DELTA処理では、入ってくるCSVファイルには、「dateLastModified」と「ステータス」フィールドに値を含まなければなりません。 つまり、CSVファイル内の各行は、(行の)データが最後に変更されたことと、そのステータスを記述しているデータを含めるべきです。 インポートシステムは、参照データへの変更として、この入ってくるデルタファイルを表示しなければならない、そして新しいデータの適切な変更、削除ならびに挿入を行う必要があります。

         フィールドヘッダー - カラムヘッダの名前。

         必須 - データが存在する必要がある場合は、表示しています。

-    「Yes」は、常に必要とされているフィールドのためです。

-    「Yes for Delta」は、デルタ処理のために投入されなければならないフィールドのためと、バルク処理のためにブランクにするためです。

-    「No」は、次の値を持っている必要がないフィールドのためです。

         フォーマット - データのデータタイプ。

-    「GUID」は、グローバルに一意な識別子いくつかの形式で表示します(これは256文字未満でなければなりません)。 これは、128ビットのUUIDの形式に限定されるものではありません。

-    「GUID Reference」は、他のいくつかのCSVデータファイルで定義されたオブジェクトのGUIDを表示します。

-    「List of GUID Reference」は、別のCSVデータファイルで定義されたGUID参照のオブジェクトのカンマ区切りのリストを表示します。

-    「ID」は、OneRoster仕様の外で定義された識別子で、例えば、リソースデータセット内のそのリソースのためにベンダーによって生成されたなどの識別子を表します。

-    「string」は、説明に従うべき文字の配列を意味します。 一般に、これは、人間が読み取り可能な、例えば、「理科教室」であることを目指しています

-    「List of Strings」は、文字列の配列を意味します。 リスト内の個々の文字列は、カンマを含めることはできません、そしてリストはカンマ区切りのリスト、例えば、「1,2,3」です。 文字列のリストに複数の要素が含まれている場合、それはダブルクオートでカプセル化する必要があります。

-    「Enumeration」は、descriptionで参照される固定値セットを表します。 必要とされないフィールドの場合には、空のフィールドは値を表示しません。

-    「Enumeration List」は、列挙型のリストを表示しています。 リストは、カンマで区切られています。例えば、「先生,生徒,補佐」です。

-    「Float」は、浮動小数点数を表示します。

-    「DateTime」は、タイムスタンプ形式を表示します。 「DateTimes」は、ISO 8601のW3Cプロファイルで表示されなければなりません。そして、UTCタイムゾーンを含まなければなりません。例えば、「2012-04-23T18:25:43.511Z」です。

-    「Date」は、日付形式を示します。 Datesは、ISO 8601形式 (http://tools.ietf.org/html/rfc3339)を用いて表示されなければなりません。より一般的には、 「YYYY-MM-DD」 形式として表示されます。例えば、 「2002-04-23」です。

-    「Year」は、年だけの日付形式で表示します。 Yearsは、ISO 8601形式 (http://tools.ietf.org/html/rfc3339)を使用して表示されなければなりません。より一般的には、「YYYY」形式で表示されます。例えば、「2002」です。

         Example/Description - 期待されるデータの一例、およびコンテンツの性質の簡潔なステートメントです。

重要な変更の数は、すなわち、v1.0のから行われています。

         V1.1の 「dateLastModified」は、v1.0から変更されました。精度は、「YYYY-MM-DD」から「YYYY-MM-DDTHH:MM:SS.sssZ 」に変更されました。 下位互換性のために、v1.0の 「YYYY-MM-DD」 の形式は、V1.1コンテキストにおいて、 「YYYY-MM-DDT23:59:59.999Z」 に変換されるべきです。

         「status」フィールドの「inactive」のenumeration値は削除されました。 v1.0のとの互換性のために、「inactive」の値が「tobedeleted」として解釈されるべきです。

         デルタ処理の情報が交換されていると、「tobedeleted」とマークされているレコードと、必須として識別されるすべてのフィールドは、(「sourcedId」オブジェクトを除いて)オプションとして考慮するべきです。

 

NOTE: 変更された機能は「青」背景が表示されているのに対して、新しいデータモデルの特徴は、「黄」背景で表示されています。


3.1.          manifest.csv

 

manifestファイルは、「プロパティ名」と「値」というヘッダーの、ちょうど2つのカラムで構成されています。 各行には単一のプロパティ/バリューのペアが含まれています。 サポートされるプロパティ/バリューのペアのリストは以下の通りです。

プロパティ名
(1行に1つ)

必須

フォーマット

値の説明

manifest.version

Yes

String

manifestのバージョン。 初期値は「1.0」です。

oneroster.version

Yes

String

OneRosterバージョンは、このファイルセットでサポートされています。 これは、「1.1」です。

file.academicSessions

Yes

Enumeration

各フィールドは次のように列挙されています。 { "absent" | "bulk" | "delta" } に値を表示しています。

         absent - このCSVファイルは提供されていません。

         bulk - このCSVファイルはバルクデータのみが含まれています。

         delta - このCSVファイルは差分のデータのみが含まれています。

これらの処理モードの意味は、付属のCSVファイル内に保持されたデータと整合性があるべきですが、不一致の場合は、CSVファイル内のデータの値が優先されなければなりません。

file.categories

Yes

Enumeration

file.classes

Yes

Enumeration

file.classResources

Yes

Enumeration

file.courses

Yes

Enumeration

file.courseResources

Yes

Enumeration

file.demographics

Yes

Enumeration

file.enrollments

Yes

Enumeration

file.lineItems

Yes

Enumeration

file.orgs

Yes

Enumeration

file.resources

Yes

Enumeration

file.results

Yes

Enumeration

file.users

Yes

Enumeration

source.systemName

No

string

ファイルセットを生成するシステムの名前。

source.systemCode

No

string

ファイルセットを生成するシステムのための識別コード。


3.2.          academicSessions.csv

このファイルは、OneRoster仕様のAcademicSessionsのデータセットを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

このacademicSessionのソースId。

status

デルタ処理の場合は、Yes

Enumeration

Enumeration listについてはセクション 4.13.8 [OneRoster, 17a] を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードで最後に変更された日付。

title

Yes

String

アカデミックセッションのタイトル名。

type

Yes

Enumeration

enumeration listについてはセクション 4.13.7 [OneRoster, 17a] を参照してください。

startDate

Yes

Date

アカデミックセッションの開始日を含む。

endDate

Yes

Date

アカデミックセッションの終了日を含まない。

parentSourcedId

No

GUID Reference.

このアカデミックセッションの親のソースID。

schoolYear

Yes

Year

アカデミックセッションが提供している学年度。この年度は学年度の終わりをに入るべきです。
(フォーマットは: YYYY).

 

バルク処理がサポートされている時は、このファイルと他のファイルの依存関係があります。:

1)       他の academicSessions は、「親のソースID」属性を通して、同じファイルを参照することができます。 したがって、意味の一貫性のために、他のファイルとの依存関係はありません。


3.3.          categories.csv

このファイルはOneRoster仕様のラインアイテムカテゴリーを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

カテゴリー毎にユニークなID。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストには、セクション 4.13.8 [OneRoster, 17a] を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

title

Yes

String

タイトルはその種類、例えば、宿題、エッセイなどを表すラインアイテムのセットに割り当てられています。

 

バルク処理がサポートされている時は、このファイルと他のファイルの依存関係はありません。

 

 


3.4.          classes.csv

このファイルはOneRoster仕様のクラスデータセットを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

クラスごとにユニークなID。 SourcedId は、他のファイルの中でも使用され、全てのクラスを通してユニークでなければなりません。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストには、セクション 4.13.8 [OneRoster, 17a] を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

title

Yes

String

クラスの名前

grades

No

List of Strings

授業に出席している学年。 許可されている語彙はCEDS(バージョン5)と「エントリー学年レベル」要素にあるものです。 https://ceds.ed.gov/CEDSElementDetails.aspx?TermId=7100

courseSourcedId

Yes

GUID Reference.

このクラスが一つのインスタンスであるコースの SourcedId。

classCode

No

String

このクラスを識別する助けになるように使用されている人間が読み取れるコード。

classType

Yes

Enumeration

列記型リストには、セクション 4.13.1 [OneRoster, 17a] を参照してください。

location

No

String

クラスが物理的に位置する場所についての人間が読み取れる説明。

schoolSourcedId

Yes

GUID Reference.

Orgタイプ "school"のクラスを教える Org の SourcedId。

termSourcedIds

Yes

List of GUID References.

教えられるクラスがある学期(アカデミックセッション)の SourceId。

subjects

No

List of Strings

人間が読み取れる形式の科目名。「subjectCodes」属性が存在する場合、サブジェクトとsubjectCodesリストは同じ長さで、順序が重要である必要があります

ボキャブラリーは、「コースタイトル」フィールドのSCED(データ交換のための学校コード)(バージョン4)からのものです:  http://nces.ed.gov/forum/SCED.asp

「コースタイトル」の値にコンマが含まれている場合、それらのコンマを削除する必要があります。

たとえば、「SCEDコースコード」「03210」の「コースタイトル」は「科学、技術、および社会」です。これは「科学技術と社会」として表さなければなりません。

subjectCodes

No

List of Strings

機械が読み取れる形式の科目コード。 複数のサブジェクトコードが必要な場合は、二重引用符を使用し、カンマで区切ります(RFC 4180に準拠)。 'subjects'属性が存在する場合、2つのリストは同じ長さで順序が必要です。複数のサブジェクトコードが必要な場合は、二重引用符を使用し、カンマで区切ります(RFC 4180に準拠)。 'subjects'属性が存在する場合、2つのリストは同じ長さで、順序が重要でなければなりません。

SCED (School Codes for the Exchange of Data) の語彙:  http://ceds.ed.gov/ScedCourseCodes.aspx (ラベル内のコンマは削除する必要があります)。

periods

No

List of Strings

クラスが与えられる日の時間帯。複数のピリオドが必要な場合は、二重引用符を使用し、カンマで区切ります(RFC 4180に準拠)。

例:1; 「1,3,5」

 

バルク処理がサポートされている時は、このファイルと他のファイルの依存関係があります。:

1)       これには、 'termSourcedIds'属性を使用した関連用語(academicSessions)への参照が必要です。これにより、academicSessions.csv への依存関係が生じます。;

2)       これには、「courseSourcedId」属性を使用した関連コース(コース)への参照が必要です。これにより、courses.csv への依存関係が生じます。;

3)       これには、「schoolSourcedId」属性を使用した関連する学校(組織)への参照が必要です。これにより、orgs.csv への依存関係が生成されます。

 


3.5.          classResources.csv

このファイルは、classes.csvファイルとresources.csvファイル間の関連付けを表します。

 

コラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

クラス/リソースの関連付けの一意のID。 SourcedIdは他のファイルで使用され、すべてのクラスリソースで一意である必要があります。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストについては、セクション4.13.8 [OneRoster、17a]を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

title

No

String

関連クラスの名前。

classSourcedId

Yes

GUID Reference.

参照クラスのSourcedId。

resourceSourcedId

Yes

GUID Reference.

クラスに関連付けられたリソースのSourcedId。

 

バルク処理をサポートする場合、他のファイルに対するこのファイルの依存関係は次のとおりです。

1)       これには、「classSourcedId」属性を使用した関連クラス(クラス)への参照が必要です。これにより、classes.csv への依存関係が生成されます。クラスへのこの依存関係は、academicSessions.csvcourses.csv、および orgs.csv ファイルの対応する依存関係につながります

2)       これには、「resourceSourcedId」属性を使用した関連リソース(リソース)への参照が必要です。これにより、resources.csv への依存関係が生成されます。

 

 


3.6.          courseResources.csv

このファイルは、courses.csvファイルとresources.csvファイル間の関連付けを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

コース/リソースの関連付けの一意のID。 SourcedIdは他のファイルで使用され、すべてのコースリソースで一意である必要があります。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストについては、セクション4.13.8 [OneRoster、17a]を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

title

No

String

関連するコースの名前。

courseSourcedId

Yes

GUID Reference.

参照コースのSourcedId。

resourceSourcedId

Yes

GUID Reference.

コースに関連付けられたリソースのSourcedId。

 

バルク処理をサポートする場合、他のファイルに対するこのファイルの依存関係は次のとおりです:

1)       これには、「courseSourcedId」属性を使用した関連コース(コース)への参照が必要です。これにより、courses.csv に依存するようになります。コースへのこの依存関係は、academicSessions.csv および orgs.csv ファイルへの対応する依存関係につながります。;

2)       これには、「resourceSourcedId」属性を使用した関連リソース(リソース)への参照が必要です。これにより、resources.csv への依存関係が生成されます。

 

 


3.7.          courses.csv

このファイルは、OneRosterのコースデータセットを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

コースの一意のID。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストについては、セクション4.13.8 [OneRoster、17a]を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

schoolYearSourcedId

No

GUID Reference.

タイプが「schoolYear」のAcademicSessionのSourcedId。

title

Yes

String

コースの名前。

courseCode

No

String

人間が読めるコースコード。

grades

No

List of Strings

クラスに参加しているグレード。許可される語彙は、「Entry Grade Level」要素のCEDS(バージョン5)からのものです https://ceds.ed.gov/CEDSElementDetails.aspx?TermId=7100

orgSourcedId

Yes

GUID Reference.

このコースが属する組織のSourcedId。

subjects

No

List of Strings

人間が読める形式のサブジェクト名。 「subjectCodes」属性が存在する場合、サブジェクトとsubjectCodesリストは同じ長さで、順序が重要である必要があります

ボキャブラリーは、「コースタイトル」フィールドのSCED(データ交換のための学校コード)(バージョン4)からのものです:  http://nces.ed.gov/forum/SCED.asp

「コースタイトル」の値にコンマが含まれている場合、それらのコンマを削除する必要があります。

たとえば、「SCEDコースコード」「03210」の「コースタイトル」は「科学、技術、および社会」です。これは「科学技術と社会」として表さなければなりません。

subjectCodes

No

String

機械可読形式の件名コード。 「subjects」属性が存在する場合、サブジェクトとsubjectCodesリストは同じ長さで、順序が重要である必要があります。

ボキャブラリーは、「SCEDコースコード」フィールドのSCED(データ交換のための学校コード)(バージョン4)からのものです。  http://nces.ed.gov/forum/SCED.asp

 

バルク処理をサポートする場合、他のファイルに対するこのファイルの依存関係は次のとおりです

1)       これには、 'schoolYearSourcedId'属性を使用して、関連する学年(academicSession)への参照が必要です。これにより、 academicSessions.csv への依存関係が生じます。

2)       これには、「orgSourcedId」属性を使用した関連組織(org)への参照が必要です。これにより、 orgs.csv への依存関係が生成されます。

 


3.8.          demographics.csv

これは、OneRosterのDemographicsデータセットを表します。人口統計はオプションであるため、データプロバイダーは必ずしもこの情報を提供する必要はありません。もしそうなら、これは使用するフォーマットです。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID Reference

人口統計が参照するユーザーのSourcedId。通常、これは学生です。各ユーザーは、1つの人口統計レコードのみを持つことができます。

status

デルタ処理の場合は、Yes

Enumeration

列挙リスト については、セクション4.13.8 [OneRoster、17a]を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

birthDate

No

Date

生年月日。

sex

No

Enumeration

列挙リストについては、セクション4.13.2 [OneRoster、17a]を参照してください。

americanIndianOrAlaskaNative

No

Enumeration

ブール値:{"true" | 「false」}。

asian

No

Enumeration

ブール値:{"true" | 「false」}。

blackOrAfricanAmerican

No

Enumeration

ブール値:{"true" | 「false」}。

nativeHawaiianOrOtherPacificIslander

No

Enumeration

ブール値:{"true" | 「false」}。

white

No

Enumeration

ブール値:{"true" | 「false」}。

demographicRaceTwoOrMoreRaces

No

Enumeration

ブール値:{"true" | 「false」}。

hispanicOrLatinoEthnicity

No

Enumeration

ブール値:{"true" | 「false」}。

countryOfBirthCode

No

String

ユーザーが生まれた国。許可された語彙は、「出生国」要素のCEDS(バージョン5)からのものです https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20002

stateOfBirthAbbreviation

No

String

ユーザーが生まれた州。許可された語彙は、「出生の状態」要素のCEDS(バージョン5)からのものです。 https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20837

cityOfBirth

No

String

 

publicSchoolResidenceStatus

No

String

通学している公立学校とその管理単位の境界に関連する(内外の)ユーザーの法的居住地の表示。許可されている語彙は、「公立学校の在留資格」要素のCEDS(バージョン5)からのものです https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20863

 

バルク処理をサポートする場合、他のファイルに対するこのファイルの依存関係は次のとおりです。:

1)       これには、「sourcedId」属性を使用した関連ユーザー(ユーザー)への参照が必要です。これにより、users.csv に依存するようになります。これにより、 orgs.csv ファイルに対応する依存関係が作成されます。

 


3.9.          enrollments.csv

これは、OneRosterの登録データセットを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

この登録の一意の識別子。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストについては、セクション4.13.8 [OneRoster、17a]を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

classSourcedId

Yes

GUID Reference.

クラスのSourcedId。

schoolSourcedId

Yes

GUID Reference.

タイプが「school」の組織のSourcedId。

userSourcedId

Yes

GUID Reference.

ユーザーのSourcedId。

role

Yes

Enumeration

列挙リストについては、セクション4.13.5 [OneRoster、17a]を参照してください。

primary

No

Boolean

教師のみに適用されます。開始日/終了日で定義された期間に、クラスの主任教師として指定できる教師は1人だけです。ブール値:{"true" | 「false」}。

beginDate

No

Date

登録の開始日。この日付は、クラスで特定された関連するアカデミックセッション(期間)と一致する必要があります。

endDate

No

Date

登録の終了日(排他的)。この日付は、クラスに対して特定された関連するアカデミックセッション(期間)と一致する必要があります。

 

バルク処理をサポートする場合、他のファイルに対するこのファイルの依存関係は次のとおりです。:

1)       これには、「classSourcedId」属性を使用した関連クラス(クラス)への参照が必要です。これにより、 classes.csv への依存関係が生成されます。これにより、 academicSessions.csv ファイルと courses.csv ファイルに対応する依存関係が作成されます。コースの依存関係は、 academicSessions.csv ファイルと orgs.csv ファイルにさらに依存関係のセットを作成します。;

2)       これには、「schoolSourcedId」属性を使用した関連する学校(組織)への参照が必要です。これにより、 orgs.csv への依存関係が生成されます。

3)       これには、「userSourcedId」属性を使用した関連ユーザー(ユーザー)への参照が必要です。これにより、 users.csv に依存するようになります。これにより、 orgs.csv ファイルに対応する依存関係が作成されます。

 


3.10.      lineItems.csv

これは、OneRosterのLineItemデータセットを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

lineItemの一意のID。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストについては、セクション4.13.8 [OneRoster、17a]を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

title

Yes

String

lineItemに割り当てられたタイトル。

description

No

String

lineItemの役割の簡単な説明。

assignDate

Yes

Date

関連するアクティビティが割り当てられた日付。

dueDate

Yes

Date

関連するアクティビティの完了予定日。

classSourcedId

Yes

GUID Reference.

クラスのSourcedId。

categorySourcedId

Yes

GUID Reference.

カテゴリのSourcedId。

gradingPeriodSourcedId

Yes

GUID Reference.

評価期間を定義するacademicSessionのSourcedId。

resultValueMin

Yes

Float

スコアに許可される最小値(包括的)。 0.0。

resultValueMax

Yes

Float

スコアに許可される最大値(両端を含む)。 100.0

 

バルク処理をサポートする場合、他のファイルに対するこのファイルの依存関係は次のとおりです。:

1)       これには、「classSourcedId」属性を使用した関連クラス(クラス)への参照が必要です。これにより、 classes.csv への依存関係が生成されます。これにより、 academicSessions.csv ファイルと courses.csv ファイルに対応する依存関係が作成されます。コースの依存関係は、 academicSessions.csv ファイルと orgs.csv ファイルにさらに依存関係のセットを作成します。;

2)       これには、 'categorySourcedId'属性を使用して、関連付けられたカテゴリ(カテゴリ)への参照が必要です。これにより、 categories.csv に依存するようになります。

3)       これには、 'gradingPeriodSourcedId'属性を使用して、関連するグレーディング期間(academicSession)への参照が必要です。これにより、 academicSessions.csv ファイルへの依存関係が作成されます。

3.11.      orgs.csv

これは、OneRosterのOrgデータセットを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

組織の一意のID。 SourcedIdは他のファイルで使用され、すべての組織で一意である必要があります。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストについては、セクション4.13.8 [OneRoster、17a]を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

name

Yes

String

組織の名前。

type

Yes

Enumeration

列挙リストについては、セクション4.13.4 [OneRoster、17a]を参照してください。

identifier

No

String

NCES(国立教育統計センター)の学校/学区 ID。

parentSourcedId

No

GUID Reference.

親組織を表す組織のSourcedId。

 

バルク処理をサポートする場合、他のファイルに対するこのファイルの依存関係は次のとおりです。:

1)       他の組織は、 'parentSourcedId'属性を介して同じファイルで参照できます。したがって、セマンティックの一貫性のために、OTHERファイルには依存関係はありません。

 

 


3.12.      resources.csv

これは、OneRosterのリソースデータセットを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

このリソースの一意のID。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストについては、セクション4.13.8 [OneRoster、17a]を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

vendorResourceId

Yes

ID

ベンダーによって割り当てられたこのリソースの一意のID。ベンダーによって割り当てられたリソース識別子のコンテキストで一意です。

title

No

String

このリソースの名前。

roles

No

Enumeration List

列挙リストについては、セクション4.13.5 [OneRoster、17a]を参照してください。

importance

No

String

列挙リストについては、セクション4.13.3 [OneRoster、17a]を参照してください。

vendorId

No

ID

このリソースを担当するベンダーの識別子。この一意のIDは、OneRoster適合プロセス中にIMSによって割り当てられます。

applicationId

No

ID

このリソースに関連付けられたアプリケーションの識別子。この識別子は、リソースの作成者/ベンダーによって割り当てられます。

 

バルク処理をサポートする場合、このファイルと他のファイルとの依存関係はありません。

 


3.13.      results.csv

これは、OneRosterのResultデータセットを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

result の一意のID。 SourcedIdは他のファイルで使用され、すべての結果で一意である必要があります。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストについては、セクション4.13.8 [OneRoster、17a]を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

lineItemSourcedId

Yes

GUID Reference.

lineItemの一意の識別子。

studentSourcedId

Yes

GUID Reference.

学生(ユーザー)の一意の識別子。 「学生」タイプのusers.csvファイルに作成された/作成されたレコードを参照します。

scoreStatus

Yes

Enumeration

列挙リストについては、セクション4.13.6 [OneRoster、17a]を参照してください。

score

Yes

Float

浮動小数点数(範囲は、関連するlineItem resultValueMinおよびresultValueMaxフィールドで定義されたものと一致する必要があります)。

scoreDate

Yes

Date

result が送信された日付。

comment

No

String

result に関する人間が読めるコメント。

 

バルク処理をサポートする場合、他のファイルに対するこのファイルの依存関係は次のとおりです。:

1)       これには、「lineItemSourcedId」属性を使用した関連するlineItemへの参照が必要です。これにより、 lineItems.csv への依存関係が生成されます。これにより、 academicSessions.csvclasses.csv>、courses.csv>、orgs.csv>、categories.csv ファイルに対応する依存関係が作成されます。

2)       これには、 'studentSourcedId'属性を使用した関連する学生(ユーザー)への参照が必要です。これにより、 users.csv に依存するようになります。これにより、 orgs.csv ファイルに対応する依存関係が作成されます。

 


3.14.      users.csv

これは、OneRosterのユーザーデータセットを表します。

 

カラムフィールドヘッダー

必須

フォーマット

備考

sourcedId

Yes

GUID

ユーザーの一意のID。 SourcedIdは他のファイルで使用され、すべてのユーザーで一意である必要があります。

status

デルタ処理の場合は、Yes

Enumeration

列挙リストについては、セクション4.13.8 [OneRoster、17a]を参照してください。

dateLastModified

デルタ処理の場合は、Yes

DateTime

このレコードが最後に変更された日付。

enabledUser

Yes

Boolean

ブール値:{"true" | 「false」}。 「false」は、ユーザーがアクティブなレコードであるが、ローカル管理ルールに従ってシステムアクセスが制限されていることを示します。

orgSourcedIds

Yes

List of GUID References.

このユーザーが属する組織のSourcedId。

(ほとんどの場合、ユーザーは単一の学校に所属することが予想されます)。

role

Yes

Enumeration

列挙リストについては、セクション4.13.5 [OneRoster、17a]を参照してください。

username

Yes

String

ユーザー名。

userIds

No

List of Strings

このユーザーの外部の機械読み取り可能なID(LDAP id、LTI idなど)。 IDには、識別子の性質を示すタイプを添付する必要があります。タイプとIDの値は '{}'で囲まれ、値の区切りにコロンが使用されます。複数のuserIdが必要な場合は、二重引用符を使用し、カンマで区切ります(RFC 4180に準拠)。

例:

{LDAP:Id}

"{LDAP:Id},{LTI:Id},{Fed:Id}"

givenName

Yes

String

ユーザーの名。

familyName

Yes

String

ユーザーの姓。

middleName

No

String

ユーザーのミドルネーム。複数の場合、それらはスペースで区切られます。

identifier

No

String

人間が読み取れる意味を持つユーザーの識別子。

email

No

String

ユーザーのeメールアドレス。

sms

No

String

ユーザーのSMSアドレス。

phone

No

String

ユーザーの電話番号。

agentSourcedIds

No

List of GUID References

このユーザーが関係しているユーザーのSourcedId。複数のIDが必要な場合は、二重引用符を使用し、コンマで区切ります。

注:ほとんどの場合、これは親の関係を示すためのものです。

grades

No

String

「学生」ロールを持つユーザーが登録されているグレード。許可される語彙は、「Entry Grade Level」要素のCEDS(バージョン5)からのものです https://ceds.ed.gov/CEDSElementDetails.aspx?TermId=7100.

password

No

String

ユーザーのパスワード。これは暗号化された文字列である場合とそうでない場合があります。暗号化する場合、処理するシステムは暗号化方式を認識する必要があります。

 

バルク処理をサポートする場合、他のファイルに対するこのファイルの依存関係は次のとおりです:

1)       これには、「orgSourcedIds」属性を使用した関連組織(組織)への参照が必要です。これにより、 orgs.csv への依存関係が生成されます。;

2)       'agentsSourcedIds'属性を介して同じファイル内のエージェント(ユーザー)への参照が存在する場合がありますが、これにより新しいファイルの依存関係は作成されません。

 

付録A - ファイル依存関係マトリックス

表A1は、CSVファイルの依存関係マトリックスです。これは、バルク交換に提供する必要があるCSVファイルのセットを示しています。この依存関係が作成されるのは、提供されるCSVファイルのセットが意味的に完全である必要があり、データモデルが特定のフィールドをCSVファイル内に存在する必要があると定義しているためです。マトリックスを読み取るには、左側の列で目的のCSVファイルを選択します。その行に沿ったエントリは、関連するオプションフィールドがソースCSVファイルに含まれている場合、他のCSVファイルが必要か(R)、または必要かもしれないか(O)を示します。

行の色キー

         緑 - 他のCSVファイルに依存しないソースファイルを示します(マニフェストには、単一のデータファイル、つまり「categories.csv」または「resources.csv」が含まれます)。;

         黄色 - 自身のみに依存するソースファイル、つまり同じCSVファイル内の別の行を示します(マニフェストには、「academicSessions.csv」または「orgs.csv」の単一のデータファイルが含まれます)。;

         オレンジ - 自己完結型の他のファイルに依存するソースファイル、つまり、緑または黄色に色分けされたCSVファイルを示します。 「courses.csv」および「users.csv」は、黄色または緑色のコード化されたファイルに依存しています。;

         ピンク - それ自体が他の依存関係を持つ他のファイルに依存するソースファイルを示します。ピンク色のコード化ファイルは、「classes.csv」、「classResources.csv」、「courseResources.csv」、および「demographics.csv」です。;

         赤 - ピンクで色分けされたファイルと比較した場合、依存関係のさらなる深さとしてのソースファイルを示します。赤コード化されたファイルは、「enrollments.csv」、「lineItems.csv」、および「results.csv」です。

主な結論

         「demographics.csv」、「enrollments.csv」、および「results.csv」ファイルに依存するCSVファイルはありません。;

         グレードブック-向けのCSVファイルセット( "categories.csv"、 "lineItems.csv"、および "results.csv"ファイル)は、他のCSVファイルから独立していません。;

         名簿指向のCSVファイルセットは、「academicsessions.csv」、「classes.csv」、「courses.csv」、「enrollments.csv」、「orgs.csv」、および「users.csv」で構成する必要があります。 OneRoster 1.0の場合、CSV準拠には「demographics.csv」ファイルも必要です。

注:実装は、学期の一貫性に必要なファイルのセットにさらに制約を課す場合があります。

 


表A1 - 「一括」処理のCSVファイル依存関係マトリックス。

 

AcademicSessions

Categories

Classes

Classresources

Courseresources

Courses

Demographics

Enrollments

LineItems

Orgs

Resources

Results

Users

academicSessions
 

O(P)

 

 

 

 

 

 

 

 

 

 

 

 

categories
 

 

 

 

 

 

 

 

 

 

 

 

 

 

classes [C]

R(T),
O[S]

 

 

 

 

R

 

 

 

R(S),
R[S]

 

 

 

classResources
 

R[C]

 

R

 

 

R[C]

 

 

 

R[C]

R

 

 

courseResources
 

O[S]

 

 

 

 

R

 

 

 

R[S]

R

 

 

courses [S]
 

O(SY)

 

 

 

 

 

 

 

 

R

 

 

 

demographics
 

 

 

 

 

 

 

 

 

 

R[U]

 

 

R

enrollments

R[C],
O(SY)

 

R

 

 

R[C]

 

 

 

R(S),
R(U)

 

 

R

lineItems [L]

R(GP),
R[C]

R

R

 

 

R[C]

 

 

 

R[C]

 

 

 

orgs
 

 

 

 

 

 

 

 

 

 

O(P)

 

 

 

resources
 

 

 

 

 

 

 

 

 

 

 

 

 

 

results

R[L],
O(SY)

R[L]

R[L]

 

 

R[L]

 

 

R

R[L]

 

 

R(S)

Users [U]

 

 

 

 

 

 

 

 

 

R

 

 

O(A)

 

 

このドキュメントについて

 

タイトル: IMS OneRoster®: CSV テーブル

著者: フィル・ニコルス (オラクル) および コリン・スマイス (IMS グローバル)

Version: 1.1

バージョン日: 2017年4月17日

状態: 最終リリース

要約: このドキュメントには、IMS OneRoster V1.1仕様を構成するOneRosterのCSVファイル構造に関する情報が含まれています。このドキュメントには、OneRosterデータをCSVファイルセットに保存する方法の説明が含まれています。システム間でのCSVファイルの交換方法は扱いません。

目的: このドキュメントは一般の方の実装にお使いいただけます。

Document Location: http://www.imsglobal.org/lis

 

 

 

 


コントリビューター・リスト

次の方々はこのドキュメントの開発に貢献されました。:

 


改訂履歴

 

バージョン No.

リリース日

コメント

V1.0 最終版

2015年6月3日

MS OneRoster Finalドキュメントの最初の正式リリース。

V1.1 最終版

2017年4月17日

IMS OneRoster Finalドキュメントの2回目の正式リリース。

 


IMS グローバルラーニングコンソーシアム(「IMS グローバル」)は、科学的、実験的、および学術的なコラボレーションのみを目的として、この IMS OneRoster (「仕様」)に含まれる情報を公開しています。

IMS グローバルは、仕様の正確性または完全性に関していかなる保証も表明も行いません。

この資料は、「現状有姿」および「提供可能な限度」で提供されます。

仕様は常に予告なしに変更および修正される場合があります。

仕様に関する有用性、正確性、完全性を評価することは、お客様に関わるお客様の責任です。

IMS グローバルは、ご意見やご提案をお待ちしています。

http://www.imsglobal.org のWebサイトからIMS グローバルに連絡してください。

ドキュメント名: IMS OneRoster® 1.1 CSV テーブル を参照してください

日付: 2017年4月17日

 


このページには、IMS Logos、Learning ToolsInteroperability®(LTI®)、Accessible Portable ItemProtocol®(APIP®)、Question and TestInteroperability®(QTI®)、CommonCartridge®(CC®など、IMS Global Learning Consortiumの商標が含まれています)、AccessForAll™、OneRoster®、Caliper Analytics™、SensorAPI™。 IMS商標使用ポリシーの詳細については、 商標ポリシーのページ をご覧ください

© 2001-2017 IMS Global Learning Consortium Inc. All Rights Reserved. 個人情報保護方針