Page Comparison

...

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.

...

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 by contacting their College Experience Manager (CEM) through CCCTC Enabling Services.

Canvas Data 2 offering is a set of services and technologies that provides institutions with access to download their raw data across various Instructure educational products. Canvas Data 2 allows institution IT/data teams to retrieve their school's LMS data in bulk and keep it up-to-date (4 hours of data freshness) to conduct their own research and build custom reports, dashboards, and tools to meet the unique needs of the institution. Canvas Data 2 allows access to high-fidelity source data and provides more granular datatheir College Experience Manager (CEM) through CCCTC Enabling Services.

...

College Participation

California Community Colleges that have adopted Canvas may requestto implement the inclusion of their Canvas data in the CCC Data Warehousethrough Enabling Services at the CCC Technology Center.

...

In order to access your Canvas data in the CCC Data Warehouse, the Canvas Data 2 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.

...

1. Open Your Account: Click the Admin link in your Canvas application, then click on the name of your account or sub-account.

2. Open Canvas Data Portal: In Account Navigation, click the Canvas Data Portal link.

3. 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.

...

1. 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.
   

   1. 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.)}

   2. 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.)}
      

2. 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.

...

1. 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.

2. 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.

...