集成 SmartSheet

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

有关 Smartsheet 的开箱即用微应用的全面详细信息,请参阅 使用 SmartSheet 微应用

注意:

此 Smartsheet 集成模板在 Citrix Labs 类别中发布。这使得功能在初始客户反馈的情况下成熟。对于 Citrix Labs 模板,没有对支持的承诺,开发人员将尽最大努力提供支持。Citrix Labs 集成模板是为了测试/验证的目的而共享。我们不建议在生产环境中部署它们。Citrix Labs 模板在单独的部分中列出。我们需要您的反馈! 请在使 对此集成模板的反馈 用时提供。对 专用论坛 于任何问题,我们的团队也会每天监控我们的。

检查必备项

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

设置与 SmartSheet 的集成后,您将需要以下对象来添加 Citrix Workspace 微应用程序中的集成:

  • 基本 URLhttps://api.smartsheet.com/
  • 授权 URLhttps://app.smartsheet.com/b/authorize
  • 令牌 URLhttps://api.smartsheet.com/2.0/token
  • 客户端 ID:客户端 ID 是表示授权服务器唯有的客户端注册信息的字符串。配置 OAuth 服务器时,您可以将其作为 应用程序密钥 收集。
  • 秘密:客户端密钥是设置目标应用程序集成时发出的唯一字符串。配置 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. 复制并保存屏幕上显示的客户端 ID密码。配置集成时,您可以将其用于 服务身份验证

配置 OAuth 客户端

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

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

将集成添加到 Citrix Workspace 微应用

将 SmartSheet 集成添加到 Citrix Workspace 微应用程序以连接到您的应用程序。身份验证选项已预先选择。确保在完成此过程时选择了这些选项。这将提供带有预先配置的通知和操作的开箱即用微应用,这些通知和操作可以在 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. 确保为范围输入以下内容:AD MIN_SHELES ADMIN_USERS READ_SHELES READ_SE
    6. 输入您的客户端 ID。客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。配置 OAuth 服务器时,您可以将其作为 ClientiD 收集。
    7. 输入您的客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。配置 OAuth 服务器时,您将其作为密钥收集。
  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_SHELES ADMIN_USERS SHARE_SHARETE_SHELES CREATE_SHAREATE_SHE
    6. 输入您的客户端 ID。客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。配置 OAuth 客户端时,您可以将其作为 ClientiD 收集。
    7. 输入您的客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。在配置 OAuth 客户端时,您将其作为密钥收集。
  7. 启用 启用请求速率限制 切换按钮。输入 300 作为 请求数 ,输入 1 分钟 作为 时间间隔
  8. 默认情况下,请求超时 设置为 120
  9. (可选)启用日志记录开关以保留 24 小时的日志记录以供支持。
  10. 选择 保存 以继续。

现在,您可以设置和运行第一个数据同步。

同步

由于 API 调用限制,增量同步设置为仅保留列出组织表、列出组织讨论和获取所有组织 sentupdate请求。剩余的终端节点将作为完全同步的一部分触发。

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

注意:

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

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

端点名称
列出组织表格 50
列出群组 10
列出组织讨论 10
获取所有组织 sentupdate 请求 10
列出工作表 50
获取床单 10
列出表单股 10
列出群组 50

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

使用 SmartSheet 微应用

现有的应用程序集成附带开箱即用的微应用。从这些微应用开始,并根据您的需求定制它们。

访问表格: 查看工作表、将工作表共享给获得许可或未获许可的用户或群组、添加工作表作为收藏夹以及允许用户查看其个人工作表。

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

创建工作表: 使用字段和选项(如工作表名称)创建新工作表,输入列标题,选择列类型,然后选择主列。

通知或页面 用例工作流
“创建工作表”页 提供用于创建新工作表的窗体。

讨论: 只要讨论创建者的讨论话题有回复,就会向他们生成通知。

通知或页面 用例工作流
新评论添加到您的讨论通知 将回复或评论添加到现有讨论中时,讨论创建者将收到通知。
讨论详细信息页面 提供一个表单来回复讨论话题并查看之前的评论。

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

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

将智能表作为附件发送: 将智能表作为附件(PDF 或 Excel)发送,其中包含收件人电子邮件、主题和消息等详细信息。

通知或页面 用例工作流
“查看所有工作表”页 允许用户搜索自己拥有的工作表。
作为电子邮件发送详情页面 提供可操作的视图,将智能表作为附件(PDF 或 Excel)发送带有主题和/或消息。

与管理员共享: 由非管理员用户将他们的工作表共享给只能查看访问权限的管理员,以及解锁其他功能,如访问表、我的更新请求、讨论以及接收相应的通知。与管理员共享工作表,为您解锁 Workspace 中的其他 Smartsheet 操作和通知,包括:更新请求操作/通知、讨论通知和查看工作表。

注意:

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

通知或页面 用例工作流
“查看所有工作表”页 允许用户在工作表中搜索并根据需要与管理员共享。
共享表到管理员详细信息页面 提供可操作的视图,以便与具有仅查看访问权限的管理员共享工作表,并向已共享的工作表添加注释。
工作表与管理员共享页面 在与管理员共享工作表时提供用户确认消息。

开始讨论: 在工作表层开始讨论。

通知或页面 用例工作流
“开始讨论”页 提供可操作的视图以启动工作表级别的讨论。
集成 SmartSheet