| Info |
|---|
This CCC Data Warehouse user guide supports implementation of the Canvas DW Direct Connect provides support and implementation steps for the Canvas data direct access service, exclusively for California Community Colleges faculty and staff. |
...
Introduction
This guide provides colleges with an overview of the implementation process and preparatory steps required for colleges to successfully access their Canvas data in the CCC Data Warehouse.
...
College requests to participate through their College Relationship Manager.
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 Connectdirect access 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. |
...
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? |
...
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 ServiceDirect Access to Canvas Data in the CCC Data Warehouse 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 implement your direct access connection to the CCC Data Warehouse, so that you can then configure access to your Canvas data. |
...