产品文档
微应用
查看 PDF

集成 Canvas LMS

December 1, 2021
投稿者: 
C

部署 Canvas LMS 集成以查看课程、创建课程公告、管理课程注册和查看学生的成绩。

  • 作为学生，查看课程及其相关详细信息。
  • 作为教师，创建课程公告、查看/添加课程成员以及查看学生的成绩。

衷心期盼您的反馈信息！请在使 用此集成模板时提供反馈 。对于任何问题，我们的团队还将每天监控我们的 专门论坛 。

有关适用于 Canvas LMS 的开箱即用微应用的全面详细信息，请参阅 使用 Canvas LMS 微应用。

查看必备项

在使用 Canvas LMS 设置此集成后，您需要以下工件才能在 Citrix Workspace 微应用中添加集成：

  • 基本 URL： https://{host_name}.com
  • 授权 URL： https://{host_name}.com/login/oauth2/auth
  • 令牌 URL： https://{host_name}.com/login/oauth2/token
  • 客户端 ID：客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。
  • 客户端密钥：客户端密钥是设置目标应用程序集成时发出的唯一字符串。

注意：

建议您始终使用 OAuth 2.0 作为服务身份验证方法（如果可用）。OAuth 2.0 可确保您的集成符合配置的微应用的最大安全合规性。

将 Citrix Gateway 配置为支持 Canvas LMS 的单点登录，这样一旦用户登录，他们将自动重新登录，而无需再次输入凭据。有关配置 SSO 的更多信息，请参阅 Citrix Gateway 服务。

启用 API

默认情况下画布 API 处于启用状态。你需要一个 Canvas 合作伙伴帐户 才能访问 API。可以向特定资源发出的 API 请求数量有限。因此，我们建议使用 API 限制限制，如本文所述： https://canvas.instructure.com/doc/api/file.throttling.html。

创建一个新的服务帐户

集成需要定期访问你的 Canvas LMS 实例，因此我们建议创建一个专用的用户帐户。此帐户必须具有以下权限：完全管理员权限

建议拥有一个 Canvas 合作伙伴帐户： https://www.instructure.com/canvas/become-partner。

配置 OAuth 服务器

将 OAuth 服务器配置为通过 Canvas 集成读取数据。

  1. 以管理员 https://{host_name}.com/accounts 身份登录。
  2. 选择要集成的账户。
  3. 选择 开发者密钥 ，然后选择 + 开发者密钥。
  4. 选择 + API Key 并填写必填字段，包括密钥名称、所有者电子邮件、重定向 URI。
  5. 在重定向 URL 字段中输入此应用的以下授权重定向 URL： https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  6. 将客户端凭证受众设为 Canvas，然后单击 保存。
  7. 将状态设置为 ON。
  8. 从详细信息中复制 clientID 和 密 码。配置集成时，您可以将这些值用于服务身份验证。

配置 OAuth 客户端

将 OAuth 客户端配置为通过 Canvas 集成写回数据。

  1. 以管理员 https://{host_name}.com/accounts 身份登录。
  2. 选择要集成的账户。
  3. 选择 开发者密钥 ，然后选择 + 开发者密钥。
  4. 选择 + API Key 并填写必填字段，包括密钥名称、所有者电子邮件、重定向 URI。
  5. 在重定向 URL 字段中输入此应用的以下授权重定向 URL： https://{yourmicroappserverurl}/admin/api/gwsc/auth/serviceAction/callback
  6. 将客户端凭证受众设为 Canvas，然后单击 保存。
  7. 将状态设置为 ON。
  8. 从详细信息中复制 clientID 和 密 码。配置集成时，您可以将这些值用于服务操作身份验证。

将集成添加到 Citrix Workspace 微应用

将 Canvas LMS 集成添加到 Citrix Workspace 微应用程序以连接到您的应用程序。这样可以提供带有预配置通知和操作的开箱即用的微应用程序，这些通知和操作可在工作区中使用

请按照以下步骤进行操作：

  1. 在 微应用集成 页面中，选择 添加新集成，然后 从 Citrix 提供的模板中添加新集成。
  2. 选择 Canvas LMS 磁贴。
  3. 输入集成的名称。

  4. 输入 连接器参数：

    • 输入实例 基本 URL： https://{host_name}.com
    • 从图标库中选择用于集成的图标，或将其保留为默认图标。

  5. 在 服务身份验证下，从身份验证 方法 菜单中选择 OAuth 2.0 ，然后填写身份验证详细信息。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。使用 OAuth 2.0 安全协议为委派访问生成请求/授权令牌。建议您始终使用 OAuth 2.0 作为可用的服务身份验证方法。OAuth 2.0 可确保您的集成符合配置的微应用的最大安全合规性。

    1. 从授权类型菜单中选择授权码。
    2. 授权 URL 已预先填充：https://{host_name}.com/login/oauth2/auth。
    3. 令牌 URL 已预先填充：https://{host_name}.com/login/oauth2/token。
    4. 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您可以在配置 OAuth 服务器时收集此信息。
    5. 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。您可以在配置 OAuth 服务器时收集此信息。

  6. 在服务操作身份验证下，启用在操作使用单独的用户身份验证开关。服务操作身份验证在服务操作级别进行身份验证。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。

    1. 从身份验证方法菜单中选择 OAuth 2.0，然后填写身份验证详细信息。
    2. 从授权类型菜单中选择授权码。
    3. 授权 URL 已预先填充：https://{host_name}.com/login/oauth2/auth。
    4. 令牌 URL 已预先填充：https://{host_name}.com/login/oauth2/token。
    5. 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您在配置 OAuth 客户端时收集了此值。
    6. 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。您在配置 OAuth 客户端时收集了此值。
  7. 启用请 求速率限制 开关。在 请求数 中输入 500 ，在 时间间隔 中输入 1 分钟。
  8. 将 “ 请求超时 ” 留空。
  9. （可选）启用 日志记录 切换以保留 24 小时的日志记录以用于支持目的。
  10. 选择 保存 以继续。

配置维修操作参数

配置上述模板后，您需要正确配置维修操作。对于 “ 我的成绩 ” 微应用，请 host_name 在 “ 我的成绩 ” 页面的 “在 画布上查看 ” 按钮中更新它们。

请按照以下步骤进行操作：

  1. 在微应用集成页面中，导航到 Canvas LMS 集成，然后选择 我的成绩 微应用。
  2. 选择 页面，然后选择 我的成绩 页面。
  3. 在页面构建器中，选择 “在 画布上查看 ” 按钮组件，然后选择右窗格中的 “ 操作 ” 选项卡。
  4. 在 “ 操作” 下，选择 “ 转到 URL”。
  5. 在 URL 模板 字段中，替换为您 host_name 的实例主机名。使用此表格： https://{host_name}/courses/\{\{id\}\}/grades
  6. 完成后，离开屏幕。系统会自动为构建器保存更改。

编辑表格属性

要完成集成的配置，您需要更改端点的数据类型，如下表所示。对于下表中列出的每个 端点 ，必须在菜单中更改给定属性的 数据类型 。

表 专栏 数据类型
分配 积分 _ 可能 二进制
分配 description 二进制
年级 current_grade 二进制

请按照以下步骤进行操作：

  1. 在 微应用集成 页面中，选择 Canvas LMS 集成旁边的菜单，然后选择 编辑。将打开 “数据加载” 屏幕。如果没有，请从左侧导航栏中选择数据加载。
  2. 对于每个终端节点，选择端点旁边的菜单，然后选择 编辑。
  3. 在 “编辑数据端点 ” 屏幕中，滚动到页面底部。在 “ 数据结构” 下的表格中，选择铅笔图标以编辑表格。
  4. 在 编辑表格属性 屏幕中，通过从菜单中选择新值来更改 数据类型 。对于每个端点所做的每个更改，请选择 保存 ，然后选择 应用。
  5. 对其他数据端点重复此过程。

现在，您已准备好设置和运行第一次数据同步。有关同步规则、不符合其计划的同步和否决规则的完整信息，请参阅同步数据。

注意：

我们建议将 完全同步 间隔设置为每 8 小时，将 增量同步 间隔设置为每小时。

有关 API 端点和表实体的更多详细信息，请参阅 Canvas LMS 连接器规范。

注意：

由于 API 调用数量的限制，增量同步设置为仅保留 公告。剩余的端点将作为完全同步的一部分触发。

使用 Canvas LMS 微应用

现有的应用程序集成随现成的微应用程序一起提供。从这些微应用开始，然后根据您的需求自定义它们。

创建课程公告： 教师为课程创建公告。

通知或页面 用例工作流
创建课程公告页 提供用于为课程创建公告的表单，其中包含以下详细信息：课程（课程下拉菜单）、标题、消息和发布日期。

我的课程： 查看课程公告、作业和课程文件。

通知或页面 用例工作流
课程邀请通知 当学生被邀请参加课程时，他们会收到通知。
新课程公告通知 当有关于课程的新公告时，注册该课程的学生会收到通知。
新课程公告（未来）通知 当有新的课程公告以及将来的发布日期时，注册该课程的学生会收到通知。
接受/拒绝邀请页面 提供课程邀请的只读视图，其中包含 “接 受 ” 或 “ 拒绝” 选项。
列出课程页面 允许用户查看其已注册课程的列表。
课程详情页 允许用户查看课程的公告和文件列表。
“公告详情” 页 允许用户查看课程公告及其详细信息。
作业详细信息页 允许用户查看作业及其详细信息。
文件详细信息页 允许用户查看和下载文件。

我的成绩： 学生查看他们的课程成绩。

通知或页面 用例工作流
新成绩通知 为课程发布新成绩后，注册该课程的学生会收到通知。
列出课程页面 允许用户查看其已注册课程的列表。
我的成绩页面 允许用户查看所选课程的成绩。

教师视图： 教师查看和添加课程成员以及查看学生。

通知或页面 用例工作流
列出课程页面 允许教师查看可用课程的列表。
“列出成员” 页 允许教师通过导航至 “添加 用户 ” 页面的 “ 添 加” 按钮查看已注册课程的成员列表。
“会员详情” 页 允许教师查看课程成员的成绩和相关详细信息。
“添加用户” 页 允许教师将学生添加到所选课程。
集成 Canvas LMS
December 1, 2021
投稿者: 
C
December 1, 2021
投稿者: 
C

在本文中

站点反馈 | 隐私和法律条款 | Cookie 首选项 | 同意设置
© 1999- Cloud Software Group, Inc. All rights reserved.