| Info |
|---|
This CCC Data Warehouse user guide supports implementation of the Canvas DW Direct Connect service, exclusively for California Community Colleges faculty and staff. |
...
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). Colleges must 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).
College Participation
...
| 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
Support for the Canvas the connection of Canvas data to the CCC Data Warehouse, to be made available to colleges through a Direct direct access connection (ODBC/JDBC) Connection. Support Support for Canvas data will require that the administrator for the Canvas system generate a data API key, to be securely passed an authorized college Canvas Administrator to generate the Canvas API credentials for your account and securely pass them to the Enabling Services Integration Implementation Engineer .California Community Colleges that have adopted Canvas CMS may request to implement the Canvas DW Direct Connect service through Enabling Services at the CCC Technology Center. working with your college.
To get started, colleges must meet the following prerequisites and complete the instructions below.
...
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 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, safely pass your API key and secret values to your ES Implementation engineer Engineer in the format below. These values should only be passed using a secure method such as Privnote.
Canvas Data API Key: [
canvas-datawarehouse-<misCode>-apikey]Canvas Data API Secret: [
canvas-datawarehouse-<misCode>-apisecret]
Upon receipt of your API values, your ES Implementation engineer 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
...
| Note |
|---|
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. |
Q. What Canvas data elements will be available in the CCC Data Warehouse following our college opt-in implementation?
A. The following documentation describes the data dictionary for the Canvas Data warehouse: https://portal.inshosteddata.com/docs