Jira 模块

NOTE
这些说明适用于Jira连接器的新版本,它简单地标记为Jira。 有关旧版Jira Cloud和Jira服务器连接器的说明,请参阅Jira软件模块

在Adobe Workfront Fusion场景中,您可以自动使用Jira的工作流,并将其连接到多个第三方应用程序和服务。

Jira连接器可用于Jira云和Jira数据服务器。

有关创建场景的说明,请参阅创建场景:文章索引中的相关文章。

有关模块的详细信息,请参阅模块:文章索引中的相关文章。

访问权限要求

展开可查看本文所述功能的访问权限要求。
table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header
Adobe Workfront 包

任意 Adobe Workfront Workflow 包以及任意 Adobe Workfront 自动化和集成包

Workfront Ultimate

Workfront Prime 和 Select 包,且需额外购买 Workfront Fusion。

Adobe Workfront 许可证

标准

工作版或更高版本

Adobe Workfront Fusion 许可证

基于操作:不需要 Workfront Fusion 许可证

基于连接器(旧版):Workfront Fusion for Work Automation and Integration

产品 如果您的组织使用的 Workfront Select 或 Prime 包不包含 Workfront 自动化和集成,则必须单独购买 Adobe Workfront Fusion。

有关此表中信息的更多详细说明,请参阅文档中的访问权限要求

有关 Adobe Workfront Fusion 许可证的详细信息,请参阅 Adobe Workfront Fusion 许可证

先决条件

  • 要使用Jira模块,您必须具有Jira帐户。
  • 您必须有权访问Jira Developer Console才能在Jira中创建OAuth2应用程序。

将Jira连接到Workfront Fusion

创建与Jira的连接过程因您创建的是基本连接还是OAuth2连接而异。

创建与Jira的OAuth2连接

要创建与Jira的OAuth2连接,必须先在Jira中创建应用程序,然后才能在Fusion中配置连接。

在Jira中创建OAuth2应用程序

IMPORTANT
您必须有权访问Jira Developer Console,才能为Jira连接创建和配置OAuth2应用程序。
  1. 转到Jira Developer Console

  2. 在“我的应用程序”区域中,单击​创建,然后选择​OAuth 2.0集成

  3. 输入集成的名称,同意开发人员条款,然后单击​创建

    此时将创建应用程序,并转到应用程序配置区域。

  4. 在左侧导航面板中单击​权限

  5. 在“权限”区域中,找到​ Jira API ​行。

  6. 单击Jira API行中的​添加,然后单击同一行中的​继续

  7. 启用以下范围:

    • 查看Jira问题数据(read:jira-work)
    • 查看用户配置文件(read:jira-user)
    • 创建和管理问题(write:jira-work)
  8. 在左侧导航中,单击​授权

  9. 在OAuth 2.0授权的行中单击​添加

  10. 在​ 回调URL ​字段中,根据您的Workfront Fusion数据中心,输入以下URL之一:

    table 0-row-2 1-row-2 2-row-2 3-row-2
    融合数据中心 回调 URL
    US https://app.workfrontfusion.com/oauth/cb/workfront-jira2
    欧盟 https://app-eu.workfrontfusion.com/oauth/cb/workfront-jira2
    Azure https://app-az.workfrontfusion.com/oauth/cb/workfront-jira2
  11. 在左侧导航中,单击​设置

  12. (可选)在“描述”字段中输入描述,然后单击该字段下的​保存更改

  13. 将客户端ID和客户端密钥从设置区域复制到安全位置,或者在Fusion中配置连接时保持此页面打开。

  14. 继续在Fusion中配置OAutt2连接

在Fusion中配置Oauth2连接

  1. 在任意Jira模块中,单击“连接”字段旁边的​添加

  2. 配置以下字段:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 layout-auto html-authored no-header
    连接类型 选择OAuth 2
    连接名称 输入新连接的名称。
    服务URL 输入您的Jira实例URL。 这是您用于访问Jira的URL。
    Jira帐户类型 选择您是连接到Jira云还是Jira数据中心。
    客户端 ID 输入您在中创建的Jira应用程序的客户端ID在Jira中创建OAuth2应用程序。
    客户端密钥 输入您在中创建的Jira应用程序的客户端密钥。在Jira中创建OAuth2应用程序。
    其他范围 输入要添加到此连接的任何其他范围。
    API 版本 选择您希望此连接连接到的Jira API版本。
  3. 单击​ 继续 ​以创建连接并返回模块。

创建与Jira的基本连接

创建与Jira的基本连接有所不同,具体取决于您是创建与Jira云还是Jira数据中心的连接。

创建与Jira Cloud的基本连接

IMPORTANT
要创建与Jira云的基本连接,您必须具有Jira API令牌。
有关获取Jira API令牌的说明,请参阅Atlassian文档中的管理Atlassian帐户的API令牌
  1. 在任意Jira模块中,单击“连接”字段旁边的​添加

  2. 配置以下字段:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 layout-auto html-authored no-header
    连接类型 选择是创建基本连接还是OAuth 2连接。
    连接名称 输入新连接的名称。
    服务URL 输入您的Jira实例URL。 这是您用于访问Jira的URL。
    Jira帐户类型 选择您是连接到Jira云还是Jira数据中心。
    电子邮件 输入您的电子邮件地址。
    api令牌 输入您的API令牌。
    API 版本 选择您希望此连接连接到的Jira API版本。
  3. 单击​ 继续 ​以创建连接并返回模块。

创建与Jira数据中心的基本连接

IMPORTANT
要创建与Jira数据中心的基本连接,您必须具有Jira个人访问令牌(PAT)。
有关获取Jira个人访问令牌的说明,请参阅Atlassian文档中的管理Atlassian帐户的API令牌
有关创建PAT时的注意事项,请参阅本文中的配置PAT
  1. 在任意Jira模块中,单击“连接”字段旁边的​添加

  2. 配置以下字段:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 layout-auto html-authored no-header
    连接类型 选择是创建基本连接还是OAuth 2连接。
    连接名称 输入新连接的名称。
    服务URL 输入您的Jira实例URL。 这是您用于访问Jira的URL。
    Jira帐户类型 选择您是连接到Jira云还是Jira数据中心。
    PAT(个人访问令牌) 输入您的Jira个人访问令牌。
    API 版本 选择您希望此连接连接到的Jira API版本。
  3. 单击​ 继续 ​以创建连接并返回模块。

配置您的PAT

要创建与Jira数据中心的基本连接,您必须具有Jira个人访问令牌(PAT)。

有关获取Jira个人访问令牌的说明,请参阅Atlassian文档中的管理Atlassian帐户的API令牌

配置PAT时,可能需要以下信息

  • 重定向URL

    table 0-row-2 1-row-2 2-row-2 3-row-2
    融合数据中心 重定向 URL
    US https://app.workfrontfusion.com/oauth/cb/workfront-jira
    欧盟 https://app-eu.workfrontfusion.com/oauth/cb/workfront-jira
    Azure https://app-az.workfrontfusion.com/oauth/cb/workfront-jira
  • 文件配置

要使用PAT,必须在文件jira/bin/WEB-INF/classes的文件jira-config.properties中启用以下内容:

  • jira.rest.auth.allow.basic = true
  • jira.rest.csrf.disabled = true

如果此文件不存在,则必须创建它。

Jira模块及其字段

配置Jira模块时,Workfront Fusion会显示以下列出的字段。 除此以外,还可能会显示其他Jira字段,具体取决于应用程序或服务中的访问级别等因素。 模块中的加粗标题表示必填字段。

如果您看到字段或功能上方的映射按钮,可使用它为该字段设置变量和函数。有关详细信息,请参阅将信息从一个模块映射到另一个模块

映射切换

触发器

留意记录

此触发器模块在添加、更新或删除记录时启动方案。

Webhook

选择要用于监视记录的webhook,或创建新的webhook。

要创建新的 Webhook:

  1. 单击添加

  2. 输入webhook的名称。

  3. 选择要用于webhook的连接。

    有关将Jira帐户连接到Workfront Fusion的说明,请参阅本文中的将Jira连接到Workfront Fusion

  4. 选择要软件监视的记录类型:

    • 问题
    • 注释
    • 工作日志
    • 项目
    • Sprint
    • 附件
  5. 选择一个或多个将触发此方案的事件类型。

  6. 输入此模块的Jira查询语言过滤器。

    有关JQL的详细信息,请参阅Atlassian帮助网站上的JQL

  7. 单击 保存 以保存webhook。

操作

将问题添加到冲刺

此操作模块向冲刺添加一个或多个问题。

连接
有关将Jira帐户连接到Workfront Fusion的说明,请参阅本文中的将Jira连接到Workfront Fusion
冲刺ID
输入或映射要添加问题的冲刺(sprint)的Sprint ID。
问题ID
对于要添加到冲刺的每个问题或键,单击 添加项 并输入问题ID或键。 在一个模块中最多可输入50个。

创建记录

此操作模块在Jira中创建新记录。

连接
有关将Jira帐户连接到Workfront Fusion的说明,请参阅本文中的将Jira连接到Workfront Fusion
记录类型

选择要模块创建的记录类型。

  • 附件
  • 注释
  • 问题
  • 项目
  • Sprint
  • 工作日志
  • 用户
  • 展示板
  • 类别
  • 筛选条件
其他字段
填写其他字段。 字段可用,具体取决于所选的记录类型。

自定义API调用

通过此操作模块,您可以对Jira API进行经过身份验证的自定义调用。

选择用于配置此 API 调用的 HTTP 请求方法。有关更多信息,请参阅 HTTP 请求方法

连接
有关将Jira帐户连接到Workfront Fusion的说明,请参阅本文中的将Jira连接到Workfront Fusion
URL
输入相对路径<Instance URL>/rest/api/2/
方法
标头

以标准 JSON 对象的形式添加请求标头。

例如, {"Content-type":"application/json"}

Workfront Fusion会为您添加授权标头。

查询字符串

以标准 JSON 对象的形式添加 API 调用的查询。

例如: {"name":"something-urgent"}

正文

以标准 JSON 对象的形式添加 API 调用的正文内容。

注意:

在 JSON 中使用 if 等条件语句时,需将引号置于条件语句外部。

删除记录

此操作模块删除指定的记录。

连接
有关将Jira帐户连接到Workfront Fusion的说明,请参阅本文中的将Jira连接到Workfront Fusion
记录类型

选择要模块删除的记录类型。

  • 注释
  • 问题
  • 项目
  • Sprint
  • 工作日志
  • 附件
  • 展示板
  • 类别
  • 筛选条件
(记录类型)ID
输入或映射要删除的记录的ID或键。

下载附件

此操作模块下载指定的附件。

连接
有关将Jira帐户连接到Workfront Fusion的说明,请参阅本文中的将Jira连接到Workfront Fusion
ID
输入或映射要下载的附件的ID。

读取记录

此操作模块从Jira中的指定记录读取数据。

连接
有关将Jira帐户连接到Workfront Fusion的说明,请参阅本文中的将Jira连接到Workfront Fusion
记录类型

选择您希望模块读取的Jira记录的类型。

  • 附件
  • 注释
  • 问题
  • 项目
  • Sprint
  • 工作日志
  • 用户
  • 展示板
  • 类别
  • 筛选条件
输出
选择要接收的输出。 根据在“记录类型”字段中选择的记录类型,输出选项可用。
(记录类型)ID
输入或映射您希望模块读取的记录的唯一Jira ID。

更新记录

此操作模块更新现有记录,如问题或项目。

连接
有关将Jira帐户连接到Workfront Fusion的说明,请参阅本文中的将Jira连接到Workfront Fusion
记录类型

选择您希望模块更新的记录类型。 选择记录类型后,该记录类型特有的其他字段将显示在模块中。

  • 注释
  • 问题
  • 项目
  • Sprint
  • 过渡问题
  • 类别
  • 筛选条件
ID或密钥
输入或映射要更新的记录的ID或键。
其他字段
填写其他字段。 字段可用,具体取决于所选的记录类型。

搜索

IMPORTANT
旧版Jira连接器使用的搜索模块可能会导致以下错误:
[410] The requested API has been removed. Please migrate to the /rest/api/3/search/jql API. A full migration guideline is available at https://developer.atlassian.com/changelog/#CHANGE-2046
这是由于Jira方面的弃用。
如果遇到此错误,您可以使用新连接器的搜索模块替换旧版Jira连接器的搜索模块。 请注意,新连接器允许您选择使用的API版本。 创建连接时请务必选择V3。
新Jira连接器中的 API版本选项
请注意:
  • 只有搜索模块受影响。 目前,Fusion连接器使用的其他Jira API端点不受此弃用的影响。

  • 地理转出可能会导致不一致。 Atlassian正在区域范围内推出此更改,这意味着某些Jira云实例可能仍会临时支持旧端点。 这可能会导致环境之间的行为不一致。

搜索记录

此搜索模块在Jira中查找与您指定的搜索查询匹配的对象中的记录。

您可以在场景后续的模块中映射这些信息。

在配置此模块时,会显示以下字段。

连接
有关将Jira帐户连接到Workfront Fusion的说明,请参阅本文中的将Jira连接到Workfront Fusion
记录类型

选择要模块搜索的记录类型。 选择记录类型后,该记录类型特有的其他字段将显示在模块中。

  • 问题
  • 项目
  • 用户
  • Sprint
  • 展示板
  • 工作日志
  • 注释
  • 过渡问题
  • 类别
最大结果
输入或映射您希望模块在每个方案执行周期中检索的最大记录数。
偏移
输入或映射要检索其详细信息的第一个项目的ID。 这是对记录进行分页的一种方式。 如果输入第5000个项目作为抵销,则模块将返回项目5000-9999。
其他字段
填写其他字段。 字段可用,具体取决于所选的记录类型。
recommendation-more-help
7e1891ad-4d59-4355-88ab-a2e62ed7d1a3