Canvas

Our Canvas 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 Canvas with the same password they use to access the school’s IT-system. The Canvas 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

URL to Canvas, typically http://%22customer%22.instructure.com

Admin User access for Canvas (preferably a separate account for UMS)

- IMPORTANT: Language for the UMS account MUST be set to english as this impacts API errors in the Canvas.log

Installation

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

You will now see an overview of your Canvas settings.

Canvas settings

To configurate your settings, go to 'Edit existing template' and choose Canvas. Click 'Manage' and 'Add'.

Description

Give the Site settings a name.

Organization settings

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

Users

Options that define how users are created

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.

Mail alias

Choose a column from the students table. Its default is <Not used>. This means that the mail alias will be the same as default username.

This column will be used as the <Mail alias>@<Mail Domain from organization settings>.

If the column from the database contains a @ it will use this mail and not add <Mail Domain from organization settings>.

SIS ID

Choose a column from the students table. Its default is <Not used>. This means that the SIS ID will be the same as default username.

This column will be used as the SIS ID.

Add organization domain as suffix to username

If this is checked the mail domain from organization settings will be added as part of the login/username.

Set random password

Enable this to set random password on users when they are created. This is used when you enable SSO in Canvas and you don't want them to login with anything else.

Delete users

Delete the users when they are no longer active

Keep inactive before deleting

Wait this number of days before deleting inactive users

Phone country code

Set the default country code for users in Canvas. This is only applied to phone numbers that are not already prefixed.

Distribution lists

Check the box to create, update, and delete groups that has a Canvas setting attached.

Maintain lists

Check this box to enable groups to be created in Canvas

Delete lists

Check this box to delete groups from Canvas

Delete unused lists after

Wait this number of days before deleting unused/old lists

Template security groups

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

Upload student information

Check these boxes to send and update information on students:

• Mobile Phone

Upload employee information

Check these boxes to send and update information on employees:

• Mobile Phone

Upload Guardian information

Create Guardians

Check this box to create guardians

Check these boxes to send and update information on guardians:

• Mobile Phone

Site

See LMS Settings for options that are not described below.

Conclude learners instead of removing them

This tells UMS to conclude the learners on a course instead of removing them.

Activity sites

See Site selection settings

Course sites

See Site selection settings

Organization settings

Description

Give your Organization setting a name.

URL

URL of the Canvas installation.

Mail domain

Mail domain for the Canvas installation.

Access token

Type the access token that is created with the help of this link https://community.canvaslms.com/docs/DOC-10806-4214724194.

The user under which the access token is created must be set to English language

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 sites being created. If left blank there are no criteria.

Root account ID

Enter the root account id from Canvas. This is default 1

Installation ID

This is not used yet

Sub accounts

This section explains how to create a hierarchy in Canvas.

DisplayName

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

Add staff as

Add staff to the sub account node with this role

Require parent criterias

Staff will only be added to the node if they meet all the criteria's from the parent nodes

Example of how UMS will build a hierarchy

The account "Byggeriuddannelserne" comes from the 'Sub accounts' settings "Education"

The account "Architectural Technology and Construction" comes from the 'Sub accounts' settings "Department"

Site Settings

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

Description

Enter a description for this setting.

Add censors

Add staff where the timetable blocks are of type Censors.

Add examiners

Add staff where the timetable blocks are of type ExamEvent.

SQL Groups

See LMS Settings for this option.

Parameters

> LiveAtEdu.exe [<optional> Action]

Eg.

> LiveAtEdu.exe

> LiveAtEdu.exe UsersOnly

Users

Parameter	Description
UsersOnly	Runs all the parameters in this table
UpdateUsers	Update users
DisableUsers	Disable users
EnableUsers	Enable users
DeleteUsers	Delete users
CreateUsers	Create users
UpdateImmutableID	Update Immutable ID on users
UpdateOffice365SettingsIDForUsers	Update Office 365 settings for users if they have changed template
UpdateUsersObjectID	Get the object ID from office 365 and save it in UMS DB

User settings

Parameter	Description
RunUserSettings	Runs all the parameters in this table
DisableStrongPassword	Disable strong password for users
SetMailAddress	Set mail address on users
Forward2OnPremiseMail	Set forward to OnPremise mail on users
SetCalendarRights	Set calendar rights on users
UpdateMailboxTimeZone	Update timezone for mailbox users
UpdateMailboxLanguage	Update language for mailbox users
EnablePasswordNeverExpires	Enable password never expires for users
UpdatePictures	Update pictures
Forward2PrivateMail	Set forward to privatemail on users
UpdateReplyToAll	Set Reply to all on users
ProvisionOneDrive	Provision OneDrive to users
UpdateAddressBookPolicy	Set address book policy on users

Groups

Parameter	Description
GroupsOnly	Runs all the parameters in this table
RemoveGroupMembers	Remove group members from groups
AddGroupMembers	Add members to groups
DeleteGroups	Delete groups
CreateGroups	Create groups
UpdateGroupsObjectID	Get the object ID from office 365 and save it in UMS DB
GetUPNsForGroups	Get the UPN of template groups from Office 365

Template groups

Parameter	Description
TemplateGroupsOnly	Runs all the parameters in this table
RemoveUsersFromTemplateGroups	Remove users from template security groups
AddUsers2TemplateGroups	Add users to template security groups
DeleteTemplateGroups	Delete groups that are no longer template security groups
UpdateTemplateGroupsObjectID	Get the object ID from office 365 and save it in UMS DB
GetUPNsForTemplateGroups	Get the UPN of template security groups from Office 365

Template extra groups

Parameter	Description
TemplateExtraGroupsOnly	Runs all the parameters in this table
CreateTemplateExtraGroups	Create groups from template extra group
DeleteTemplateExtraGroups	Delete groups that are no longer in extra groups
AddTemplateExtraGroupMembers	Add users to template extra groups
UpdateTemplateExtraGroupsObjectID	Get the object ID from office 365 and save it in UMS DB

Keep alive groups

Parameter	Description
KeepAliveGroupsOnly	Runs all the parameters in this table
CreateKeepAliveGroups	Create keep alive groups
DeleteKeepAliveGroups	Delete keep alive groups if they are no longer in UMS
UpdateSetMailAddressOnKeepAliveGroups	Update the mail address on keep alive groups
AddKeepAliveGroupMembers	Add users to keep alive groups
RemoveKeepAliveGroupMembers	Remove users from keep alive groups

Disabled groups

Parameter	Description
DisabledGroupsOnly	Runs all the parameters in this table
CreateDisabledGroups	Create disabled groups
DeleteDisabledGroups	Delete disabled groups if they are no longer in UMS
UpdateSetMailAddressOnDisabledGroups	Update the mail address on disabled groups
AddDisabledGroupMembers	Add users to disabled groups
RemoveDisabledGroupMembers	Remove users from disabled groups

Teams

Parameter	Description
TeamsOnly	Runs all the parameters in this table
AddTeams2DB	Add Teams to UMS DB
CreateTeams	Create Teams
AddTeamToGroup	Add teams to groups
ActivateTeams	Activate teams
UpdateTeams	Update Teams
DeleteTeams	Delete Teams
AddTeachers2TeamsDBTable	Add teachers to Office365Teams_Teachers table in UMS DB
AddTeachers2Teams	Add teachers to Teams
AddLearners2TeamsDBTable	Add learners to Office365Teams_Learners table in UMS DB
AddLearners2Teams	Add learners to Teams
TeamsDeleteTeachers	Delete teachers in Teams
TeamsDeleteLearners	Delete learners in Teams
TeamsUpdateNeedToBeUpdated	Set update on next run flag
UpdateLearnersExternalID	Retrieve the learners object id from Office 365 and save it in UMS DB
UpdateTeachersExternalID	Retrieve the teachers object id from Office 365 and save it in UMS DB
UpdateSchoolsExternalID	Retrieve the schools object id from Office 365 and save it in UMS DB
UpdateTeamsExternalID	Retrieve the teams object id from Office 365 and save it in UMS DB

SharePoint

Parameter	Description
SharepointOnly	Runs all the parameters in this table
CreateSites	Create sites
AddSites2DB	Add sites in UMS DB
DeleteSites	Delete sites
UpdateSites	Update sites
AddLearners2SitesInDB	Add learners to UMS DB
DeleteTeachers	Delete teachers
AddTeachers2Sites	Add teachers to sites
DeleteSiteGroups	Delete site groups
AddTeachers2SitesInDB	Add teachers to UMS DB
DeleteLearners	Delete learners
AddLearners2Sites	Add learners to sites
UpdateSiteURL	Update sites with new URL
AddNoteBooks2Sites	Add OneNote Class NoteBooks to sites
SharePointDeleteNoteBooks	Delete OneNote Class NoteBooks from sites
UpdateNeedToBeUpdated	Set the update on next run flag
UpdateSitesIsActive	Update site active/inactive status
SharePoint_OneNoteClassNotebook_AddMissingTeachers	Add missing Teachers to OneNote Class NoteBooks
SharePoint_OneNoteClassNotebook_AddMissingLearners	Add missing Learners to OneNote Class NoteBooks
ReAddLearners2Sites	Re-add learners to sites if ReAdd is true in DB
ReAddTeachers2Sites	Re-add teachers to sites if ReAdd is true in DB

OneNoteClassNoteBook

Parameter	Description
OneNoteClassNotebookOnly	Runs all the parameters in this table
AddNotebooks2DB	Add OneNote Class NoteBooks to UMS DB
CreateNotebooks	Create OneNote Class NoteBooks
UpdateOneNotes	Update OneNote Class NoteBooks
DeleteOneNotes	Delete OneNote Class NoteBooks
AddTeachers2OneNotesInDB	Add teachers to OneNote Class NoteBooks in UMS DB
AddTeachers2OneNotes	Add teachers to OneNote Class NoteBooks
AddLearners2OneNotesInDB	Add learners to OneNote Class NoteBooks in UMS DB
AddLearners2OneNotes	Add learners to OneNote Class NoteBooks
OneNoteDeleteTeachers	Delete teachers in OneNote Class NoteBooks
OneNoteDeleteLearners	Delete learners in OneNote Class NoteBooks
OneNoteUpdateNeedToBeUpdated	Set update on next run flag

FAQ

Error. Could not create user

Could not create user and it was not found in a search

• Open the Canvas.log file and find the more specific error message.
• Check Canvas for a user that already has this login. This would written in the log files error message.

How do I clean up UMS db?

Delete from Canvas_Learners

Delete from Canvas_Teachers

Delete from Canvas_Guardians

Delete from Canvas_Sites

Delete from Canvas_Groups

Delete from Canvas_SubAccount

Delete from Canvas_RemoveLog

Delete from CanvasTemplateGroups