Lampiran jenis aktivitas

Ini adalah panduan kelima dalam seri panduan add-on Classroom.

Dalam panduan ini, Anda akan mengubah contoh dari langkah panduan sebelumnya untuk menghasilkan lampiran jenis aktivitas. Lampiran ini harus dikirimkan oleh siswa, seperti respons tertulis, kuis, atau artefak buatan siswa lainnya.

Perbedaan antara lampiran jenis konten dan jenis aktivitas adalah penting. Lampiran jenis aktivitas berbeda dengan jenis konten dalam hal berikut:

• Tombol "Serahkan" akan muncul di kanan atas iframe Tampilan Siswa.
• ID unik untuk tugas siswa akan diberikan.
• Kartu lampiran siswa akan muncul di UI pemberi nilai Classroom.
• Mereka dapat menetapkan nilai untuk tugas yang dimiliki.

Lihat panduan berikutnya untuk diskusi tentang penilaian. Dalam panduan ini, Anda telah menyelesaikan hal-hal berikut:

• Ubah permintaan pembuatan lampiran sebelumnya ke Classroom API untuk membuat lampiran jenis aktivitas.
• Terapkan penyimpanan persisten untuk kiriman siswa.
• Ubah rute Tampilan Siswa sebelumnya untuk menerima input siswa.
• Berikan rute untuk menayangkan iframe Tinjauan Tugas Siswa.

Setelah selesai, Anda dapat membuat lampiran jenis aktivitas pada tugas melalui UI Google Classroom saat login sebagai pengajar. Siswa di kelas juga dapat menyelesaikan aktivitas di iframe dan mengirim respons. Pengajar dapat melihat tugas siswa di UI penilaian Classroom.

Untuk tujuan contoh ini, gunakan kembali template lampiran dari panduan sebelumnya yang menampilkan gambar tempat terkenal dan teks dengan nama tempat terkenal. Aktivitas ini terdiri dari meminta siswa memberikan nama tempat terkenal tersebut.

Penting: Sebelum mengikuti panduan ini, selesaikan panduan sebelumnya dalam rangkaian ini. Panduan ini memperluas aplikasi web yang dikembangkan dalam panduan sebelumnya. Anda dapat mendownload kode sumber lengkap untuk semua panduan dari halaman Ringkasan. Kode untuk panduan khusus ini dapat ditemukan di direktori /05-activity-attachments/.

Mengubah permintaan pembuatan lampiran

Buka bagian kode tempat Anda membuat lampiran jenis konten di panduan sebelumnya. Item kunci di sini adalah instance objek AddOn attachment, tempat kami sebelumnya menentukan teacherViewUri, studentViewUri, dan title untuk lampiran.

Meskipun semua lampiran add-on memerlukan tiga kolom ini, kehadiran atau ketiadaan studentWorkReviewUri akan menentukan apakah lampiran merupakan jenis aktivitas atau jenis konten. Permintaan CREATE dengan studentWorkReviewUri yang terisi akan menjadi lampiran jenis aktivitas, sedangkan permintaan CREATE tanpa studentWorkReviewUri akan menjadi lampiran jenis konten.

Penting: Tetapkan kolom studentWorkReviewUri saat membuat lampiran jenis aktivitas.

Satu-satunya perubahan yang dibuat pada permintaan ini adalah mengisi kolom studentWorkReviewUri. Tambahkan rute dengan nama yang sesuai di sini; Anda akan menerapkannya di langkah berikutnya.

Python

Dalam contoh yang diberikan, ini ada di metode create_attachments di file webapp/attachment_routes.py.

attachment = {
    # Specifies the route for a teacher user.
    "teacherViewUri": {
        "uri":
            flask.url_for(
                "load_activity_attachment",
                _scheme='https',
                _external=True),
    },
    # Specifies the route for a student user.
    "studentViewUri": {
        "uri":
            flask.url_for(
                "load_activity_attachment",
                _scheme='https',
                _external=True)
    },
    # Specifies the route for a teacher user when the attachment is
    # loaded in the Classroom grading view.
    # The presence of this field marks this as an activity-type attachment.
    "studentWorkReviewUri": {
        "uri":
            flask.url_for(
                "view_submission", _scheme='https', _external=True)
    },
    # The title of the attachment.
    "title": f"Attachment {attachment_count}",
}

Menambahkan penyimpanan persisten untuk lampiran jenis konten

Catat respons siswa terhadap aktivitas kita. Anda dapat mencarinya nanti saat pengajar melihat kiriman di iframe Tinjauan Tugas Siswa.

Siapkan skema database untuk Submission. Contoh yang diberikan mengharuskan siswa memasukkan nama tempat terkenal yang ditampilkan pada gambar. Oleh karena itu, Submission berisi atribut berikut:

• attachment_id: ID unik untuk lampiran. Ditetapkan oleh Classroom dan ditampilkan sebagai respons saat membuat lampiran.
• submission_id: ID untuk kiriman siswa. Ditugaskan oleh Classroom dan ditampilkan dalam respons getAddOnContext di Tampilan Siswa.

Catatan: ID pengiriman tidak harus unik. Sebaiknya simpan data pengiriman menggunakan kunci gabungan yang terdiri dari ID lampiran dan ID pengiriman.

• student_response: Jawaban yang diberikan oleh siswa.

Catatan: Atribut ini berjenis string.

Python

Perluas implementasi SQLite dan flask_sqlalchemy dari langkah sebelumnya.

Buka file tempat Anda telah menentukan tabel sebelumnya (models.py jika Anda mengikuti contoh yang kami sediakan). Tambahkan kode berikut di bagian bawah file.

# Database model to represent a student submission.
class Submission(db.Model):
    # The attachmentId is the unique identifier for the attachment.
    submission_id = db.Column(db.String(120), primary_key=True)

    # The unique identifier for the student's submission.
    attachment_id = db.Column(db.String(120), primary_key=True)

    # The student's response to the question prompt.
    student_response = db.Column(db.String(120))

Impor class Submission baru ke dalam file server dengan rute penanganan lampiran Anda.

Mengubah rute Tampilan Siswa

Selanjutnya, ubah rute Tampilan Siswa sebelumnya untuk menampilkan formulir kecil dan menerima input dari siswa. Anda dapat menggunakan kembali sebagian besar kode dari panduan sebelumnya.

Temukan kode server yang menyediakan rute untuk Tampilan Siswa Anda. Ini adalah rute yang ditentukan di kolom studentViewUri saat membuat lampiran. Perubahan pertama yang harus dilakukan adalah mengekstrak submissionId dari respons getAddOnContext.

Python

Dalam contoh yang diberikan, ini ada di metode load_activity_attachment di file webapp/attachment_routes.py.

# Issue a request to the courseWork.getAddOnContext endpoint
addon_context_response = classroom_service.courses().courseWork(
).getAddOnContext(
    courseId=flask.session["courseId"],
    itemId=flask.session["itemId"]).execute()

# One of studentContext or teacherContext will be populated.
user_context = "student" if addon_context_response.get(
    "studentContext") else "teacher"

# If the user is a student...
if user_context == "student":
    # Extract the submissionId from the studentContext object.
    # This value is provided by Google Classroom.
    flask.session["submissionId"] = addon_context_response.get(
            "studentContext").get("submissionId")

Anda juga dapat mengajukan permintaan untuk mendapatkan status pengiriman siswa. Respons berisi nilai SubmissionState, yang menunjukkan status seperti apakah siswa telah membuka lampiran atau menyerahkannya. Hal ini dapat berguna jika Anda ingin melarang pengeditan pada kiriman yang telah diserahkan, atau jika Anda tertarik untuk memberikan insight kepada pengajar tentang progres siswa mereka:

Python

Dalam contoh yang diberikan, ini adalah kelanjutan dari metode load_activity_attachment di atas.

# Issue a request to get the status of the student submission.
submission_response = classroom_service.courses().courseWork(
).addOnAttachments().studentSubmissions().get(
    courseId=flask.session["courseId"],
    itemId=flask.session["itemId"],
    attachmentId=flask.session["attachmentId"],
    submissionId=flask.session["submissionId"]).execute()

Terakhir, ambil informasi lampiran dari database dan tampilkan formulir input. Formulir dalam contoh yang kami sediakan terdiri dari kolom input string dan tombol kirim. Tampilkan gambar tempat terkenal dan minta siswa memasukkan namanya. Setelah mereka memberikan respons, catat dalam database kita.

Python

Dalam contoh yang diberikan, ini adalah kelanjutan dari metode load_activity_attachment di atas.

# Look up the attachment in the database.
attachment = Attachment.query.get(flask.session["attachmentId"])

message_str = f"I see that you're a {user_context}! "
message_str += (
    f"I've loaded the attachment with ID {attachment.attachment_id}. "
    if user_context == "teacher" else
    "Please complete the activity below.")

form = activity_form_builder()

if form.validate_on_submit():
    # Record the student's response in our database.

    # Check if the student has already submitted a response.
    # If so, update the response stored in the database.
    student_submission = Submission.query.get(flask.session["submissionId"])

    if student_submission is not None:
        student_submission.student_response = form.student_response.data
    else:
        # Store the student's response by the submission ID.
        new_submission = Submission(
            submission_id=flask.session["submissionId"],
            attachment_id=flask.session["attachmentId"],
            student_response=form.student_response.data)
        db.session.add(new_submission)

    db.session.commit()

    return flask.render_template(
        "acknowledge-submission.html",
        message="Your response has been recorded. You can close the " \
            "iframe now.",
        instructions="Please Turn In your assignment if you have " \
            "completed all tasks."
    )

# Show the activity.
return flask.render_template(
    "show-activity-attachment.html",
    message=message_str,
    image_filename=attachment.image_filename,
    image_caption=attachment.image_caption,
    user_context=user_context,
    form=form,
    responses=response_strings)

Untuk membedakan antar-pengguna, sebaiknya nonaktifkan fungsi kirim dan tampilkan jawaban yang benar di Tampilan Pengajar.

Menambahkan rute untuk iframe Tinjauan Tugas Siswa

Terakhir, tambahkan rute untuk menayangkan iframe Tinjauan Tugas Siswa. Nama rute ini harus cocok dengan nama yang diberikan untuk studentWorkReviewUri saat membuat lampiran. Rute ini akan terbuka saat pengajar melihat kiriman siswa di UI pemberi nilai Classroom.

Anda akan menerima parameter kueri submissionId saat Classroom membuka iframe Peninjauan Tugas Siswa. Gunakan API tersebut untuk mengambil tugas siswa dari database lokal Anda:

Python

Dalam contoh yang diberikan, file ini ada dalam file webapp/attachment_routes.py.

@app.route("/view-submission")
def view_submission():
    """
    Render a student submission using the show-student-submission.html template.
    """

    # Save the query parameters passed to the iframe in the session, just as we did
    # in previous routes. Abbreviated here for readability.
    add_iframe_query_parameters_to_session(flask.request.args)

    # For the sake of brevity in this example, we'll skip the conditional logic
    # to see if we need to authorize the user as we have done in previous steps.
    # We can assume that the user that reaches this route is a teacher that has
    # already authorized and created an attachment using the add-on.

    # In production, we recommend fully validating the user's authorization at
    # this stage as well.

    # Look up the student's submission in our database.
    student_submission = Submission.query.get(flask.session["submissionId"])

    # Look up the attachment in the database.
    attachment = Attachment.query.get(student_submission.attachment_id)

    # Render the student's response alongside the correct answer.
    return flask.render_template(
        "show-student-submission.html",
        message=f"Loaded submission {student_submission.submission_id} for "\
            f"attachment {attachment.attachment_id}.",
        student_response=student_submission.student_response,
        correct_answer=attachment.image_caption)

Menguji add-on

Penting: Pada tahap pengembangan ini, Anda hanya dapat menguji aplikasi di iframe add-on Classroom. Baca halaman panduan iframe dan parameter kueri untuk melihat deskripsi setiap iframe. Semua petunjuk yang diberikan dalam panduan ini mengasumsikan add-on dapat digunakan dalam konteks iframe.

Ulangi Menguji langkah add-on dari panduan sebelumnya. Anda harus memiliki lampiran yang dapat dibuka oleh siswa.

Selesaikan langkah-langkah berikut untuk menguji lampiran aktivitas:

• Login ke Google Classroom sebagai salah satu pengguna uji coba siswa di kelas yang sama dengan pengguna uji coba pengajar.
• Buka tab Tugas Kelas dan luaskan pengujian Tugas.
• Klik kartu lampiran add-on untuk membuka Tampilan Siswa dan mengirimkan respons untuk aktivitas tersebut.
• Tutup iframe setelah menyelesaikan aktivitas ini. Anda juga dapat mengklik tombol Serahkan.

Anda tidak akan melihat perubahan apa pun di Classroom setelah menyelesaikan aktivitas. Sekarang, uji iframe Tinjauan Tugas Siswa:

• Login ke Classroom sebagai pengguna uji coba pengajar.
• Cari kolom untuk tugas ujian Anda di tab Nilai. Klik nama tugas ujian Anda.
• Temukan kartu untuk pengguna siswa uji coba. Klik lampiran pada kartu.

Pastikan bahwa kiriman yang benar ditampilkan untuk siswa.

Selamat! Anda siap untuk melanjutkan ke langkah berikutnya: menyinkronkan nilai lampiran.