Moodle: Difference between revisions
| (35 intermediate revisions by 4 users not shown) | |||
| Line 9: | Line 9: | ||
===Module requirements=== | ===Module requirements=== | ||
'''Minimum Moodle Server version 3.4''' | |||
===What to have ready=== | ===What to have ready=== | ||
Moodle | Moodle | ||
===API functions=== | |||
[https://docs.moodle.org/dev/Web_service_API_functions Web service API functions] | |||
{| class="wikitable sortable" | |||
|+Default permissions | |||
!Permission name | |||
!Required | |||
!Used by | |||
|- | |||
|core_webservice_get_site_info | |||
|Yes | |||
|All | |||
|- | |||
|core_user_create_users | |||
|Yes | |||
|Persons | |||
|- | |||
|core_user_get_users | |||
|Yes | |||
|Persons | |||
|- | |||
|core_user_update_users | |||
|Yes | |||
|Persons | |||
|- | |||
|core_user_delete_users | |||
|Yes | |||
|Persons | |||
|- | |||
|core_files_upload | |||
| | |||
|Profile picture upload | |||
|- | |||
|core_user_update_picture | |||
| | |||
|Profile picture upload | |||
|- | |||
|core_course_create_courses | |||
| | |||
|Courses | |||
|- | |||
|core_course_duplicate_course | |||
| | |||
|Courses | |||
|- | |||
|core_course_delete_courses | |||
| | |||
|Courses | |||
|- | |||
|core_course_get_courses | |||
| | |||
|Courses | |||
|- | |||
|core_course_get_courses_by_field | |||
| | |||
|Courses | |||
|- | |||
|core_course_update_courses | |||
| | |||
|Courses | |||
|- | |||
|core_course_get_categories | |||
| | |||
|Courses, Cohort | |||
|- | |||
|enrol_manual_enrol_users | |||
| | |||
|Courses | |||
|- | |||
|enrol_manual_unenrol_users | |||
| | |||
|Courses | |||
|- | |||
|core_cohort_create_cohorts | |||
| | |||
|Cohort | |||
|- | |||
|core_cohort_update_cohorts | |||
| | |||
|Cohort | |||
|- | |||
|core_cohort_delete_cohorts | |||
| | |||
|Cohort | |||
|- | |||
|core_cohort_get_cohorts | |||
| | |||
|Cohort | |||
|- | |||
|core_cohort_search_cohorts | |||
| | |||
|Cohort | |||
|- | |||
|core_cohort_add_cohort_members | |||
| | |||
|Cohort | |||
|- | |||
|core_cohort_delete_cohort_members | |||
| | |||
|Cohort | |||
|} | |||
==Installation== | ==Installation== | ||
Open UMS Configurator and go to Modules > Moodle > Organization settings | Open UMS Configurator and go to Modules > Moodle > Organization settings | ||
[[File:Image.png|none|thumb|643x643px]] | [[File:Image.png|none|thumb|643x643px]] | ||
==Organization settings== | ==Organization settings== | ||
[[File:Moodle organization settings2.png|none|thumb|534x534px]] | [[File:Moodle organization settings2.png|none|thumb|534x534px]] | ||
=== Description === | |||
Give your Organization setting a name. | Give your Organization setting a name. | ||
=== URL === | |||
URL for your Moodle installation ex. <nowiki>http://moodle.inlogic.dk</nowiki> | URL for your Moodle installation ex. <nowiki>http://moodle.inlogic.dk</nowiki> | ||
=== Webservice Token === | |||
'''UMS Uses REST when communicating with Moodle webservices.''' | |||
UMS Uses REST when communicating with | |||
''' | |||
''' | '''Token created in Moodle site administration. [https://docs.moodle.org/24/en/Using_web_services Guide to create access and token] ( Remember: When adding functions to webservice, add all functions or the ones below)''' | ||
=== Suspend student when removing from course === | |||
Supend the student enrollment on a course instead of deleting the enrollment. | |||
==Moodle Site settings== | ==Moodle Site settings== | ||
| Line 91: | Line 140: | ||
[[File:Moodle Settings.jpg|none|thumb|961x961px]] | [[File:Moodle Settings.jpg|none|thumb|961x961px]] | ||
=== | ===Description=== | ||
Give the Site settings a name. | Give the Site settings a name. | ||
| Line 97: | Line 146: | ||
Choose the Organization setting you want to use for this site setting. | Choose the Organization setting you want to use for this site setting. | ||
=== | ===Default country=== | ||
Choose default country. This is used when creating users. | Choose default country. This is used when creating users. | ||
| Line 115: | Line 164: | ||
The address appended to their username in Moodle to give them an email address | The address appended to their username in Moodle to give them an email address | ||
===Username for | ===Username for employees=== | ||
Use a field from the UMS database as username for employees | Use a field from the UMS database as username for employees | ||
| Line 150: | Line 199: | ||
[[File:Moodle Course Settings.jpg|none|thumb|1044x1044px]] | [[File:Moodle Course Settings.jpg|none|thumb|1044x1044px]] | ||
See [[LMS Settings]] for options not described below | |||
See [[LMS Settings]] for options not | |||
====Language==== | ====Language==== | ||
| Line 170: | Line 218: | ||
===Cohort=== | ===Cohort=== | ||
[[File:Moodle Cohort Settings.png|none|thumb|895x895px]] | [[File:Moodle Cohort Settings.png|none|thumb|895x895px]] | ||
See [[LMS Settings]] for options not | See [[LMS Settings]] for options not described below | ||
====Activity sites==== | ====Activity sites==== | ||
See [[Site selection settings]] | See [[Site selection settings]] | ||
Latest revision as of 08:28, 17 November 2025
Our Moodle integration is developed for schools, which want to avoid hour-long administrative tasks. The integration automatically creates, maintains and deletes users, based on data from your student administrative system. It also creates and maintains group rooms, which teachers and students can use for teaching purposes. The rooms automatically use the language you require and can be categorized according to your needs, making them easier to find. Rooms that are no longer in use are deleted automatically.
Configuration in UMS
The integration makes it possible to upload pictures of the users to Moodle, making it easy for teachers and students to see whom they are interacting with. If these pictures are replaced in UMS, they are automatically updated in Moodle. Last, but not least, the module can integrate with the AD. This allows users to log into Moodle with the same password they use to access the school’s IT-system. The Moodle integration gives you an easy overview and ensures that the users’ data is always managed correctly, without requiring any manual updates. This frees up time for the IT-department, who can focus on other tasks instead.
If you want to make it easy for students and teachers to keep track of their timetables, you can embed our Web Timetable module in Moodle as an iframe. By doing this, users can access homework and notes that are registered on the various timetable blocks in the timetable. Please note: To embed Web Time Table, the Web Timetable and SSO modules are required. In order to see homework, the Homework module is required.
Prerequisites
Module requirements
Minimum Moodle Server version 3.4
What to have ready
Moodle
API functions
| Permission name | Required | Used by |
|---|---|---|
| core_webservice_get_site_info | Yes | All |
| core_user_create_users | Yes | Persons |
| core_user_get_users | Yes | Persons |
| core_user_update_users | Yes | Persons |
| core_user_delete_users | Yes | Persons |
| core_files_upload | Profile picture upload | |
| core_user_update_picture | Profile picture upload | |
| core_course_create_courses | Courses | |
| core_course_duplicate_course | Courses | |
| core_course_delete_courses | Courses | |
| core_course_get_courses | Courses | |
| core_course_get_courses_by_field | Courses | |
| core_course_update_courses | Courses | |
| core_course_get_categories | Courses, Cohort | |
| enrol_manual_enrol_users | Courses | |
| enrol_manual_unenrol_users | Courses | |
| core_cohort_create_cohorts | Cohort | |
| core_cohort_update_cohorts | Cohort | |
| core_cohort_delete_cohorts | Cohort | |
| core_cohort_get_cohorts | Cohort | |
| core_cohort_search_cohorts | Cohort | |
| core_cohort_add_cohort_members | Cohort | |
| core_cohort_delete_cohort_members | Cohort |
Installation
Open UMS Configurator and go to Modules > Moodle > Organization settings

Organization settings

Description
Give your Organization setting a name.
URL
URL for your Moodle installation ex. http://moodle.inlogic.dk
Webservice Token
UMS Uses REST when communicating with Moodle webservices.
Token created in Moodle site administration. Guide to create access and token ( Remember: When adding functions to webservice, add all functions or the ones below)
Suspend student when removing from course
Supend the student enrollment on a course instead of deleting the enrollment.
Moodle Site settings
From Configurator, Edit existing template > Moodle > Manage > Add or Configurator > Modules > Moodle > Site Settings > Add

Description
Give the Site settings a name.
Organization settings
Choose the Organization setting you want to use for this site setting.
Default country
Choose default country. This is used when creating users.
Authentication method
Login method for the users
Mail domain for new students
The address appended to their username in Moodle to give them an email address
Username for students
Use a field from the UMS database as username for students
Append mail domain to username
Adds @ + "Mail domain for new students" to the username when creating Moodle user.
Mail domain for new employees
The address appended to their username in Moodle to give them an email address
Username for employees
Use a field from the UMS database as username for employees
Append mail domain to username
Adds @ + "Mail domain for new employees" to the username when creating Moodle user.
Upload student information
Check these boxes to send and update information on students
- Address
- Phone (Phone1)
- Mobile Phone (Phone 2)
- Mail from AD (This is taken from the local Active Directory account)
Picture library
Upload pictures of students
Upload employee information
Check these boxes to send and update information on employees
- Address
- Phone (Phone1)
- Mobile Phone (Phone 2)
- Mail from AD (This is taken from the local Active Directory account)
Picture library
Upload pictures of employees
Course

See LMS Settings for options not described below
Language
The language set on a site when is it created.
Course category
The category the course is put on when the site is created. The course category is case sensitive and needs to match a category created in Moodle.
Maximum upload file size
Set the file size limit on a course when its created to a specific Mega byte amount.
Activity sites
Course sites
Cohort

See LMS Settings for options not described below
Activity sites
Course sites
Template Settings
You need to attach a cohort setting to a template. This will tell UMS that cohorts will be created from this template.

Description
Enter a description for this setting
Cohort category
Enter a category that will be attached to the cohorts when they are created
SQL Groups
See LMS Settings for this option
FAQ
(CreateLearners) Error Webservice error. User = 010xxxx - Webservice error. ERRORCODE><div>Adgangskoder skal indeholde mindst 1 små bogstaver.</div></ERRORCODE>
Password setting can be changed, see image below
