产品文档
微应用
查看 PDF

集成 Blackboard Learn

December 1, 2021
投稿者: 
C

部署 Blackboard Learn 集成以注册新课程，以学生和教师身份查看课程及其相关详细信息，以创建课程公告并查看课程成员和成绩。

注意：

我们希望得到你的反馈！请在使 用此集成模板时提供反馈 。对于任何问题，我们的团队还将每天监控我们的 专门论坛 。

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

查看必备项

要在 Citrix Workspace 微应用中添加集成，您需要以下工件：

  • 基本 URL： https://{host_name}.com
  • 授权 URL： https://{host_name}.com/learn/api/public/v1/oauth2/authorizationcode
  • 令牌 URL： https://{host_name}.com/learn/api/public/v1/oauth2/token
  • 客户端 ID：客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。您在配置 OAuth 服务器时将其作为 应用程序密钥 收集。
  • Secret：客户端密钥是设置目标应用程序集成时发出的唯一字符串。您在配置 OAuth 客户端时将其作为 S ecret 收集。

注意：

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

将 Citrix Gateway 配置为支持单点登录，以便用户登录后即可自动重新登录，而无需再次输入凭据。有关配置 SSO 的更多信息，请参阅 Citrix Gateway 服务 https://docs.citrix.com/en-us/citrix-gateway-service/。

创建用户账户

集成需要定期访问您的 Blackboard 实例。我们建议创建一个专用的用户帐户： Blackboard 合作伙伴帐 https://docs.blackboard.com/partners/become-a-partner户。

需要以下权限：完全管理员权限。

API 访问

默认情况下，黑板 API 处于启用状态，我们需要 Blackboard 开发人员 AMI 或 Blackboard 合作伙伴帐户才能访问这些 API。可以向特定资源发出的 API 请求数量有限。我们建议您查看以下信息： https://docs.blackboard.com/learn/rest/admin/groups-quotas-rates

重要

说明分页限制设置为 100。管理员可以根据 API 将此限制最多扩展到 200 个。

Blackboard Learn 开发人员服务器支持多达 10000 次 API 调用/站点 /24 小时。

Blackboard Learn 生产服务器支持多达 75000 个 API 调用/站点 /24 小时。

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

配置 OAuth 服务器

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

  1. 登录到 https://developer.blackboard.com/。
  2. 选择 我的应用程序 ，然后选择 + 图标以创建新应用程序。或者，导航到： https://developer.blackboard.com/portal/applications/create。
  3. 填写必填字段，然后选择 注册应用程序并生成 API 密钥。
  4. 复制并保存屏幕上显示的 应用程序ID、应用程序密钥和密钥。配置集成时，使用这些详细信息进行服务身份验证
  5. 以管理员身份登录 Blackboard Learn 应用程序。
  6. 导航到 “ 系统管理员”。
  7. 在 “ 集成” 表下选择 REST API集成 。
  8. 选择 创建集成。

  9. 填写必填字段：

    1. 粘贴您在上述步骤 4 中选择的 应用程序 ID 。
    2. 在 “ 学习用户” 字段中输入管理员用户 名。
    3. 为 最终用户访问 选择 是 ，并选 择授权充当用户。

配置 OAuth 客户端

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

  1. 登录到 https://developer.blackboard.com/。
  2. 选择 我的应用程序 ，然后选择 + 图标以创建新应用程序。或者，导航到： https://developer.blackboard.com/portal/applications/create。
  3. 填写必填字段，然后选择 注册应用程序并生成 API 密钥。
  4. 复制并保存屏幕上显示的 应用程序ID、应用程序密钥和密钥。配置集成时，使用这些详细信息进行服务操作身份验证。
  5. 以管理员身份登录 Blackboard Learn 应用程序。
  6. 导航到 “ 系统管理员”。
  7. 在 “ 集成” 表下选择 REST API集成 。
  8. 选择 创建集成。

  9. 填写必填字段：

    1. 粘贴您在上述步骤 4 中选择的 应用程序 ID 。
    2. 在 “ 学习用户” 字段中输入管理员用户 名。
    3. 为 最终用户访问 选择 是 ，并选 择授权充当用户。

将集成添加到 Citrix Workspace 微应用

将 Blackboard Learn 集成添加到 Citrix Workspace 微应用程序以连接到您的应用程序。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。这将提供开箱即用的微应用程序，其中包含预先配置的通知和操作，可在工作区中使用。

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

  1. 在 微应用集成 页面中，选择 添加新集 成，然后 从 Citrix 提供的模板中添加新集成。
  2. 选择 Blackboard Learn 磁贴。
  3. 输入 集成的集成名称 。
  4. 输入 连接器参数。
    • 输入实例 基本 URL：
    • 从 图标 库中选择用于集成的图标，或将其保留为默认图标。

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

    1. 从 授权类型 菜单中选择 客户端凭据 。
    2. 从 令牌授权菜单中选择授权 标头。
    3. 令牌 URL 已预先填充：https://{host_name}.com/learn/api/public/v1/oauth2/token
    4. 确保为 Scope 输入以下内容： 阅读
    5. 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您在配置 OAuth 服务器时将其作为 应用程序密钥 收集。
    6. 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。您在配置 OAuth 服务器时将其作为 S ecret 收集。

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

    1. 从 身份验证方法 菜单中选择 OAuth 2.0 ，然后填写身份验证详细信息。
    2. 从 令牌授权菜单中选择授权 标头。
    3. 授权 URL 是预先填写的： https://{host_name}.com/learn/api/public/v1/oauth2/authorizationcode
    4. 令牌 URL 已预先填充：https://{host_name}.com/learn/api/public/v1/oauth2/token
    5. 确保为 Scope 输入以下内容： 写
    6. 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您在配置 OAuth 客户端时将其作为 应用程序密钥 收集。
    7. 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。您在配置 OAuth 客户端时将其作为 S ecret 收集。
  7. 启用请求速率限制 开关已启用。 请求数量 保留 60分钟， **时间间隔 为 1 分钟。
  8. 默认情况下，请求超时 设置为 120 。
  9. （可选）启用 日志记录 切换以保留 24 小时的日志记录以用于支持目的。
  10. 选择 保存 以继续。

配置维修操作参数

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

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

  1. 在 微应用集成 页面中，导航到 Blackboard Learn 集成，然后选择 我的成绩 微应用。
  2. 选择 页面，然后选择 我的成绩 页面。
  3. 在页面构建器中，选择 “在 Blackboard 上查看 ” 按钮元素，然后选择右窗格中的 “ 操作 ” 选项卡。
  4. 在 “ 操作” 下，选择 “ 转到 URL”。

  5. 在 URL 模板 字段中，替换为您 host_name 的实例主机名。使用此表格： https://{host_name}/webapps/bb-social-learning-BBLEARN/execute/mybb?cmd=display&toolId=MyGradesOnMyBb_____MyGradesTool

    完成后，离开屏幕。系统会自动为构建器保存更改。

编辑表格属性

要完成集成的配置，您需要更改下面列出的端点的数据类型。

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

  1. 在 微应用集成 页面中，选择 Blackboard Learn 集成旁边的菜单，然后选择 编辑。将打开 “ 数据加载 ” 屏幕。如果没有，请从左侧导航栏中选择 数据加载 。

  2. 对于下表中列出的每个 端点 ，您需要在给定 属性 的菜单中更改 数据类型。

    端点 属性 数据类型更改
    课程公告 正文 二进制
    用户成绩 显示分数 双
    成绩分数 可能得分 双
  3. 对于每个终端节点，选择端点旁边的菜单，然后选择 编辑。
  4. 在 “编辑数据端点 ” 屏幕中，滚动到页面底部。在 “ 数据结构” 下的表格中，选择铅笔图标以编辑表格。
  5. 在 编辑表格属性 屏幕中，通过从菜单中选择新值来更改 数据类型 。对于每个端点所做的每个更改，请选择 保存 ，然后选择 应用。
  6. 对其他数据端点重复此操作。

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

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

注意

分页限制设置为 100。管理员可以根据 API 将此限制最多扩展到 200 个。

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

使用 Blackboard Learn 微应用

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

注意

对于 “ 我的成绩” 微应用，管理员需要在 “ 我的成绩” 页面 的 “在 Blackboard 上查看” 按钮中更新其 “host_name”。有关完整步骤，请参阅 配置服务操作参数。

课程注册： 注册课程。

通知或页面 用例工作流
新课程注册通知 当学生注册课程时，已注册的学生会收到通知。
课程注册详情页面 提供已注册课程的只读视图以及课程和教师详细信息。
列出课程页面 提供可用课程的列表。
课程详情页 使用 快速注册 选项查看课程详细信息、教师详细信息。

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

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

教师视图： 允许教师查看课程成员和成绩。

通知或页面 用例工作流
课程详情页 允许教师查看可用课程的列表。
“会员详情” 页 允许教师查看在课程中注册的成员列表。
成绩详情页面 允许教师查看特定课程成员的成绩。

我的课程： 查看课程公告和课程的附件

通知或页面 用例工作流
新课程公告通知 当有新的公告时，注册课程的学生会收到通知。
课程公告详情页 为课程提供包含详细信息的新公告的只读视图。
我的课程页面 提供用户注册的课程的列表。
课程详情页 提供课程的公告和附件的列表。
公告详情页 查看课程公告及其详细信息。
附件详情页 查看并下载附件。

我的成绩： 允许学生查看课程成绩。

通知或页面 用例工作流
新成绩通知 发布新成绩后，注册课程的学生会收到通知。
我的成绩页面 允许学生通过选择课程来查看成绩。
集成 Blackboard Learn
December 1, 2021
投稿者: 
C
December 1, 2021
投稿者: 
C

在本文中

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