集成 Jira

与 Jira 集成以跟踪问题,并获取任何设备、内部网或信使上任务的自动更新。使用以下过程启用与 Jira 的集成。完成此过程后,您的现有审核日志记录级别将持续存在,包括使用 Citrix 微应用执行的任何操作。

注意:

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

检查必备项

要通过此集成使用的所有用户帐户必须在设置为任何人的帐户设置中对其电子邮件具有可见性。这意味着服务帐户以及用户通过 OAuth 登录到 Citrix Workspace 的帐户。导航到 https://id.atlassian.com/manage-profile/profile-and-visibility,如有必要,请登录,在联系人 部分,然后在电子邮件帐户旁边选择谁能看到?下的任何人菜单。

在 Jira 中准备此集成后,您将需要这些工件在 Citrix Workspace 微应用中添加集成:

  • 基本 URLtemplatebaseurl{cloud-id} 替换为您的云 ID。如果您需要找到自己的云 ID,请以 JIRA 实例的管理员身份登录并查看 URL。
  • 授权 URL:这是预定义的。这是设置目标应用程序集成时提供的授权服务器 URL。
  • 令牌 URL:这是预定义的。这是访问授权令牌的 URL。
  • Epic-Name-customFieldId:这可以在 Jira 管理员门户中找到。请参阅 替换维修操作变量
  • 客户端 ID:客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。
  • 客户端密钥:客户端密钥是设置目标应用程序集成时发出的唯一字符串。
  • 用户名:这是您的服务帐户用户名。
  • 密码:这是您的服务帐号密码。

注意:

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

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

启用 OAuth 2.0(3LO)

在实现 OAuth 2.0 (3LO) 之前,您需要在 Jira 应用管理中为您的应用启用它。

  1. 导航到 应用程序管理
  2. 创建新应用程序,方法是选择创建新应用程序,输入名称,同意条款,然后选择创建
  3. 复制客户端 ID密码以供以后使用
  4. 在侧面导航的 API 和功能部分,单击 + 添加
  5. API 和功能页面的“功能”部分中,找到 OAuth 2.0 (3LO),选择添加,然后选择配置
  6. 输入回调 URL。将此 URL 设置为应用程序可访问的任何 URL。 当您在应用程序中实现 OAuth 2.0 (3LO) 时(请参阅下一节),redirect_uri 必须匹配此 URL。
  7. 单击“保存更改”。

您的屏幕将如下所示: Jira OAuth2

创建 API 令牌

脚本或其他进程可以使用 API 令牌对 Jira Cloud 应用程序或 Confluence Cloud 执行基本身份验证。如果您使用身份验证的 Atlassian 帐户启用了两步验证,则必须使用 API 令牌。

  1. 登录 Atlassian 帐户后,转到 API 令牌
  2. 选择创建 API 令牌,然后在标签字段中输入令牌的名称。
  3. 复制到剪贴板并保存以备以后使用。

将集成添加到 Citrix Workspace 微应用时,必须输入 API 令牌作为密码

添加 Jira 平台 REST API

如果您尚未添加 Jira 平台 REST API,请立即执行此操作。

  1. 在侧面导航的 API 和功能部分中,单击 + 添加
  2. API 和功能页面API 部分中,找到 OAuth 2.0 (3LO) ,选择添加,然后选择配置
  3. 为您的应用添加所需的范围。

添加回调 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 变量。请参阅 替换数据加载变量

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

  1. 微应用集成页面中,选择添加新集成,然后选择从 Citrix 提供的模板添加新集成
  2. 集成下选择 Jira 磁贴。
  3. 输入集成的集成名称
  4. 输入连接器参数
    • 输入实例基本 URL ,或者只是在示例中将 {cloud-id} 替换为您的云 ID。如果您需要找到自己的云 ID,请以 JIRA 实例的管理员身份登录并查看 URL。此 Cloud-ID 是一个通用唯一标识符 (UUID),即作为 URL 的一部分的 8-4-4-4-12 位十六进制数字。或者,您可以使用管理员凭据进行身份验证,然后向发送 GET 请求 https://api.atlassian.com/oauth/token/accessible-resources。Cloud ID 是响应的一部分。
    • 图标库中选择集成的图标,或将其保留为默认的 Jira 图标。
    • 如果要创建本地连接,请启用本地实例开关。有关详细信息,请参阅本地实例。由于 Jira 实例的 Jira Cloud API v2 和 Jira Server API v2 之间的差异,您还必须手动更新集成的某些部分。联系支持人员。

    Jira HTTP 本地

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

    1. 授权类型流程菜单中选择授权码。这将授予客户端交换访问令牌的临时代码。代码从授权服务器获取,您可以在其中查看客户端请求的信息。只有此授权类型才能启用安全用户模拟。这将显示您在注册应用程序时使用的 回调 URL。服务身份验证和服务操作身份验证具有不同的回调 URL。
    2. 授权类型值字段中输入 authorization_code
    3. 令牌授权菜单中选择请求正文
    4. 令牌内容类型菜单中选择 URL 编码表单。
    5. 您的授权 URL 是预定义的。这是设置目标应用程序集成时提供的授权服务器 URL。
    6. 您的令牌 URL 是预定义的。这是访问授权令牌的 URL。
    7. 确保为 范围输入以下内容。此字符串由授权服务器在设置目标集成应用程序时定义。要同步其他实体,必须在此处添加范围。请使用以下命令,用空格分隔: read:jira-user read:jira-work manage:jira-project manage:jira-configuration write:jira-work manage:jira-data-provider offline_access
    8. 输入您的客户端 ID。客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。你可以通过在 Jira 帐户中注册 OAuth 客户端来收集这个和秘密。客户端 ID 和密钥必须与服务身份验证回调 URL 相应。
    9. 输入您的客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。
    10. 输入您的标题前缀。(可选)如果持有者前缀与默认标题不同,请输入标题前缀。

    Jira HTTP 令牌

  6. 服务操作身份验证下,启用在操作中使用单独用户身份验证开关在维修操作级别进行身份验证。身份验证选项已预先选择。确保在完成此过程时选择了这些选项。

    1. 从“身份验证方法”菜单中选择“OAuth 2.0”,然后完成身份验证详细信息。
    2. 授权类型流程菜单中选择授权码。这将授予客户端交换访问令牌的临时代码。代码从授权服务器获取,您可以在其中查看客户端请求的信息。只有此授权类型才能启用安全用户模拟。这将显示您在注册应用程序时使用的 回调 URL。服务身份验证和服务操作身份验证具有不同的回调 URL。
    3. 授权类型值字段中输入 authorization_code
    4. 令牌授权菜单中选择请求正文
    5. 令牌内容类型菜单中选择 URL 编码表单。
    6. 您的授权 URL 是预定义的。这是设置目标应用程序集成时提供的授权服务器 URL。
    7. 您的令牌 URL 是预定义的。这是访问授权令牌的 URL。
    8. 确保为 范围输入以下内容。此字符串由授权服务器在设置目标集成应用程序时定义。要同步其他实体,必须在此处添加范围。请使用以下命令,用空格分隔: read:jira-user read:jira-work manage:jira-project manage:jira-configuration write:jira-work manage:jira-data-provider offline_access
    9. 输入您的客户端 ID。客户端 ID 是表示授权服务器唯一的客户端注册信息的字符串。你可以通过在 Jira 帐户中注册 OAuth 客户端来收集这个和秘密。客户端 ID 和密码必须是适合于服务操作身份验证回调 URL 的。
    10. 输入您的客户端密钥。客户端密钥是设置目标应用程序集成时发出的唯一字符串。
    11. 输入您的标题前缀。(可选)如果持有者前缀与默认标题不同,请输入标题前缀。
    12. 如果选择了 OAuth 2.0 身份验证方法,则可以选择 + 添加参数以包含访问令牌参数。访问令牌参数根据目标应用程序授权服务器的要求定义访问令牌参数(如有必要)。

    Jira 服务操作身份验证

  7. (可选)如果要激活此集成的速率限制,请启用请求速率限制开关并设置每个时间间隔请求数
  8. (可选)启用日志记录开关以保留 24 小时的日志记录以供支持。
  9. 默认情况下,请求超时字段设置为 120。

    速率限制和记录切换

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

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

替换维修操作变量

要启用“创建 Epic”页面功能,您必须手动修改创建 authorization_code创建 Epic wo 被分派人服务操作。将 EpicFieldId 模板变量的 {Epic-Name-customFieldId} 值替换为 Epic Name 所在的自定义字段的 ID。

  1. 在 Jira 管理员门户中,导航到问题。从左侧菜单中选择自定义字段。找到条目 Epic Name,然后选择屏幕另一侧的菜单。选择查看字段信息
  2. 复制并保存 URL 末尾的数值。
  3. 回到微应用中,选择 Jira 集成旁边的菜单,然后选择编辑。从左侧导航栏中选择服务操作
  4. 选择其中一个服务操作旁边的菜单,然后选择编辑,或选择该维修操作的名称。让我们从创建 Epic 服务操作开始。
  5. 编辑服务操作屏幕中,在模板变量下,将 EpicFieldId 模板变量的 {Epic-Name-customFieldId} 值替换为您之前在 Jira 中收集的自定义字段 ID。

    速率限制和记录切换

  6. 选择“保存”以完成。
  7. 现在对另一个服务操作重复此操作:创建 Epic wo 被分派人

替换数据加载变量

默认情况下,此集成会同步六 (6) 个月的数据。我们建议您根据自己的需求和机票的通常年龄修改此值。筛选器基于上次更新,而不是创建的。要更改此设置,您必须修改问题数据加载端点中的 timeToSync 变量。

  1. 微应用集成页面中,选择 Jira 集成旁边的菜单,然后选择编辑。此时将打开“数据加载”屏幕。如果您在配置屏幕中,请从左侧导航栏中选择数据加载
  2. 选择问题端点旁边的菜单,然后选择编辑选择端点的名称:问题
  3. 编辑数据端点屏幕中,在模板变量下,将 timeToSync 变量的值替换为所需的值。
  4. 选择屏幕底部的应用并确认。

    速率限制和记录切换

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

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

使用 Jira 微应用

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

创建史诗: 创建一个带有细节的新 Jira 史诗。

注意:

要启用 “创建 Epic” 页面功能,您必须修改 “ 创建史诗 ” 和 “ 创建 Epic wo 受让人 ” 服务操作。请参阅 替换维修操作变量

通知或页面 用例工作流
创建史诗页 提供用于创建新 Jira epic 的表单,包括输入史诗名称和选择问题类型、项目和可选的受让人,以及用于添加描述的字段。
项目页 提供一个可搜索的表单,用于选择要将新史诗分配给的项目。

创建票证: 创建一个包含详细信息的新 Jira 票证。

通知或页面 用例工作流
“创建票证”页面 提供用于创建新的 Jira 票证的窗体,包括选择问题类型、项目和可选的受理人,以及用于添加描述的字段。
项目页 提供一个可搜索的表单,用于选择要向其分配新票证的项目。

票证: 查看票证、添加评论、创建子任务以及更改状态和受理人。

通知或页面 用例工作流
评论编辑(已分配票证)通知 在分配给用户的现有票证上编辑注释时,他们会在 Workspace 中收到已编辑注释的通知。
评论已编辑(报告的票证)通知 在用户报告的现有票证上编辑注释时,他们会收到 Workspace 中编辑注释的通知。
新评论(分配票证)通知 当新注释添加到分配给用户的现有票证中时,他们会收到通知。
“新建评论(已报告的票证)”通知 当新注释添加到用户报告的现有票证中时,他们会收到通知。
“分配给您的票证(更改)”通知 将现有票证分配给用户时,他们会收到通知。
“分配给您的票证(新)”通知 向用户分配新票证时,他们会收到通知。
票证受让人变更(已报告)通知 重新分配票证时,票证的报告人会收到通知。
票证状态更改(已分配票证)通知 当票证的状态发生变化时,票证的受让人会收到通知。
“票证状态更改(已报告)”通知 当票证状态发生变化时,票证报告员会收到通知。
注释详细信息页面 提供含有详细信息的注释的只读视图。
“创建子任务”页 提供用于为 Jira 票证创建子任务的表单。
“票证详细信息”页面 提供 Jira 票证的详细视图,其中包含直接从页面添加评论以及修改状态、优先级和受理人的字段。
票证页面 允许用户使用搜索字段、项目选择器和状态选择器在 Jira 票证中搜索,以在 “全部”、“我的”、“已分配”、“已报告”、“关注” 和 “已评论” 票证之间

添加传统 Jira 集成

除了上述步骤外,请按照以下说明设置旧版集成。

必备条件

对于传统集成,您需要这些值。

  • URL
  • 用户名
  • 密码 - 将集成添加到 Citrix Workspace 微应用时,必须输入 API 令牌作为密码
  • 身份验证方法(凭据或 OAuth2)

对于 OAuth 2.0,您还需要:

  • 客户端 ID
  • 客户端密钥

设置检索问题的持续时间

对于 Legacy Jira 集成,请设置要在 Jira 中检索问题的持续时间。将集成添加到 Citrix Workspace 微应用时,可以通过应用负载过滤器来限制集成从 Jira 检索的数据量。

  1. 使用您的专用帐户和密码登录 Jira。

    注意:

    如果您使用的是现有帐户,则用户名不是该帐户的电子邮件。要查找帐户的用户名,请登录到您的 Jira 实例,选择配置文件缩略图,选择配置文件

  2. 输入要检索的问题天数。

    默认值:90 天。

添加 Jira Legacy 集成

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

  1. 从概览页面中,选择开始

    此时将打开“管理集成”页面。

  2. 选择添加新集成,然后选择从 Citrix 提供的模板中添加新集成
  3. 选择要添加的 Jira 磁贴。
  4. 输入集成的名称。

    Jira 连接器参数、URL、用户名、密码、用户验证

  5. 输入作为必备条件收集的连接器参数
    • 输入您的 URL
    • 输入您的服务验证用户名密码

      注意:

      将集成添加到 Citrix Workspace 微应用时,输入上一步中收集的 API 令牌作为密码

  6. 选择身份验证方法。使用 OAuth 2.0 安全协议为委派访问生成请求/授权令牌。
    • 凭据 -凭据使用客户端的凭据。
    • Oauth 2.0 - 输入您在必备条件过程中收集的 OAuth 客户端 IDOAuth 客户端密钥
  7. 选择要加载的更改票证周数
  8. 选择添加

Jira HTTP OAuth

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

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

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

传统 Jira 微应用

我们的 Jira 集成带有以下预配置的现成微应用:

Jira 微应用

创建票证: 创建一个包含详细信息的新 Jira 票证。

通知或页面 用例工作流
“创建票证”页面 提供用于创建新的 Jira 票证的窗体,包括选择问题类型、项目和可选的受理人,以及用于添加描述的字段。

票证: 查看票证、添加评论、创建子任务以及更改状态和受理人。

通知或页面 用例工作流
评论编辑(已分配票证)通知 在分配给用户的现有票证上编辑注释时,他们会在 Workspace 中收到已编辑注释的通知。
注释已编辑(已报告)通知 在用户报告的现有票证上编辑注释时,他们会收到 Workspace 中编辑注释的通知。
新评论(分配票证)通知 当新注释添加到分配给用户的现有票证中时,他们会收到通知。
“新建评论(已报告的票证)”通知 当新注释添加到用户报告的现有票证中时,他们会收到通知。
“分配给您的票证(更改)”通知 将现有票证分配给用户时,他们会收到通知。
“分配给您的票证(新)”通知 向用户分配新票证时,他们会收到通知。
票证受让人变更(已报告)通知 重新分配票证时,票证的报告人会收到通知。
票证状态更改(已分配票证)通知 当票证的状态发生变化时,票证的受让人会收到通知。
“票证状态更改(已报告)”通知 当票证状态发生变化时,票证报告员会收到通知。
“添加评论”页 提供用于向 Jira 票证添加注释的表单。
“更改受理人”页 提供更改 Jira 票证受让人的表单。
“更改状态”页 提供用于更改 Jira 票证状态的表单。
注释详细信息页面 提供含有详细信息的注释的只读视图。
“创建子任务”页 提供用于为 Jira 票证创建子任务的表单。
“票证详细信息”页面 提供包含详细信息的 Jira 票证的只读视图。
票证页面 允许用户搜索分配给他们、由他们报告或他们评论过的 Jira 票证。