This document provides instructions on integrating the YuJa Panorama Platform into your Moodle Learning Management System (LMS). If you have any questions regarding any steps in this process, please contact your dedicated Customer Success Manager.
Overview
The below steps will allow you to make the Panorama Platform an accessibility tool for all courses in your Moodle instance.
Generating the Moodle Web Services Token for the YuJa Panorama - LMS Connector
The guide below will provide Administrators instructions to generate a Moodle Web Services Token in order to use the YuJa Panorama - LMS Connector.
- Log in to Moodle as an Admin. From the left-side navigation menu, choose Site Administration.
- Next, choose the Plugins tab, then scroll all the way down to Web Services, and click on Overview.
- Make sure to update Enable Web Services to Yes and change Enable Protocols to REST.
- Go back to the Site Administration page and choose Plugins. Scroll down to Web Services and click on External Services.
- Click Add to add a new External Service.
- Click Show More, then entered all the information as followed then click Add Service.
- Name: Panorama
- Enabled: Enabled
- Can Download Files: Enabled
- Can Upload Files: Enabled
- Required Capability: repository/url:view
- Back on the External Services page, find the newly added Panorama Web Service, and click Functions.
- Next, choose Add Functions and enter all these below functions and click Add Functions once done.
- core_course_get_categories
- core_course_get_contents
- core_course_get_course_module
- core_course_get_course_module_by_instance
- core_course_get_courses
- core_course_get_courses_by_field
- core_course_get_module
- core_course_get_updates_since
- core_course_get_user_administration_options
- core_course_get_user_navigation_options
- core_enrol_get_enrolled_users
- core_enrol_get_enrolled_users_with_capability
- core_files_get_files
- core_files_upload
- core_message_data_for_messagearea_get_profile
- core_user_get_users
- core_user_view_user_list
- mod_forum_get_forum_discussion_posts
- mod_forum_get_discussion_posts
- mod_forum_get_forum_discussions_paginated
- mod_forum_get_forums_by_courses
- mod_resource_get_resources_by_courses
- mod_quiz_get_quizzes_by_courses
- mod_chat_get_chats_by_courses
- mod_data_get_databases_by_courses
- mod_data_get_entries
- mod_page_get_pages_by_courses
- mod_choice_get_choices_by_courses
- mod_lesson_get_lessons_by_courses
- mod_lesson_get_pages
- mod_lesson_get_page_data
- mod_assign_get_assignments
- mod_survey_get_surveys_by_courses
- mod_glossary_get_glossaries_by_courses
- mod_glossary_get_entries_by_letter
- mod_wiki_get_wikis_by_courses
- mod_wiki_get_subwiki_files
- Go back to the Site Administration page and choose Manage Tokens under the Plugins tab. Click Add to add a new Token.
- Enter all the information as followed, then click Save Changes.
- User: Search for a Moodle user with Admin privileges.
- Service: Choose the Panorama service created in Step 6.
- Valid Until: Leave as is.
- Copy down the highlighted Token and send it to your YuJa Customer Success Manager. Only moving to the next steps once you receive back all the required plugins and keys.
Installing the YuJa Panorama - LMS Viewer in Moodle
- Once received back all the required plugins and keys from your YuJa Customer Success Manager, log into Moodle as an Admin, and go to Site Administration.
- Navigate to the Plugins tab, then select Install Plugins.
- Click Choose a File, then select the local_panorama.zip file from the plugins package that the YuJa Customer Success Manager sends you. Click Install plugin from the ZIP file to proceed.
- Enter in the following information if asked, then click Save Changes.
- Primary Identify Key: The API Key from the YuJa Customer Success Manager.
- Secondary Identify Key: The Student API Key from the YuJa Customer Success Manager.
- LTI Consumer Key: The Consumer Key from the YuJa Customer Success Manager.
- LTI Key: The LTI Key from the YuJa Customer Success Manager.
- Panorama Environment: Production.
- Once done, repeat the same steps to install the filter_panorama.zip and report_panorama.zip files.
- If you were not asked to enter the required information on step 4, then follow steps 7 and 8. Otherwise, skip to step 9.
- Navigate to the Plugins tab, then scroll down to find the Panorama for Moodle Settings.
- Next, enter in the following information if asked, then click Save Changes.
- Primary Identify Key: The API Key from the YuJa Customer Success Manager.
- Secondary Identify Key: The Student API Key from the YuJa Customer Success Manager.
- LTI Consumer Key: The Consumer Key from the YuJa Customer Success Manager.
- LTI Key: The LTI Key from the YuJa Customer Success Manager.
- Panorama Environment: Production.
- Under the Plugins tab, scroll down and find the Filters tab, then select Manage Filters.
- Switch the status for the Panorama for Moodle filter to ON.
- If you are using Moodle with version 3.5 or older, continue with steps 12 and 13. Otherwise, skip to step 14.
- Under the Appearances tab, choose Additional HTML.
- On this page, scroll to the Within HEAD section, paste in this script, then click Save Changes <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script>
- The YuJa Panorama - LMS Viewer is now available for use in Moodle.
- The YuJa Panorama - LMS Viewer may take up to an hour to process depending on the number of documents on the queue. Users may choose to select the option for the On-Demand Alternative Format process to have the file ready in between 5 to 10 minutes.
Accessing the Panorama LTI Settings
As a System Admin, you can access the Panorama LTI to check the Course Report, Institution Report, or change the Panorama settings for your Organization..
- To access the Panorama LTI, navigate to any of your courses and select Panorama from the navigation menu.
- Click the Gear icon on the top right corner to navigate to the configuration panel. Fill in the following information if they were not auto-filled.
- Access Token: Moodle access token obtained in Section 1.
- Server API URL: https://<YOUR_MOODLE_URL>/webservice/rest/server.php
- From the same configuration window, ADministrators can choose to enable Panorama for certain courses ID or for the whole Organization.
- To access the Panorama Institution Accessibility Report, navigate to the Institution Report tab.
- To access the Course Accessibility Report, navigate to the Course Report tab.
