This CCC Data Warehouse user guide supports implementation of the Canvas DW Direct Connect service, exclusively for California Community Colleges faculty and staff.
Introduction
This guide colleges with an overview of the Canvas DW Direct Connect implementation process and the preparatory steps required for colleges to successfully access their Canvas API data in the CCC Data Warehouse.
Canvas Data is currently only available and accessible to California Community Colleges via CCC Data Warehouse (DW) Direct Connect service.
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.
A part of the Data Services Program initiative from the California Community Colleges Chancellor's Office, CCC Data provides the necessary infrastructure to the California Community College System to aggregate data across disparate systems to an enterprise data warehouse (CCC Data Warehouse).
Access to [CCC Data Warehouse] data 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 DW Direct Connect Service
The Canvas DW Direct Connect service allows colleges to access their Canvas data in the CCC Data Warehouse/Data Lake through direct access connection (site-to-site VPN). Colleges must “opt-in” or request access separately, even if they are in a multi-college district.
Colleges may request to implement this exclusive service (opt-in) by email. Please contact Enabling Services at the CCC Technology Center.
College Participation
The CCC Technology Center (CCCTC) Enabling Services group will support the connection of Canvas data to the Data Warehouse, to be made available through a Direct (ODBC/JDBC) Connection. Support for Canvas data will require that the administrator for the Canvas system generate a data API key, to be securely passed to the Enabling Services Integration Engineer.
California Community Colleges that have adopted Canvas CMS may request to implement the Canvas DW Direct Connect service through Enabling Services at the CCC Technology Center. 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 DW Direct Connect (Live).
College has a Canvas Admin user that can generate and provide the required Canvas Data API Key and other account-related information.
Getting Started
College must request (opt-in) to participate in the Canvas DW Direct Connect service.
College will participate in the Enabling Services Implementation process, through successful setup and confirmed data access.
IMPORTANT: Participation requires the college to have a “live” direct access connection to the CCC Data Warehouse. Contact Enabling Services to get started with DW Direct Connect.
Implementation Process Overview
College requests to participate (Opt-In) in Canvas DW Direct Connect.
College generates and submits the required Canvas Data API key values to CCCTC Enabling Services
College works with the Enabling Services implementation team to confirm successful access to their Canvas Data using their established direct access connection.
The Canvas DW Direct Connect implementation has two configuration steps: first, your college Canvas data is added to the CCC Data Warehouse using the Canvas Data API and your college’s unique credentials; and second, access to the data is configured through DW direct access connection.
Step 1: Email a Request to Participate (Opt-In)
As the Canvas Data API key is generated at the root account level, implementation will require each college in a multi-college district to consent to have their Canvas data made available in the CCC Data Warehouse.
To participate (opt-in), send an email to Enabling Services with the following subject line: Request for Canvas DW Direct Connect at [college].
Data Security: For security reasons, access to the CCC Data Warehouse must be requested and managed by the Institutional Research, Planning, and Effectiveness (IRPE) lead at each college and district (as authorized by the department VP, when the IRPE lead is not the VP). IRPE requests should be submitted to your CRM at Enabling Services at the CCC Technology Center.
Next Step: Upon receipt of your request, an Implementation Project Manager from Enabling Services will support your Canvas Admin to generate and submit your Canvas API information.
Step 2: Generate Your Canvas API Credentials
In order to make your Canvas Data accessible in the CCC Data Warehouse, your data must be added using the Canvas Data API - which requires the unique API credentials (API key and secret) in the format that works with the structure of your Canvas account.
To generate your college’s Canvas Data API credentials, follow the steps below. 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.
College Canvas Administrator
Generate the following Canvas Data API credentials in your Canvas Admin Portal:
Canvas Data API Key: [
canvas-datawarehouse-<misCode>-apikey]Canvas Data API Secret: [
canvas-datawarehouse-<misCode>-apisecret]
The Way Canvas API Credentials Work
Any Canvas Data admin can generate API credentials, but the credentials are shared between all admin users in that [college] account. If you would like to grant access to other users or third-party partners to download files via the API, you can generate credentials and securely pass them to those users. However, if you need to revoke access for a user, you will need to regenerate the credentials and securely distribute the credentials again.
Step 3: Copy, Store, and Safely Pass Your Canvas API Credentials in a Secure Manner
Once the Tech Center receives the data API key, the data pipeline will be configured so that the college's Canvas data is securely passed to the CCC Data Lake and CCC Data Warehouse; after which it will be updated nightly.
Step 4: Work with Implementation Team to Test Access
Connect to the CCC Data Warehouse through your established DW Direct Connect (ODBC/JDBC) and access your Canvas Data either through your local BI application (typically Tableau or Power BI) or an SQL query.
Support FAQs
CCC Data Warehouse User Documentation
Support FAQs
Q. How do I obtain an [Canvas] API access token in the Canvas Data Portal?
A. Colleges can review this page for instructions and other information related to their custom API access token.