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 document is to outline the ES implementation process required to support colleges access their Canvas API key data in the CCC Data Warehouse.
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
Direct connection
College Participation
California Community Colleges that have implemented the Canvas CMS may request to participate in 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 and implemented Canvas CMS through the CCC Technology Center (Live).
College has implemented DW Direct Connect service (Live).
College has a Canvas Admin user that can provide the required API 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 to successful setup and user testing.
Implementation Overview
Request to participate (Opt-In)
Obtain and submit Canvas Data API credentials to CCCTC Enabling Services
Work with Enabling Services team to access and test Canvas Data via
Requesting to Participate (Opt-In)
To participate in the Canvas DW Direct Connect service, the authorized IRPE at your college or district must send an email, “Request for Canvas DW Direct Connect at [college], to crms@ccctechcenter.org. The request should include your college or district name and MIS code.
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: Once your opt-in request is received, an Implementation Project Manager from Enabling Services will work with you to gather and submit your Canvas API information.
Obtaining & Submitting Canvas API Information
In order to add your college Canvas data to the CCC Data Warehouse, the Tech Center will work with the Canvas Data API to get information about or download your college’s Canvas Data files.
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.
Obtain and submit your college’s Canvas API token and secret key
Admin Credentials
Testing Access to Canvas Data
Support FAQs
CCC Data Warehouse User Documentation
Instructions
Follow the steps below to initiate custom implementation for each college:
ICE team will work with the college to identify their Canvas Administrator who will be asked to generate the Canvas data API key to be securely transmitted to the Tech Center.
College locates and submits their unique Canvas API key to the ES team
College Canvas Admin / Pilot participant will connect to the CCC Data Warehouse through ODBC/JDBC connection (secured through the use of a site-to-site VPN), and accessing the Canvas data either through a local BI application (typically Tableau or Power BI) or SQL query.
ES member creates InterVision SNOW ticket and attaches API key for custom configuration process.
The Canvas API Access Token
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.