Created page with "Our itslearning integration is developed for schools, which want to avoid hour-long administrative tasks. The integration automatically creates, maintains and deletes users, b..."
Our itslearning 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.
Our itslearning integration is developed for schools that 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 ===
===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.
This allows users to log into itslearning with the same password they use to access the school’s IT-system. The itslearning 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 so they can focus on other tasks.
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==
== Prerequisites ==
===Module requirements===
[[UMS]]
===What to have ready===
*Request a test site from Its learning. It's learning will send username, password and URL for the test site.
*The user must be system Administrator on the test site.
*You must have itslearning give the rights to "'''manage Enterprise web services'''" for this administrative user
*As System Administrator will you have access to the following displayed on the image below
[[File:It's learing 1.png|none|thumb|755x755px]]
Make sure that "Manage API" is enabled, as shown in the image below
[[File:It's learing 2.png|none|thumb|753x753px]]
Click on "Manage Enterprise web services" as shown in the image below
[[File:It's learing 3.png|none|thumb|752x752px]]
Fill out in the following points, as shown in the image below.
*Title
*Username (If set to auto-generate, new username will be generated. If set to import, will username be imported from ums)
*Password (If set to auto-generate, new password will be generated. If set to import, will password be imported from ums)
*User profile data (choose which permerts should sync to it's learning)
*System to use must be set to IMS-Enterprise
*URL to service (copy url for it to be used later)
*Username (copy url for it to be used later)
*Password (copy url for it to be used later)
[[File:Capture.png|none|thumb|857x857px]]
=== Module requirements ===
==Installation==
[[UMS]]
Open UMS Configurator and go to Template > itslearning. Click the first manage button.
Choose the Organization setting you want to use for this site setting.
'''Description'''
====Users====
Give your Organization setting a name.
=====Username=====
Choose a column from the students table. Its default is <Not used>. This means that the username will be the same as in Active Directory.
'''DatabaseServer'''
This column will be used as the login.
Name of database server hosting the Moodle database.
=====Delete users=====
Delete the users when they are no longer active
'''DatabaseName'''
=====Keep inactive before deleting=====
Wait this number of days before deleting inactive users
Name of Moodle database.
====Template security groups====
Check the box to create, update, and delete template security groups that has an itslearning setting attached.
'''Database TablesPrefix'''
====Upload student information====
Check these boxes to send and update information on students:
Table prefix set when installing Moodle.
*Address
*Phone
*Mobile Phone
*Private mail
'''UserName'''
====Timetable====
Check maintain to make the timetable on users
UserName of the user that can access the database.
Check Delete old to cleanup appointments from users calendar
'''Password'''
====Timetable courses====
Check maintain to make the timetable on Activities or courses
Password of the user that can access the database.
Check Delete old to cleanup appointments from activity or course calendar
'''URL'''
====Upload employee information====
Check these boxes to send and update information on employees:
URL for your Moodle installation ex. <nowiki>http://moodle.inlogic.dk</nowiki>
*Address
*Phone
*Mobile Phone
*Private mail
'''Webservice Token'''
===Site===
See [[LMS Settings]] for options that are not described below.
[[File:Itslearning Settings Edit Site Settings.jpg|none|thumb|895x895px]]
====Language====
The language used for a site when it is created
Token created in Moodle siteadministration. [https://docs.moodle.org/24/en/Using_web_services Guide to create access and token] ( Remember: When adding functions to webservice, add all functions )
====Course category====
The category is put on the site when it is created
'''DataPath'''
====Activity sites====
See [[Site selection settings]]
Moodle data path ex. \\moodle.inlogic.dk\c$\Moodle\server\moodledata\filedir.
====Course sites====
See [[Site selection settings]]
The user running moodle exe must have access to this path.
Type your "URL to service" for API connection (contact itslearning to acquire your username or login as an admin on yourschool.itslearning.com, Manage IMS Enterprise web services).
Choose Database type used for Moodle. can only be one in the list below.
====Username====
* Microsoft SQL
Type your username for API connection (contact itslearning to acquire your username or login as an admin on yourschool.itslearning.com, Manage IMS Enterprise web services).
* MySQL
* Oracle SQL
== Moodle Site settings ==
====Password====
From Configurator, Edit existing template > Moodle > Manage > Add or Configurator > Modules > Moodle > Site Settings > Add
Type your password for API connection (contact itslearning to acquire your username or login as an admin on yourschool.itslearning.com, Manage IMS Enterprise web services).
[[File:Moodle Settings.png|none|thumb|824x824px]]
'''Description:'''
Give the Site settings a name.
====Source organization====
Type the source organization for API connection (contact itslearning to acquire the source organization).
'''Organization settings'''
====SQL Criteria====
This is an overall SQL sentence that is used when creating groups. It is used in conjunction with the sub account settings. This has no impact on courses being created. If left blank there are no criteria.
Choose the Organization setting you want to use for this site setting.
====Organization API Client ID====
Only relevant if you have a contract with itslearning that allows synchronization of timetableblocks
'''Default country'''
====Organization API Client secret====
Only relevant if you have a contract with itslearning that allows synchronization of timetableblocks
Choose default country. This is used when creating users.
====Use test installation====
Enable this to use a test installation instead of production.
'''Authentication method'''
====Installation ID====
This is an ID you set in UMS to specify the multiple organization settings belong to the same itslearning installation.
Login method for the users
itslearning installations that has the same URL should normally have the same ID in UMS.
===Sub accounts===
This section explains how to create a hierarchy in itslearning. [[File:Itslearning Sub accounts.jpg|none|thumb|620x620px]]
'''Mail domain for new students'''
====Description====
This is an overall SQL sentence that is used when creating groups. It is used in conjunction with the sub account settings. This has no impact on courses being created.
The address appended to their username in moodle to give them an email address
====Database field====
Select a column from the students table use the contents of that column to build the hierarchy.
'''Mail domain for new employees'''
====SQL Criteria====
Select only rows that match the SQL sentence. If left blank there are no criteria.
The address appended to their username in moodle to give them an email address
====Example of how UMS will build a hierarchy====
=== Upload student information ===
All groups will be sorted in the hierarchy. Groups that are not sorted in the hierarchy will be put in 'UMS Groups'.
Check these boxes to send and update information on students
* Address
* Phone (Phone1)
* Mobile Phone (Phone 2)
* Mail
=== Picture library ===
All template security groups will be created in 'UMS Template Groups'.
Upload pictures of students
See [[Configurator/Picture_libraries|Picture libraries]]
Check these boxes to send and update information on employees
This section explains how to create a hierarchy in itslearning. [[File:Itslearning Sub accounts.jpg|none|thumb|620x620px]]
* Address
* Phone (Phone1)
* Mobile Phone (Phone 2)
* Mail
=== Picture library ===
====Description====
Upload pictures of employees
This is an overall SQL sentence that is used when creating groups. It is used in conjunction with the sub account settings. This has no impact on courses being created.
See [[Configurator/Picture_libraries|Picture libraries]]
====Database field====
Select a column from the students table use the contents of that column to build the hierarchy.
=== Course ===
====Database field (Displayname)====
Select a column from the students table use the contents of that column as title in the hierarchy. This is dependent on the "'''Database field'''".
[[File:Itslearning Group Template Settings.jpg|none|thumb|556x556px]]
[[File:Itslearning Group Template Settings Edit.jpg|none|thumb|422x422px]]
====Description====
Enter a description for this setting.
====Template====
Enter a template SyncKey that is used when creating groups.
if you are using a group that was created by UMS then remember to prefix the template name with UMSGroups_.
Validation rule: The group template SyncKey must exist, and must refer to a course template, not a regular group. The option to set the synchronization must be enabled on the customer.
itslearning.exe usersonly (run this twice, on 2nd run UMS will detect users with missing sync keys)
'''SQL Groups'''
===Missing uses in Course.===
See [[LMS Settings]] for this option
*Check that the course exists
*Check if user exists in It'slearning
*If course exists and user exists but user does not exist in course. Find course, sign up for course then click on participants, click tab hierarchy synchronization, click on find hierarchy, click on Search. [[File:2019-12-04 11 34 30-itslearning.png|none|thumb|1360x1360px]]Search for the relevant course, then click "Choose"[[File:2019-12-04 11 37 22-Search for hierarchy.png|none|thumb|1285x1285px]]Now all participants should be in the relevant course
== FAQ ==
=== Trying to set synckey on user but fails ===
if it says something like "'''already on another user with the name unknown unknown'''" it's because the unknown user is in the "'''Recycle bin'''"
Latest revision as of 14:03, 15 November 2022
Our itslearning integration is developed for schools that 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.
This allows users to log into itslearning with the same password they use to access the school’s IT-system. The itslearning 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 so they can focus on other tasks.
Type your "URL to service" for API connection (contact itslearning to acquire your username or login as an admin on yourschool.itslearning.com, Manage IMS Enterprise web services).
Username
Type your username for API connection (contact itslearning to acquire your username or login as an admin on yourschool.itslearning.com, Manage IMS Enterprise web services).
Password
Type your password for API connection (contact itslearning to acquire your username or login as an admin on yourschool.itslearning.com, Manage IMS Enterprise web services).
Source organization
Type the source organization for API connection (contact itslearning to acquire the source organization).
SQL Criteria
This is an overall SQL sentence that is used when creating groups. It is used in conjunction with the sub account settings. This has no impact on courses being created. If left blank there are no criteria.
Organization API Client ID
Only relevant if you have a contract with itslearning that allows synchronization of timetableblocks
Organization API Client secret
Only relevant if you have a contract with itslearning that allows synchronization of timetableblocks
Use test installation
Enable this to use a test installation instead of production.
Installation ID
This is an ID you set in UMS to specify the multiple organization settings belong to the same itslearning installation.
itslearning installations that has the same URL should normally have the same ID in UMS.
Sub accounts
This section explains how to create a hierarchy in itslearning.
Description
This is an overall SQL sentence that is used when creating groups. It is used in conjunction with the sub account settings. This has no impact on courses being created.
Database field
Select a column from the students table use the contents of that column to build the hierarchy.
SQL Criteria
Select only rows that match the SQL sentence. If left blank there are no criteria.
Example of how UMS will build a hierarchy
All groups will be sorted in the hierarchy. Groups that are not sorted in the hierarchy will be put in 'UMS Groups'.
All template security groups will be created in 'UMS Template Groups'.
Sub accounts Courses
This section explains how to create a hierarchy in itslearning.
Description
This is an overall SQL sentence that is used when creating groups. It is used in conjunction with the sub account settings. This has no impact on courses being created.
Database field
Select a column from the students table use the contents of that column to build the hierarchy.
Database field (Displayname)
Select a column from the students table use the contents of that column as title in the hierarchy. This is dependent on the "Database field".
SQL Criteria
Select only rows that match the SQL sentence. If left blank there are no criteria.
Example of how UMS will build a hierarchy
All groups will be sorted in the hierarchy. Groups that are not sorted in the hierarchy will be put in 'UMS Courses'.
All courses that becomes inactive will be put in 'UMS Courses archive'.
Site 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.
Template
Enter a template SyncKey that is used when creating courses.
if you are using a course that was created by UMS then remember to prefix the template name with UMSCourse_.
Validation rule: The course template SyncKey must exist, and must refer to a course template, not a regular course.
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.
Template
Enter a template SyncKey that is used when creating groups.
if you are using a group that was created by UMS then remember to prefix the template name with UMSGroups_.
Validation rule: The group template SyncKey must exist, and must refer to a course template, not a regular group. The option to set the synchronization must be enabled on the customer.
Is password synchronization between UMS and Itslearning supported?
Short answer: No
Itslearning supports SSO and LDAP
How do I clean up UMS db?
Delete from itslearning_Learners
Delete from itslearning_Teachers
Delete from itslearning_Sites
Delete from itslearning_SubAccount_Courses
Delete from itslearning_Groups
Delete from itslearning_SubAccount
Delete from itslearningTemplateGroups
Update itslearningOrganizationSettings Set UMSCoursesCreated = 0, UMSTemplateGroupsCreated= 0, UMSGroupsCreated = 0, UMSCoursesArchiveCreated = 0
Then run this commands:
itslearning.exe ChangeAllPersonIdentifiersToUserName
itslearning.exe usersonly (run this twice, on 2nd run UMS will detect users with missing sync keys)
Missing uses in Course.
Check that the course exists
Check if user exists in It'slearning
If course exists and user exists but user does not exist in course. Find course, sign up for course then click on participants, click tab hierarchy synchronization, click on find hierarchy, click on Search. Search for the relevant course, then click "Choose"Now all participants should be in the relevant course
Trying to set synckey on user but fails
if it says something like "already on another user with the name unknown unknown" it's because the unknown user is in the "Recycle bin"
