...
Introduction
The purpose of this document guide is to outline the ES implementation process required to support colleges 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 key data in the CCC Data Warehouse.
| Note |
|---|
Canvas Data is currently only available and accessible to colleges via DW Direct Connect service. |
About Canvas Data in the CCC Data Warehouse
...
Canvas DW Direct Connect Service
Direct connection The ability to have your college Canvas Data available in the CCC Data Warehouse and accessible through direct access connection (DW Direct Connect) is the Canvas DW Direct Connect service. 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 implemented the adopted Canvas CMS may request to participate in 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 and implemented Canvas CMS through the CCC Technology Center (Live).
College has implemented DW Direct Connectservice (Live).
College has a Canvas Admin user that can generate and provide the required Canvas Data API Key and other account-related information.
...
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 testingconfirmed data access.
...
Implementation Process Overview
Request College requests to participate (Opt-In) Obtain and submit in Canvas DW Direct Connect.
College generates and submits the required Canvas Data API credentials values to CCCTC Enabling Services
Work College works with the Enabling Services implementation team to confirm successful access and test to their Canvas Data via
...
using their established direct access connection.
| Note |
|---|
Step 1: Email a Request 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 to Enabling Services requesting to initiate the Canvas DW Direct Connect service. crms@ccctechcenter.org. The email subject line should read, “Request for Canvas DW Direct Connect at [college], to crms@ccctechcenter.org. The request should include your college or district name and MIS code.”.
| Note |
|---|
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 receivedUpon receipt of your request, an Implementation Project Manager from Enabling Services will work with you to gather 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 college Canvas data to the CCC Data Warehouse in order for your college to access it via direct access connection. To do that, the Tech Center will work with the Canvas Data API to get information about or download your college’s Canvas Data files.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:
| Note |
|---|
The Way Canvas API Credentials Work |
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
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
...
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 connection (secured through the use of a site-to-site VPN) , and accessing the access your Canvas data Data either through a your local BI application (typically Tableau or Power BI) or an SQL query.ES member creates InterVision SNOW ticket and attaches API key for custom configuration process.
Support FAQs
CCC Data Warehouse User Documentation
| Tip |
|---|
Information for Colleges to obtain their Canvas API key and secure admin credentials |
...
Support FAQs
Q. How do I obtain an [Canvas] API access token in the Canvas Data Portal?
...