CCC Data Warehouse User Documentation for use by the California Community Colleges
This guide supports the Canvas DW Direct Connect implementation for the CCC Technology Center.
Introduction
The purpose of this guide is to provide colleges with an overview of the Canvas DW Direct Connect implementation process and the preparatory information required for colleges to successfully access their Canvas API data in the CCC Data Warehouse.
Canvas Data is currently only available and accessible to colleges via DW Direct Connect service.
About Canvas Data in the CCC Data Warehouse
[ description of the availability of Canvas data in the DW via direct connect. ]
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 must officially request (opt-in) to implement this service. To opt-in, please contact Enabling Services at the CCC Technology Center.
College Participation
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 implemented Canvas CMS 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.
Implementation Process Overview
College requests to participate (Opt-In) in Canvas DW Direct Connect.
College generates and submits the required Canvas Data API 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.
Step 1: Email a Request to Participate (Opt-In)
To participate in the Canvas DW Direct Connect service - to access your college Canvas data in the CCC Data Warehouse via direct access connection - the authorized IRPE at your college or district must send an email to Enabling Services requesting to implement the service.
The email subject line should read, “Request for Canvas DW Direct Connect at [college]”.
The CCC Data Warehouse is now able to provides the ability for colleges to access their Canvas data by direct access connection (VPN) in the CCC Data Warehouse/Data Lake.
Access to their Canvas data is available by Direct Access Connection (ODBC/JDBC) only in the v.2.1 release.
Each college must “opt-in” or request access separately, even if they are in a multi-college district.
Colleges must contact their CRM to request direct access to Canvas data.
To request your college's Canvas data be included in your instance of the Data Warehouse, contact your college's College Relationship Manager (or email crms@ccctechcenter.org if you do not know who your CRM is). The inclusion of Canvas data will require each college in a multi-college district to opt into its inclusion.
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
The first step in the process is to add your Canvas data to the CCC Data Warehouse in order for your college to access it via direct access connection. To do that, an authorized Canvas Admin at your college must generate the API credentials (key and secret values) in a specific format that works with the structure of your Canvas account. 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 Admin: Generate the following Canvas Data API credentials in your Canvas Admin Portal:
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
Obtain and submit your college’s Canvas API token and secret key
Admin Credentials
Step 4: Work with Implementation Team to Test Access
College Canvas Admin: 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.