集成 Jira
与 Jira 集成以跟踪问题并获取有关任何设备、Intranet 或 Messenger 上任务的自动更新。使用以下过程启用与 Jira 的集成。完成此过程后，您现有的审核日志记录级别将保留，包括使用 Citrix Microapps 执行的任何操作。
注意：
我们提供了两个 Jira 集成模板供您使用。对于大多数用例，我们建议使用较新的 HTTP 集成。HTTP 集成提供了更多功能来配置缓存的数据结构。有关每个集成中可用的微应用的完整详细信息，请参阅 使用 Jira 微应用。
查看必备项
要通过此集成使用的所有用户帐户必须在帐户设置设置为 “ 任何人” 中对其电子邮件具有可见性。这意味着服务帐户以及用户通过 OAuth 登录到 Citrix Workspace 的帐户。导航到 https://id.atlassian.com/manage-profile/profile-and-visibility，必要时登录，在 “ 联系 人” 部分中，然后在电子邮件帐户旁边的 “ 谁可以看到此内容？” 下选择任何人。 菜单。
注意：
Jira 不再支持 IE 浏览器 11。使用 Internet Explore 11 配置此微应用将导致错误。切换到其他浏览器（Chrome、Edge 等）以正确配置。
在 Jira 中准备此集成后，需要以下工件才能在 Citrix Workspace 微应用中添加集成：
-
基本 URL：
templatebaseurl{cloud-id}替换为您的云 ID。如果您需要查找自己的 cloud ID，请以 JIRA 实例的管理员身份登录并查看 URL。 - 授权 URL：这是预定义的。这是设置目标应用程序集成时提供的授权服务器 URL。
- 令牌 URL：这是预定义的。这是访问授权令牌的 URL。
- 史诗般的名字-自定义菲尔德：这可以在 Jira 管理员门户中找到。请参阅 替换维修操作变量。
- 客户端 ID：客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。
- 客户端密钥：客户端密钥是设置目标应用程序集成时发出的唯一字符串。
- 用户名：这是您的服务帐户用户名。
- 密码：这是您的服务帐户密码。
注意：
建议您始终使用 OAuth 2.0 作为服务身份验证方法（如果可用）。OAuth 2.0 可确保您的集成符合配置的微应用的最大安全合规性。
在开始集成过程之前，必须满足以下先决条件：
-
具有浏览项目访问权限的专用用户帐户，可以访问您要管理的 Jira 项目。
有关管理用户的更多信息，请参阅 https://www.atlassian.com/software/jira/guides#ManagingUsers-Addingusers。
有关如何将用户添加到 Jira 项目的权限方案的更多信息，请参阅 管理项目权限。
-
将 Citrix Gateway 配置为支持 Jira 的单点登录，这样一旦用户登录，他们将自动重新登录，而无需再次输入凭据。按照 Jira 单点登录配置中的说明进行操作。有关配置 SSO 的更多信息，请参阅 Citrix Gateway 服务。
启用 OAuth 2.0 (3LO)
在实施 OAuth 2.0 (3LO) 之前，您需要在 Jira 应用管理中为您的应用启用它。
- 导航到 应用程序管理。
- 通过选择创建新应用程序来 创建新应用程序，输入名称，同意条款，然后选择 创建。
- 复制 客户端 ID 和 密钥 供以后使用
- 在侧面导航的 API 和功能 部分中，单击 + 添加
- 在 API 和功能页面的功能 部分中，找到 OAuth 2.0 (3LO)，然后依次选择 添加 和 配置。
- 输入 回调 URL。将此 URL 设置为应用程序可访问的任何 URL。当您在应用中实现 OAuth 2.0 (3LO) 时（请参阅下一节），redirect_uri 必须与此 URL 匹配。
- 单击保存更改。
你的屏幕看起来像这样：
创建 API 令牌
脚本或其他进程可以使用 API 令牌对 Jira Cloud 应用程序或 Confluence Cloud 执行基本身份验证。如果您使用的 Atlassian 帐户已启用两步验证，则必须使用 API 令牌。
- 登录 Atlassian 帐户后，转到 API 令牌。
- 选择 创建 API 令牌 ，然后在 标签 字段中输入令牌的名称。
- 复制到剪贴板 并保存以备后用。
将集成添加到 Citrix Workspace 微应用时，必须输入 API 令牌 作为 密码 。
添加 Jira 平台 REST API
如果您尚未添加 Jira 平台 REST API，请立即执行此操作。
- 在侧面导航的 “ API 和功能 ” 部分中，单击 + 添加。
- 在 API和功能页面的 API部分中，找到OAuth 2.0 (3LO)，然后依次选择添加和配置。
- 为你的应用添加所需的范围。
添加回调 URL
向实例配置添加自定义 URL，以授予对私有数据的访问权限并启用经 OAuth 身份验证的用户操作。要查找微应用服务器 URL，请登录 Citrix Cloud，然后选择 微应用 磁贴。在 URL 栏中，复制 URL 的第一部分。这是你的微应用服务器 URL。{yourmicroappserverurl} 部分由租户部分、区域部分和环境部分组成：https://{tenantID}.{region(us/eu/ap-s)}.iws.cloud.com。
对于 HTTP Jira 集成，必须添加两个不同的回调 URL。但是，Jira 应用程序只能有一个回调 URL。这意味着你需要注册两个应用程序；一个用于用户操作，另一个用于同步。它们必须有不同的回调 URL。
https://{yourmicroappserverurl}/admin/api/gwsc/auth/serverContext
https://{yourmicroappserverurl}/app/api/auth/serviceAction/callback
注意：
添加 Jira 集成时，请注意回调 URL。服务身份验证和服务操作身份验证具有不同的回调 URL。客户端 ID 和密钥必须适合于服务身份验证或服务操作身份验证回调 URL。
将集成添加到 Citrix Workspace 微应用
请按照以下步骤设置 Jira HTTP 集成。对于大多数用例，我们建议使用较新的 HTTP 集成。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。对于大多数用例，我们建议使用这种较新的 HTTP 集成。HTTP 集成提供了更多功能来配置缓存的数据结构。
注意：
默认情况下，此集成会在六 (6) 个月的时间段内同步数据。我们建议您根据自己的需求和机票的通常年龄修改此值。筛选器基于上次更新，而不是创建的。要更改此设置，您必须修改数据加载端点中的
timeToSync变量。请参阅 替换数据加载变量。
请按照以下步骤进行操作：
- 在 微应用集成 页面中，选择 添加新集成，然后 从 Citrix 提供的模板中添加新集成。
- 选择 集成下的 Jira 磁贴。
- 输入 集成的集成名称 。
- 输入 连接器参数。
- 输入实例 基本 URL ，或者直接将示例
{cloud-id}中的内容替换为您的云 ID。如果您需要查找自己的 cloud ID，请以 JIRA 实例的管理员身份登录并查看 URL。这个 cloud-ID 是一个通用唯一标识符 (UUID)，它是一个 8-4-4-4-12 位的十六进制数字，是 URL 的一部分。或者，您可以使用管理员凭据进行身份验证，然后向发送 GET 请求https://api.atlassian.com/oauth/token/accessible-resources。云 ID 是响应的一部分。 - 从 图标 库中选择一个用于集成的图标，或将其保留为默认的 Jira 图标。
- 如果要创建 本地连接，请启用本地实例 切换。有关更多信息，请参阅 本地实例。由于 Jira Cloud API v2 和 Jira Server API v2 之间存在差异，您还必须手动更新集成的某些部分。联系支持。
- 输入实例 基本 URL ，或者直接将示例
-
在 服务身份验证下，从身份验证 方法 菜单中选择 OAuth 2.0 ，然后填写身份验证详细信息。身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。使用 OAuth 2.0 安全协议为委派访问生成请求/授权令牌。建议您始终使用 OAuth 2.0 作为可用的服务身份验证方法。OAuth 2.0 可确保您的集成符合配置的微应用的最大安全合规性。
- 从 授权类型流程菜单中选择授权码 。这会授予客户端用来交换访问令牌的临时代码。该代码从授权服务器获取，您可以在其中查看客户端请求的信息。只有这种授权类型才能启用安全的用户模拟。这将显示您在注册应用程序时使用的 回调 URL。服务身份验证和服务操作身份验证具有不同的回调 URL。
- 在 授权类型值字段中输入 authorization_code 。
- 从令牌授权菜单中选择请求正文。
- 从 令牌内容类型 菜单中选择 URL 编码表 单。
- 您的 授权 URL 是预定义的。这是设置目标应用程序集成时提供的授权服务器 URL。
- 您的 令牌 URL 是预定义的。这是访问授权令牌的 URL。
- 确保为作用域输入以下内容。此字符串由授权服务器在设置目标集成应用程序时定义。要同步其他实体，必须在此处添加范围。使用以下内容，用空格分隔：
read:jira-user read:jira-work manage:jira-project manage:jira-configuration write:jira-work manage:jira-data-provider offline_access。 - 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您可以通过在 Jira 账户中注册 OAuth 客户端来收集此信息和秘密信息。客户端 ID 和 Secret 必须是适合服务身份验证回调 URL 的 ID 和 Secret。
- 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。
- 输入您的 标题前缀。（可选）如果您的持票人前缀与默认标题不同，请输入标题前缀。
-
在 “维 修操作身份验证” 下，启 用 “在操作中使用单独的用户 身份验证” 开关 “在服务操作级别进行身份验证” 身份验证选项是预先选择的。确保在完成该过程时选择了这些选项。
- 从身份验证方法菜单中选择 OAuth 2.0，然后填写身份验证详细信息。
- 从 授权类型流程菜单中选择授权码 。这会授予客户端用来交换访问令牌的临时代码。该代码从授权服务器获取，您可以在其中查看客户端请求的信息。只有这种授权类型才能启用安全的用户模拟。这将显示您在注册应用程序时使用的 回调 URL。服务身份验证和服务操作身份验证具有不同的回调 URL。
- 在 授权类型值字段中输入 authorization_code 。
- 从令牌授权菜单中选择请求正文。
- 从 令牌内容类型 菜单中选择 URL 编码表 单。
- 您的 授权 URL 是预定义的。这是设置目标应用程序集成时提供的授权服务器 URL。
- 您的 令牌 URL 是预定义的。这是访问授权令牌的 URL。
- 确保为作用域输入以下内容。此字符串由授权服务器在设置目标集成应用程序时定义。要同步其他实体，必须在此处添加范围。使用以下内容，用空格分隔：
read:jira-user read:jira-work manage:jira-project manage:jira-configuration write:jira-work manage:jira-data-provider offline_access。 - 输入您的 客户 ID。客户端 ID 是表示授权服务器特有的客户端注册信息的字符串。您可以通过在 Jira 账户中注册 OAuth 客户端来收集此信息和秘密信息。客户端 ID 和密钥必须适合于服务操作身份验证回调 URL。
- 输入您的 客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。
- 输入您的 标题前缀。（可选）如果您的持票人前缀与默认标题不同，请输入标题前缀。
- 如果您选择了 OAuth 2.0 身份验证方法，则可以选择 + 添加参数 以包含 访问令牌参数。如有必要，访问令牌参数可根据目标应用程序授权服务器的要求定义访问令牌参数。
- （可选）如果要为此集成激活速率限制，请启用请 求速率限制 开关并设置每个 时间间隔的请求数。
- （可选）启用 日志记录 切换以保留 24 小时的日志记录以用于支持目的。
-
默认情况下， 请求超时 字段设置为 120。
- 选择 保存 以继续。
- 在 OAuth 授权下，选择 授权 以使用您的服务帐户登录。此时将显示带有 Webex 登录屏幕的弹出窗口。
- 输入您的服务帐户用户名和密码，然后选择登录。
- 选择 接受。
继续执行以下步骤以完成设置过程。
替换维修操作变量
要启用创建 Epic 页面功能，您必须手动修改 “ 创建 Epic ” 和 “ 创建 Epic wo 受让人 ” 服务操作。将 EpicFieldId 模板变量的 {Epic-Name-customFieldId} 值替换为存储 Epic Name 的自定义字段的 ID。
- 在 Jira 管理员门户中，导航到 问题。从左侧菜单中选择 自定义字段 。找到条目 Epic Name ，然后选择屏幕另一侧的菜单。选择 查看字段信息。
- 复制并保存 URL 末尾的数值。
- 返回微应用中，选择 Jira 集成旁边的菜单，然后选择 编辑。从左侧导航栏中选择维 修操作 。
- 选择其中一个维修操作旁边的菜单，然后选择 编辑，或者选择该维修操作的名称。让我们从 创建 Epic 服务操作开始。
-
在 “编辑服务操作 ” 屏幕中，在 “ 模板变量 ” 下，将
EpicFieldId模板变量的{Epic-Name-customFieldId}值替换为您之前在 Jira 中收集的自定义字段 ID。
- 选择 保存 以完成操作。
- 现在对其他维修操作重复此步骤： 创建 Epic wo 受让人。
替换数据加载变量
默认情况下，此集成会在六 (6) 个月的时间段内同步数据。我们建议您根据自己的需求和机票的通常年龄修改此值。筛选器基于上次更新，而不是创建的。要更改此设置，您必须在 问题 数据加载端点中修改 timeToSync 变量。
- 在 微应用集成 页面中，选择 Jira 集成旁边的菜单，然后选择 编辑。将打开 “ 数据加载 ” 屏幕。如果您在配置屏幕中，请从左侧导航栏中选择 数据加载 。
- 选择问 题 端点旁边的菜单，然后选择 编辑，或者选择终端节点的名称： 问题。
- 在 “编辑数据端点 ” 屏幕中，在 “ 模板变量 ” 下，将
timeToSync变量的值替换为所需的值。 -
选择屏幕底部的 应用 并确认。
现在，您已准备好设置和运行第一次数据同步。有关同步规则、不符合其计划的同步和否决规则的完整信息，请参阅同步数据。
有关 API 端点和表实体的更多详细信息，请参阅 Jira HTTP 连接器规范。
使用 Jira 微应用
我们的 Jira HTTP 集成带有以下预配置的开箱即用微应用：
创建史诗： 创建包含详细信息的新 Jira Epic。
注意：
要启用创建 Epic 页面功能，您必须修改 创建 Epic 和 创建 Epic wo 受让人 服务操作。请参阅 替换维修操作变量。
| 通知或页面 | 用例工作流 |
|---|---|
| 创建 Epic 页面 | 提供用于创建新 Jira Epic 的表单，包括输入史诗名称、选择问题类型、项目和可选的受让人，以及用于添加说明的字段。 |
| “项目” 页 | 提供可搜索的表单，用于选择要向其分配新 Epic 的项目。 |
创建票证： 创建包含详细信息的新 Jira 票证。
| 通知或页面 | 用例工作流 |
|---|---|
| “创建票证” 页 | 提供用于创建新 Jira 票证的表单，包括选择问题类型、项目和可选的工作负责人，以及用于添加说明的字段。 |
| “项目” 页 | 提供一个可搜索的表单，用于选择要向其分配新票证的项目。 |
票证： 查看票证、添加评论、创建子任务以及更改状态和受让人。
| 通知或页面 | 用例工作流 |
|---|---|
| 评论已编辑（已分配票证）通知 | 在分配给用户的现有票证上编辑评论时，他们会在 Workspace 中收到有关已编辑评论的通知。 |
| 评论已编辑（报告的 TT）通知 | 在用户报告的现有票证上编辑评论时，他们会在 Workspace 中收到有关已编辑评论的通知。 |
| 新评论（已分配票证）通知 | 将新评论添加到分配给用户的现有票证时，他们会收到通知。 |
| 新评论（报告的 TT）通知 | 当用户报告的现有票证中添加新评论时，他们会收到通知。 |
| 已分配给您的 TT（更改）通知 | 将现有票证分配给用户后，他们会收到通知。 |
| 分配给你的 TT（新）通知 | 向用户分配新票证时，他们会收到通知。 |
| 票证受让人变更（已报告）通知 | 重新分配票证后，票证的报告人会收到通知。 |
| 票证状态更改（已分配票证）通知 | 当票证的状态发生更改时，票证的受让人会收到通知。 |
| TT 状态更改（已报告）通知 | 当票证的状态发生更改时，票证的报告者会收到通知。 |
| 评论详情页面 | 提供包含详细信息的评论的只读视图。 |
| “创建子任务” 页 | 提供用于为 Jira 票证创建子任务的表单。 |
| 票证详情页面 | 提供 Jira 票证的详细视图，其中包含用于直接从页面添加评论以及修改状态、优先级和受让人的字段。 |
| 门票页面 | 允许用户使用搜索字段、项目选择器和状态选择器搜索 Jira 票证，以便在 “全部”、“我的”、“已分配”、“已报告”、“正在观看” 和 “已评论” 票证之间快 |
添加旧版 Jira 集成
除了上述步骤外，还要按照以下说明设置旧版集成。
必备条件
对于旧版集成，您需要这些值。
- URL
- 用户名
- 密码-将集成添加到 Citrix Workspace 微应用时，必须输入 API 令牌 作为 密码
- 身份验证方法（凭据或 OAuth2）
对于 OAuth 2.0，你还需要：
- 客户端 ID
- 客户端密钥
设置检索问题的持续时间
对于旧版 Jira 集成，请设置要在 Jira 中检索问题的持续时间。将集成添加到 Citrix Workspace 微应用时，可以通过应用负载筛选器来限制集成从 Jira 检索的数据量。
-
使用您的专用用户帐户和密码登录 Jira。
注意：
如果您使用的是现有帐户，则用户名不是该帐户的电子邮件地址。要查找帐户的用户名，请登录到您的 Jira 实例，选择配置文件缩略图，然后选择 配置文件。
-
输入要检索的问题的天数。
默认值：90 天。
添加 Jira Legacy 集成
请按照以下步骤进行操作：
-
在概述页面中，选择 入门。
此时将打开 “管理集成” 页面。
- 选择 添加新集成，然后 从 Citrix 提供的模板中添加新集成。
- 选择要添加的 Jira 磁贴。
-
输入集成的名称。
- 输入作为先决条件收集的 连接器参数 。
- 输入你的 URL。
-
输入您的服务验证 用户名 和 密码。
注意：
将集成添加到 Citrix Workspace 微应用时，请输入您在上一步中收集的 API 令牌 作为 密码 。
- 选择一种 身份验证方法。使用 OAuth 2.0 安全协议为委派访问生成请求/授权令牌。
- 凭证 -凭据使用客户端的凭据。
- Oauth 2.0 -输入您在先决条件过程中收集的 OAuth 客户端 ID和 OAuth 客户端密钥 。
- 选择要加 载的已更改票证周数。
- 选择添加。
微应用集成 页面随即打开，其中包含您添加的集成及其微应用。在这里，您可以添加另一个集成，继续设置开箱即用的微应用，或为此集成创建新的微应用。
现在，您已准备好设置和运行第一次数据同步。由于可以将大量数据从集成应用程序提取到微应用平台，因此我们建议您使用 “ 表 ” 页面筛选实体以进行首次数据同步，以加快同步速度。有关更多信息，请参阅验证所需实体。有关同步规则、不符合其计划的同步和否决规则的完整信息，请参阅同步数据。
有关 API 端点和表实体的更多详细信息，请参阅 Jira 连接器规范。
旧版 Jira 微应用
我们的 Jira 集成带有以下预配置的开箱即用微应用：
创建票证： 创建包含详细信息的新 Jira 票证。
| 通知或页面 | 用例工作流 |
|---|---|
| “创建票证” 页 | 提供用于创建新 Jira 票证的表单，包括选择问题类型、项目和可选的工作负责人，以及用于添加说明的字段。 |
票证： 查看票证、添加评论、创建子任务以及更改状态和受让人。
| 通知或页面 | 用例工作流 |
|---|---|
| 评论已编辑（已分配票证）通知 | 在分配给用户的现有票证上编辑评论时，他们会在 Workspace 中收到有关已编辑评论的通知。 |
| 评论已编辑（已报告）通知 | 在用户报告的现有票证上编辑评论时，他们会在 Workspace 中收到有关已编辑评论的通知。 |
| 新评论（已分配票证）通知 | 将新评论添加到分配给用户的现有票证时，他们会收到通知。 |
| 新评论（报告的 TT）通知 | 当用户报告的现有票证中添加新评论时，他们会收到通知。 |
| 已分配给您的 TT（更改）通知 | 将现有票证分配给用户后，他们会收到通知。 |
| 分配给你的 TT（新）通知 | 向用户分配新票证时，他们会收到通知。 |
| 票证受让人变更（已报告）通知 | 重新分配票证后，票证的报告人会收到通知。 |
| 票证状态更改（已分配票证）通知 | 当票证的状态发生更改时，票证的受让人会收到通知。 |
| TT 状态更改（已报告）通知 | 当票证的状态发生更改时，票证的报告者会收到通知。 |
| 添加评论页面 | 提供用于向 Jira 票证添加评论的表单。 |
| 更改受让人页面 | 提供用于更改 Jira 票证的受让人的表单。 |
| “更改状态” 页 | 提供用于更改 Jira 票证状态的表单。 |
| 评论详情页面 | 提供包含详细信息的评论的只读视图。 |
| “创建子任务” 页 | 提供用于为 Jira 票证创建子任务的表单。 |
| 票证详情页面 | 提供 Jira 票证的只读视图及详细信息。 |
| 门票页面 | 允许用户搜索分配给他们、由他们报告或他们已评论的 Jira 票证。 |