diff --git a/source/common/develop/ide/editing/connect-github-codio.rst b/source/common/develop/ide/editing/connect-github-codio.rst index be0d8b57..b5c47cf2 100644 --- a/source/common/develop/ide/editing/connect-github-codio.rst +++ b/source/common/develop/ide/editing/connect-github-codio.rst @@ -116,7 +116,7 @@ To manually import a Git repo into Codio, follow these steps: .. figure:: /img/github-clone-url.png :alt: create from GitHub - If you are cloning using SSH, you must have already added the Codio SSH public key as described in :ref:`Upload SSH Key to Remote Server `. + If you are cloning using SSH, you must have already added the Codio SSH public key as described in :ref:`SSH Key `. 2. Create a :ref:`new project ` or :ref:`add an assignment ` to a course. diff --git a/source/common/develop/ide/editing/git.rst b/source/common/develop/ide/editing/git.rst index 60a29d37..13bfca6c 100644 --- a/source/common/develop/ide/editing/git.rst +++ b/source/common/develop/ide/editing/git.rst @@ -72,11 +72,9 @@ To manually import a Git repo into Codio, follow these steps: -.. raw:: html - -
- Note: If you are cloning using SSH, you must have already added the Codio SSH public key as described in Upload SSH Key to Remote Server. -
+.. note:: + If you are cloning using SSH, you must have already added the Codio SSH public key as described in :ref:`SSH Key `. + Create New GitHub Repo From Codio --------------------------------- @@ -89,15 +87,15 @@ If you have code in Codio and want to create a new GitHub (or other remote) repo 1. Create a new project in Codio or open up an existing project. 2. Open the terminal (**Tools > Terminal**), type **git init** and press **Enter** to initialize Git. -3. Create a new, empty repo on GitHub or other remote repo. -4. Copy the repo url to the clipboard. + -.. raw:: html - -
- Note: If you're using GitHub, use the SSH url rather than https. Also make sure that your Codio public key is uploaded to your GitHub account or repo settings as described in Upload SSH Key to Remote Server. -
+.. container:: float-right + .. note:: + If you're using GitHub, use the **SSH url** rather than **https**. Also make sure that your Codio public key is uploaded to your GitHub account or repo settings as described in :ref:`SSH Key `. + +3. Create a new, empty repo on GitHub or other remote repo. +4. Copy the repo url to the clipboard. 5. In the Codio IDE, click **Tools > Git > Remotes** on the menu. 6. Click the **Edit** icon and enter the **Name** and paste the **URL** into the field. It is recommended you use **origin** as the name to confirm the normal standards. You do not need to specify a username or password if you are using SSH. 7. Click **Save**. @@ -108,8 +106,6 @@ Github Commands GitHub functions normally within Codio, giving you access to all the standard Git commands and GitHub features you're familiar with. -.. raw:: html - -
- Note: The Guides folder is automatically included in your project, unless you manually remove it. -
+.. note:: + The Guides folder is automatically included in your project, unless you manually remove it. + diff --git a/source/img/common-cartridge.png b/source/img/common-cartridge.png index 92506a9e..67b2f52d 100644 Binary files a/source/img/common-cartridge.png and b/source/img/common-cartridge.png differ diff --git a/source/img/google_integrate.png b/source/img/google_integrate.png index df0fd6a0..71055336 100644 Binary files a/source/img/google_integrate.png and b/source/img/google_integrate.png differ diff --git a/source/img/lti/LMS-Unit-URL.png b/source/img/lti/LMS-Unit-URL.png index 429ebd29..e04c1610 100644 Binary files a/source/img/lti/LMS-Unit-URL.png and b/source/img/lti/LMS-Unit-URL.png differ diff --git a/source/img/lti/LTIenrolllink.png b/source/img/lti/LTIenrolllink.png index cc370694..185aa32f 100644 Binary files a/source/img/lti/LTIenrolllink.png and b/source/img/lti/LTIenrolllink.png differ diff --git a/source/img/lti/LTIintegrationinfo.png b/source/img/lti/LTIintegrationinfo.png index e04f18dc..77187907 100644 Binary files a/source/img/lti/LTIintegrationinfo.png and b/source/img/lti/LTIintegrationinfo.png differ diff --git a/source/img/lti/codiolti13settings.png b/source/img/lti/codiolti13settings.png index a778f3f7..145986f1 100644 Binary files a/source/img/lti/codiolti13settings.png and b/source/img/lti/codiolti13settings.png differ diff --git a/source/img/lti/codioplatformlti1-3.png b/source/img/lti/codioplatformlti1-3.png index 7482b124..69478d23 100644 Binary files a/source/img/lti/codioplatformlti1-3.png and b/source/img/lti/codioplatformlti1-3.png differ diff --git a/source/img/lti/enable-lti-new.png b/source/img/lti/enable-lti-new.png index c77bc080..17cf1d6f 100644 Binary files a/source/img/lti/enable-lti-new.png and b/source/img/lti/enable-lti-new.png differ diff --git a/source/img/lti/enable-lti.png b/source/img/lti/enable-lti.png index 0a92a680..a963528d 100644 Binary files a/source/img/lti/enable-lti.png and b/source/img/lti/enable-lti.png differ diff --git a/source/img/lti/enable_class_fork.png b/source/img/lti/enable_class_fork.png index 929626ad..665fb992 100644 Binary files a/source/img/lti/enable_class_fork.png and b/source/img/lti/enable_class_fork.png differ diff --git a/source/img/lti/parent_class.png b/source/img/lti/parent_class.png index e2827579..00e34e04 100644 Binary files a/source/img/lti/parent_class.png and b/source/img/lti/parent_class.png differ diff --git a/source/instructors/admin/integration/lms-students.rst b/source/instructors/admin/integration/lms-students.rst index 74368547..6ad3a7eb 100644 --- a/source/instructors/admin/integration/lms-students.rst +++ b/source/instructors/admin/integration/lms-students.rst @@ -10,11 +10,12 @@ When integrating with an external system, you don't need to manually :ref:`add o Understanding how Codio maps external system users to Codio users is important. Here are the key mapping rules: -.. raw:: html -
- Note: Anonymous students (with no email associated) can access Codio through an LMS. This must be set up within the LMS. -
+.. container:: float-right + + .. note:: + Anonymous students (with no email associated) can access Codio through an LMS. This must be set up within the LMS. + - If students or faculty access Codio via an LMS assignment then Codio will initially use the LMS email address to identify the user and create the Codio account. @@ -22,30 +23,24 @@ Understanding how Codio maps external system users to Codio users is important. - If the user is not known to Codio then we will sign up the user as a new Codio user in the background and take the user directly into the Codio content. The LMS user role will be carried over as well. -.. raw:: html -
- Note: The users LMS password is not passed to Codio so if the user may wish to log into Codio directly in the future, they will need to create a password for their Codio account (and of course it is always recommended that the same passwords are not used in different applications). -
+.. container:: float-right -- If the user is known to Codio then Codio will take them directly into the Codio content without any sign-in required. If they are a Codio user but are not a member of your organization then they will be required to complete a verification via email. + .. note:: + The user's LMS password is not passed to Codio so if the user wishes to log in to Codio directly in the future, they will need to create a password for their Codio account (and of course it is always recommended that the same passwords are not used in different applications). -- If a student joins Codio from an LMS a new Codio account will be created even if the student already has a Codio account using the same email address where we do not have a userID + LMS system id. -.. raw:: html +- If the user is known to Codio then Codio will take them directly into the Codio content without any sign-in required. If they are a Codio user but are not a member of your organization then they will be required to complete a verification via email. -
- Note: If you need to reset your password, you can use your username instead of your email address. Alternatively, you can contact your course instructor, who can assist with resetting the password. -
+- If a student joins Codio from an LMS a new Codio account will be created even if the student already has a Codio account using the same email address where we do not have a userID + LMS system id. - After successful mapping of an user's LMS account to their Codio account, if the user has changed their details such as name or email in their LMS account, Codio will automatically update those details the next time the user accesses Codio from their LMS. Codio will not update the email if another user with the same email already exists. -.. raw:: html -
- Note: If your organization is in trial mode, student accounts will not be created via LTI integration. Ensure your organization has an active subscription to allow student enrollments. -
+.. note:: + If you need to reset your password, you can use your username instead of your email address. Alternatively, you can contact your course instructor, who can assist with :ref:`resetting the password `. + Student accounts are **not** created via LTI integration while an organization is in trial mode. Activate a subscription to enable student enrolments. Teacher Roles ~~~~~~~~~~~~~ @@ -68,4 +63,5 @@ If you wish to only allow Mentors to view/manage specific students in the course LTI Field to Uniquely Identify Students --------------------------------------- -This is a unique identifier for students found in a custom LTI field. This field is automatically added to the CSV export data files, enabling you to map results manually if necessary. You can adjust this option in the **LTI Integrations** section of your Organization Settings. \ No newline at end of file +This is a unique identifier for students found in a custom LTI field. This field is automatically added to the CSV export data files, enabling you to map results manually if necessary. You can adjust this option in the **LTI Integrations** section of your Organization Settings. + diff --git a/source/instructors/admin/integration/lms-systems/canvas.rst b/source/instructors/admin/integration/lms-systems/canvas.rst index 32fddb84..c7d314e4 100644 --- a/source/instructors/admin/integration/lms-systems/canvas.rst +++ b/source/instructors/admin/integration/lms-systems/canvas.rst @@ -12,7 +12,8 @@ Integrating with Canvas using LTI App The **Codio LTI App** method allows for an easy way to integrate and to map Codio course assignments to Canvas. Access the directions at :ref:`LTI App(LTI 1.1 Only) ` page. If you are not able to use the LTI App, follow the manual integration directions below. -.. Note:: Configuring your LTI settings using the LTI App is only for the US version of Codio. It will not work with Codio UK (codio.co.uk). +.. Note:: The LTI App configuration works **only** with the US instance of Codio (`codio.com`) and is not supported on Codio UK (`codio.co.uk`). + Integrating with Canvas Manually -------------------------------- @@ -32,9 +33,10 @@ Enable LTI for Your Course | :ref:`Add and Remove Course Assignments | | | `) | | | | | -| 3. Select the **LTI/LMS** tab. | | +| 3. In the left-hand **Admin** menu, open the | | +| **LTI/LMS** section. | | | | | -| 4. Select the **ENABLE LTI** option. | | +| 4. Toggle **ENABLE LTI** on. | | | | | | 5. Click **Save Changes**. | | +---------------------------------------------------+-----------------------------------------------------------------------------------------+ @@ -46,13 +48,14 @@ Bring up the LTI Integration Information | | .. image:: /img/lti/LTIintegrationinfo.png | | | :alt: Org LTI info | | | | -| 6. Click your user name in the bottom left of | | -| your dashboard | | +| 6. Click your **username** in the top-right corner| | +| and choose **Organization**. | | | | | -| 7. Choose your Organization | | +| 7. In **Organizations**, select your | | +| organization’s name. | | | | | -| 8. Click the **LTI Integrations** tab to bring | | -| up the following settings. | | +| 8. In the left panel, open **LTI Integrations** | | +| to view the settings. | | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------+ diff --git a/source/instructors/admin/integration/lms-systems/moodle.rst b/source/instructors/admin/integration/lms-systems/moodle.rst index 7960b6dc..b5521992 100644 --- a/source/instructors/admin/integration/lms-systems/moodle.rst +++ b/source/instructors/admin/integration/lms-systems/moodle.rst @@ -11,24 +11,9 @@ Please be sure to check out the :ref:`Codio LTI App ` which allows for Setup and Configuration ------------------------ -.. raw:: html - - - - - - Important Notice - - -
-
- ! Important -
- Codio needs the User Role, Email Address and Name of the Moodle user in order to work. It is important that you access the LTI security settings and ensure that these three fields are enabled. If they are not available, contact Moodle support who can help you enable this. If enabled after you have mapped Codio content to Moodle, you may need to re publish for the changes to be implemented. -
- - +.. important:: + Codio needs the User Role, Email Address and Name of the Moodle user in order to work. It is important that you access the LTI security settings and ensure that these three fields are enabled. If they are not available, contact Moodle support who can help you enable this. If enabled after you have mapped Codio content to Moodle, you may need to re publish for the changes to be implemented. **Video: Connect Moodle to Codio using the LTI Integration URL** @@ -48,11 +33,9 @@ Then in the Moodle course you have created: - Proceed through the steps. -.. raw:: html - -
- Note: Restore is required as Moodle currently does not support importing of .imscc files. -
+ .. note:: + Restore is required as Moodle currently does not support importing of **.imscc** files. + To confirm your setup, just click on any assignment available in Moodle. If all configurations are correct, you will be redirected straight to the Teacher view of that assignment in Codio. diff --git a/source/instructors/admin/integration/lms-systems/schoology.rst b/source/instructors/admin/integration/lms-systems/schoology.rst index 643ff168..b17bbe78 100644 --- a/source/instructors/admin/integration/lms-systems/schoology.rst +++ b/source/instructors/admin/integration/lms-systems/schoology.rst @@ -13,26 +13,44 @@ In Codio The Schoology system administrator should install a Codio external tool for the course so that it is quick and easy for instructors to add material. The Schoology system administrator should follow these directions to install Codio as an external tool: +.. image:: /img/lti/enable-lti-new.png + :alt: enable lti and urls + :width: 400px + :align: right + 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. -5. Select the **ENABLE LTI CONSTANT URLS** option. +4. Toggle **ENABLE LTI** on. +5. Toggle **ENABLE LTI CONSTANT URLS** on. 6. Note the **Codio Course Target ID**, you will need that in subsequent steps. 7. Click **Save**. - .. image:: /img/lti/enable-lti-new.png - :alt: enable lti and urls +| +| +| Bring up the LTI Integration Information ---------------------------------------- -8. Click your user name in the bottom left of your dashboard. -9. Select your Organization. +.. image:: /img/lti/LTIintegrationinfo.png + :alt: Org LTI info + :width: 375px + :align: right + +| +| +| + +8. Click your username in the top-right corner, then select **Organizations** from the menu. +9. In the **Organizations** area, click the name of your organization. 10. Click the **LTI Integrations** tab to bring up the following settings. You will need to enter these into Schoology in the subsequent steps. - .. image:: /img/lti/LTIintegrationinfo.png - :alt: Org LTI info +| +| +| +| +| In Schoology ~~~~~~~~~~~~ @@ -81,7 +99,7 @@ In Codio ~~~~~~~~ 21. Navigate to the course you would like to integrate with Schoology and go to the **Overview** area. -22. Click the icon with 3 blue dots for each assignment you wish to map and select **LTI Integration URL.** Select the clipboard to copy the link. +22. Click the 3 vertical dots to the right of the assignment for each assignment you wish to map and select **LTI Integration URL.** Select the clipboard to copy the link. .. figure:: /img/lti/LMS-Unit-URL.png :alt: Unit URL diff --git a/source/instructors/admin/integration/lti-course-copy.rst b/source/instructors/admin/integration/lti-course-copy.rst index e946749f..446a2232 100644 --- a/source/instructors/admin/integration/lti-course-copy.rst +++ b/source/instructors/admin/integration/lti-course-copy.rst @@ -8,12 +8,9 @@ LTI Course copy Enabling this setting allows existing Codio course content used in your LMS to be copied into a new Codio course and a new course in your LMS. This should be enabled for the courses connected with the "Master" course in your LMS. The parameter will be disabled by default for all copied courses. -.. raw:: html - - -
- Note: The screenshots below are for implementation in Canvas but other LMS systems should be similar. Refer to their documentation for more assistance. -
+ .. note:: + The screenshots below are for implementation in Canvas but other LMS systems should be similar. Refer to their documentation for more assistance. + First enable :ref:`LTI Constant URLs ` for your course. @@ -62,8 +59,6 @@ First enable :ref:`LTI Constant URLs ` for your c +-----------------------------------------------+------------------------------------------------------------------------------+ -.. raw:: html +.. note:: + If your LMS supports ``lis_course_offering_sourcedid`` you do not need to specify ``codio_course_target_id`` for the copied course, ``lis_course_offering_sourcedid`` will be used automatically to detect the course. For cases when ``lis_course_offering_sourcedid`` is needed for course copy but not available due to privacy settings in Canvas, a custom parameter ``custom_codio_course_offering_sourcedid=$CourseOffering.sourcedId`` can be tried. -
- Note: If your LMS supports lis_course_offering_sourcedid you do not need to specify codio_course_target_id for the copied course, lis_course_offering_sourcedid will be used automatically to detect the course. For cases when lis_course_offering_sourcedid is needed for course copy but not available due to privacy settings in Canvas, a custom parameter custom_codio_course_offering_sourcedid=$CourseOffering.sourcedId can be tried. -
diff --git a/source/instructors/admin/integration/lti-enrol.rst b/source/instructors/admin/integration/lti-enrol.rst index 3edb7040..ad34c4d7 100644 --- a/source/instructors/admin/integration/lti-enrol.rst +++ b/source/instructors/admin/integration/lti-enrol.rst @@ -8,17 +8,31 @@ LTI Enroll to Course Only LTI Enrollment provides single sign-on access to an entire course without linking each assignment. **It does not allow for automatic grade passback**. -To use this feature, you first generate a link from your Codio course and then add it to your LMS course as an **External Tool** in an assignment or module. When students click the link, they are enrolled in the Codio course and redirected to the Codio dashboard, where they will see all the assignments for the course. +To use this feature, first generate a link from your Codio course and then add it to your LMS course as an **External Tool** in an assignment or module. When students click the link, they are enrolled in the Codio course and redirected to the Codio dashboard. On their dashboards they will see all the assignments for the course. Students do not need to begin each assignment using the LMS system. To generate an **LTI Enroll Link**, follow the steps below: +.. image:: /img/lti/LTIenrolllink.png + :alt: Export LTI settings + :align: right + :width: 60% + +| +| + 1. Navigate to the **Courses** page and select the course you wish to connect. -2. Click **LTI/LMS** tab and turn ON the **Enable LTI** setting from LTI/LMS Setting area. +2. Click the **LTI/LMS** tab and toggle the **Enable LTI** setting on in the LTI/LMS Settings area. 3. Enable the **Enroll to course only** setting to generate the link. 4. Copy the link and paste it as an **External Tool** in your LMS system. +| +| +| +| +| +| +.. Note:: With the **Enroll to course only** setting, grades are not passed back to the LMS. Refer to :ref:`Webhook ` for more information about passing grades back. -.. Note:: With the **Enroll to course only** setting, grades are not passed back to the LMS. Refer to :ref:`Webhook ` for more information about passing grades back. \ No newline at end of file diff --git a/source/instructors/admin/integration/lti-keys-and-urls-information.rst b/source/instructors/admin/integration/lti-keys-and-urls-information.rst index 1fde8f65..d9c8ff31 100644 --- a/source/instructors/admin/integration/lti-keys-and-urls-information.rst +++ b/source/instructors/admin/integration/lti-keys-and-urls-information.rst @@ -24,15 +24,15 @@ LTI Keys To find these keys: -+---------------------------------------------------------------+---------------------------------------------------------------------------------------------+ -| 1. Go to your organization account settings by clicking on | .. figure:: /img/lti/lti-org-fields.png | -| your user name in the bottom left of your dashboard and | :alt: lti-keys | -| then selecting your organization within **Organizations**. | | ++---------------------------------------------------------------+---------------------------------------------------------------------------------------------+ +| 1. Click your user name in the top right corner, | .. figure:: /img/lti/LTI1.1IntegrationCodio.png | +| then select **Organization** from the menu. | :alt: Organization menu showing LTI integrations | | | | -| 2. Select the **LTI Integrations** tab. | | +| 2. In the **Organizations** area, click the name | | +| of your organization. | | | | | -| 3. Scroll down to the **LTI Integration 1.0** section. You | | -| should see the following fields. | | +| 3. Click the **LTI Integrations** section on the | | +| left to bring up the following settings. | | +---------------------------------------------------------------+---------------------------------------------------------------------------------------------+ @@ -94,37 +94,6 @@ The LTI integration URLs for the assignments in a course can be exported. - - - - - -LTI Enroll to Course Only -========================= - -LTI Enrollment provides single sign-on access to an entire course without linking each assignment. **It does not allow for automatic grade passback**. - -To use this feature, first generate a link from your Codio course and then add it to your LMS course as an **External Tool** in an assignment or module. When students click the link, they are enrolled in the Codio course and redirected to the Codio dashboard. On there dashboards they will see all the assignments for the course. -Students do not need to begin each assignment using the LMS system. - -To generate an **LTI Enroll Link**, follow the steps below: - -.. image:: /img/lti/LTIenrolllink.png - :alt: Export LTI settings - :align: right - :width: 510px - -1. Navigate to the **Courses** page and select the course you wish to connect. -2. Click **LTI/LMS** tab and turn ON the **Enable LTI** setting from LTI/LMS Setting area. -3. Enable the **Enroll to course only** setting to generate the link. -4. Copy the link and paste it as an **External Tool** in your LMS system. - - -| - -.. Note:: With the **Enroll to course only** setting, grades are not passed back to the LMS. Refer to :ref:`Webhook ` for more information about passing grades back. - - Common Cartridge ================= diff --git a/source/instructors/admin/integration/lti1-3.rst b/source/instructors/admin/integration/lti1-3.rst index 7e014437..a8be59cd 100644 --- a/source/instructors/admin/integration/lti1-3.rst +++ b/source/instructors/admin/integration/lti1-3.rst @@ -11,7 +11,7 @@ LTI version 1.3 improves upon version [LTI-1.1] by moving away from the use of O 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 Canvas ------ diff --git a/source/instructors/admin/integration/lti1-3BS-D2L.rst b/source/instructors/admin/integration/lti1-3BS-D2L.rst index 4bae9c0b..9fc2029f 100644 --- a/source/instructors/admin/integration/lti1-3BS-D2L.rst +++ b/source/instructors/admin/integration/lti1-3BS-D2L.rst @@ -14,37 +14,54 @@ The following is created in Manage Extensibility, LTI Advantage - Register a Too Access LTI Integration settings in Codio ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -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. You should see the following fields. Remain on this screen for the time being. +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. You should see the following fields. Remain on this screen for the time being. -The LTI 1.3 area of your LTI Integrations settings for your organization. - .. image:: /img/lti/codiolti13settings.png - :alt: LTI 1.3 settings in Codio Copy fields from Codio to Brightspace/D2L ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. figure:: /img/lti/codiolti13settings.png + :alt: LTI 1.3 settings in Codio + :width: 350px + :figwidth: 415px + :align: right + + LTI 1.3 settings in your organization's LTI Integrations. + 1. Copy **Initiate Login URL** to the **OpenID Connect Login URL** field. 2. Copy **Redirect URL** to the **Redirect URL** field. 3. Copy **Keyset URL** to the **Keyset URL** field. 4. In the **Extensions** section enable **Assignment and Grader Services**, **Deep Linking** and **Names and Role Provisioning Services**. 5. Press **Register** - leave the pop-up on the screen, you will be copying values from it. +| +| + Add the Integration you created ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + 1. In Codio on the LTI Integrations screen scroll down to the LTI 1.3 Configurations field and click **Add Integration** - .. image:: /img/lti/addlti13integration.png +.. image:: /img/lti/addlti13integration.png :alt: LTI 1.3 Configurations + +| 2. From the pop-up in Brightspace/D2L copy the **Issuer ID** and place in the **PLATFORM ID** field - .. image:: /img/lti/codioplatformlti1-3.png - :alt: LTI 1.3 Platform information in Codio - Copy fields from Brightspace/D2L pop-up to Codio ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. image:: /img/lti/codioplatformlti1-3.png + :alt: LTI 1.3 Platform information in Codio + :width: 325px + :align: right + + 1. Copy the **Client ID** to the **Client ID** field in Codio. 2. Copy the **Keyset URL** to **Public Keyset URL** field. 3. Copy the **Brightspace OAuth2 Access Token URL** to the **Access Token URL** field in Codio @@ -89,12 +106,44 @@ In Brightspace/D2L LTI Course copy for Brightspace/D2L ----------------------------------- +.. figure:: /img/lti/enable_class_fork.png + :alt: Enable course copy field + :width: 375px + :align: right + Enabling this setting allows existing Codio course content used in your LMS to be copied into a new Codio course and a new course in your LMS. This should be enabled for the courses connected with the "Master" course in your LMS. The parameter will be disabled by default for all copied courses. First enable :ref:`LTI Constant URLs ` for your course. 1. In your existing Codio course, enable the **Enable LTI course copy** button, and save your changes -.. figure:: /img/lti/enable_class_fork.png - :alt: Enable course copy field + + + + + +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 1084b5c4..cfd73781 100644 --- a/source/instructors/admin/integration/lti1-3Blackboard.rst +++ b/source/instructors/admin/integration/lti1-3Blackboard.rst @@ -39,9 +39,10 @@ Part 2: In Codio - Create the configuration In Codio: ~~~~~~~~~ -- 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**. +- Click your username in the top-right corner, then select **Organizations** from the menu. +- In the **Organizations** area, click the name of your organization. - Select the **LTI Integrations** tab. -- Scroll down to the **LTI Integration 1.3** section. +- Scroll down to the **LTI 1.3 Configurations** section. - Click **Add Blackboard Integration** - In the **Deployment Id:** field paste the value you copied above. - Click **Create**. @@ -56,14 +57,15 @@ In Codio enable LTI for Your Course - Open the course you would like to connect or create a new course. - Make sure you have at least one published assignment or add a new one. (see :ref:`Add and Remove Course Assignments `) - Select the **LTI/LMS** tab. -- Select the **ENABLE LTI** option. +- Toggle **ENABLE LTI** on. .. image:: /img/lti/enable-lti.png :alt: enable lti - Click **Save Changes**. -- Select an assignment you want to connect and click the icon with 3 blue dots and select **LTI Integration URL**. +- Select an assignment you want to connect and click the 3 vertical dots to the right of that assignment. +- Select **LTI Integration URL**. - Copy the LTI integration url to the clipboard by clicking on the clipboard icon. .. figure:: /img/lti/LMS-Unit-URL.png @@ -72,4 +74,145 @@ In Codio enable LTI for Your Course In Blackboard: ~~~~~~~~~~~~~~ -- Paste the **LTI Integration URL** you copied in the last step into the **Configuration URL** field for your assignments. \ No newline at end of file +- 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 8fcf12bb..fe79831a 100644 --- a/source/instructors/admin/integration/lti1-3Canvas.rst +++ b/source/instructors/admin/integration/lti1-3Canvas.rst @@ -309,7 +309,8 @@ In Codio: |
| | | Updating the fields in Platform Information

| | | Note: replace [CANVAS DOMAIN] with your institution’s | | -| domain in steps 5-7

| .. image:: /img/lti/canvasplatform25.png | +| 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 | | 2. Platform ID: | | | https://canvas.instructure.com | | | | | @@ -434,5 +435,36 @@ How to connect assignment with custom param
+ +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/organization/add-teachers.rst b/source/instructors/admin/organization/add-teachers.rst index 7d08dc9d..8f0e4290 100644 --- a/source/instructors/admin/organization/add-teachers.rst +++ b/source/instructors/admin/organization/add-teachers.rst @@ -58,17 +58,14 @@ After setting up your organization, you can add teachers to give them access to -.. raw:: html -
- Note: They must use the same email address to which the invitation was sent; otherwise, they will not be added to the organization. This invitation is valid for 7 days. If it is not used within that time frame, it will expire, and the recipient will no longer be able to use it to join the organization. In such cases, you will need to resend the invitation. All pending invitations are displayed and you have the option to Resend or Revoke the invitation. +.. note:: + They must use the same email address to which the invitation was sent; otherwise, they will not be added to the organization. This invitation is valid for 7 days. If it is not used within that time frame, it will expire, and the recipient will no longer be able to use it to join the organization. In such cases, you will need to resend the invitation. All pending invitations are displayed and you have the option to **Resend** or **Revoke** the invitation. -
-.. raw:: html -
- Note: If you already have courses set up, you can add and invite teachers directly into your course(s). See Add or Remove Teachers in a Course. You can then add them as an organization owner so they can then manage and create courses, and have full Admin access to the organization. -
+ +.. note:: + If you already have courses set up, you can add and invite teachers directly into your course(s). See :ref:`Add or Remove Teachers in a Course `. You can then add them as an :ref:`Organization Owner ` so they can then manage and create courses, and have full Admin access to the organization.