Institution-wide Canvas integration is similar to course-by-course Canvas integration. The biggest difference is customizability. While we strongly recommend that instructors follow our course-by-course integration instructions to the letter, we understand that LMS administrators and instructional designers may require more flexibility in their institution-wide setups. To that end, we support a few different LTI configurations for the most common use cases.
A word of caution: While you are welcome to customize our Canvas XMLs as you see fit, we cannot support all possible customizations. We are not responsible if a customization that you designed breaks your Canvas instance, and our ability to support your integration preferences may be limited by your institution's prior customizations, by updates to Canvas' software (which we cannot control), and by our own software updates. Unless you are adept at customizing XMLs and prepared to debug as necessary, we recommend that you stick with one of our boiler plate XMLs.
How to Integrate with Canvas via XML
1. Make sure you have your LMS Key and Secret for your Institutional Network. Your Institutional Network is the broadest Network that belongs to your institution. For example, if you are an Administrator at Yellowdig University, your Institutional Network is probably called "Yellowdig University". If you do not know your Institutional Network's Key and Secret, please reach out to firstname.lastname@example.org.
2. In your Admin page, navigate to Settings → Apps. Then click on the View App Configurations button, followed by the +App button. Do not select the Yellowdig app from the Canvas App Center.
3a. In the Add App pop-up window, choose "By URL" as your configuration type, and copy-paste one of the following URLs into the "Config URL" field unless you are using a custom XML:
URLs (3) and (4) create an account-level link to Yellowdig that allows everyone in your organization to interact with one another inside one organization-wide Community. The Community to which this account-level link connects is separate from course-level Communities created by individual instructors. URLs (1) and (2) do not have such an account-level link. If you want only course-level Communities in your organization, use URL (1) or (2).
URLs (1) and (3) hide the "Yellowdig Engage" sidebar link in Canvas courses by default. URLs (2) and (4) display the sidebar link by default. Regardless of the URL you choose, each instructor can enable or disable the sidebar link for their course at any time by navigating to Settings → Navigation, clicking on the vertical ellipses next to "Yellowdig Engage", selecting "Enable" or "Disable", and clicking the Save button:
Since it's unlikely that all instructors in your institution will use Yellowdig—and since clicking the "Yellowdig Engage" sidebar link automatically creates a Yellowdig Community for that course—we generally recommend using URL (1) or (3) to configure Yellowdig for your institution.
Alternatively, you can use the URL (2) or (4) to automatically add a "Yellowdig Engage" link to every instructor's Canvas sidebar. Regardless, if any of your instructors are using Yellowdig to pass back a grade, make sure they know that their students must enter their Yellowdig Community through the Assignments link at least once during the life of their Community in order to establish grade passback.
Finally, fill in the rest of the fields as follows using your Config URL of choice and click the Submit button:
3b. If you are using a custom XML, follow all the steps in (3a) with one exception: instead of "By URL", choose "Paste XML" as your Configuration Type. Then copy-paste your custom XML into the "XML Configuration" field and proceed as usual.