Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

This CCC Data Warehouse user guide supports implementation of the Canvas DW Direct Connect service, exclusively for California Community Colleges faculty and staff.

...

A part of the Data Services Program initiative from the California Community Colleges Chancellor's Office, CCC Data provides the necessary infrastructure to the California Community College System to aggregate data across disparate systems to an enterprise data warehouse (CCC Data Warehouse).

Info

Access to [data in the 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

...

Inclusion of Canvas data in the CCC Data Warehouse

The 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). Each CCC college is required to “opt-in”, or request access separately, even if they are 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 exclusive service (opt-in) by email. Please contact contacting their College Relationship Manager (CRM) through Enabling Services at the CCC Technology Center (CCCTC).

...

  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.

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?

...

  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.

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.

...