Canvas

The Canvas integration keeps the Canvas LMS in step with Full Fabric. Full Fabric is the source of truth for courses, students and registrations: it creates and updates courses in Canvas, creates Canvas users for your students and enrols them in the right Canvas courses. In the other direction, Canvas is the source of truth for coursework: assignments, submissions and grades flow back into Full Fabric, as described in Canvas grades and assignments.

What Syncs

Records Direction When
Courses Full Fabric to Canvas When a course is created, and when a mapped field or its status changes
Users Full Fabric to Canvas Created the first time a student is enrolled; updated when a mapped field changes
Enrolments Full Fabric to Canvas When a student is registered on a course; removed when the registration goes
Assignments and grades Canvas to Full Fabric Once a day and on demand, see Canvas grades and assignments

Each of the four has its own switch on the settings page, and a single Pause sync button stops all of them.

Connecting Canvas

The Canvas feature is off by default and only a Full Fabric administrator can switch it on. Once it is on, open Settings → Other integrations → Canvas (in the Other group). The header shows the status (Active or Inactive) and, until Canvas is connected, only the Canvas API card.

  1. Create a developer key in Canvas. Set its redirect URI to https://<your Full Fabric domain>/auth/canvas/callback.
  2. Enter the API details. On the Canvas API card, click Add API details, fill in the fields below and click Save API details.
  3. Authenticate. Click Authenticate in the page header. Canvas always asks you to sign in, then to authorise the key, and returns you to the Canvas settings page with the status Active.
  4. Choose the Canvas account. On the Canvas account card, pick the account from Canvas Account ID. The list shows the active accounts your Canvas user can see.
  5. Turn on the syncs you need, then click Enable sync in the header.
Field Notes
Canvas site URL The base URL of your Canvas instance, e.g. https://your-institution.instructure.com. Must be a full URL.
API client ID From the developer key.
API client secret From the developer key. Hidden once saved: leave it empty when updating other fields to keep the saved secret.

Full Fabric calls Canvas with the access of the person who clicked Authenticate, so that Canvas user needs rights to create courses, users and enrolments in the chosen account. The access token is renewed automatically.

New courses are created in the selected Canvas account (unless the course mapping sends an account_id), and so are new Canvas users.

Pausing and De-activating

Pause sync stops every course, user, enrolment and grade sync until you click Enable sync again. Changes made while paused are skipped, not queued. When grades sync is on, course pages in the Academic Calendar show Canvas Sync Paused instead of the sync button.

De-activate asks for confirmation (De-activate Canvas?), then disconnects the Canvas account, resets the course field mapping to its defaults and turns off Sync Courses. The API details, the Canvas account and the other switches are kept, so Authenticate reconnects with the same setup.

Courses

The FullFabric Course → Canvas Course card has the Sync Courses switch. When it is on:

  • A course created in Full Fabric is created in Canvas, together with its registrations when Sync Registrations is on.
  • A course is updated in Canvas when a mapped field or its status changes.
  • Stop syncing new courses by default makes new courses start with Stop syncing course to Canvas ticked, so you opt each one in.

The mapping table pairs a Full Fabric field with a Canvas property. The Canvas name, start date and course code properties are always in the mapping: you can change which Full Fabric field feeds the name and the code, but not the start date row. Choose a field and a property in the empty last row to add a mapping; changes save as you make them. Canvas properties include the end date, time zone, locale, term, sub-account, format, visibility and public description. For term_id and account_id, map a field holding the Canvas ID, or sis_term_id:<SIS ID> / sis_account_id:<SIS ID>.

The course status also sets the Canvas course state:

Full Fabric status Canvas course
Class new Unpublished
Applications Open, Applications Closed, Class in progress Published
Class finished Concluded

Note: Canvas cannot move a concluded course back to published. Reopening a finished course in Full Fabric leaves its Canvas course concluded.

Linking a Course to Canvas Courses

When Canvas is connected, each course page (Settings → Products → Courses) has a Canvas section. Click Edit canvas mappings to change it:

  • Stop syncing course to Canvas: the course is never created or updated in Canvas.
  • Stop syncing registrations to Canvas: Full Fabric never creates or removes this course's enrolments in Canvas.
  • Mappings: each row links the course to one Canvas course by SIS ID, Canvas ID (the numeric course ID), or both. Canvas ID takes precedence when both are filled in. Use Add mapping for courses taught across several Canvas courses; every sync goes to each of them.

Grades still sync from Canvas when either box is ticked. A course without mappings is matched in Canvas by its Full Fabric course ID as the SIS ID, which is also the SIS ID it is created with.

Changing the SIS ID of a saved mapping renames that SIS ID in Canvas (a re-key). While it runs, the row shows a spinner (Re-key in progress) and the mappings cannot be edited. If it fails, the reason appears in red under the row.

Course imports have a Canvas fields group: Canvas mappings, Sync course to Canvas and Sync registrations to Canvas (yes, no, true or false). Write mappings as canvas_id:sis_id pairs separated by |, for example 12345:BIO-101 | :BIO-101-B (:BIO-101-B is SIS ID only, 12345 alone is Canvas ID only). A filled-in cell replaces the course's mappings, but an empty cell, or one with an invalid pair, never deletes any.

Users

The FullFabric Profile → Canvas Profile card has the Sync Profiles switch and a mapping table. The email, name and sortable name properties are always in the mapping, and the email row cannot be changed. Available Canvas properties are name, sortable name, email and short name.

  • Creating users: a Canvas user is only created when a student is enrolled through the enrolment sync. It is created in the selected Canvas account, with the profile's email as the login and the profile's Canvas SIS ID (or its Full Fabric ID) as the SIS user ID.
  • Updating users: when a mapped field changes on a profile with a Prospect, Applicant, Student or Alumnus role, the existing Canvas user is updated. Profile changes never create Canvas users.

Full Fabric finds a student's Canvas user by Canvas ID, then Canvas SIS ID, then the Full Fabric profile ID. Set the first two with a profile import (the Canvas group). Once set, a Canvas SIS ID cannot be cleared. With Sync Profiles on, changing it renames the SIS ID on the user's Canvas login.

Enrolments

The Canvas Registration ← FullFabric Registration card has the Sync Registrations switch and Lifecycle states that sync to Canvas (Prospect, Applicant, Student and Alumnus by default; at least one must stay selected).

  • A registration for a profile with no role in a selected state waits. It is synced when one of the profile's roles enters a selected state.
  • When a course is first synced, or its sync is turned back on, its existing registrations are enrolled: registered as active, conditional as invited, rejected as inactive.
  • When a registration is deleted, a conditional registration is rejected, or the profile is anonymised, the student's enrolments are removed from the mapped Canvas courses. A Canvas course stays if another of the student's registered or conditional registrations maps to it. Teacher and observer roles in Canvas are never removed.

Common Failures

Course, user and enrolment syncs that fail on a network or Canvas error are retried up to five times, waiting longer each time. Each sync attempt appears in Sync management, with the error for failed ones.

What you see Usual cause Fix
Canvas connection has expired on the settings page Canvas rejected the stored credentials (key changed or access revoked) Click Reconnect. Mappings are not affected.
Couldn't load Canvas accounts: "Canvas is currently unavailable" Canvas did not answer Try again later.
Enter a full URL. The Canvas site URL is incomplete Enter the full https:// address.
Failed sync: "Canvas course … not found for …" A mapping's Canvas ID points at a course that does not exist Correct or remove the mapping.
Red text under a mapping, e.g. "Canvas course not found … The SIS ID may have been changed or the course deleted in Canvas." The re-key could not find the Canvas course Fix the mapping and save; the error clears.
"cannot be changed while a re-key is in progress" A mapping or Canvas SIS ID is still being renamed Wait for the re-key to finish.
Course or enrolment missing in Canvas, no error Sync paused, the switch is off, the course is opted out, or the profile has no role in a selected lifecycle state Check the settings page and the course's Canvas section.

Permissions

Configuring Canvas needs Global integrations, see Permissions. Sync management has its own permissions, see Sync management. Course-level options follow the permission to change courses (core.institutions.courses_change).