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.

...

California Community Colleges that have adopted Canvas CMS may requestto implement the Canvas DW Direct Connect service inclusion of their Canvas data in the CCC Data Warehousethrough 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 access connection (ODBC/JDBC). Support for Canvas data will require an authorized college Canvas Administrator to generate the Canvas Data API credentials for your account and securely pass them to the Enabling Services Implementation Engineer working with your college.

...

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

  • College has implemented, or is implementing, DW Direct (ODBVC/JDBC) Connect (Live).

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


Getting Started

  • College must request (opt-in) to participate in having their Canvas data in the Canvas DW Direct Connect serviceCCC Data Warehouse.

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

...

  1. College requests to participate (Opt-In) in Canvas DW Direct Connectthrough their College Relationship Manager.

  2. College generates and submits the required Canvas Data API key values to CCCTC Enabling Services

  3. College works with the Enabling Services implementation team to confirm successful access to their Canvas Data using their established direct access connection.

Note

The Canvas DW Direct Connect implementation has two configuration steps: first, your college Canvas data is added to the CCC Data Warehouse using the Canvas Data API and your college’s unique credentials; and second, access to the data is configured through DW direct access connection.

Step 1: Email a Request to Participate

...

As the Canvas Data API key is generated at the root account level, implementation will require each college in a multi-college district to consent to have their Canvas data made available in the CCC Data Warehouse.

  1. To participate (opt-in), send an email to Enabling Serviceswith the following subject line: Request for Canvas DW Direct Connect at [college]their Canvas data be added to the CCC Data Warehouse.

  2. The College Relationship Manager (CRM) will process your request and pass your interest to the Enabling Services Implementation team who will work with your college to facilitate the Canvas to Data Warehouse setup process.

...

  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.

...