集成帆布LMS
部署Canvas LMS集成以查看课程、创建课程公告、管理课程注册和查看学生成绩。
- 作为学生,查看课程及其相关详细信息。
- 作为教师,创建课程公告、查看/添加课程成员以及查看学生成绩。
我们需要你的反馈!请提供此集成模板的反馈当你使用它的时候。对于任何问题,我们的团队也会监控我们的专门的论坛每天都是。
有关Canvas LMS的开箱即用微应用程序的详细信息,请参见使用Canvas LMS微应用程序.
检查先决条件
在设置与Canvas LMS的集成后,您将需要以下工件来添加Citrix Workspace MicroApp中的集成:
- 基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确保您的集成符合配置microapp的最大安全遵从性。
将Citrix Gateway配置为支持Canvas LMS的单点登录,这样一旦用户登录,他们就会自动再次登录,而无需再次输入凭证。有关配置SSO的详细信息,请参见Citrix网关服务.
使api
Canvas api在默认情况下是启用的。你需要一个画布合作伙伴账户访问api。可以对特定资源发出的API请求的数量是有限的。因此,我们推荐API限制节流,如本文所述:https://canvas.instructure.com/doc/api/file.throttling.html.
创建一个新的服务帐户
集成需要定期访问您的Canvas LMS实例,因此我们建议创建一个专用用户帐户。该帐户必须具有以下权限:完全管理员权限
建议有一个画布合作伙伴帐户:https://www.instructure.com/canvas/become-partner.
OAuth服务器配置
配置OAuth服务器以通过画布集成读取数据。
- 登录到
https:// {host_name} .com/accounts
作为一个管理员。 - 选择要集成的帐户。
- 选择开发者密钥和选择+开发人员的关键.
- 选择+API密钥并完成所需的字段,包括密钥名称、所有者电子邮件、重定向uri。
- 在重定向URL字段中输入此应用程序的以下授权重定向URL:
https:// {yourmicroappserverurl} / admin / api / gwsc /认证/ serverContext
- 将客户端凭证受众设置为Canvas并单击保存.
- 使国家成为在.
- 复制ClientID和秘密从细节开始。您可以在配置集成时将这些值用于服务身份验证。
配置OAuth客户端
配置OAuth客户端通过Canvas集成回写数据。
- 登录到
https:// {host_name} .com/accounts
作为一个管理员。 - 选择要集成的帐户。
- 选择开发者密钥和选择+开发人员的关键.
- 选择+API密钥并完成所需的字段,包括密钥名称、所有者电子邮件、重定向uri。
- 在重定向URL字段中输入此应用程序的以下授权重定向URL:
https://{yourmoappserverurl}/admin/api/gwsc/auth/serviceAction/callback
- 将客户端凭证受众设置为Canvas并单击保存.
- 使国家成为在.
- 复制ClientID和秘密从细节上看。在配置集成时,可以使用这些值进行服务操作身份验证。
将集成添加到Citrix Workspace MicroApp
将Canvas LMS集成添加到Citrix Workspace MicroApp以连接到您的应用程序。这提供了现成的MicroApp,带有预先配置的通知和操作,可以在您的工作区内使用。
遵循以下步骤:
- 从Microapp集成页面,选择添加新的集成,从citrix提供的模板添加新的集成.
- 选择帆布LMS瓷砖。
- 输入集成的名称。
输入连接器参数:
- 输入实例基本URL:
https://{host_name}.com
- 从图标库中选择用于集成的图标,或将其保留为默认图标。
- 输入实例基本URL:
下服务认证中,选择OAuth 2.0从身份验证方法菜单并完成身份验证细节。已预先选择身份验证选项。确保在完成流程时选择了这些选项。使用OAuth 2.0安全协议为委托访问生成请求/授权令牌。建议您始终使用OAuth 2.0作为您的服务身份验证方法。OAuth 2.0确保您的集成符合配置microapp的最大安全遵从性。
- 选择授权码从格兰特类型菜单。
- 授权URL已预先填充:
https:// {host_name} .com/login/oauth2/auth
. - Token URL是预填充的:
https:// {host_name} .com/login/oauth2/token
. - 输入您的客户机ID. 客户端ID是表示授权服务器特有的客户端注册信息的字符串。您在配置OAuth服务器时收集此信息。
- 输入您的客户的秘密.客户端秘密是在设置目标应用程序集成时发出的唯一字符串。您可以在配置OAuth服务器时收集这些信息。
下服务操作身份验证,启用使用单独的用户身份验证在操作切换。服务操作身份验证在服务操作级别进行身份验证。已预先选择身份验证选项。确保在完成流程时选择了这些选项。
- 选择OAuth 2.0从身份验证方法菜单并完成身份验证细节。
- 选择授权码从格兰特类型菜单。
- 授权URL已预先填充:
https:// {host_name} .com/login/oauth2/auth
. - Token URL是预填充的:
https:// {host_name} .com/login/oauth2/token
. - 输入您的客户机ID.客户端ID是表示授权服务器唯一的客户端注册信息的字符串。您在配置OAuth客户端时收集了这个值。
- 输入您的客户的秘密.客户端秘密是在设置目标应用程序集成时发出的唯一字符串。您在配置OAuth客户端时收集了这个值。
- 启用请求速率限制切换。输入500为的请求数量和1分钟为时间间隔.
- 离开请求超时空的。
- (可选)启用日志记录为了支持目的,切换到保持24小时的日志记录。
- 选择保存继续。
配置服务操作参数
配置上述模板后,需要正确配置服务操作。对于我的成绩microapp,更新他们的host_name
在视图在画布上按钮的我的成绩页面。
遵循以下步骤:
- 从Microapp integration页面,导航到帆布LMS集成,并选择我的成绩microapp。
- 选择页,然后是我的成绩页面。
- 在页面生成器中,选择画布上的视图按钮组件,然后是行动选项卡。
- 下行动中,选择转到URL.
- 在URL模板领域,取代
host_name
使用实例主机名。此表格用于:https:// {host_name} /课程/ \ {\ \ {id} \} /成绩
- 完成后,离开屏幕。更改将自动为生成器保存。
编辑表属性
要完成集成配置,您需要更改端点的数据类型,如下表所示。每人端点下表中列出的,必须更改数据类型在给定属性的菜单中。
桌子 | 列 | 数据类型 |
---|---|---|
作业 | points_possible | 二进制的 |
作业 | 描述 | 二进制的 |
成绩 | current_grade | 二进制的 |
遵循以下步骤:
- 从Microapp集成页面上,选择画布LMS集成旁边的菜单,然后编辑. 数据加载屏幕打开。如果不是,请从左侧导航列中选择数据加载。
- 对于每个端点,选择端点旁边的菜单,然后单击编辑.
- 在编辑数据端点屏幕,滚动到页面底部。在下面的表格中数据结构,选择铅笔图标以编辑表格。
- 在编辑表属性屏幕上,改变数据类型通过从菜单中选择新值。对于每个端点所做的每个更改,选择保存然后应用.
- 对其他数据端点重复此过程。
现在可以设置和运行第一次数据同步了。有关同步规则、不满足其调度和否决规则的同步的完整信息,请参见同步数据.
注意:
我们建议将完全同步间隔至每8小时,并增量同步每小时间隔。
有关API端点和表实体的更多细节,请参见画布LMS连接器规范.
注意:
由于API调用数量的限制,增量同步被设置为仅保留公告.其余端点将作为全同步的一部分触发。
使用Canvas LMS微应用程序
现有的应用程序集成提供了现成的MicroApp。从这些微应用程序开始,根据您的需要进行定制。
创建课程公告:教师为课程创建公告。
通知或页面 | 用例的工作流 |
---|---|
创建课程公告页面 | 提供一个表单,用于为具有以下详细信息的课程创建公告:课程(课程下拉菜单)、标题、消息和发布日期。 |
我的课程:查看课程公告、作业和课程文件。
通知或页面 | 用例的工作流 |
---|---|
课程的邀请通知 | 当学生被邀请参加课程时,他们会收到通知。 |
新课程通知通知书 | 当有新的课程通知时,注册该课程的学生会收到通知。 |
新课程通知(未来) | 当有未来发布日期的课程的新公告时,注册该课程的学生将收到通知。 |
接受/拒绝邀请页面 | 提供带有选项的课程邀请的只读视图接受或拒绝. |
课程列表页面 | 允许用户查看已注册课程的列表。 |
课程详细信息页面 | 允许用户查看课程的公告和文件列表。 |
公告详情页 | 允许用户查看课程公告及其详细信息。 |
任务详细信息页面 | 允许用户查看分配及其详细信息。 |
文件详细信息页面 | 允许用户查看和下载文件。 |
我的成绩:学生查看他们的课程成绩。
通知或页面 | 用例的工作流 |
---|---|
新成绩通知 | 当一门课程公布新成绩时,注册该课程的学生会收到通知。 |
课程列表页面 | 允许用户查看已注册课程的列表。 |
我的成绩页面 | 允许用户查看所选课程的成绩。 |
老师的观点:教师查看和添加课程成员以及查看学生。
通知或页面 | 用例的工作流 |
---|---|
课程列表页面 | 允许教师查看可用课程列表。 |
列表成员页面 | 允许教师查看已注册课程的成员列表,并带有添加按钮,该按钮导航到添加用户页面。 |
会员详情页 | 允许教师查看课程成员的成绩和相关详细信息。 |
添加用户页面 | 允许教师将学生添加到选定的课程中。 |