자료 정보와 설정 저장
자료 정보
sdk.material;
// {
// description: { type: 'text', text: '…' } 또는 { type: 'html', html: '…' },
// entries: { learn: 'index.html', instructor: 'instructor.html', edit: 'edit.html' },
// settings: { … }, // 설정 화면이 저장한 값
// completionPolicy: 'on_submit', // 이 페이지의 학습 완료 설정 (읽기만. 서버가 주지 않으면 null)
// }
entries에는metadata.json에서 켠 화면의 진입 파일이 들어 있습니다.settings는 학생을 포함한 모든 보는 사람에게 내려가는 공개 값입니다. 정답이나 비밀 값, 학습자 개인정보는 넣지 마세요. 예외는 채점 설정settings.grading하나입니다. 서버가 학습 페이지(학생 · 튜터 · 교육자) 응답에서grading을 빼고, 편집 화면에서만 보입니다.
설정 화면에서 저장
편집 페이지는 entries.edit 파일을 edit 범위 토큰으로 띄웁니다. 이때 material.settings는 자료의 draft 값(draft가 없으면 지금 버전 값)입니다. 저장 버튼을 설정 화면 안에 두고 saveSettings()를 부르면 draft의 settings가 저장되고, 저장이 끝나면 material.settings가 저장된 값으로 바뀝니다. 학습자는 편집 페이지에서 draft를 반영(새 버전으로 저장)한 뒤에 이 값을 받습니다.
import { EliceCDKError } from '@eliceio/cdk';
if (sdk.screen === 'edit') {
document.getElementById('save').addEventListener('click', async () => {
try {
await sdk.saveSettings({ difficulty: 'hard', questionCount: 10 });
showMessage('저장했습니다.');
} catch (err) {
showMessage(
err.code === EliceCDKError.code.DraftNotSaved
? '자료를 먼저 저장하세요.'
: '저장하지 못했습니다.'
);
}
});
}
- 동시에 저장하면 나중 것이 남습니다.
- draft가 아직 처리 중이거나 처리에 실패했으면
content_not_ready로 실패합니다. - 저장 전 업로드의 설정 화면(
#edit=1, 토큰 없음)에서는draft_not_saved로 실패합니다. 이때 저장하면 이전 버전의 설정이 바뀌고 업로드가 지워지기 때문입니다. 자료를 먼저 저장한 뒤 설정 화면을 다시 엽니다. - 설정 화면 밖에서 부르면
screen_not_supported, 세션이 끝났으면session_expired로 실패합니다.
저장 결과는 편집 페이지에도 메시지로 알립니다. 편집 페이지는 성공하면 자료를 다시 불러옵니다. 콘텐츠가 따로 처리할 일은 없습니다.
{ source: 'eliceio-content-sdk', type: 'settings-saved', materialId, payload: { status: 'saved' } }
{ source: 'eliceio-content-sdk', type: 'settings-saved', materialId, payload: { status: 'failed', code } }
채점 설정 (settings.grading)
채점 방식과 정답은 설정 화면이 saveSettings()로 settings.grading에 저장합니다. 타입은 EliceCDKGrading입니다.
settings.grading | 뜻 |
|---|---|
{ type: "pattern", answer_key } | answer_key: 정규식 하나. 답 문자열(앞뒤 공백 자름) 전체가 맞으면 100점, 아니면 0점 |
{ type: "partial_pattern", answer_key, scores } | 문항별 부분 점수. answer_key는 정규식 배열, scores는 점수 배열(같은 길이 1 |
{ type: "rubric", rubric } | rubric: 평가 기준. AI가 0~100점으로 채점 |
- 정규식은 모두 앞뒤 공백을 자른 답 전체와 맞춰 보고(전체 일치), 500자 이하이며 컴파일되어야 합니다.
- 서버는 Python
re로 맞춥니다. 대소문자를 무시하려면 맨 앞에(?i)를 둡니다(예:(?i)파리|paris).
await sdk.saveSettings({
...sdk.material.settings,
grading: { type: 'partial_pattern', answer_key: ['(?i)paris', '4', '광합성'], scores: [34, 33, 33] },
});
학습 완료 설정
학습 완료 기준은 settings가 아니라 LXP 페이지의 설정입니다. 자료를 올린 뒤 교육자가 자료 편집 화면의 '설정'에서 고르고, 버전과 상관없이 유지됩니다. 콘텐츠는 material.completionPolicy로 읽기만 하고 바꾸지 않습니다.
completionPolicy | LXP 화면 이름 | 채점 |
|---|---|---|
on_access | 열람 시 학습 완료 | 채점하지 않음. 학생이 처음 열 때 100점으로 완료 |
on_submit | 제출 시 학습 완료 | 제출하면 100점으로 완료 |
on_graded | 답안 확인 후 완료 | settings.grading으로 채점 |
채점 결과가 어떻게 오는지는 답안 제출과 기록을 봅니다.