IMS Final Release

IMS Global Logo

IMS OneRoster™: CSV テーブル

バージョン1.0 最終版

発行日:            2015年6月3日

最新バージョン:         http://www.imsglobal.org/lis/

 

知的財産権と配布に関するお知らせ
この文書の受信者は、コメント、関連する特許請求の通知、またはこの文書に記載されている仕様の実装によって侵害される可能性のあるその他の知的財産権の通知を提出し、サポート資料を提供するように要求されています。

IMSは、このドキュメントに記載されている技術の実装または使用に関連すると主張される可能性のある知的財産またはその他の権利の有効性または範囲、またはそのような権利に基づくライセンスが利用可能かどうかに関していかなる立場もとりません; また、そのような権利を特定する努力を行ったことを表明するものでもありません。 IMS仕様の権利に関するIMSの手順に関する情報は、IMS知的財産権のWebページ: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf にあります。

Copyright © 2015 IMS Global Learning Consortium. All Rights Reserved.

製品またはサービスを開発するためのこの仕様の使用は、IMSのWebサイト: http://www.imsglobal.org/license.html にあるIMSのライセンスによって管理されます。

提案の要求を作成する際は必要に応じて、この文書からの抜粋を使用するすべての関係者に許可が与えられます。

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

この仕様はいかなる保証もなく提供されており、特に、非侵害の保証は明示的に否認されます。この仕様の使用は、実装者の独自のリスクにおいて全面的に行われるものとし、そのコンソーシアム、そのメンバーまたは提出者のいずれも、この仕様の使用に起因する直接または第三者のいかなる損害についても、いかなる責任も負わないものとします。

コメントとフィードバックについては、: http://www.imsglobal.org/community/forum/categories.cfm?catid=59 のディスカッションに参加してください。

 

© 2015 IMS Global Learning Consortium, Inc.
All Rights Reserved.

商標情報: http://www.imsglobal.org/copyright.html
ドキュメント名:  IMS OneRoster: CSV テーブル
改訂:2015年6月3日

 

目次

1.             はじめに.. 3

1.1.         OneRoster の概要... 3

1.2.         参照資料. 3

2.             CSV の概要... 4

3.             CSV のフォーマット.. 5

3.1.         orgs.csv.. 5

3.2.         users.csv.. 6

3.3.         courses.csv.. 7

3.4.         classes.csv.. 8

3.5.         enrollments.csv.. 9

3.6.         academicSessions.csv.. 10

3.7.         demographics.csv.. 10

4.             適合性テスト.. 12

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

貢献者のリスト. 13

改訂履歴.. 14

 

1. はじめに

1.1. OneRoster の概要

学習情報サービス(LIS)は、IMS グローバルによって開発された標準です。この規格は、さまざまな教育システム間での学生データ(人、コース、登録、成績に関する)の交換に対応しています。

K12コミュニティのニーズに対応するために、IMSは、LISコアプロファイルのプロファイルを引き受けて、K12のグレード転送に関する機能を拡大し、LISデータモデルを絞り込んでK12により適したものにし、学習ツールに名簿情報を提供したい人のためにcsv形式のファイルを提供しました。また、RESTまたはSOAPバインディングを介してOneRoster仕様が利用可能にしました。

OneRoster仕様[OneRoster、15]には、ベストプラクティスと実装ガイド、および公開名簿情報を含む複数の部分が含まれます。このドキュメントはv1.0の最終リリースであり、仕様のさらなる実装に基づいて変更されます。 OneRosterへの適合はまもなく利用可能になります

1.2. 参照資料

[LTI, 10]                IMS Learning Tools Interoperability (LTI) v1.0IMS グローバル、2010年5月。

[LIS, 13]                IMS Learning Information サービス 2.0.1IMS グローバル、2013年7月。

[OneRoster, 15]    IMS One Roster 仕様 v1.0IMS グローバル、2015年6月。

 

2. CSV の概要

多くの学区は現在、学生情報をツールプロバイダーおよびLMS / LORベンダーに.csv形式のファイルとして提供しています。

ベンダーと名簿情報を交換するために引き続き.csvファイルを使用する必要がある地区の場合、OneRoster標準に対応する名簿データの形式の概要を以下に示します。 

学区は、この文書に記載されているcsv形式の7つのファイルを準備することにより、クラス名簿をアップロードすることを選択できます。名簿は、インポートとエクスポートの両方に使用できます。

1.       orgs.csv

2.       users.csv

3.       courses.csv

4.       classes.csv

5.       enrollments.csv

6.       academicSessions.csv

7.       demographics.csv

 

3. CSV のフォーマット

ファイル形式は、OneRosterプロファイルのコンマ区切り値形式(CSV)である必要があります。各フィールドは、各行の間のコンマと改行で区切られます。コンマを含むフィールドでは二重引用符を使用する必要があります。

        すべてのファイルが必要です

        ヘッダー行が必要です。

        一部のフィールドは必須です。

        プライマリIDは下に赤でマークされています。これはファイルごとに一意である必要があります。

すべてのヘッダーフィールドは、下の表とまったく同じ順序で指定する必要があります。データのないオプションフィールドは、CSVでは単に空にする必要があります。 ヘッダーフィールドには、以下の表のフィールドヘッダーと同じ名前を付ける必要があります。すべてのファイル名とヘッダーフィールドでは大文字と小文字が区別されます。

CSVインポートは、バルクとデルタの2つの方法のいずれかで機能することが想定されています。

バルク処理では、着信したcsvファイルに「dateLastModified」および「status」フィールドにDATAを含めることはできません。つまり、各行について、これらのフィールドのいずれにもデータはなく、コンマの間に空のスペースがあるだけです。

 インポートシステムは、この着信したデータをすべてのデータの参照バージョンとして表示する必要があります。つまり、以前にインポートされたレコードがこのバルクcsvファイルに表示されない場合、インポートシステムはそれらのレコードを内部的に非アクティブとしてマークする必要があります。その後、これらのレコードが将来のバルクファイルに表示される場合は、それらのレコードを更新してアクティブにする必要があります。

デルタ処理では、着信したCSVファイルの「dateLastModified」および「status」フィールドにDATAを含める必要があります。つまり、csvファイルの各行には、(行)データが最後に変更されたこととそのステータスを説明するデータが含まれている必要があります。

インポートシステムは、この着信したデルタファイルを参照データの変更として表示し、新しいデータの適切な変更、削除、挿入を行う必要があります。

空のデルタファイルは拒否されるか、何も変更されないように処理されます。

空のファイルであっても、すべての(7つの)ファイルを処理用に提供することをお勧めします。データを含まないファイルには、ヘッダーフィールドを含める必要があります。

CSVファイルの日付フォーマットは、RESTful APIの日付フォーマットとは異なります。このプロパティにはYYYY-MM-DD形式を使用してください。

3.1. orgs.csv

 

フィールドヘッダー

必須

フォーマット

備考

sourcedId

はい

string

組織の一意のID。 SourcedIdは他のファイルで使用され、すべての組織で一意である必要があります。 (たとえば、学区内の学校)。

status

いいえ

String

「アクティブ」| 「非アクティブ」| 「削除予定」。 削除予定オブジェクトが、既に存在する場合、受信システムで削除される場合があります

dateLastModified

いいえ

Date

このレコードが最後に変更された日付。(形式はYYYY-MM-DD)

name

はい

string

組織の名前

type

はい

String

「学校」| 「ローカル」| 「状態」| 「国の」

identifier

いいえ

string

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

metadata.classification

いいえ

String

「チャーター」| 「プライベート」| "パブリック"

metadata.gender

いいえ

String

「女性」| 「男性」| 「混合」

metadata.boarding

いいえ

Boolean

学校が寄宿学校であれば真

parentSourcedId

いいえ

string

親組織のSourcedId

 

3.2. users.csv

 

フィールドヘッダー

必須

フォーマット

備考

sourcedId

はい

String

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

status

いいえ

String

「アクティブ」| 「非アクティブ」| 「削除予定」。 削除予定オブジェクトが、既に存在する場合、受信システムで削除される場合があります

dateLastModified

いいえ

Date

このレコードが最後に変更された日付。 (フォーマットはYYYY-MM-DDです)

orgSourcedIds

はい

String

このユーザーが属する組織のSourcedId。複数のIDが必須の場合は、二重引用符を使用し、コンマで区切ります。

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

role

はい

String

「教師」、「学生」、「親」、「保護者」、「親戚」、「補助」、「管理者」

username

はい

String

ユーザー名

userId

いいえ

String

sourcedIdを使用しない場合に使用する、このユーザーの外部マシン読み取り可能なID(LDAP ID、LTI idなど)

givenName

はい

String

ユーザーの名

familyName

はい

String

ユーザーの姓

identifier

いいえ

String

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

email

いいえ

String

ユーザーのEメールアドレス

sms

いいえ

String

ユーザーのSMSアドレス

phone

いいえ

String

ユーザーの電話番号

agents

いいえ

String

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

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

 

3.3. courses.csv

 

フィールドヘッダー

必須

フォーマット

備考

sourcedId

はい

String

コースの一意のID。 SourcedIdは他のファイルで使用され、すべてのコースで一意でなければなりません。

status

いいえ

String

「アクティブ」| 「非アクティブ」| 「削除予定」。 削除予定オブジェクトが、既に存在する場合、受信システムで削除される場合があります

dateLastModified

いいえ

Date

このレコードが最後に変更された日付。 (フォーマットはYYYY-MM-DDです)

schoolYearId

いいえ

String

コースが実施される学年。これはアカデミックセッションのsourcedIdです(以下を参照)

metadata.duration

いいえ

String

コースの期間の説明(2週間、1学期など)。

title

はい

String

コース名

courseCode

いいえ

String

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

grade

いいえ

String

学年(例:9または範囲9-12)

orgSourcedId

いいえ

String

このコースが属する組織のSourcedId。これは、学区レベルの組織IDである可能性があります。

subjects

いいえ

String

サブジェクト名。複数の件名が必要な場合は、二重引用符を使用し、カンマで区切ります(RFC 4180に準拠)。:

例:
「化学、物理学」
物理
「音楽、ドラマ、詩」

 

3.4. classes.csv

 

フィールドヘッダー

必須

フォーマット

備考

sourcedId

はい

String

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

status

いいえ

String

「アクティブ」| 「非アクティブ」| 「削除予定」。 削除予定オブジェクトが、既に存在する場合、受信システムで削除される場合があります

dateLastModified

いいえ

Date

このレコードが最後に変更された日付。 (フォーマットはYYYY-MM-DDです)

title

はい

String

このクラスの名前

grade

いいえ

String

学年(例:9または範囲9-12)

courseSourcedId

いいえ

String

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

classCode

いいえ

String

このクラスを識別するのに役立つ人間が読めるコード

classType

はい

String

「ホームルーム」、「予定」

location

いいえ

String

クラスが物理的に配置されている場所の人間が読める説明

schoolSourcedId

はい

String

このクラスを教える組織のSourcedId

termSourcedId

はい

String

クラスが教えられているacademicSessionsのSourcedId。複数の用語が必要な場合は、二重引用符を使用し、カンマで区切ります(RFC 4180による)

例:

「1,2」

1

「1,4,8」

subjects

いいえ

String

サブジェクト名。複数の件名が必要な場合は、二重引用符を使用し、カンマで区切ります(RFC 4180に準拠):

例:
「化学、物理学」
物理
「音楽、ドラマ、詩」

3.5. enrollments.csv

 

フィールドヘッダー

必須

フォーマット

備考

sourcedId

はい

String

この登録のID

classSourcedId

はい

String

クラスのID

schoolSourcedId

はい

String

学校のID

userSourcedId

はい

String

ユーザーのID(教師または学生)

role

はい

String

「学生」| 「先生」| 「親」| 「保護者」| 「親戚」| 「補助」、「管理者」

status

いいえ

String

「アクティブ」| 「非アクティブ」| 「削除予定」。 削除予定オブジェクトが、既に存在する場合、受信システムで削除される場合があります

dateLastModified

いいえ

Date

このレコードが最後に変更された日付。 (フォーマットはYYYY-MM-DDです)

primary

いいえ

Boolean

クラスの教師1人に対してのみtrueに設定する必要があります。

 

3.6. academicSessions.csv

 

フィールドヘッダー

必須

フォーマット

備考

sourcedId

はい

String

このAcademySessionのSourcedId。 AcademicSessionsは他のファイルで使用され、すべてのAcademySessionsで一意である必要があります。

status

いいえ

String

「アクティブ」| 「非アクティブ」| 「削除予定」。 削除予定オブジェクトが、既に存在する場合、受信システムで削除される場合があります

dateLastModified

いいえ

Date

このレコードが最後に変更された日付。 (フォーマットはYYYY-MM-DDです)

title

はい

String

採点期間の名前またはタイトル

type

はい

String

「学期」、「採点期間」、「学年」、「学期」

startDate

はい

String

開始日

endDate

はい

String

終了日

parentSourcedId

いいえ

String

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

 

3.7. demographics.csv

人口統計はオプションであるため、データプロバイダーは必ずしもこの情報を提供する必要はありません。もしそうなら、これは使用するフォーマットです。 (人口統計が提供されていない場合は、空のファイル(ヘッダー付き)を送信する必要があります)。

 

フィールドヘッダー

必須

フォーマット

備考

userSourcedId

はい

String

人口統計が参照するユーザーのSourcedId。通常、これは学生です。

status

いいえ

String

「アクティブ」| 「非アクティブ」| 「削除予定」。 削除予定オブジェクトが、既に存在する場合、受信システムで削除される場合があります

dateLastModified

いいえ

Date

このレコードが最後に変更された日付。 (フォーマットはYYYY-MM-DDです)

birthdate

はい

Date

学生の生年月日

sex

はい

String

「女性」| "男性"

americanIndianOrAlaskaNative

はい

Boolean

 

asian

はい

Boolean

 

blackOrAfricanAmerican

はい

Boolean

 

nativeHawaiianOrOtherPacificIslander

はい

Boolean

 

white

はい

Boolean

 

demographicRaceTwoOrMoreRaces

はい

Boolean

 

hispanicOrLatinoEthnicity

はい

Boolean

 

countryOfBirthCode

はい

String

語彙 – https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20002

stateOfBirthAbbreviation

いいえ*

String

語彙 – https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20837

注:米国および米国領の場合、このフィールドは必須と見なす必要があります。

米国以外の場合、このフィールドはオプションです。

cityOfBirth

はい

String

 

publicSchoolResidenceStatus

はい

String

語彙 – https://ceds.ed.gov/CEDSElementDetails.aspx?TermxTopicId=20863

 

4. 適合性テスト

IMS グローバルは、csvファイルの適合性テストを提供します。 (未定)

 

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

 

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

編集者:                                  フィル・ニコルス(IMS グローバル)

バージョン:                             1.0

バージョン日付:                       2015年6月3日

ステータス:                             最終版

概要:                                     このドキュメントには、IMS OneRoster仕様を構成するOneRosterのcsvファイル構造に関する情報が含まれています。

目的:                                     このドキュメントは、パブリックコメントとフィードバックに利用できます。

ドキュメントの場所:                http://www.imsglobal.org/lis

 

貢献者のリスト

次の個人がこのドキュメントの開発に貢献しました。:

名前                                             組織

デビッド・ガッパ                         サファリ・モンテージュ

トム・イングラム                         エスカンビア郡学区

マイク・カーストラ                      ディザイアー2ラーン

アンドリュー・クリツキー             HMH

リサ・マットソン                         IMS グローバル

デビッド・メイエス                      グウィンネット郡学校

アンディ・ミラー                         ラーニング・コム

フィル・ニコルス                         IMS グローバル (UK)

パドレグ・オヒセアダ                   HMH

ユーペンドラ・ペネガラパティ       ピアソン

ジョージ・ペロールト                   オレンジ郡公立学校

ジェームズ・ペロールト                FLVS

パトリック・ポーター                   ヒューストン ISD       

ウェンディー・ライエディー          サンガード K12

カート・ロムポット                      ピアソン

アディチャ・スブラマニアム          スクーロジー

マーク・ウォールズ                      グウィンネット郡学校

スタンリー・ワッツ                      クラスリンク

マイク・ザッカーソン                   インストラクチャー

 

改訂履歴

 

バージョン No.

リリース日

コメント

v1.0 パブリックドラフト

 2015年2月12日

OneRoster 仕様の最初のリリース。

v1.0 最終版

2015年6月3日

メンバーコメントと実装実績がアップデートされました。

                               

 

 

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

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

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

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

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

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

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

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

日付: 2015年6月3日