产品文档
微应用
查看 PDF

集成 Smartsheet

December 1, 2021
投稿者: 
C

部署 Smartsheet 集成以管理工作表、讨论、更新请求和附件。

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

注意：

此 Smartsheet 集成模板在 Citrix Labs 类别中发布。这样一来，根据最初的客户反馈，该功能就会成熟。对于 Citrix Labs 模板，不承诺提供支持，开发人员会尽最大努力提供支持。Citrix Labs 集成模板是出于测试/验证的目的而共享的。我们不建议在生产环境中部署它们。Citrix Labs 模板在单独的部分中列出。衷心期盼您的反馈信息！请在使 用此集成模板时提供反馈 。对于任何问题，我们的团队还将每天监控我们的 专门论坛 。

查看必备项

这些先决条件假定管理员将成为组织的 SmartSheet 集成设置的一部分。此 Smartsheet 管理员帐户必须对所有用户和工作表信息具有完全读取权限。

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

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

注意：

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

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

创建一个服务账号

集成需要定期访问您的 Smartsheet 实例，因此我们建议创建一个专用的用户帐户。此帐户必须对您的服务帐户具有以下权限：完全管理员权限。您可以使用 https://admin.smartsheet.com 查看权限/特权。

创建服务帐户, 在这里注册: https://app.smartsheet.com/b/signup. 确保付费帐户可用于创建新的服务帐户。

如果在设置新服务帐户时出现问题, 请联系相应的销售支持团队或客户支持团队: https://www.smartsheet.com/contact/sales?fts=contact.

API 访问

可以对特定资源发出的 API 请求数量有限，因此我们建议您执行以下操作：

默认情况下，Smartsheet API 在开源中可用。

配置 OAuth 服务器

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

  1. 导航到 https://developers.smartsheet.com/register/ 并输入您的服务帐户管理员电子邮件。
  2. 选择 注册开发者帐户。
  3. 在服务帐户管理员收件箱中检查来自 Smartsheet 的电子邮件。
  4. 选择链接。您将被导航到 https://app.smartsheet.com。
  5. 将出现一个对话框，提示您创建新的应用程序。选择开发人员资料部分下的 创建新应用程序 。
  6. 填写必填字段，包括应用程序名称、描述、URL 和联系/支持电子邮件。
  7. 在重定向 URL 字段中输入此应用的以下授权重定向 URL： https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  8. 选中发布应用程序复选框，然后选择 保存。
  9. 复制并保存屏幕上显示的 clientId 和 S ecret 。您可以在配置集成时将其用于 服务身份验证 。

配置 OAuth 客户端

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

  1. 如上面的步骤 5 所示，选择开发人员资料部分下的 创建新应用程序 。
  2. 填写必填字段，包括应用程序名称、描述、URL 和联系/支持电子邮件。
  3. 在重定向 URL 字段中输入此应用的以下授权重定向 URL： https://{yourmicroappserverurl}/admin/api/gwsc/auth/serviceAction/callback
  4. 选中发布应用程序复选框，然后选择 保存。
  5. 复制并保存屏幕上显示的 clientId 和 S ecret 。您可以在配置集成时将其用于维 修操作身份验证 。
  6. 选择 “ 关闭”。

将集成添加到 Citrix Workspace 微应用

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

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

  1. 在 微应用集成 页面中，选择 添加新集 成，然后 从 Citrix 提供的模板中添加新集成。
  2. 选择 SmartSheet 磁贴。
  3. 输入 集成的集成名称 。
  4. 输入 连接器参数。
    • 输入实例 基本 URL：
    • 从 图标 库中选择用于集成的图标，或将其保留为默认图标。
  5. 在 服务身份验证下，从身份验证 方法 菜单中选择 OAuth 2.0 ，然后填写身份验证详细信息。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。使用 OAuth 2.0 安全协议为委派访问生成请求/授权令牌。建议您始终使用 OAuth 2.0 作为可用的服务身份验证方法。OAuth 2.0 可确保您的集成符合配置的微应用的最大安全合规性。
    1. 从身份验证方法菜单中选择 OAuth 2.0，然后填写身份验证详细信息。
    2. 从 令牌授权菜单中选择授权 标头。
    3. 授权 URL 是预先填写的： https://app.smartsheet.com/b/authorize
    4. 令牌 URL 已预先填充：https://api.smartsheet.com/2.0/token
    5. 确保为范围输入以下内容： ADMIN_SHEETS ADMIN_USERS READM_SHEETS READ_SHEETS READ_US
    6. 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您可以在配置 OAuth 服务器时将其作为 clientID 收集。
    7. 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。您在配置 OAuth 服务器时将其作为 S ecret 收集。
  6. 在服务操作身份验证下，启用在操作使用单独的用户身份验证开关。服务操作身份验证在服务操作级别进行身份验证。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。
    1. 从身份验证方法菜单中选择 OAuth 2.0，然后填写身份验证详细信息。
    2. 从 令牌授权菜单中选择授权 标头。
    3. 授权 URL 是预先填写的： https://app.smartsheet.com/b/authorize
    4. 令牌 URL 已预先填充：https://api.smartsheet.com/2.0/token
    5. 确保为范围输入了以下内容： ADMIN_SHEETS ADMIN_USERS 共享 _ 表格 WRITE_SHESTE_SHESTES 创建 _ 表格 ADMIN_WORKSPACES
    6. 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您可以在配置 OAuth 客户端时将其作为 clientID 收集。
    7. 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。您在配置 OAuth 客户端时将其作为 S ecret 收集。
  7. 启用 启用请求速率限制 切换按钮。在 请求数 中输入 300 ，在 时间间隔 中输入 1 分钟。
  8. 默认情况下，请求超时 设置为 120 。
  9. （可选）启用 日志记录 切换以保留 24 小时的日志记录以用于支持目的。
  10. 选择 保存 以继续。

现在，您已准备好设置和运行第一次数据同步。

同步

由于 API 调用限制，增量同步设置为仅保留 “列出组织表”、“列出组织讨论” 和 “获取所有组织发送更新请求”。其余端点将作为完全同步的一部分触发。

我们建议将 完全同步 间隔设置为 每日 ，将 增量同步 间隔设置为 每 5 分钟 ，以便定期将数据从 Smartsheet 刷新到微应用平台并及时接收通知。有关同步规则、不符合其计划的同步和否决规则的完整信息，请参阅同步数据。

注意：

分页限制设置为 100。管理员可以根据 API 扩展此限制。

要加载的最大页数变量 的默认值设置如下所示：

端点名称 值
列出组织表 50
列出群组 10
列出组织讨论 10
获取所有组织发送的更新请求 10
列出工作表 50
获取工作表 10
列出工作表份额 10
列出群组 50

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

使用 Smartsheet 微应用

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

访问表格： 查看工作表、将工作表共享给许可或未获得许可的用户或组、将工作表添加为收藏夹，以及允许用户查看他们的单个工作表。

通知或页面 用例工作流
查看所有表格页面 允许用户搜索可共享和不可共享的工作表。
可共享工作表详细信息页 提供将工作表添加为收藏夹、查看工作表、与获得许可/未许可的用户或组共享工作表的可操作视图。
不可共享的工作表详细信息页 提供将工作表添加为收藏夹并查看工作表的可操作视图。
“可共享组表详细信息” 页 提供将工作表添加为收藏夹、查看工作表、与获得许可/未许可的用户或组共享工作表的可操作视图。
不可共享的组表详细信息页面 提供将组表添加为收藏夹和查看组工作表的可操作视图。

创建工作表： 使用字段和选项（例如工作表名称）创建新工作表，输入列标题，选择列类型，然后选择主列。

通知或页面 用例工作流
创建工作表页 提供用于创建新工作表的表单。

讨论： 只要有对讨论主题的回复，就会向讨论创建者生成通知。

通知或页面 用例工作流
您的讨论通知中添加了新评论 将回复或评论添加到现有讨论时，讨论创建者会收到通知。
讨论详情页面 提供用于回复讨论话题和查看以前评论的表单。

我的更新请求： 查看已发送和已接收的更新请求，其中包含发送到、发送者、主题和状态等详细信息。此外，当用户向收件人发送更新请求时，收件人会收到通知。更新请求完成后，发件人将收到完整的通知。

通知或页面 用例工作流
Smartsheet 更新请求已收到通知 当请求者请求更新请求时，收件人会收到通知。
Smartsheet 更新请求已完成通知 收件人完成更新请求后，请求者会收到通知。
“所有更新请求” 页 允许用户搜索已发送和已接收的更新请求。
已发送更新请求详情页面 使用删除更新请求和视图表功能，提供已发送更新请求的可操作视图。
已收到更新请求详情页 提供具有视图表功能的收到的更新请求的只读视图。
已完成更新请求详情页面 提供具有视图表功能的已完成更新请求的只读视图。

将 Smartsheet 作为附件发送： 将智能表作为附件（PDF 或 Excel）发送，其中包含 “收件人电子邮件”、“主题” 和 “消息” 等详细信息。

通知或页面 用例工作流
查看所有表格页面 允许用户搜索他们拥有的工作表。
作为电子邮件发送详情页 提供可操作的视图，以附件（PDF 或 Excel）的形式发送带有主题和/或消息的智能表。

与管理员共享： 由非管理员用户用来将他们的工作表共享给具有仅查看权限的管理员，以及解锁访问表、我的更新请求、讨论等其他功能，以及接收相应的通知。与管理员共享工作表，以便为你解锁 Workspace 中的其他 Smartsheet 操作和通知，包括：更新请求操作/通知、讨论通知和查看工作表。

注意：

在此微应用中，有一个名为 “ 将工作表共享给管理员 ” 的页面，其中包含一个名为 Admin Email 的 Select 组件（最终用户不可见）。此组件用于与组织的管理员帐户共享用户表。此管理员帐户与您在上一步中设置的服务帐户相同。如果您的组织有多个服务/管理员帐户，请确保将此 管理员电子邮 件选择组件指向正确的帐户，以确保此微应用正常运行。

通知或页面 用例工作流
查看所有表格页面 允许用户搜索他们的工作表并根据需要与管理员共享。
将工作表共享到管理员详情页 提供可操作的视图，以便与具有仅查看权限的管理员共享工作表，并向已共享的工作表添加注释。
与管理员共享的工作表页 与管理员共享工作表时提供用户确认消息。

开始讨论： 在工作表级别开始讨论。

通知或页面 用例工作流
开始讨论页 提供可操作的视图，以便在工作表级别启动讨论。
集成 Smartsheet
December 1, 2021
投稿者: 
C
December 1, 2021
投稿者: 
C

在本文中

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