| Info |
|---|
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 provides 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.
| Note |
|---|
Canvas Data is currently only available and accessible to California Community Colleges via CCC Data Warehouse (DW) Direct Connect service, once in the Data Warehouse, will be available through a Direct (ODBC/JDBC) Connection to the CCC Data Warehouse. Canvas data will not be available through the CCC DW (Jaspersoft) Report Server. |
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 [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). Each CCC college is required to “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 (CCCTC).
| Note |
|---|
Reminder: If your college has not yet implemented DW Direct Connect service, your Enabling Services Implementation team will work with you to configure your connection to the CCC Data Warehouse (DW Direct Connect) so that you may participate in the Canvas DW Direct Connect service. |
...
College Participation
California Community Colleges that have adopted Canvas CMS may requestto implement the Canvas DW Direct Connect service through Enabling Services at the CCC Technology Center. For security
...
| Note |
|---|
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.
| Note |
|---|
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.
...
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 access your Canvas data in the CCC Data Warehouse, the Canvas Data API will be used to add your college’s Canvas data to the DW pipeline. This process requires your unique Canvas Data API credentials (API key and secret) in the format that works with the structure of your Canvas account.
...
Open Your Account: Click the Admin link in your Canvas application, then click on the name of your account or sub-account.
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. |
| Tip |
|---|
Read more creating your Canvas API credentials: How do I obtain an API access token in the Canvas Data Portal? |
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. |
...
| Tip |
|---|
Implementation FAQs: See the FAQ: Canvas DW Direct Connect Service section below. |
...
| Note |
|---|
Reminder: If your college has not yet implemented DW Direct Connect access, your Enabling Services Implementation team will work with you to configure your connection to the CCC Data Warehouse (DW Direct Connect) so that you may participate in the Canvas DW Direct Connect service. |
Step 4: Work with the ES Implementation Team to Test Access & Query Canvas Data Sets
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 either through your local BI application (typically Tableau or Power BI) or an SQL query.
Once connected, test connection to your Canvas data using your local BI data application, and attempt to run at least one query against the Canvas Data set.
In running your query, please verify that:
(i) only data associated with your college (or district) misCode appears in the data results;
(ii) the results appear to be complete and as expected.
...
FAQ: Canvas DW Direct Connect Service
Q. What is the Canvas Data API?
...