User Manual

When you first use the tool it will prompt you to authorize its access to both your Microsoft and Canvas accounts. First you will have to allow the tool the ability to read your Canvas calendar events and then you will need to allow the tool the ability to write to your Outlook calendar. Once connected to both accounts the tools will then allow you to enable or disable synchronisation.

The tool will create a calendar group for your Canvas calendars and then create a calendar for each Canvas course and a calendar for your Canvas personal calendar.

The calendars in Office 365 will then be kept in sync with any changes that happen in Canvas.

Administrator Manual

The calendar synchroniser is designed to be a LTI 1.1 tool installed into Canvas. When setup in Canvas it should appear in menu attached to each user’s account:

Installation

Add LTI Tool

There’s an overview of what an LTI tool is in the Canvas Community site. To setup Calendar Synchroniser firstly request a LTI key and secret from: support@wyelearning.com. When requesting a LTI key please include the domain name that you are using Canvas on (eg https://institution.instructure.com) and if you are Once you have a key and secret add the external tool to your Canvas instance following these steps.

• Navigate to the top sub-account for your Canvas installation (typically this has the ID of 1).
• Click on the Settings page.
• Click on the Apps tab.
• Click on the View App Configurations button if using Instructure hosted Canvas.
• Click on the + App button.
• In the dialogue enter:
  • Configuration Type: By URL
  • Name: Calendar Synchroniser
  • Consumer Key: value from support email
  • Consumer Secret: value from support email
  • Config URL: https://calendar.wyelearning.com/config-prod.xml
• Click on the Submit button and the app should now be added to the Canvas installation and available from the account menu for each user.

Add API Developer Key

As well as LTI configuration the tool needs a developer key to function. To create the developer key:

• Navigate to the top sub-account for your Canvas installation (typically this has the ID of 1).
• Click on the Developer Keys page.
• Click on the + Developer Key button.
• Click on the + API Key option.
• In the settings enter:
  • Key Name: Calendar Sync
  • Owner Email: support@wyelearning.com
  • Redirect URIs: https://calendar.wyelearning.com/login/oauth2/code/{canvas.domain.name}
  • Redirect URI (Legacy):
  • Vendor Code (LTI 2):
  • Icon URL: https://calendar.wyelearning.com/images/logo.svg
  • Enforce Scopes: Ticked

    • url:GET

      /api/v1/calendar_events - checked

    • url:GET

      /api/v1/courses - checked

Demo Mode

If you wish to try out the tool then it can be setup in a demonstration mode where it can be installed into a Canvas course so that only a few Canvas users are able to find it and this way it can be tested before rolling the tool out more widely. When in demo mode the tool doesn’t use a developer key and requires users to manually generate a token.

Instructure produce documentation on generating an Access Token for a student, instructor and administrator.

FAQ

How frequently will the calendars be synchronised?

Currently, calendars are synchronised every hour although this may change in the future.

Why is my course not showing up as a calendar?

Only published courses are synchronised into Outlook

How do I stop synchronisation?

Return to the tool and disable the calendar synchronisation. You can then delete all the Canvas calendars and remove the Canvas calendar group.

Can I synchronise more than one Canvas instance?

Currently, you can only synchronise one Canvas instance with your Outlook calendar.

How can I remove the authorisation from my Outlook account?

Depending on the account type there are different URLs:

• Microsoft Account (live.com), personal - https://account.live.com/consent/Manage
• Office 365 Account (office.com), work - https://portal.office.com/account/#apps

How can I remove the authorisation from my Canvas account?

• Login to your Canvas instance.
• Click on your user icon.
• Click on Settings in the menu.
• Scroll down and in the Approved Integrations section delete the entry related to calendar synchronisation.