名簿同期zipの要件 – Turnitin ガイド

管理者向けのこのガイドでは、Turnitin Feedback Studioの名簿同期に準拠した名簿zipファイルを準備し、提出する方法について説明します。必要なファイル構造、エンコード標準、SFTPの動作について説明し、名簿データを正常に送信できるようにします。

このガイドの内容は次のとおりです。

概要
zipファイル
ファイルエンコーディング
SFTPフォルダー

概要

管理者が名簿同期を設定する際、OneRoster v1.1仕様に従った名簿zipファイルを（SFTP経由で）送信する必要があります。 Turnitinでは、OneRoster標準規格で定義されているすべてのファイルやフィールドを必須としているわけではありませんが、名簿zipには名簿同期が処理中に使用する特定のCSVファイルとプロパティ値が含まれている必要があります。

一括とデルタの比較

名簿同期はmanifest.csvファイルを使用して、送信されたデータの解釈方法を理解します。特に、「一括」モードと「デルタ」モードに基づいて、各ファイルがデータの完全なスナップショットを表すのか、それとも一連の変更を表すのかを判断します。

一括とは、「このファイルが現在の記録の完全なセットを表す」ことを意味します。
クラス、ユーザー、または登録を一括アップロードから省略した場合、それらの項目は削除されたものとして扱われることがあります。
デルタとは、「このファイルには、前回のアップロード以降の変更のみが含まれている」ことを意味します。

ほとんどの問題は、一括アップロード時に必要な記録が欠落している場合に発生します（例えば、SISエクスポートが不完全な場合）。送信する前に、エクスポートでアクティブな状態を維持する記録一式が含まれていることを確認します。

zipファイル

名簿zipファイルの名前は何でも構いませんが、その中に含まれるファイルは必要なCSV名を正確に使用する必要があります。名簿同期が正しくデータを処理できるように、各登録zipにはこのガイドに記載されている指定ファイルが含まれている必要があります。

各名簿zipには、必要なプロパティ名と形式を持つ以下のファイルが含まれている必要があります。

manifest.csv

顧客によって値が異なりますが、プロパティ名が存在し、正しい形式である必要があります。

propertyName,value manifest.version, 1.0 oneroster.version, 1.1 file.academicSessions,bulk file.categories,absent file.classes,bulk file.classResources,absent file.courses,bulk file.courseResources,absent file.demographics,bulk file.enrollments,bulk file.lineItems,absent file.orgs,bulk file.resources,absent file.results,absent file.users,bulk source.systemName, "OneRoster-Zipper" source.systemCode,OneRoster-Zipper

file.[item]エントリのいずれかがbulkに設定されていれば、そのデータセットのアップロードは完了したものとみなされます。欠落した記録はクラスから除外される可能性があります（例えば、登録情報が不足していると、学生がクラスから削除される可能性があります）。

orgs.csv

sourcedId, status, dateLastModified, name

academicSessions.csv

sourcedId, status, dateLastModified, title, startDate, endDate, schoolYear

users.csv

sourcedId, status, dateLastModified, enabledUser, orgSourcedIds, role, username, givenName, familyName, email

名簿同期はユーザーのEメールアドレスを更新しません。ユーザーのEメールがSISで変更された場合、その変更は名簿同期に反映されず、更新には別のワークフローが必要になる場合があります。

classes.csv

sourcedId, status, dateLastModified, title, courseSourcedId, schoolSourcedId, termSourcedIds

enrollments.csv

sourcedId, status, dateLastModified, classSourcedId, schoolSourcedId, userSourcedId, role, primary

ファイルエンコーディング

名簿zip内のCSVファイルはすべてUTF-8でエンコードされている必要があります。 UTF-16（およびその他のエンコード）では、ファイル名やヘッダーが正しくても、処理に失敗することがあります。

SFTPフォルダー

顧客が名簿zipをSFTPで送信すると、/transferフォルダーにアップロードされます。

ファイルが受信されると、名簿同期は処理を開始するよう通知されます。その処理の一環として、名簿zipは/transferから/archiveフォルダーに移動されます。 /archiveフォルダーには、過去に処理されたアップロードが最大30日間保存されるので、/transferにファイルがない場合は、/archiveを確認します。