diff --git a/source/instructors/admin/integration/intro.rst b/source/instructors/admin/integration/intro.rst index d74f0a74..2c2bf28d 100644 --- a/source/instructors/admin/integration/intro.rst +++ b/source/instructors/admin/integration/intro.rst @@ -14,6 +14,7 @@ Integrating with your LMS system (Canvas etc.) lms-systems/system-specific-directions lms-students lti-enrol + open-student-assignments-lms grading lti-app lti-keys-and-urls-information diff --git a/source/instructors/admin/integration/lms-systems/blackboard.rst b/source/instructors/admin/integration/lms-systems/blackboard.rst index 731eef9a..c935ef29 100644 --- a/source/instructors/admin/integration/lms-systems/blackboard.rst +++ b/source/instructors/admin/integration/lms-systems/blackboard.rst @@ -6,7 +6,7 @@ Blackboard LTI 1.x ================== -Please be sure to check out the :ref:`Codio LTI App ` which allows for an easy way to integrate and to map Codio course assignments to your LMS system. The `following page `_ explains how to set up external apps in Blackboard Learn. +Please be sure to check out the :ref:`Codio LTI App ` which allows for an easy way to integrate and to map Codio course assignments to your LMS. The `following page `_ explains how to set up external apps in Blackboard Learn. In Codio: @@ -26,8 +26,8 @@ Enable LTI for Your Course Bring up the LTI Integration Information ---------------------------------------- -6. Click your user name in the bottom left of your dashboard -7. Choose your Organization +6. Click your username in the top-right corner of your dashboard. +7. Choose your Organization. 8. Click the **LTI Integrations** tab to bring up the following settings. .. image:: /img/lti/LTIintegrationinfo.png @@ -81,7 +81,7 @@ In Codio 24. On the main course screen, make sure the **Edit Assignments** tab is selected. 25. Click the **Add Assignment** button and select **Project Based**. 26. Select a project that has some autograded assessments. The **My First Project** that you created earlier in the Onboarding Guide has some auto-graded assessments. You can also assign another project but you will need to manually grade the assignment so there are some scores to pass back to the Blackboard gradebook. -27. Once the assignment has been added to the course, you should click the icon with 3 blue dots and select **LTI Integration URL**. +27. Once the assignment has been added to the course, you should click the three dots to the right of that assignment and select **LTI Integration URL**. 28. You should copy the LTI integration url to the clipboard by clicking on the field (it will auto copy). .. figure:: /img/lti/LMS-Unit-URL.png @@ -99,7 +99,7 @@ We now return to Blackboard complete the mapping. 33. In the **Web Link Information** section ... 34. Enter a name for the content 35. Paste in the **LTI Integration URL** that you just copied to the clipboard from Codio -36. Check the box **Ths is a link to a tool provider** +36. Check the box **This is a link to a tool provider** 37. Select **Yes** for the field **Enable Evaluation** after which more fields will appear 38. Set the points you want to award for this content (Codio will automatically scale the percentage value it uses to the points you specify here) 39. Save the content settings. @@ -107,4 +107,4 @@ We now return to Blackboard complete the mapping. Authentication and account creation ----------------------------------- -To add students/teachers see :ref:`Users account creation ` \ No newline at end of file +To add students/teachers, see :ref:`User account creation `. \ No newline at end of file diff --git a/source/instructors/admin/integration/lms-systems/d2l.rst b/source/instructors/admin/integration/lms-systems/d2l.rst index 3d8be7e7..f8fc283f 100644 --- a/source/instructors/admin/integration/lms-systems/d2l.rst +++ b/source/instructors/admin/integration/lms-systems/d2l.rst @@ -61,7 +61,7 @@ Enable LTI for Your Course Bring up the LTI Integration Information **************************************** -1. Click your user name in the bottom left of your dashboard. +1. Click your username in the top-right corner of the dashboard, then select **Organizations**. 2. Choose your Organization. 3. Click the **LTI Integrations** tab to bring up the following settings. @@ -144,3 +144,5 @@ Based on the LMS role, if teachers join Codio via the LMS, the following will ap +----------------------+-----------------------------------------------------------------------------------------------------+ | Mentor | TEACHER (with :ref:`read only ` access to the course} | +----------------------+-----------------------------------------------------------------------------------------------------+ + + diff --git a/source/instructors/admin/integration/lms-systems/google-classroom.rst b/source/instructors/admin/integration/lms-systems/google-classroom.rst index dfca54d0..ec155837 100644 --- a/source/instructors/admin/integration/lms-systems/google-classroom.rst +++ b/source/instructors/admin/integration/lms-systems/google-classroom.rst @@ -64,3 +64,5 @@ Removing .. Note:: Removing the integration link will mean students will not be able to access any of their assignments any longer from Google Classroom .. |Connect to Codio| image:: /img/google_classlist.png + + diff --git a/source/instructors/admin/integration/lms-systems/schoology.rst b/source/instructors/admin/integration/lms-systems/schoology.rst index b17bbe78..5ac465ca 100644 --- a/source/instructors/admin/integration/lms-systems/schoology.rst +++ b/source/instructors/admin/integration/lms-systems/schoology.rst @@ -112,4 +112,6 @@ In Schoology 23. Go back to Schoology and paste the **LTI Integration URL** into the URL field of the Add External Tool form from step 20. 24. You can enable grading on external tool items which adds the material to your Gradebook so that you can assign a grade for each student who completes the assignment launched via the external tool. - .. Note:: LTI and external tool materials that have grading enabled in Schoology do not trigger submission notifications, grading reminders, or overdue notifications because Schoology does not automatically detect submissions from external tools. \ No newline at end of file + .. Note:: LTI and external tool materials that have grading enabled in Schoology do not trigger submission notifications, grading reminders, or overdue notifications because Schoology does not automatically detect submissions from external tools. + + diff --git a/source/instructors/admin/integration/lti-app.rst b/source/instructors/admin/integration/lti-app.rst index 44029a85..16d3902e 100644 --- a/source/instructors/admin/integration/lti-app.rst +++ b/source/instructors/admin/integration/lti-app.rst @@ -201,43 +201,6 @@ LTI 1.1 -LTI 1.3 -""""""" - -**Custom parameters claim object** -specified in https://purl.imsglobal.org/spec/lti/claim/custom - -**actual_user** - - -+------------------+---------------------------------------------------------------+--------------------------------------------------+ -| Parameter | Description | Example | -+==================+===============================================================+==================================================+ -| id | id= lms user identification | "actual_user_id": "123" | -| | | | -| | This is equivalent of sub when the request is executed | | -| | without changing the current user. | | -+------------------+---------------------------------------------------------------+--------------------------------------------------+ -| email | email= actual user email | | -| | | | -| | This will be used for registration if | "actual_user_email": "lms-admin@email.com" | -| | custom_actual_user_id is not matched to an existed user. | | -+------------------+---------------------------------------------------------------+--------------------------------------------------+ -| role | role= actual user role | | -| | | | -| | This should not be Student-like role. | "actual_user_role": "Instructor" | -+------------------+---------------------------------------------------------------+--------------------------------------------------+ -| given_name | given_name= actual user given name | "actual_user_given_name": "Name" | -+------------------+---------------------------------------------------------------+--------------------------------------------------+ -| family_name | family_name= actual user family name | "actual_user_family_name": "Family" | -+------------------+---------------------------------------------------------------+--------------------------------------------------+ -| full_name | full_name= actual user full name | | -| | | | -| | This could be omitted if | "actual_user_full_name": "Name Family" | -| | custom_actual_user_name_family and | | -| | custom_actual_user_name_given passed. | | -+------------------+---------------------------------------------------------------+--------------------------------------------------+ - .. Note:: The parameters should be set by LMS dynamically based on current user, not statically. If you need assistance contact help@codio.com .. important:: Canvas/Moodle/Blackboard do not support this feature. diff --git a/source/instructors/admin/integration/lti1-3BS-D2L.rst b/source/instructors/admin/integration/lti1-3BS-D2L.rst index 9fc2029f..629e9ea0 100644 --- a/source/instructors/admin/integration/lti1-3BS-D2L.rst +++ b/source/instructors/admin/integration/lti1-3BS-D2L.rst @@ -23,6 +23,12 @@ Access LTI Integration settings in Codio Copy fields from Codio to Brightspace/D2L ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. important:: + When copying links, please use the copy button adjacent to each link to ensure accuracy and prevent linking errors. + + + + .. figure:: /img/lti/codiolti13settings.png :alt: LTI 1.3 settings in Codio :width: 350px @@ -122,28 +128,3 @@ First enable :ref:`LTI Constant URLs ` for your c -LTI 1.3 Dynamic Registration ------------------------------ - - -Dynamic Registration simplifies the setup process by automatically sharing configuration information between Tools and LMS systems. - - -Access LTI Integration Settings in Codio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -.. image:: /img/lti/codiolti13settings.png - :alt: LTI 1.3 settings in Codio - :align: right - :width: 350px - :class: img-responsive - - -1. Click your username in the top-right corner, then select **Organizations** from the menu. -2. In the **Organizations** area, click the name of your organization. -3. Select the **LTI Integrations** tab. -4. Scroll down to the **LTI Integration 1.3** section. -5. The **Dynamic Registration URL** is at the bottom of the list, you can copy it by clicking on the **Dynamic Registration URL** button. - - diff --git a/source/instructors/admin/integration/lti1-3Blackboard.rst b/source/instructors/admin/integration/lti1-3Blackboard.rst index cfd73781..ff383ba6 100644 --- a/source/instructors/admin/integration/lti1-3Blackboard.rst +++ b/source/instructors/admin/integration/lti1-3Blackboard.rst @@ -77,142 +77,3 @@ In Blackboard: - Paste the **LTI Integration URL** you copied in the last step into the **Configuration URL** field for your assignments. -Blackboard LTI 1.x -------------------- - -Please be sure to check out the :ref:`Codio LTI App ` which allows for an easy way to integrate and to map Codio course assignments to your LMS. The `following page `_ explains how to set up external apps in Blackboard Learn. - -In Codio: - -Enable LTI for Your Course -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -1. Open the course you would like to connect or create a new course. -2. Make sure you have at least one published assignment or add a new one. (see :ref:`Add and Remove Course Assignments `) -3. Select the **LTI/LMS** tab. -4. Select the **ENABLE LTI** option. - - .. image:: /img/lti/enable-lti.png - :alt: enable lti - -5. Click **Save Changes**. - -Bring up the LTI Integration Information ----------------------------------------- - -6. Click your user name in the bottom left of your dashboard -7. Choose your Organization -8. Click the **LTI Integrations** tab to bring up the following settings. - - .. image:: /img/lti/LTIintegrationinfo.png - :alt: Org LTI info - - -In Blackboard -~~~~~~~~~~~~~ - -The Blackboard user who carries out these steps must be a Blackboard system administrator. - -9. Create a new Course in Blackboard. We suggest you create a test course called **Codio Blackboard** before you do it with a production course. -10. Look for the **System Admin** tab near the top right of the page and select it. -11. Look for the **Building Blocks** section and select it. -12. Click on **LTI tool providers**. -13. Click on **Register Provider Domain** in the menu bar. -14. In the **Provider Domain** field, enter ``apollo.codio.com``. -15. In the **Default Configuration** section, set **Default Configuration** to be **Set globally**. -16. In the **Organization Policies** section you should -17. set **Send User Data** to **Send user data only over SSL**. -18. in **User Fields to Send** you should set all 3 fields (Constituency in Course, Name, Email Address). - -In Codio and Blackboard -~~~~~~~~~~~~~~~~~~~~~~~ - -19. Now return to the **Default Configuration** section in Blackboard. We will now copy the following global integration fields from Codio to Blackboard. - -- LTI Consumer -> Tool Provider Key -- LTI Secret -> Tool Provider Secret - -Codio course setup ------------------- - -You need to perform the following actions one time only for a course. The Blackboard user who carries out these steps does not need to be a system administrator but must have suitable privileges to edit courses and assignments. - -20. In Codio, go to your course and click on the **LTI/LMS** tab. -21. Go to the **LTI/LMS Settings** area. -22. At the top is a switch **Enable LTI** which you should check is enabled. -23. Below this is an empty field **Course LMS URL**. Switch back to Blackboard and make sure you are on the main the Codio Blackboard course you created earlier. Copy the url in the address bar of your browser to the clipboard and paste it into the above mentioned field in Codio. - -This URL ensures that Codio knows how to redirect students back to the correct Blackboard course should they attempt to access the course through their dashboard. - -Mapping an assignment to Blackboard Content -------------------------------------------- - -The final mapping step needs to be taken for each individual assignment within Codio. It maps a piece of Blackboard content to a Codio assignment. - -In Codio -~~~~~~~~ - -24. On the main course screen, make sure the **Edit Assignments** tab is selected. -25. Click the **Add Assignment** button and select **Project Based**. -26. Select a project that has some autograded assessments. The **My First Project** that you created earlier in the Onboarding Guide has some auto-graded assessments. You can also assign another project but you will need to manually grade the assignment so there are some scores to pass back to the Blackboard gradebook. -27. Once the assignment has been added to the course, you should click the 3 dots to the right of that assignment and select **LTI Integration URL**. -28. You should copy the LTI integration url to the clipboard by clicking on the field (it will auto copy). - -.. figure:: /img/lti/LMS-Unit-URL.png - :alt: Unit URL - -In Blackboard -~~~~~~~~~~~~~ - -We now return to Blackboard complete the mapping. - -29. Make sure you have selected the Blackboard course. -30. Click **Content** in the left hand menu. -31. Select or hover over **Build Content** in the menu bar -32. Select **Web Link**. -33. In the **Web Link Information** section ... -34. Enter a name for the content -35. Paste in the **LTI Integration URL** that you just copied to the clipboard from Codio -36. Check the box **This is a link to a tool provider** -37. Select **Yes** for the field **Enable Evaluation** after which more fields will appear -38. Set the points you want to award for this content (Codio will automatically scale the percentage value it uses to the points you specify here) -39. Save the content settings. - -Authentication and account creation ------------------------------------ - -To add students/teachers see :ref:`Users account creation ` - -LTI 1.3 Dynamic Registration ------------------------------ - - -Dynamic Registration simplifies the setup process by automatically sharing configuration information between Tools and LMS systems. - - -Access LTI Integration Settings in Codio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -.. image:: /img/lti/codiolti13settings.png - :alt: LTI 1.3 settings in Codio - :align: right - :width: 350px - :class: img-responsive - - -1. Click your username in the top-right corner, then select **Organizations** from the menu. -2. In the **Organizations** area, click the name of your organization. -3. Select the **LTI Integrations** tab. -4. Scroll down to the **LTI Integration 1.3** section. -5. The **Dynamic Registration URL** is at the bottom of the list, you can copy it by clicking on the **Dynamic Registration URL** button. - - - - - - - - - - diff --git a/source/instructors/admin/integration/lti1-3Canvas.rst b/source/instructors/admin/integration/lti1-3Canvas.rst index fe79831a..add23785 100644 --- a/source/instructors/admin/integration/lti1-3Canvas.rst +++ b/source/instructors/admin/integration/lti1-3Canvas.rst @@ -12,13 +12,17 @@ On this page, you will find detailed step-by-step guidelines to help you integra LTI version 1.3 improves upon version 1.1 by moving away from the use of OAuth 1.0a-style signing for authentication and towards a new security model, using OpenID Connect, signed JWTs, and OAuth2.0 workflows for authentication. For more information, see Learning Tools Interoperability Core Specification -The deep linking url is : https://apollo.codio.com/lti/resource_selection +The deep-linking URL is ``https://apollo.codio.com/lti/resource_selection``. Part 1: In Canvas - Create a Developer Key ------------------------------------------ The Canvas user who carries out these steps must be a system administrator. + .. important:: + When copying links, please use the copy button adjacent to each link to ensure accuracy and prevent linking errors. + + +-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | .. raw:: html | | @@ -96,9 +100,7 @@ The Canvas user who carries out these steps must be a system administrator. +-----------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - - + +-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |image7| | | | @@ -117,7 +119,7 @@ The Canvas user who carries out these steps must be a system administrator. | navigator.clipboard.writeText(url).then(() => { | | alert('URL copied to clipboard!'); }).catch(err => { | | console.error('Failed to copy: ', err); }); } | -| Icon Url:
| +| Icon URL:
| | https://static-assets.codio.com/dashboard/images/icons/favicon-16x16.da14ae918fd9bc3b.png | | | |
| @@ -227,7 +229,7 @@ The Canvas user who carries out these steps must be a system administrator. | 18. Press Save in bottom right corner

| | | 19. You will be back at the list of developer keys.

| | | 20. Update State to: on

| | -| 21. Copy the number in the Details column (for use in Parts 2 and 3) | | +| 21. Copy the number in the Details column (for use in Parts 2 and 3) | | | | | +-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -309,8 +311,8 @@ In Codio: |
| | | Updating the fields in Platform Information

| | | Note: replace [CANVAS DOMAIN] with your institution’s | | -| domain in steps 5-7. Make sure to remove the brackets. Example: | | -| https://Codio.instructure.com/api/lti/security/jwks

| .. image:: /img/lti/canvasplatform25.png | +| domain in steps 5–7. Remove the brackets. Example: | | +| https://yourinstitution.instructure.com/api/lti/security/jwks

| .. image:: /img/lti/canvasplatform25.png | | 2. Platform ID: | | | https://canvas.instructure.com | | | | | @@ -322,7 +324,7 @@ In Codio: | console.error('Failed to copy: ', err); }); }

| | | | | | 3. Client ID: copied from Developer Keys at end of Part 1

| | -| 4. Deployment Id: copied in Part 2

| | +| 4. Deployment ID: copied in Part 2

| | | | | | 5. Public Keyset URL: | | | https://[CANVAS DOMAIN]/api/lti/security/jwks | | @@ -374,22 +376,28 @@ In Canvas: | 4. Under Submission Type, select External Tool.

| | | 5. Select Find.

| | | | | -| Note: Do not use LTI Integration URL to assign an assignment

| | +| Note: Do not paste the LTI Integration URL directly into the Canvas | | +| External Tool URL field when creating an assignment. Instead, use the deep link | | +| “Find” flow (recommended) or follow the “Connect by LTI Integration URL” method | | +| described below.

| | +| | | | | | | 6. Select the tool created in Part 1.
| | -| - Choose the Course and Assignment to connect to
| | -| - Recommended: Select Load in a new tab

| | +|
  • Choose the Course and Assignment to connect to
    • | | +|
  • Recommended: Select Load in a new tab

| | +| | | | 7. Select Save at bottom of the page | | |
| | +-------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ -Note: these settings are not final and can be edited in Canvas at a later time. + .. note:: + These settings are not final and can be edited in Canvas at a later time. Part 5: Customizing Iframe Width/Height --------------------------------------- -You can customize the width and height of the Codio window embedded in the Canvas. The default width is 1000 pixels and height is 800 pixels, change those values if you need and press **Save Changes**. +You can customize the width and height of the Codio window embedded in Canvas. The default width is 1000 pixels and height is 800 pixels; change those values if needed and press **Save Changes**. .. image:: /img/lti/iframe-width-height.png :alt: Iframe Width and Height settings @@ -402,69 +410,42 @@ Important Notes on Course Copy in Canvas: - An SIS ID that is different from the Blueprint Course (Canvas’ Parent Course) is required for Codio to spawn a corresponding child course. - An SIS ID is optional for the Blueprint Course. + + + + + Connecting/mapping assignments in Canvas ------------------------------------------ There are also a number of ways you can connect/map assignments. Check out the following videos to see the option that best suits you. -How to connect assignment by lti integration url of assignment -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +How to Connect an Assignment by LTI Integration URL +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. raw:: html
-How to connect assignment by resource selection preview -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +How to Connect an Assignment via Resource Selection Preview +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. raw:: html
-How to connect assignment by endpoint url -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +How to Connect an Assignment by Endpoint URL +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. raw:: html
-How to connect assignment with custom param -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +How to Connect an Assignment with a Custom Parameter +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. raw:: html
-LTI 1.3 Dynamic Registration ------------------------------ - - -Dynamic Registration simplifies the setup process by automatically sharing configuration information between Tools and LMS systems. - - - -Access LTI Integration Settings in Codio -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -.. image:: /img/lti/codiolti13settings.png - :alt: LTI 1.3 settings in Codio - :align: right - :width: 350px - :class: img-responsive - - -1. Click your username in the top-right corner, then select **Organizations** from the menu. -2. In the **Organizations** area, click the name of your organization. -3. Select the **LTI Integrations** tab. -4. Scroll down to the **LTI Integration 1.3** section. -5. The **Dynamic Registration URL** is at the bottom of the list, you can copy it by clicking on the **Dynamic Registration URL** button. - - - - - - -If you require any assistance, please don't hesitate to :ref:`contact us ` - diff --git a/source/instructors/admin/integration/lti1-3DynReg.rst b/source/instructors/admin/integration/lti1-3DynReg.rst index e1528482..a25965c3 100644 --- a/source/instructors/admin/integration/lti1-3DynReg.rst +++ b/source/instructors/admin/integration/lti1-3DynReg.rst @@ -27,10 +27,19 @@ Access LTI Integration Settings in Codio :class: img-responsive -1. Go to your organization account settings by clicking on your user name in the bottom left of your dashboard and then selecting your organization within **Organizations**. -2. Select the **LTI Integrations** tab. -3. Scroll down to the **LTI Integration 1.3** section. -4. The **Dynamic Registration URL** is at the bottom of the list, you can copy it by clicking on the **Dynamic Registration URL** button. +1. Click your username in the top-right corner, then select **Organizations** from the menu. +2. In the **Organizations** area, click the name of your organization. +3. Select the **LTI Integrations** tab. +4. Scroll down to the **LTI Integration 1.3** section. +5. Scroll to the bottom of the list and click the copy icon next to **Dynamic Registration URL**. + + + + + + + + diff --git a/source/instructors/admin/integration/open-student-assignments-lms.rst b/source/instructors/admin/integration/open-student-assignments-lms.rst new file mode 100644 index 00000000..3dbe8c33 --- /dev/null +++ b/source/instructors/admin/integration/open-student-assignments-lms.rst @@ -0,0 +1,59 @@ +.. meta:: + :description: Open Student Assignments Directly from LMS + +.. _open-student-assignments-lms: + +Open Student Assignments Directly from LMS +========================================== + + +The **Open student assignments directly from LMS** feature allows teachers to access their students' assignments directly from their Learning Management System (LMS) without needing to navigate to the teacher dashboard. This streamlines the grading and feedback process, making it more efficient. + + + .. important:: + Not all LMS systems support this direct integration feature. Please verify that your specific LMS platform is compatible with this functionality before relying on it for your workflow. If your LMS doesn't support direct assignment access, you'll need to use the traditional method of accessing assignments through the teacher dashboard. + +LTI 1.3 +""""""" + + +Custom parameters +~~~~~~~~~~~~~~~~~ + + + + + + ++------------------+---------------------------------------------------------------+--------------------------------------------------+ +| Parameter | Description | Example | ++==================+===============================================================+==================================================+ +| id | id= lms user identification | "actual_user_id": "123" | +| | | | +| | This is equivalent of sub when the request is executed | | +| | without changing the current user. | | ++------------------+---------------------------------------------------------------+--------------------------------------------------+ +| email | email= actual user email | | +| | | | +| | Used for registration if ``custom_actual_user_id`` | "actual_user_email": "lms-admin@email.com" | +| | does not match an existing user. | | ++------------------+---------------------------------------------------------------+--------------------------------------------------+ +| role | role= actual user role | | +| | | | +| | This role must not be student-like. | "actual_user_role": "Instructor" | ++------------------+---------------------------------------------------------------+--------------------------------------------------+ +| given_name | given_name= actual user given name | "actual_user_given_name": "Name" | ++------------------+---------------------------------------------------------------+--------------------------------------------------+ +| family_name | family_name= actual user family name | "actual_user_family_name": "Family" | ++------------------+---------------------------------------------------------------+--------------------------------------------------+ +| full_name | full_name= actual user full name | | +| | | | +| | This could be omitted if | "actual_user_full_name": "Name Family" | +| | custom_actual_user_name_family and | | +| | custom_actual_user_name_given passed. | | ++------------------+---------------------------------------------------------------+--------------------------------------------------+ + + + .. note:: + These parameters must be set dynamically by the LMS based on the current user (not configured statically). + If you need assistance, contact . diff --git a/source/instructors/getstarted/howto.rst b/source/instructors/getstarted/howto.rst index 8c38b107..4a9c9f01 100644 --- a/source/instructors/getstarted/howto.rst +++ b/source/instructors/getstarted/howto.rst @@ -6,35 +6,87 @@ How to Videos ============= -**Codio overview** +On this page you will find detailed step-by-step video tutorials designed to guide your initial setup and orientation. + + + +Codio Overview +~~~~~~~~~~~~~~~ + .. raw:: html -
+ +
+ -**Using Codio Resources** +Using Codio Resources +~~~~~~~~~~~~~~~~~~~~~~ .. raw:: html -
-**Editing Existing Guides Content** +
+ + + +Editing Existing Guide Content +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. raw:: html -
+ +
+ + -**Adding Students and Test Students** +Adding Students and Test Students +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. raw:: html -
-**Creating a Standard Code Test** +
+ + + + +Additional Video Resources +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Additional tutorial videos are available below to further assist with setup and configuration of your Codio teaching environment. + +| + + .. list-table:: + :header-rows: 1 + :widths: 40 70 + + * - **Section** + - **Topics** + * - **Content Authoring in Codio** + - | `Editable, Interactive Course Resources for Intro CS in Python, Java, C++ `_ + | `Assigning Codio Resource `_ + | `Rearranging and Deleting Assignments `_ + * - **Teacher & Course Management** + - | `Setting Due Dates and Late Work Penalties `_ + | `Viewing Student Work and Adjusting Individual Due Dates `_ + | `Releasing Grades to Students and LMS `_ + * - **Student Insights & Experience** + - | `Learner Behavior Insights in Codio `_ + | `Flexible Student Learning Experience `_ + | `Student Codio IDE Overview `_ + * - **Assessment & Grading** + - | `Auto Grading in Codio `_ + | `Combining Grading Sources `_ + * - **Integration & Support** + - | `LMS Integration Overview `_ + | `Access in Product Support `_ + -.. raw:: html -
+ .. note:: + All videos are configured to start at the 8-second mark for optimal viewing experience. \ No newline at end of file