Apple School Managerにデータを読み込むためのテンプレート情報
Apple School Managerにデータを追加するには、AppleまたはOneRosterによって形式設定された.csvテンプレートファイルを使用できます。
Apple .csvテンプレート名:生徒、職員、コース、クラス、名簿、場所
OneRoster .csvテンプレート名:ユーザ、コース、クラス、登録、組織
Appleファイル名 | OneRosterファイル名 | コンテンツ | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Apple:生徒アカウント情報が含まれます。 OneRoster:生徒、講師、職員のアカウント情報が含まれます。 | |||||||||||
N/A | 講師を含む職員アカウント情報が含まれます。 | ||||||||||
コース情報が含まれます。 | |||||||||||
クラスと講師(スタッフ)の情報が含まれます。 | |||||||||||
クラス、生徒、および場所(名簿)情報が含まれます。 | |||||||||||
場所(学校または学部)情報が含まれます。 |
テンプレートと管理対象Apple Account
管理対象Apple Accountのフォーマットにperson_numberやsis_usernameといったオプションのフィールドが含まれている場合、それらのフィールドは必須フィールドになります。それらのフィールドを空白のままにした場合、SFTPのアップロードが失敗し、「MANAGED_ID_GENERATION_FAILED」のエラーが表示されます。
テンプレートの用意
テンプレートを用意する際は、以下の条件が満たされていなければなりません:
students.csvとstaff.csvのテンプレートでは、すべての場所を通じてperson_idが一意の値を持つようにします。
重要: SFTPを使用して新規ユーザをアップロードする際、割り当てたperson_idが別のユーザにすでに割り当てられている場合は、その新規ユーザでApple School Managerの既存のユーザが上書きされます。上書きの完了後、そのユーザのアップデートはSFTP経由でのみ行えます。
テンプレートを編集する場合は、サンプルデータを独自のデータで置き換えます。各ファイルのヘッダー行の内容を変更しないでください。どのファイルでも重複する列を作成しないでください。特定のテンプレートには、列を追加することができます。
それぞれのテンプレートで、各行に一意の値が指定されている必要があります。たとえば、students.csvファイル内の各行はそれぞれ固有の生徒が指定されている必要があります。生徒の一部の値は空にすることができます。リテラル値(たとえば、名前に含まれる改行や引用符)はバックスラッシュ(\)でエスケープする必要があります。例:\"。入力する識別子はすべて、英数字でなければなりません。ただし、ハイフン(-)を含めることはできます。
値にスペース( )またはカンマ(,)が含まれる場合は、直線型の引用符(")で囲みます。値にこれらの特殊文字が含まれない場合、引用符は使用しないでください。必要なところで引用符が使用されていない場合や、曲線型の引用符を使用した場合は、アップロードプロセスでエラーが発生します。
ファイルの作成方法に関わらず、ファイル内の値は、カンマ(,)またはセミコロン(;)で区切られていなければなりません。カンマまたはセミコロンと後続の値の間に、スペースやタブを使用しないでください。ファイルのエンコーディングにはUTF-8を使用します。行の終わりを示すには、UNIXの改行コードである\nを使用します。
以前のアップロードからのエントリが欠落している場合、次の場合を除き、ユーザアカウントは無効化され、120日後に自動的に削除されます。
ユーザがアプリまたはブックを一括購入した役割を持っている。
ユーザが120日の制限前に手動で削除された
.csvファイルの名前は、元のファイル名と完全に一致させる必要があります。
すべてのファイルを1つのZIPアーカイブファイル(.zip)に圧縮してからアップロードします。
ZIPアーカイブファイルに含まれるフォルダ内には、ファイルを入れないようにしてください。
他の.csvファイルに対する外部キー参照はすべて、参照先のファイル内で定義されている必要があります。
.csvテンプレートでの文字数制限
.csvテンプレートの一部のフィールドには、許容文字数に制限があります。
属性名 | テンプレート | 文字数制限 |
---|---|---|
Apple:first_name OneRoster:givenName | Apple:生徒、職員 OneRoster:ユーザ | 32 |
Apple:middle_name OneRoster:middleName | Apple:生徒、職員 OneRoster:ユーザ | 32 |
Apple:last_name OneRoster:familyName | Apple:生徒、職員 OneRoster:ユーザ | 64 |
Apple:grade_level OneRoster:grades | Apple:生徒 OneRoster:ユーザ | 64 |
Apple:email_address OneRoster:email | Apple:生徒 OneRoster:ユーザ | 256 |
Apple:person_number OneRoster:identifier | Apple:生徒、職員 OneRoster:ユーザ | 64 |
Apple:person_id OneRoster:sourcedId | Apple:生徒、職員、クラス、名簿 OneRoster:ユーザ、クラス、登録 | 256 |
Apple:sis_username OneRoster:username | Apple:生徒、職員 OneRoster:ユーザ | 256 |
Apple:class_id OneRoster:sourcedID | Apple:クラス、名簿 OneRoster:クラス、登録 | 256 |
Apple:class_number OneRoster:classCode | Apple:生徒、クラス OneRoster:クラス | 64 |
Apple:course_id OneRoster:sourcedID | Apple:コース、クラス OneRoster:コース、クラス | 256 |
Apple:course_name OneRoster:title | Apple:コース OneRoster:コース | 128 |
Apple:course_number OneRoster:courseCode | Apple:コース OneRoster:コース | 64 |
Apple:location_name OneRoster:name | Apple:場所 OneRoster:組織 | 256 |
Apple:location_id OneRoster:sourcedID | Apple:生徒、職員、コース、クラス、場所 OneRoster:ユーザ、コース、クラス、組織 | 256 |