Difference between revisions of "Itslearning"

From UmsWiki
Jump to: navigation, search
(Missing uses in Course.)
 
(48 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
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.  
 
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===
 
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.
 
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.
  
== Prerequisites ==
+
==Prerequisites==
  
=== Module requirements ===
+
===Module requirements===
 
[[UMS]]
 
[[UMS]]
  
=== What to have ready ===
+
===What to have ready===
itslearning
 
  
== Installation ==
+
*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]]
 +
 
 +
==Installation==
 
Open UMS Configurator and go to Template > itslearning. Click the first manage button.
 
Open UMS Configurator and go to Template > itslearning. Click the first manage button.
 
[[File:Itslearning Template.jpg|none|thumb|791x791px]]
 
[[File:Itslearning Template.jpg|none|thumb|791x791px]]
Line 19: Line 44:
 
[[File:Itslearning Settings.jpg|none|thumb|556x556px]]
 
[[File:Itslearning Settings.jpg|none|thumb|556x556px]]
  
== itslearning settings ==
+
==itslearning settings==
To configurate your settings, go to 'Edit existing template', choose itslearning, click 'Manage' and 'Add'.
+
[[File:Itslearning settings.png|none|thumb|751x751px]]
 +
 
 +
====Description====
 +
Give the Site settings a name.
 +
 
 +
====Organization settings====
 +
Choose the Organization setting you want to use for this site setting.
 +
 
 +
====Users====
  
==== Description ====
+
=====Username=====
Give the Site settings a name
+
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.
  
==== Organization settings ====
+
This column will be used as the login.
Choose the Organization setting you want to use for this site setting
 
  
==== Template security groups ====
+
=====Delete users=====
Check the box to create, update, and delete template security groups that has an itslearning setting attached
+
Delete the users when they are no longer active
  
=== Upload student information ===
+
=====Keep inactive before deleting=====
Check these boxes to send and update information on students
+
Wait this number of days before deleting inactive users
* Address
 
* Phone
 
* Mobile Phone
 
* Mail
 
  
=== Upload employee information ===
+
====Template security groups====
Check these boxes to send and update information on employees
+
Check the box to create, update, and delete template security groups that has an itslearning setting attached.
* Address
 
* Phone
 
* Mobile Phone
 
* Mail
 
[[File:Itslearning Settings Edit.jpg|none|thumb|751x751px]]
 
=== Site ===
 
See [[LMS Settings]] for options not described below.
 
  
==== Language ====
+
====Upload student information====
 +
Check these boxes to send and update information on students:
 +
 
 +
*Address
 +
*Phone
 +
*Mobile Phone
 +
*Private mail
 +
 
 +
====Timetable====
 +
Check maintain to make the timetable on users
 +
 
 +
Check Delete old to cleanup appointments from users calendar
 +
 
 +
====Timetable courses====
 +
Check maintain to make the timetable on Activities or courses
 +
 
 +
Check Delete old to cleanup appointments from activity or course calendar
 +
 
 +
====Upload employee information====
 +
Check these boxes to send and update information on employees:
 +
 
 +
*Address
 +
*Phone
 +
*Mobile Phone
 +
*Private mail
 +
 
 +
===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
 
The language used for a site when it is created
  
==== Course category ====
+
====Course category====
 
The category is put on the site when it is created
 
The category is put on the site when it is created
  
==== Activity sites ====
+
====Activity sites====
 
See [[Site selection settings]]
 
See [[Site selection settings]]
  
==== Course sites ====
+
====Course sites====
See [[Site selection settings]][[File:Itslearning Settings Edit Site Settings.jpg|none|thumb|895x895px]]
+
See [[Site selection settings]]
== Organization settings ==
 
Go to ????[[File:Itslearning Organization Settings.jpg|link=http://wiki.inlogic.dk/index.php/File:Itslearning%20Organization%20Settings.jpg|none|thumb|556x556px]]
 
  
==== Description ====
+
==Organization settings==
Give your Organization setting a name
+
[[File:Itslearning Organization Settings.jpg|link=http://wiki.inlogic.dk/index.php/File:Itslearning%20Organization%20Settings.jpg|none|thumb|556x556px]]
 +
[[File:Itslearning Organization Settings Edit.jpg|link=http://wiki.inlogic.dk/index.php/File:Itslearning%20Organization%20Settings%20Edit.jpg|none|thumb|449x449px]]
 +
====Description====
 +
Give your Organization setting a name.
  
==== Username ====
+
====Service URL====
Type your username for API connection (contact itslearning to acquire your username)
+
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).
  
==== Password ====
+
====Username====
Type your password for API connection (contact itslearning to acquire your password)
+
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).
  
==== Source organization ====
+
====Password====
Type the source organization for API connection (contact itslearning to acquire the source organization)
+
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).
  
==== SQL Criteria ====
+
====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.
 
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.
  
==== Installation ID ====
+
====Organization API Client ID====
Type the password for the user with access to the database[[File:Itslearning Organization Settings Edit.jpg|link=http://wiki.inlogic.dk/index.php/File:Itslearning%20Organization%20Settings%20Edit.jpg|none|thumb|324x324px]]
+
Only relevant if you have a contract with itslearning that allows synchronization of timetableblocks
=== Sub accounts ===
+
 
 +
====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. [[File:Itslearning Sub accounts.jpg|none|thumb|620x620px]]
 
This section explains how to create a hierarchy in itslearning. [[File:Itslearning Sub accounts.jpg|none|thumb|620x620px]]
  
==== DisplayName ====
+
====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.
 
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 ====
+
====Database field====
 
Select a column from the students table use the contents of that column to build the hierarchy.
 
Select a column from the students table use the contents of that column to build the hierarchy.
  
==== SQL Criteria ====
+
====SQL Criteria====
 
Select only rows that match the SQL sentence. If left blank there are no criteria.
 
Select only rows that match the SQL sentence. If left blank there are no criteria.
  
==== Example of how UMS will build a hierarchy ====
+
====Example of how UMS will build a hierarchy====
The first two root elements come from the '<nowiki/>Sub accounts' settings.
+
 
 +
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'.
 +
 
 +
[[File:Itslearning hierarchy.jpg|none|thumb|1263x1263px]]
 +
 
 +
===Sub accounts Courses===
 +
This section explains how to create a hierarchy in itslearning. [[File:Itslearning Sub accounts.jpg|none|thumb|620x620px]]
 +
 
 +
====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.
  
All courses that UMS creates will be put in 'UMS Courses'.
+
====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 groups will be sorted in the hierarchy. Groups that are not sorted in the hierarchy will be put in 'UMS Courses'.
  
All template security groups will be created in 'UMS Template Groups'.[[File:Itslearning hierarchy.jpg|none|thumb|920x920px]]
+
All courses that becomes inactive will be put in 'UMS Courses archive'.
 +
[[File:Itslearning hierarchy Courses.jpg|none|thumb|1263x1263px]]
  
== Site Settings ==
+
==Site Settings==
 
You need to attach a cohort setting to a template. This will tell UMS that cohorts will be created from this template.
 
You need to attach a cohort setting to a template. This will tell UMS that cohorts will be created from this template.
 
[[File:Itslearning Site Template Settings.jpg|none|thumb|556x556px]]
 
[[File:Itslearning Site Template Settings.jpg|none|thumb|556x556px]]
 +
[[File:Itslearning Site Template Settings Edit.jpg|none|thumb|422x422px]]
  
==== Description ====
+
====Description====
 
Enter a description for this setting.
 
Enter a description for this setting.
  
==== Template ====
+
====Template====
Enter a template that is used when creating courses.
+
Enter a template SyncKey that is used when creating courses.
  
==== SQL Groups ====
+
if you are using a course that was created by UMS then remember to prefix the template name with UMSCourse_.
See [[LMS Settings]] for this option.[[File:Itslearning Site Template Settings Edit.jpg|none|thumb|422x422px]]
 
  
== Group Settings ==
+
Validation rule: The course template SyncKey must exist, and must refer to a course template, not a regular course.
 +
 
 +
[https://developer.itslearning.com/Working_with_course_templates_in_IMS_ES.html Working_with_course_templates_in_IMS_ES]
 +
 
 +
For this purpose we need a UMSServiceUser. The synckey for user object has to be the same as the username, UMSServiceUser.
 +
 
 +
====SQL Groups====
 +
See [[LMS Settings]] for this option.
 +
 
 +
==Group Settings==
 
You need to attach a cohort setting to a template. This will tell UMS that cohorts will be created from this template.
 
You need to attach a cohort setting to a template. This will tell UMS that cohorts will be created from this template.
 
[[File:Itslearning Group Template Settings.jpg|none|thumb|556x556px]]
 
[[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.
  
==== Description ====
+
if you are using a group that was created by UMS then remember to prefix the template name with UMSGroups_.
Enter a description for this setting.
+
 
 +
Validation rule: The group template SyncKey must exist, and must refer to a course template, not a regular group.
 +
 
 +
[https://developer.itslearning.com/Working_with_course_templates_in_IMS_ES.html Working_with_course_templates_in_IMS_ES]
 +
 
 +
For this purpose we need a UMSServiceUser. The synckey for user object has to be the same as the username, UMSServiceUser.
 +
 
 +
====SQL Groups====
 +
See [[LMS Settings]] for this option.
 +
 
 +
==FAQ==
 +
 
 +
===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)
  
==== Template ====
+
===Missing uses in Course.===
Enter a template that is used when creating groups.
 
  
==== SQL Groups ====
+
*Check that the course exists
See [[LMS Settings]] for this option.[[File:Itslearning Group Template Settings Edit.jpg|none|thumb|422x422px]]
+
*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 12:00, 29 July 2021

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

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.

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
It's learing 1.png

Make sure that "Manage API" is enabled, as shown in the image below

It's learing 2.png

Click on "Manage Enterprise web services" as shown in the image below

It's learing 3.png

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)
Capture.png

Installation

Open UMS Configurator and go to Template > itslearning. Click the first manage button.

Itslearning Template.jpg

You will now see an overview of your itslearning settings.

Itslearning Settings.jpg

itslearning settings

Itslearning settings.png

Description

Give the Site settings a name.

Organization settings

Choose the Organization setting you want to use for this site setting.

Users

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.

This column will be used as the login.

Delete users

Delete the users when they are no longer active

Keep inactive before deleting

Wait this number of days before deleting inactive users

Template security groups

Check the box to create, update, and delete template security groups that has an itslearning setting attached.

Upload student information

Check these boxes to send and update information on students:

  • Address
  • Phone
  • Mobile Phone
  • Private mail

Timetable

Check maintain to make the timetable on users

Check Delete old to cleanup appointments from users calendar

Timetable courses

Check maintain to make the timetable on Activities or courses

Check Delete old to cleanup appointments from activity or course calendar

Upload employee information

Check these boxes to send and update information on employees:

  • Address
  • Phone
  • Mobile Phone
  • Private mail

Site

See LMS Settings for options that are not described below.

Itslearning Settings Edit Site Settings.jpg

Language

The language used for a site when it is created

Course category

The category is put on the site when it is created

Activity sites

See Site selection settings

Course sites

See Site selection settings

Organization settings

Itslearning Organization Settings.jpg
Itslearning Organization Settings Edit.jpg

Description

Give your Organization setting a name.

Service URL

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.

Itslearning Sub accounts.jpg

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'.

Itslearning hierarchy.jpg

Sub accounts Courses

This section explains how to create a hierarchy in itslearning.

Itslearning Sub accounts.jpg

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'.

Itslearning hierarchy Courses.jpg

Site Settings

You need to attach a cohort setting to a template. This will tell UMS that cohorts will be created from this template.

Itslearning Site Template Settings.jpg
Itslearning Site Template Settings Edit.jpg

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.

Working_with_course_templates_in_IMS_ES

For this purpose we need a UMSServiceUser. The synckey for user object has to be the same as the username, UMSServiceUser.

SQL Groups

See LMS Settings for this option.

Group Settings

You need to attach a cohort setting to a template. This will tell UMS that cohorts will be created from this template.

Itslearning Group Template Settings.jpg
Itslearning Group Template Settings Edit.jpg

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.

Working_with_course_templates_in_IMS_ES

For this purpose we need a UMSServiceUser. The synckey for user object has to be the same as the username, UMSServiceUser.

SQL Groups

See LMS Settings for this option.

FAQ

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.
    2019-12-04 11 34 30-itslearning.png
    Search for the relevant course, then click "Choose"
    2019-12-04 11 37 22-Search for hierarchy.png
    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"