| Info |
|---|
This CCC Data Warehouse user guide supports implementation of the Canvas DW Direct Connect service, exclusively for California Community Colleges faculty and staff. |
...
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, 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 Data Warehouse Report Server (Jaspersoft) Report Server. |
About the CCC Data Warehouse
...
| Info |
|---|
Access to data in the CCC Data Warehouse 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. |
Inclusion of Canvas
...
Data in the CCC Data Warehouse
The CCC Data Warehouse can optionally support the inclusion of Canvas data. When a college (or district) elects to have their Canvas data added to the CCC Data Warehouse, these data can then be accessed through a direct connection (secured through the use of a site-to-site VPN). As Canvas data is managed at a district level, each college in a multi-college district may need to opt-in for their data to be supported in the DW. Colleges may request to implement this service (opt-in) by contacting their College Relationship Manager (CRM) through CCCTC Enabling Services at the CCC Technology Center (CCCTC).
| Note |
|---|
Reminder: If your college has not yet implemented the 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 will get that process started as part of the Canvas direct access service. |
...
College Participation
...
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. |
...
| Note |
|---|
Reminder: If your college has not yet implemented DW Direct Connect access, your Enabling Services Implementation team will work with you to configure implement your direct access connection to the CCC Data Warehouse (DW Direct Connect) , so that you may participate in the Canvas DW Direct Connect servicecan then configure access to your Canvas data. |
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.
Recommended
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:
...
Direct Access to Canvas Data in the CCC Data Warehouse
Q. What is the Canvas Data API?
...