Canvas Guides (en)Canvas GuidesCanvas Admin Guide Canvas DataHow do I install Canvas Data Services in my account?

How do I install Canvas Data Services in my account?

As an admin, you can install Canvas Data Services in your account. Enabling Canvas Data Services creates a link in your Account Navigation, where you can view and manage Canvas Data streams. Canvas Data Services is separate feature from the Canvas Data Portal.

Notes:

  • Users must have the Data Services - manage permission to access Canvas Data Services.
  • Canvas Data streams may include personal information for Canvas users. You should only stream data to trusted services and endpoints.

Open Account

Open Account

In Global Navigation, click the Admin link [1], then click the name of the account [2].

Open Developer Keys

Open Developer Keys

In Account Navigation, click the Developer Keys link.

Open Inherited Tab

In the Developer Keys page, click the Inherited tab.

View Canvas Data Services Key

View Canvas Data Services Key

Find the Canvas Data Services key [1]. If necessary, set the key to On by clicking the State button [2].

Copy Client ID

Copy Client ID

Copy the client ID found in the Details column.

Open Account Settings

Open Account Settings

In Account Navigation, click the Settings link.

Open App Configurations

Click the Apps tab [1]. Then click the View App Configurations button [2].

Add App

Click the Add App button.

Enter App Details

Enter App Details

In the Configuration Type menu, select the By Client ID option [1].

Then paste the Canvas Data Services client ID in the Client ID field [2].

Click the Submit button [3].

Verify App Installation

Verify App Installation

To verify that you want to install Canvas Data Services, click the Install button.

View Canvas Data Services

Once Data Services is installed, you can view the Data Services link in your Account Navigation [1].

Clicking the Data Services link will open the Data Streaming Options page [2]. From this page, you can create and manage data streams.