Admins can integrate Engage into their Moodle learning management system (LMS). The integration allows polls to be created, published, and graded directly to Moodle courses and viewed by admins, instructors, and students. If you have any questions regarding the steps in this process, please contact your dedicated Client Success Manager.
Integrating Engage into Moodle
The integration process will create the details to configure the Engage API for your institution.
- Log in to Moodle as an administrator.
- In the side navbar, select Site administration > Plugins.
- In the Activity modules section, select Manage tools.
- Click configure a tool manually.
-
In the Tool settings section, enter the following information as shown below.
-
- Tool name: Any name you choose that helps identify the tool.
- Tool URL: The tool URL provided by your Client Success Manager.
- LTI version: Select LTI 1.3.
- Public key type: Select Keyset URL.
- Public keyset: The public keyset provided by your Client Success Manager.
- Initiate login URL: The initiate login URL provided by your Client Success Manager.
-
Redirection URl(s): The redirection URI(s) provided by your Client Success Manager.
-
Custom parameters:
- person_sourcedid=$Person.email.primary
-
lis_person_sourcedid=$User.username
- Tool configuration usage: Select Show in activity chooser and as a preconfigured tool.
- Default Launch Container: Select New Window.
- Select the Supports Deep Linking (Content-Item Message) check box.
-
- In the Services section, select the settings as shown below.
-
- IMS LTI Assignment and Grade Services: Select Use this service for grade sync and column management.
- IMS LTI Names and Role Provisioning: Select Use this service to retrieve members' information as per privacy settings.
- Tool Settings: Select Do not use this service.
-
- In the Privacy section, select the settings as shown below.
-
- Share launcher's name with tool: Select Always.
- Share launcher's email with tool: Select Always.
- Accept grades from the tool: Select Always.
-
- In the Miscellaneous section, select the settings as shown below, and then click Save Changes.
-
- Default organisation ID: Select Site hostname.
- Organisation URL: The organisation URL provided by your Client Success Manager.
-
- Locate the YuJa Engage tool and click the View configuration details button.
- Make note of the Tool configuration details. They will be required when configuring the Engage API.
Configuring the Engage API
Once you have added Engage to Moodle, you will be required to configure the Engage API to allow for data transfer between Moodle and Engage. Make sure your Client Success Manager has provided you with your ISS, OIDC Endpoint, JWKS Endpoint, and OAuth2 Token Endpoint.
- Log in to Engage as an admin using your zone URL.
-
- Example: https://www.evergreen.engage.yuja.com
-
- In the side navbar, select Integrations.
- In the Select Integration Type drop-down menu, select LMS LTI 1.3.
- In the Select LMS drop-down menu, select Moodle.
- In the API Configuration section, use the Tool configuration details noted in the Integrating Engage into LTI 1.3 section to enter the information as shown below.
-
- ISS: Your Platform ID
- Client Id: Your Client ID
- OIDC Endpoint: Your Authentication Request URL
- JWKS Endpoint: Your Public keyset URL
- OAuth2 Token Endpoint: Your Access token URL
- Deployment Id: Your Deployment ID
-
- In the User Configuration and Course Configuration sections, turn on the toggles.
- Click Save Changes.
Adding Engage to a Course
Once the integration process is complete, Engage can be added to any course as an external tool.
- Log in to Moodle and select your course.
- Turn on the Edit mode toggle.
- In the section you want to add Engage, click Add an activity or resource or + > Activity or resource.
- Select the Activities tab and then click YuJa Engage.
Note: The name of the Activity is the name you entered in step 5 of Integrating Engage into LTI 1.3.
- Enter the information as shown below, and then click Save and return to course. The Engage LTI link will appear.
-
- Activity name: Enter the name you want the Engage LTI link to appear as.
-
- Select the Engage LTI link to access Engage inside Moodle.