微应用

集成 Zendesk

与 Zendesk 集成以提交和监控来自任何设备、内部网或 Messenger 的请求。

注意:

我们提供了两个 Zendesk 集成模板供您使用。对于大多数用例,我们建议使用较新的 HTTP 集成。HTTP 集成提供了更多功能来配置缓存的数据结构。有关每个集成中可用的微应用的完整详细信息,请参阅 使用 Zendesk 微应用。

使用以下过程启用 Zendesk 集成。确保满足先决条件,并获得客户端 ID 和秘密令牌。完成此过程后,您现有的审核日志记录级别将保留,包括使用 Citrix Microapps 执行的任何操作。

有关开箱即用的 Zendesk 微应用的完整列表,请参阅 使用 Zendesk 微应用。

查看必备项

创建一个专用的 Zendesk 帐户并使用它来设置 Zendesk 集成。此帐户必须分配了具有完全数据访问权限的角色,例如管理员。在 Zendesk 中设置此集成后,需要以下工件才能在 Citrix Workspace 微应用中添加集成:

  • 基本 URL:基本 URL 遵循此模式:https://{customer-id}.zendesk.com/
  • 客户 IDcustomer-id 在设置过程中,使用 URL 的客户 ID 部分(如上所述)进行替换。
  • 客户端 ID:客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。您可以通过在 Zendesk 账户中注册 OAuth 客户端来收集此信息和秘密信息。
  • 客户端密钥:客户端密钥是设置目标应用程序集成时发出的唯一字符串。
  • 帐户:这是您的服务帐户用户名。
  • 密码:这是您的服务帐户密码。

在开始集成过程之前,应满足以下先决条件:

Zendesk 有一个选项 Enable On-hold status ,允许用户为票证分配 Hold 状态。我们的微应用程序 证允许用户查看包含详细信息的 Zendesk 票证, 更新票证 页面有一个字段 状态 ,其中 Hold有一个选项。如果您 Hold 的 Zendesk 实例中不允许该项目,则需要从 Status 列表中删除该 Hold 项目。有关更多信息,请参阅 使用 Zendesk 微应用。

设置 Zendesk 集成

  1. 使用专用的用户帐户登录 www.zendesk.com。
  2. 选择左侧边栏中的 管理员 (设置图标)。在 频道 下,选择 API
  3. 选择 OAuth 客户端 选项卡,然后选择 + (加号)图标。
  4. 输入应用的 客户端名称
  5. (可选)添加 描述公司徽标
  6. 复制自动填充的 唯一标识符 值供以后使用。
  7. 如下所述设置 重定向 URL
  8. 选择 保存确定
  9. 页面刷新后,将显示一个新的预填充的 Secret 字段。复制生成的 秘密令牌 以供以后使用。离开此屏幕后,此功能不可用。
  10. 选择保存

您已准备好在 Citrix Workspace 微应用程序中完成集成。

添加回调 URL

向实例配置添加自定义 URL,以授予对私有数据的访问权限并启用经 OAuth 身份验证的用户操作。列出的第一个回调不会改变。第二个回调取决于目标应用程序,创建集成时可以在 URL 地址栏中找到。{yourmicroappserverurl} 部分由租户部分、区域部分和环境部分组成: https://{tenantID}.{region(us/eu/ap-s)}.iws.cloud.com

以管理员身份登录 Zendesk,然后为此集成添加以下授权重定向 URL:

  • https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
  • https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback

将集成添加到 Citrix Workspace 微应用

请按照以下步骤设置 Zendesk HTTP 集成。对于大多数用例,我们建议使用较新的 HTTP 集成。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。对于大多数用例,我们建议使用这种较新的 HTTP 集成。HTTP 集成提供了更多功能来配置缓存的数据结构。

注意:

默认情况下,此集成会在三 (3) 个月的时间段内同步数据。我们建议您根据自己的需求和机票的通常年龄修改此值。筛选器基于上次更新,而不是创建的。要更改此设置,您必须修改数据加载端点中的 start_time 变量。请参阅 替换数据加载变量

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

  1. 微应用集成 页面中,选择 添加新集成,然后 从 Citrix 提供的模板中添加新集成。
  2. 集成下选择 Zendesk 磁贴。
  3. 输入 集成的集成名称
  4. 输入 连接器参数
    • 输入您的 基本 URL ,或者直接将示例 {customer-id} 中的客户 ID 替换为您的客户 ID。
    • 图标 库中选择一个用于集成的图标,或将其保留为默认的 Zendesk 图标。

    HTTP zendesk 连接器参数

    • 如果要创建 本地连接,请启用本地实例 切换。有关更多信息,请参阅 本地实例

    HTTP zendesk 连接器本地

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

    1. 授权类型流程菜单中选择授权码 。这会授予客户端用来交换访问令牌的临时代码。该代码从授权服务器获取,您可以在其中查看客户端请求的信息。只有这种授权类型才能启用安全的用户模拟。这将显示您在注册应用程序时使用的回调 URL
    2. 授权类型值字段中输入 authorization_code
    3. 令牌授权菜单中选择授权 标题。
    4. 令牌内容类型 菜单中选择 URL 编码表 单。
    5. 输入您的授权 URL,或者直接将示例中的 {customer-id} 替换为您的客户 ID。这是设置目标应用程序集成时提供的授权服务器 URL。
    6. 输入您的令牌 URL,或者直接将示例中的 {customer-id} 替换为您的客户 ID。这是访问授权令牌的 URL。
    7. 确保输入了 范围读写 以定义访问请求的范围。
    8. 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您可以通过在 Zendesk 账户中注册 OAuth 客户端来收集此信息和秘密信息。您需要添加在集成配置页面上看到的 回调 URL
    9. 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。
    10. 输入您的 标题前缀。(可选)如果您的持票人前缀与默认标题不同,请输入标题前缀。

    zendeskHTTP 服务身份验证

    1. 如果您选择了 OAuth 2.0 身份验证方法,则可以选择 + 添加参数 以包含 访问令牌参数。如有必要,访问令牌参数可根据目标应用程序授权服务器的要求定义访问令牌参数。

    Zendesk HTTP 令牌

  6. 在 “维 修操作身份验证” 下,启 用 “在操作中使用单独的用户 身份验证” 开关 “在服务操作级别进行身份验证” 凭证与服务授权级别的凭证相同。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。

    1. 身份验证方法菜单中选择 OAuth 2.0,然后填写身份验证详细信息。
    2. 授权类型流程菜单中选择授权码 。这会授予客户端用来交换访问令牌的临时代码。该代码从授权服务器获取,您可以在其中查看客户端请求的信息。只有这种授权类型才能启用安全的用户模拟。这将显示您在注册应用程序时使用的回调 URL
    3. 授权类型值字段中输入 authorization_code
    4. 令牌授权菜单中选择授权 标题。
    5. 令牌内容类型 菜单中选择 URL 编码表 单。
    6. 输入您的授权 URL,或者直接将示例中的 {customer-id} 替换为您的客户 ID。这是设置目标应用程序集成时提供的授权服务器 URL。
    7. 输入您的令牌 URL,或者直接将示例中的 {customer-id} 替换为您的客户 ID。这是访问授权令牌的 URL。
    8. 确保输入了 范围读写 以定义访问请求的范围。
    9. 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您可以通过在 Zendesk 账户中注册 OAuth 客户端来收集此信息和秘密信息。您需要添加在集成配置页面上看到的 回调 URL
    10. 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。
    11. 输入您的 标题前缀。(可选)如果您的持票人前缀与默认标题不同,请输入标题前缀。

    HTTP zendesk 服务操作身份验证

  7. “请 求速率限制 ” 开关已启用,每个 时间间隔请求数 设置为每分钟 500 个。
  8. (可选)启用 日志记录 切换以保留 24 小时的日志记录以用于支持目的。
  9. 默认情况下, 请求超时 字段设置为 120。

    速率限制和日志记录切换

  10. 选择 保存 以继续。
  11. OAuth 授权下,选择 授权 以使用您的服务帐户登录。此时将显示带有 Webex 登录屏幕的弹出窗口。
    1. 输入您的服务帐户用户名和密码,然后选择登录
    2. 选择 接受服务验证

继续执行以下步骤以完成设置过程。

替换数据加载变量

默认情况下,在完全同步期间,此集成仅加载最近三 (3) 个月内修改过的票证。如果需要更改此设置,请在此集成数据加载设置中修改 票证 端点的 start_time 模板变量参数。我们建议您根据自己的需求和机票的通常年龄修改此值。筛选器基于上次更新,而不是创建的。

  1. 微应用集成 页面中,选择 Zendesk 集成旁边的菜单,然后选择 编辑。将打开 “ 数据加载 ” 屏幕。如果您在配置屏幕中,请从左侧导航栏中选择 数据加载
  2. 选择 票证 终端节点旁边的菜单,然后选择 编辑,或选择终端节点的名称: 票证
  3. “编辑数据端点 ” 屏幕中,在 “ 模板 start_time 变量 ” 下,根据需要将变量的值替换为要更改时间参数和数值的值。
  4. 选择屏幕底部的 应用 并确认。

    速率限制和日志记录切换

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

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

使用 Zendesk 微应用

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

注意: 我们提供了两个 Zendesk 集成模板供您使用。我们建议在大多数用例中使用较新的 HTTP 集成,而不是旧的基于 Java 的集成。它们包含的微应用略有不同。

使用 Zendesk 微应用

我们的 Zendesk HTTP 集成带有以下预配置的开箱即用微应用:

Zendesk 微应用

添加票证: 提交 Zendesk 门票。

通知或页面 用例工作流
添加票证页面 提供用于提交票证的表单。

门票: 查看详细信息的 Zendesk 门票。如果您 Hold 的 Zendesk 实例中不允许该 Hold 项目,则需要从 更新票证 页面的 Status 列表中删除该项目。

通知或页面 用例工作流
分配给你的新票证(已更改)通知 将现有票证分配给用户后,他们会收到通知。
分配给你的新票证(新)通知 向用户分配新票证时,他们会收到通知。
票证状态更改通知 当票证的状态发生更改时,票证的提交者会收到通知。
票证已更新通知 票证更新后,提交者会收到通知。
添加评论页面 提供用于向票证添加评论的页面。
评论详情页面 提供注释的只读视图及其详细信息。
我的门票页面 提供与用户相关的票证的个性化列表以及票证详细信息的链接。
票证详情页面 提供包含详细信息的票证的只读视图。
更新票证页面 为管理员提供修改票证的页面。字段包括优先级、类型和状态。

添加 Zendesk 旧版集成

按照以下说明设置旧版基于 Java 的 Zendesk 集成。

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

  1. 微应用集成 页面中,选择 添加新集成,然后 从 Citrix 提供的模板中添加新集成。
  2. 旧版下,选择 Zendesk 磁贴。
  3. 输入集成的名称。

    zendesk 连接器参数、URL、客户端 ID、客户端密钥、要加载的票证月数

  4. 输入作为先决条件收集的 连接器参数
    • 输入实例 URL
    • 输入 客户端 ID。此值是您在 Zendesk 注册应用程序时获得的唯一标识符。
    • 输入 客户端密钥。此值是您在 Zendesk 注册应用程序时复制的 Secret。
    • 要加载的票证的月数选择一个值。
  5. 选择使用 您的 Zendesk 帐户登录 以启用 OAuth 授权。Zendesk 登录页面将在新选项卡中打开。系统会提示您输入帐户名、确认访问权限并输入密码。
  6. 选择添加

微应用集成 页面随即打开,其中包含您添加的集成及其微应用。在这里,您可以添加另一个集成,继续设置开箱即用的微应用,或为此集成创建新的微应用。

现在,您已准备好设置和运行第一次数据同步。由于可以将大量数据从集成应用程序提取到微应用平台,因此我们建议您使用 “ ” 页面筛选实体以进行首次数据同步,以加快同步速度。有关更多信息,请参阅验证所需实体。有关同步规则、不符合其计划的同步和否决规则的完整信息,请参阅同步数据

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

旧版 Zendesk 微应用

我们基于 Java 的 Zendesk 集成带有以下预配置的开箱即用微应用:

Zendesk 微应用

添加票证: 提交 Zendesk 门票。

通知或页面 用例工作流
提交票证页面 提供用于提交票证的表单。

门票: 查看详细信息的 Zendesk 门票。

通知或页面 用例工作流
分配给你的新票证(已更改)通知 将现有票证分配给用户后,他们会收到通知。
分配给你的新票证(新)通知 向用户分配新票证时,他们会收到通知。
票证状态更改通知 当票证的状态发生更改时,票证的提交者会收到通知。
票证已更新通知 票证更新后,提交者会收到通知。
我的门票页面 提供与用户相关的票证的个性化列表以及票证详细信息的链接。
票证详情页面 提供包含详细信息的票证的只读视图。
集成 Zendesk