search

moodlehq / moodle-enrol_oneroster

OneRoster Enrolment plugin for Moodle
GNU General Public License v3.0
3 stars 7 forks source link

Improve initial setup documentation #11

Open tylercarrwork opened 3 years ago

tylercarrwork commented 3 years ago

Do you have additional documentation beyond the README.md? I understand your development started partway through 2020, and it's an ambitious project. I think from looking at the settings page that we can connect a moodle instance to just one LIS at a time?

Describe the solution you'd like A how-to guide of what "One Roster Root URL" and "Token URL" to fill in would be helpful.

Sorry if this isn't the best way to submit questions to you, I'm new to the OpenSource github environments/workflows.

Thank you!

andrewnicols commented 3 years ago

Hi @tylercarrwork,

The documentation is currently via the readme and inline help, where appropriate.

At this time it is only possible to connect one LIS. The OneRoster design is geared towards one LIS connecting to multiple LMS and I haven't really encountered any cases where it may be desirable to have one Moodle connected to multiple LISs.

Perhaps you can describe your use-case and intended deployment?

It may be possible to adapt the OneRoster plugin to connect to multiple LIS but doing so will require a number of changes and I'll need as much information as possible in order to achieve this.

Regarding the Root URL and Token URL, these are features of OneRoster which your LIS must provide and you'll have to look at the documentation provided by your LIS to find these. The Root URL Is the base of the REST endpoints. That may just be the URL you use to access it via the web, or it may be a separate URL. The Token URL will also be provided by your LIS. This is a different URL which is used for authentication via OAuth 2.0. You will need to look at the documentation for your LIS to determine what these are.

tylercarrwork commented 3 years ago

@andrewnicols ,

Thanks so much for your prompt reply!

Our software is more of an LTI 1.3 tool that can be integrated to multiple LMS's (for multiple distinct client school districts). We also host a Moodle LMS to present some content to staff members of the various distinct school districts. This Moodle course is an LTI 1.3 client to directly link into our product/tool.

One of the districts (whose LMS solution doesn't support LTI 1.3 integration) asked if we support OpenRoster, which we don't at this time. I found your plugin documented on the IMS Global Learning Consortium and thought we might satisfy that districts which to use OpenRoster by having the District register/enrol students for classes from their LIS/SIS to Moodle with OpenRoster, and then the Moodle course content would integrate to our tool with LTI 1.3. So I incorrectly assumed that maybe other (distinct) school districts might want to register to our Moodle Course via OpenRoster (Clearly I didn't read the full OpenRoster specification before reaching out to you either, sorry!)