Versions Compared

Old Version 16

changes.mady.by.user Patricia Donohue

Saved on

compared with

New Version 17

changes.mady.by.user Patricia Donohue

Saved on

Key

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

...

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. To get started, colleges must meet the following prerequisites and complete the instructions below.

Prerequisites

  • College has implemented adopted Canvas CMS through the CCC Technology Center (Live).

  • College has implemented DW Direct Connect (Live).

  • College has a Canvas Admin user that can generate and provide the required Canvas Data API Key and other account-related information.

...

  • College must request (opt-in) to participate in the Canvas DW Direct Connect service.

  • College will participate in the Enabling Services Implementation process, through successful setup and confirmed data access.

Note

IMPORTANT: Participation requires the college to have a “live” direct access connection to the CCC Data Warehouse. Contact Enabling Services to get started with DW Direct Connect.

...

Implementation Process Overview

...

To generate your college’s Canvas Data API credentials, follow the steps below. Once the credentials are generated, a copy of the credentials should be captured for security purposes, and safely passed to the CCC Technology Center in a secure manner.


College Canvas

...

Administrator

  1. Generate the following Canvas Data API credentials in your Canvas Admin Portal:

    1. Canvas Data API Key: [canvas-datawarehouse-<misCode>-apikey]

    2. Canvas Data API Secret:

...

    1. [canvas-datawarehouse-<misCode>-apisecret]

Tip

Read More: How do I obtain an API access token in the Canvas Data Portal?

Note

The Way Canvas API Credentials Work
Any Canvas Data admin can generate API credentials, but the credentials are shared between all admin users in that [college] account. If you would like to grant access to other users or third-party partners to download files via the API, you can generate credentials and securely pass them to those users. However, if you need to revoke access for a user, you will need to regenerate the credentials and securely distribute the credentials again. 

...

Step 3: Copy, Store, and Safely Pass Your Canvas API Credentials in a Secure Manner

Obtain and submit your college’s Canvas API token and secret key

Admin Credentials

Note

Once the Tech Center receives the data API key, the data pipeline will be configured so that the college's Canvas data is securely passed to the CCC Data Lake and CCC Data Warehouse; after which it will be updated nightly.

Step 4: Work with Implementation Team to Test Access

  1. College Canvas Admin: 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.

...