Your organization must have an active Canvas LMS account to use the Canvas LMS integration. Note that Canvas LMS integration is per branch and not shared across branches in a multi-Branch system.
Follow these steps in Canvas to start the Canvas LMS integration process.
- Log into your Canvas LMS account.
- Add an [Admin User] to the account. This user will be the account that connects to the Canvas API.
- Logout of Canvas.
- Log into Canvas with this new Account.
- Click on Account >> Settings.
- In the [Approved Integrations] area, click the [New Access Token] button.
- Enter a purpose, “XenDirect Connection” for example, and leave the Expires field blank.
- Click the [Generate Token] button.
- You will see a long string of characters. This is the [Canvas Token] you will use later. Copy and save that string somewhere locally.
- Logout of Canvas.
Choose your Canvas Vendor.
You can only Add one Canvas Vendor type per Branch.
Caution: Adding 2 Canvas records will cause problems. Most likely only the "Canvas" record will be used.
-
Vendor = Canvas - XenDirect Client Email is used as the Canvas Unique ID.
- When a Client updates their Email from the WebReg MyAccount area, an additional login associated with the User is created in Canvas.
-
Vendor = Canvas-B - XenDirect Client UserName is used as the Canvas Unique ID.
- When a Client updates their Profile in WebReg MyAccount thier UserName and Password are Updated in the User Login in Canvas.
Follow these steps in XenDirect to enable Canvas LMS integration.
- Go to view mode of Admin Menu »» Settings »» Branch Profile.
- Click on the Vendor Logins tab.
- Click on [New] Vendor Login.
- Vendor: Select [Canvas] as the Vendor.
- Account Name: Enter the [Canvas Token] from the prior Canvas login.
- URL/Extension: Enter the Canvas API URL. The URL should look something like this:
- Vendor Email: If you prefer that a Canvas User Login is created without a password, ask Xenegrade to place "NoPassword" in the vendor email field.
-
User Name: Optional prefix for the SIS ID field in a Course and Section. Will have the following formats:
- Course: -XenDirectCourseID
- Section: -XenDirectCourseID-XenDirectSectionID
-
Password: Only used if you prefer that a Client is created as a Canvas User in the base Canvas Account and not just in the Account associated with the PIN value below.
- No Password will ever be sent to Canvas
- PIN: The Canvas Account or Sub-Account ID that is used by your XenDirect Branch. If you are using a Sub-Account for your Organization or Branch be sure to get the correct Account ID. This will be a number.
- From Email: Enter the email address of the organization that will be the FROM and REPLY email address in the emails being sent to the client.
- Other fields in the form can be left blank as they are not used for this feature.
- Click OK to save and close.
- Canvas LMS integration is now enabled.
- The next step is to add/edit Canvas courses and sections.
Related Topics
How To Enable Canvas LMS Integration
How to Tag a XenDirect Course/Section as Canvas LMS
Register a Client Into a Canvas LMS Offering
Create a WebReg Direct URL for Canvas LMS Courses