> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flashcat.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Jira 同步

> 通过 Jira 同步 Webhook，实现故障与 Jira Issue 的关联。

<Tip>**版本要求**：此功能需要 On-call 专业版及以上订阅。[了解更多](https://flashcat.cloud/flashduty/price/)</Tip>

通过 Jira 同步 Webhook，将 Flashduty 的故障与 Jira Issue 进行关联同步，实现 Flashduty 与 Jira 的联动。

## 前提说明

* 该集成兼容 Jira Cloud 以及 Jira Server 和 Jira Data Center 的 7.x 和 8.x 版本。
* 目前仅支持将故障相关信息或状态单向同步到 Jira 中，Jira 中的信息不会同步到 Flashduty 中。
* 对于 Jira Cloud，请在授权配置的密码处填写 API Token；而对于Jira Server 或 Data Center，则使用您的 Jira 账户登录密码即可。

## 在 Jira Cloud 中获取 API Token （Jira Server 和 Data Center 请跳过）

* 登录 Jira Cloud 后，点击右上角头像，选择 **管理账户**。
* 在 **管理账户** 页面中，选择 **安全性** 选项卡。
* 在 **安全性** 页面中，点击 **创建并管理 API 令牌** 按钮。
* 在 **创建并管理 API 令牌** 弹窗中，填写 API token 名称，并选择过期时间。
* 点击 **创建** 按钮，创建 API token。
* 创建完成后，复制 API token 值，并粘贴到 Flashduty 授权配置中的 API 令牌处。

## 在 Flashduty On-call 中配置集成

### 1. 创建并认证 Jira 集成

<div className="hide">
  在集成中心，选择 **Webhook** ，选择 **Jira 同步** 集成，并填写以下认证信息。
</div>

* **Jira 平台类型**：根据您使用的版本进行选择，如果是 Data Center 版本的请选择私有化（Server） 即可。
* **服务地址**：Cloud 版本请填写您的实际访问地址，例如： [https://your-domain.atlassian.net，Server](https://your-domain.atlassian.net，Server) 版本请填写您的服务访问地址，例如： [https://your-jira-server-url.com。](https://your-jira-server-url.com。)
* **用户名**：您的 Jira 账户名，Cloud 版本请填写您的邮箱，Server 版本请填写您的 Jira 账户名。
* **API令牌/密码**：您的 Jira 账户密码，Cloud 版本请填写 API Token，Server 版本请填写您的 Jira 账户密码。
* 填写完成后，点击 **下一步** 按钮，进行相关配置。

**关于权限**：请确保您的 Jira 账户拥有获取相关项目、事务类型以及创建 Issue 等权限，建议使用管理员账户。

### 2. Jira 集成配置

* **集成名称**：为当前集成定义一个名称。
* **管理团队**：选择管理该集成的团队，只有团队成员可以编辑此集成配置。
* **触发模式**：
  * 自动触发：需要配置相应的条件，Flashduty On-call 会自动将符合条件的故障同步到 Jira 中。
  * 手动触发：需要在故障详情页的更多操作中手动触发 Jira 同步（该集成配置的名称为触发器名称）。
* **项目 ID**：选择需要同步至 Jira 的项目。
* **事务类型**：选择需要同步至 Jira 的事务类型。
* **协作空间**：选择该集成生效的协作空间，只有该协作空间内的故障才可以同步至 Jira 中。
* **严重程度映射**：如果选择的事务类型不支持优先级字段，则无法配置该映射关系。
* **自定义字段映射**：可以选择将故障的某些标签或所有标签以及自定义字段内容同步至 Jira 的字段中（仅支持文本类型的字段）。

### 3. 关于更新

* 已经创建 Issue 的故障，如果您更新了故障的严重程度、状态，Jira 中会自动更新，但 Jira 中的更新不会同步到 Flashduty 中。
* 评论信息会同步到 Jira 中，但 Jira 中更新的内容不会同步到 Flashduty 中。
* 更新故障中的标题、描述、标签等字段的信息，Jira 中不会更新。

### 4. Flashduty 与 Jira 的映射关系

#### 字段映射

| Jira | Flashduty |
| ---- | --------- |
| 摘要   | 标题        |
| 描述   | 描述        |
| 优先级  | 严重程度      |
| 报告人  | 集成配置的用户   |
| 评论   | 评论        |

#### 状态映射

| Jira        | Flashduty |
| ----------- | --------- |
| Todo        | 待处理       |
| In Progress | 处理中       |
| Done        | 已解决       |

### 5. 注意事项

* Flashduty On-call 会按照默认的字段映射以及您配置的自定义字段映射进行同步信息，如果您的 Jira 事务类型中有必选的字段且没有配置映射关系，则会遇到创建 Jira Issue 失败的情况。
* Jira 的 Issue 详情是基于项目 KEY + 编号的格式进行访问的，如果您修改了项目 KEY，可能无法通过 Flashduty 中保存的 Issue 地址进行访问，请谨慎修改项目 KEY。