...
...
...
...
...
...
...
...
...
...
| bgColor | #FFFAE6 |
|---|
...
NOTE: This document pertains to Canvas 1.0 - currently being replaced with Canvas Data 2 from Instructure.
For information on integrating your college’s Canvas Data 2 API with the CCC Data Warehouse Direct Connect Service, see CCC Data Warehouse - Direct Access User Guide.
Introduction
This guide provides colleges with an overview of the implementation process and preparatory steps required for colleges to successfully access their Canvas data in the CCC Data Warehouse.
| Note |
|---|
Once in the Data Warehouse, Canvas Data is available through a Direct (ODBC/JDBC) Connection only. Canvas data will not be available through the CCC Data Warehouse Report Server (Jaspersoft). |
About the CCC Data Warehouse
CCC Data has been developed by the CCC Technology Center in coordination with, and at the direction of, the CCC Chancellor's Office.
...
| Info |
|---|
Access to data in the CCC Data Warehouse is provided to institutional researchers, college and district administrators, and other decision makers at the California Community Colleges, district offices, and the Chancellor’s Office, where these critical data may be used to support instructional and institutional decision-making aligned with the Chancellor's Vision for Success. |
Canvas Data in the CCC Data Warehouse
The CCC Data Warehouse can optionally support the inclusion of Canvas data. When a college (or district) elects to have their Canvas data added to the CCC Data Warehouse, these data can then be accessed through a direct connection (secured through the use of a site-to-site VPN). As Canvas data is managed at a district level, each college in a multi-college district may need to opt-in for their data to be supported in the DW. Colleges may request to implement this service by contacting their College Experience Manager (CEM) through CCCTC Enabling Services.
...
To get started, colleges must meet the following prerequisites and complete the instructions below.
Prerequisites
College has adopted Canvas through the CCC Technology Center (Live).
College has implemented, or is implementing, DW Direct (ODBVC/JDBC) Connect (Live).
College has a Canvas Admin user that can generate and provide the required Canvas Data API Key and other required account-related information.
| Note |
|---|
Strongly Recommended: For security reasons, the CCCTC recommends that a new Admin user account be created specifically for this project to prevent the API key from affecting other active Admin accounts. In the event this API key needs to be changed or disabled, other API keys would then not be affected. See Creating a New Canvas Admin User instructions below. |
Getting Started
College must request to participate in having their Canvas data in the CCC Data Warehouse.
College will participate in the Enabling Services Implementation process, through successful setup and confirmed data access.
...
To generate your college’s Canvas Data API credentials, follow the steps below. in How do I Generate a Canvas Data 2 API key? Once the credentials are generated, a copy of the credentials should be captured for security purposes, and safely passed to the CCC Technology Center in a secure manner.
| Note |
|---|
Strongly Recommended: For security reasons, the CCCTC recommends that a new Admin user account be created specifically for this project to prevent the API key from affecting other active Admin accounts. In the event this API key needs to be changed or disabled, other API keys would then not be affected. See Creating a New Canvas Admin User instructions below. |
College Canvas Administrator
From the Admin section of your Canvas application:
...
. |
...
Open Canvas Data Portal: In Account Navigation, click the Canvas Data Portal link.
...
Create API Credentials: Click the Create Credentials button. A success notification with your API credentials will display.
...
4. Copy API Credentials: Once API credentials are created, copy the API Key and API Secret and prepare to pass to the Implementation Engineer at the CCC Technology Center.
| Note |
|---|
Note: If you return to the Credentials Portal, you will be able to see the API Key but not the API Secret. |
...
Step 3: Configure the Format of Your Canvas API Credentials & Send Them to CCC Technology Center
To facilitate the process of adding your Canvas data into the Data Warehouse, provide your API Key and Secret values to your ES Implementation Engineer in the format shown below. These values should be passed using a secure method such as Privnote.
Canvas Data API Key: [
canvas-datawarehouse-<misCode>-apikey]
(Replace <misCode> with your college MIS code, and replace “apikey” with your Canvas API key value generated for your specific Instructure account.)Canvas Data API Secret: [
canvas-datawarehouse-<misCode>-apisecret]
(Replace <misCode> with your college MIS code, and replace “apisecret” with your Canvas API secret value generated for your specific Instructure account.)
Upon receipt of your API values, your ES Implementation Engineer will facilitate the process of adding your Canvas data into the CCC Data Warehouse with the CCCTC DevOps team.
...
Creating New API Credentials: You can create new credentials by clicking the Create Credentials button again.
| Warning |
|---|
Important: Generating new API credentials will invalidate the old credentials for all users who have access to them. This includes third-party partner accounts, such as the CCC Data Warehouse. |
...
After your Canvas data has been added to the CCC Data Warehouse, the ES Implementation Engineer will guide you to connect to the CCC Data Warehouse through your established DW Direct Connect (ODBC/JDBC) and access your Canvas Data.
Once connected, test connection to your Canvas data to run at least one query against the Canvas Data set.
...
FAQ: Direct Access to Canvas Data in the CCC Data Warehouse
Q. What is the Canvas Data API?
...