集成 Zendesk

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

注意:

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

使用以下过程来启用 Zendesk 集成。确保满足必备条件,并获取客户端 ID 和秘密令牌。完成此过程后,您的现有审核日志记录级别将持续存在,包括使用 Citrix 微应用执行的任何操作。

有关现成的 Zendesk 微应用的完整列表,请参阅使用 Zendesk 微应用

检查必备项

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

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

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

  • 将 Citrix Gateway 配置为支持 Zendesk 的单点登录,以便在用户登录后,他们将自动重新登录,而无需再次输入凭据。请按照 Zendesk 单点登录配置 中的说明进行操作。有关配置 SSO 的详细信息,请参阅Citrix Gateway 服务

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

设置 Zendesk 集成

  1. 使用专用的用户帐户登录到 www.zendesk。
  2. 选择左侧边栏上的管理员(设置图标)。在渠道下选择 API
  3. 选择 OAuth 客户端选项卡,然后选择 +(加号)图标。
  4. 输入应用程序的客户端名称
  5. (可选)添加描述公司徽标
  6. 复制自动填充的唯一标识符值以供以后使用。
  7. 如下所述设置重定向 URL
  8. 选择保存确定
  9. 刷新页面后,将显示一个新的预填充密码字段。复制生成供以后使用的私有令牌。离开此屏幕后,此功能不可用。
  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,或者只是在示例中用您的客户 ID 替换 {customer-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) 个月内修改过的票证。如果需要更改此设置,请在此集成数据加载设置中修改 TT 终端节点的 start_time 模板变量参数。我们建议您根据自己的需求和机票的通常年龄修改此值。筛选器基于上次更新,而不是创建的。

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

    速率限制和记录切换

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

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

使用 Zendesk 微应用

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

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

使用 Zendesk 微应用

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

Zendesk 微应用

添加票证: 提交 Zendesk 票证。

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

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

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

添加 Zendesk 传统集成

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

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

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

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

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

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

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

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

传统 Zendesk 微应用

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

Zendesk 微应用

添加票证: 提交 Zendesk 票证。

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

票证: 查看 Zendesk 票证详细信息。

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