flashduty-knowledge-base 1.3.4 → 1.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -2
- package/dist/en.d.ts +2 -0
- package/dist/esm/en.js +362 -50
- package/dist/esm/zh.js +372 -61
- package/dist/iife/en.js +347 -35
- package/dist/iife/zh.js +357 -46
- package/dist/zh.d.ts +2 -0
- package/package.json +1 -1
package/dist/iife/zh.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
(function(n){"use strict";const
|
|
1
|
+
(function(n){"use strict";const e={CustomAlert:`---
|
|
2
2
|
title: "标准告警事件集成指引"
|
|
3
3
|
description: "通过标准协议推送自有系统告警事件到 Flashduty,实现告警事件自动化降噪处理。"
|
|
4
4
|
date: "2025-05-19T10:00:00+08:00"
|
|
@@ -5135,13 +5135,20 @@ url: "https://docs.flashcat.cloud/zh/flashduty/lark-integration-guide"
|
|
|
5135
5135
|
|
|
5136
5136
|

|
|
5137
5137
|
|
|
5138
|
-
3. 前往 事件回调 →
|
|
5138
|
+
3. 前往 事件回调 → **事件配置** 页面,配置 \`订阅方式\`(内容为集成详情中的 **消息卡片请求网址**)。然后,添加以下两项事件:
|
|
5139
5139
|
|
|
5140
|
-
- \`im.message.receive_v1\`
|
|
5141
5140
|
- \`im.chat.disbanded_v1\`
|
|
5141
|
+
- \`im.message.receive_v1\`
|
|
5142
5142
|
|
|
5143
5143
|

|
|
5144
5144
|
|
|
5145
|
+
4. 前往 事件回调 → **回调配置** 页面,配置 \`订阅方式\`(内容为集成详情中的 **消息卡片请求网址**)。然后,订阅以下两项回调:
|
|
5146
|
+
|
|
5147
|
+
- \`card.action.trigger\`
|
|
5148
|
+
- \`card.action.trigger_v1\`
|
|
5149
|
+
|
|
5150
|
+

|
|
5151
|
+
|
|
5145
5152
|
### 2. 添加重定向 URL 到飞书应用
|
|
5146
5153
|
|
|
5147
5154
|
进入 **安全设置** 页面,配置 \`重定向URL\`,内容为集成详情中的 **重定向 URL**。
|
|
@@ -5156,7 +5163,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/lark-integration-guide"
|
|
|
5156
5163
|
|
|
5157
5164
|
- \`im:chat\`:获取与更新群组信息
|
|
5158
5165
|
- \`im:message\`:获取与发送单聊、群组消息
|
|
5159
|
-
- \`contact:user.id:readonly\`:通过手机号或邮箱获取用户 ID
|
|
5166
|
+
- \`contact:user.id:readonly\`:通过手机号或邮箱获取用户 ID <span id="war-room-scope"></span>
|
|
5160
5167
|
|
|
5161
5168
|

|
|
5162
5169
|
|
|
@@ -5437,7 +5444,6 @@ url: "https://docs.flashcat.cloud/zh/flashduty/dingtalk-integration-guide"
|
|
|
5437
5444
|

|
|
5438
5445
|

|
|
5439
5446
|
|
|
5440
|
-
|
|
5441
5447
|
- 回到分派策略配置页面,刷新后重新选择群聊列表。
|
|
5442
5448
|
- 如果仍然无法获取群聊列表,请尝试在群内卸载酷应用后,重试以上步骤。如果问题依旧,请联系客户或专属技术支持。
|
|
5443
5449
|
|
|
@@ -5549,6 +5555,10 @@ url: "https://docs.flashcat.cloud/zh/flashduty/wecom-integration-guide"
|
|
|
5549
5555
|
|
|
5550
5556
|

|
|
5551
5557
|
|
|
5558
|
+
10. 配置可信 IP 地址:47.94.95.118; 123.56.8.183; 47.94.193.81; 1.13.19.96
|
|
5559
|
+
|
|
5560
|
+

|
|
5561
|
+
|
|
5552
5562
|
## 三、配置作战室
|
|
5553
5563
|
|
|
5554
5564
|
---
|
|
@@ -5681,7 +5691,7 @@ Microsoft Teams 集成现处于 Beta 阶段,在关联前您需要先完成以
|
|
|
5681
5691
|
#### 查看是否添加成功
|
|
5682
5692
|
等待几分钟,组织成员即可在 +Apps → **Built for your org** 找到此应用。
|
|
5683
5693
|
|
|
5684
|
-

|
|
5685
5695
|
|
|
5686
5696
|
### 3. 更新应用
|
|
5687
5697
|
::: caution
|
|
@@ -5702,21 +5712,22 @@ Microsoft Teams 集成现处于 Beta 阶段,在关联前您需要先完成以
|
|
|
5702
5712
|
---
|
|
5703
5713
|
### 1. 添加 Flashduty 应用
|
|
5704
5714
|
1. 在应用市场中找到 Flashduty 应用。
|
|
5705
|
-
> 如无应用,请联系您的 Microsoft Teams 组织管理员。
|
|
5715
|
+
> 如无应用,请联系您的 Microsoft Teams 组织管理员。
|
|
5716
|
+
|
|
5717
|
+

|
|
5706
5718
|
|
|
5707
|
-

|
|
5708
5719
|
|
|
5709
5720
|
2. 将应用添加到目标 Team。
|
|
5710
5721
|
::: caution
|
|
5711
5722
|
此步骤必须选择目标 Team 的 General Channel,否则将无法发送故障到 Team 中。
|
|
5712
5723
|
:::
|
|
5713
5724
|
|
|
5714
|
-

|
|
5715
5726
|
|
|
5716
5727
|
### 2. 发送关联指令
|
|
5717
5728
|
在 Team 中 @Flashduty 并发送指令 \`linkTeam {ID}\`,然后点击 **立即关联**。
|
|
5718
5729
|
|
|
5719
|
-

|
|
5730
|
+

|
|
5720
5731
|
|
|
5721
5732
|
## 三、关联群聊 (Chat)
|
|
5722
5733
|
---
|
|
@@ -5724,11 +5735,11 @@ Microsoft Teams 集成现处于 Beta 阶段,在关联前您需要先完成以
|
|
|
5724
5735
|
1. 在应用市场中找到 Flashduty 应用。
|
|
5725
5736
|
> 如无应用,请联系您的 Microsoft Teams 组织管理员。
|
|
5726
5737
|
|
|
5727
|
-

|
|
5728
5739
|
|
|
5729
5740
|
2. 将应用添加到目标 Chat。
|
|
5730
5741
|
|
|
5731
|
-

|
|
5732
5743
|
|
|
5733
5744
|
### 2. 发送关联指令
|
|
5734
5745
|
在 Chat 中 @Flashduty 并发送指令 \`linkChat {ID} {ChatName}\`,然后点击 **立即关联**。
|
|
@@ -5741,7 +5752,7 @@ Microsoft Teams 集成现处于 Beta 阶段,在关联前您需要先完成以
|
|
|
5741
5752
|
1. 在应用市场中找到 Flashduty 应用。
|
|
5742
5753
|
> 如无应用,请联系您的 Microsoft Teams 组织管理员。
|
|
5743
5754
|
|
|
5744
|
-

|
|
5745
5756
|
|
|
5746
5757
|
2. 点击 **打开应用**。
|
|
5747
5758
|
|
|
@@ -8375,6 +8386,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/service-now-sync"
|
|
|
8375
8386
|
## 在 ServiceNow
|
|
8376
8387
|
|
|
8377
8388
|
### 创建用户
|
|
8389
|
+
需创建一个用户以连接 ServiceNow 实例,用于 Incident 的同步与更新。如果已有可用用户,请直接跳过本步骤。
|
|
8378
8390
|
|
|
8379
8391
|
1. 登录 ServiceNow 实例控制台,通过选择 \`ALL\` ,输入 \`USERS\` 选择\`Organization\`-\`Users\` 。
|
|
8380
8392
|
2. 点击 \`New\` 新建用户。
|
|
@@ -8382,18 +8394,24 @@ url: "https://docs.flashcat.cloud/zh/flashduty/service-now-sync"
|
|
|
8382
8394
|
4. \`Password needs reset\` 和 \`Web service access only\` 以及 \`Internal Integration User\` 保持取消勾选状态。
|
|
8383
8395
|
5. 提交保存。
|
|
8384
8396
|
|
|
8385
|
-
|
|
8397
|
+

|
|
8386
8398
|
|
|
8387
8399
|
### 配置用户
|
|
8388
8400
|
|
|
8389
|
-
|
|
8401
|
+
> **用户角色说明**
|
|
8402
|
+
> **itil:** 该角色在 Flashduty 中的主要使用范围仅限于在同步 ServiceNow Incident 时,进行获取、创建、更新 ServiceNow Incident,不涉及其他任何操作。
|
|
8403
|
+
>
|
|
8404
|
+
> **personalize_dictionary:** 该角色在 Flashduty 中的主要使用范围仅限于 ServiceNow Incident Table 的字段获取,不涉及其他任何操作。
|
|
8405
|
+
>
|
|
8406
|
+
> 关于以上两个角色更多权限范围,可以参考 ServiceNow [官方文档](https://www.servicenow.com/docs/bundle/washingtondc-platform-administration/page/administer/roles/reference/r_BaseSystemRoles.html#d130465e3182)
|
|
8390
8407
|
|
|
8391
8408
|
1. 在用户列表页面,找到新创建的 \`flashduty\` 用户并进到配置页面。
|
|
8392
8409
|
2. 在编辑页面中,点击 \`Set Password\` 设置一个密码。
|
|
8393
8410
|
3. 点击 \`Roles\` 添加 **personalize_dictionary 和 itil** 角色(如果不需要配置自定义字段映射关系,可以不授予 personalize_dictionary 权限)。
|
|
8394
8411
|
4. 点击 \`Update\` 更新配置。
|
|
8395
8412
|
|
|
8396
|
-
|
|
8413
|
+

|
|
8414
|
+

|
|
8397
8415
|
|
|
8398
8416
|
## 在 Flashduty
|
|
8399
8417
|
|
|
@@ -8401,18 +8419,31 @@ url: "https://docs.flashcat.cloud/zh/flashduty/service-now-sync"
|
|
|
8401
8419
|
|
|
8402
8420
|
将以上配置的用户名/密码以及实例名称输入到左侧集成信息中并点击下一步进行配置。
|
|
8403
8421
|
|
|
8404
|
-
|
|
8405
|
-
|
|
8406
|
-
|
|
8407
|
-
|
|
8408
|
-
|
|
8409
|
-
|
|
8410
|
-
|
|
8411
|
-
-
|
|
8412
|
-
|
|
8413
|
-
|
|
8414
|
-
-
|
|
8415
|
-
-
|
|
8422
|
+
1. **集成名称:** 为当前集成定义一个名称。
|
|
8423
|
+
2. **管理团队:** 当选择管理团队后,只有该团队成员以及租户管理员可以编辑此集成。
|
|
8424
|
+
3. **协作空间**:选择该集成生效的协作空间,。
|
|
8425
|
+
4. **同步方向:**
|
|
8426
|
+
|
|
8427
|
+
- To_ServiceNow:将 Flashduty 的故障同步至 ServiceNow。
|
|
8428
|
+
- From_ServiceNow:将 ServiceNow 的 Incident 同步至 Flashduty。
|
|
8429
|
+
- Two-way:Flashduty 和 ServiceNow 互相同步。
|
|
8430
|
+
|
|
8431
|
+
5. **触发模式**:
|
|
8432
|
+
- 自动触发:需要配置相应的条件,Flashduty 会自动将符合条件的故障同步到 ServiceNow 中。
|
|
8433
|
+
- 手动触发:需要在故障详情页的更多操作中手动触发 ServiceNow 同步(该集成配置的名称为触发器名称)。
|
|
8434
|
+
|
|
8435
|
+
6. **严重程度映射**:
|
|
8436
|
+
|
|
8437
|
+
- ServiceNow 的 Priority 是由 Impact 和 Urgency 的值共同决定的,所以可以参考 ServiceNow 的 \`Priority Lookup Rules\` 进行配置。
|
|
8438
|
+
- 当 ServiceNow Incident 的 Urgency 发生变化时,才会触发 Flashduty 故障严重程度的更新。
|
|
8439
|
+
- 由于 Flashduty 在遵循最小权限的情况下,无法获取 ServiceNow 的 Impact 和 Urgency 列表,所以只提供了默认值,如果您需要自定义映射关系时,可以联系技术支持。
|
|
8440
|
+
|
|
8441
|
+
7. **自定义字段映射**:可以将故障中的标签或自定义字段,映射到 ServiceNow 工单中的对应文本字段,实现信息自动填充。该功能支持将常见上下文信息(如服务名、实例地址、指标名称等)同步至 ServiceNow,便于后续排查与跟踪。
|
|
8442
|
+
|
|
8443
|
+
- 仅支持目标为单行文本或多行文本类型的字段。
|
|
8444
|
+
- 支持从故障标签(如 service、instance)或自定义属性中提取值。
|
|
8445
|
+
- 若源字段为空,目标字段也将保持为空,不会覆盖原有内容。
|
|
8446
|
+
- 映射配置在集成设置中统一管理,无需每次手动填写。
|
|
8416
8447
|
|
|
8417
8448
|
## 在 ServiceNow
|
|
8418
8449
|
|
|
@@ -8453,7 +8484,7 @@ url: "https://docs.flashcat.cloud/zh/flashduty/service-now-sync"
|
|
|
8453
8484
|
2. 点击 \`New\` 新建 Script Include。
|
|
8454
8485
|
3. \`Name\` 输入:**IncidentWebhookHelper** , \`Accessible from\` 选择 **All application scopes**。
|
|
8455
8486
|
4. \`Client callable\` 和 \`Active\` 保持勾选状态。
|
|
8456
|
-
5. \`Script\` 输入以下内容,其中 **request.setEndpoint**
|
|
8487
|
+
5. \`Script\` 输入以下内容,其中 **request.setEndpoint** 中需要补充集成的<span class='integration_url'>推送地址</span>:
|
|
8457
8488
|
|
|
8458
8489
|
<div class="hide">
|
|
8459
8490
|
|
|
@@ -8547,7 +8578,7 @@ IncidentWebhookHelper.prototype = {
|
|
|
8547
8578
|
3. \`Name\` 输入:**Send To Flashduty** , \`Table\` 选择 **Incident**。
|
|
8548
8579
|
4. \`Advanced\` 和 \`Active\` 保持勾选状态。
|
|
8549
8580
|
5. 在 \`When to run\` 区域中,\`When\` 选择 **async**,\`Insert\` 和 \`Upsert\` 保持勾选状态,其他按需配置。
|
|
8550
|
-
6. 在 \`Advanced\` 区域中,\`Script\` 填写以下内容,其中 **endpoint**
|
|
8581
|
+
6. 在 \`Advanced\` 区域中,\`Script\` 填写以下内容,其中 **endpoint** 中需要补充集成的<span class='integration_url'>推送地址</span>
|
|
8551
8582
|
|
|
8552
8583
|
<div class="hide">
|
|
8553
8584
|
|
|
@@ -8618,23 +8649,23 @@ IncidentWebhookHelper.prototype = {
|
|
|
8618
8649
|
|
|
8619
8650
|
| ServiceNow | Flashduty | 备注 |
|
|
8620
8651
|
| ------------------- | ------------- | ---- |
|
|
8621
|
-
| Short_description | Title |
|
|
8622
|
-
| Description | Description |
|
|
8623
|
-
| Additional comments | Comments |
|
|
8624
|
-
| State | Progress |
|
|
8625
|
-
| Urgency | Severity |
|
|
8626
|
-
| Others | Custom Fields |
|
|
8652
|
+
| Short_description | Title | 标题 |
|
|
8653
|
+
| Description | Description | 描述信息 |
|
|
8654
|
+
| Additional comments | Comments | 评论 |
|
|
8655
|
+
| State | Progress | 状态 |
|
|
8656
|
+
| Urgency | Severity | 严重程度 |
|
|
8657
|
+
| Others | Custom Fields | 自定义字段 |
|
|
8627
8658
|
|
|
8628
8659
|
### 状态映射
|
|
8629
8660
|
|
|
8630
8661
|
| ServiceNow | Flashduty | 备注 |
|
|
8631
8662
|
| ----------- | ---------- | --------------- |
|
|
8632
|
-
| New | Trigger |
|
|
8633
|
-
| In Progress | Processing |
|
|
8663
|
+
| New | Trigger | 触发 |
|
|
8664
|
+
| In Progress | Processing | 待处理 |
|
|
8634
8665
|
| On Hold | Snoozed | 默认暂缓 2 小时 |
|
|
8635
|
-
| Resolved | CLosed |
|
|
8636
|
-
| Closed | CLosed |
|
|
8637
|
-
| Canceled | CLosed |
|
|
8666
|
+
| Resolved | CLosed | 关闭 |
|
|
8667
|
+
| Closed | CLosed | 关闭 |
|
|
8668
|
+
| Canceled | CLosed | 关闭 |
|
|
8638
8669
|
|
|
8639
8670
|
### 优先级映射
|
|
8640
8671
|
|
|
@@ -8642,10 +8673,21 @@ IncidentWebhookHelper.prototype = {
|
|
|
8642
8673
|
|
|
8643
8674
|
| ServiceNow | Flashduty | 备注 |
|
|
8644
8675
|
| ---------- | --------- | ---- |
|
|
8645
|
-
| Low | Info |
|
|
8646
|
-
| Medium | Warning |
|
|
8647
|
-
| High | Critical |
|
|
8648
|
-
|
|
8676
|
+
| Low | Info | 提示 |
|
|
8677
|
+
| Medium | Warning | 警告 |
|
|
8678
|
+
| High | Critical | 灾难 |
|
|
8679
|
+
|
|
8680
|
+
## 常见问题
|
|
8681
|
+
|
|
8682
|
+
<details>
|
|
8683
|
+
<summary>新建 ServiceNow 用户时,UserID 是否可以自定义?</summary>
|
|
8684
|
+
可以自定义,文档指引中使用 flashduty 作为 UserID,是为了更好的标识该用户用于 Incident 同步
|
|
8685
|
+
</details>
|
|
8686
|
+
|
|
8687
|
+
<details>
|
|
8688
|
+
<summary>配置集成时提示 401 错误 </summary>
|
|
8689
|
+
提示 401 一般是密码错误导致的,请检查密码是否正确,或者重新设置新的密码(在配置密码时,请勿勾选 Password needs reset 选项)
|
|
8690
|
+
</details>`,Monit:`---
|
|
8649
8691
|
title: "Monit 告警集成"
|
|
8650
8692
|
description: "Flashduty Monit 告警集成,Monit 服务通过此集成上报告警"
|
|
8651
8693
|
date: "2025-05-19T10:00:00+08:00"
|
|
@@ -8753,4 +8795,273 @@ url: "https://docs.flashcat.cloud/zh/flashduty/volcengine-detect-integration-gui
|
|
|
8753
8795
|
|
|
8754
8796
|
</div>
|
|
8755
8797
|
|
|
8756
|
-
|
|
8798
|
+
`,WecomAlert:`---
|
|
8799
|
+
title: "企微告警集成"
|
|
8800
|
+
description: "在 Flashduty 生成唯一的企微机器人地址,通过企微的方式将告警的发生与恢复同步到 Flashduty"
|
|
8801
|
+
date: "2025-05-19T10:00:00+08:00"
|
|
8802
|
+
url: "https://docs.flashcat.cloud/zh/flashduty/wecom-alert-integration-guide"
|
|
8803
|
+
---
|
|
8804
|
+
|
|
8805
|
+
在 Flashduty 生成唯一的企微机器人告警地址,通过企微机器人告警地址将告警的发生与恢复同步到 Flashduty。
|
|
8806
|
+
|
|
8807
|
+
<div class="hide">
|
|
8808
|
+
|
|
8809
|
+
## 操作步骤
|
|
8810
|
+
---
|
|
8811
|
+
|
|
8812
|
+
### 创建企微告警集成
|
|
8813
|
+
|
|
8814
|
+
您可通过以下2种方式,获取一个企微机器人告警集成地址,任选其一即可。
|
|
8815
|
+
|
|
8816
|
+
#### 使用专属集成
|
|
8817
|
+
|
|
8818
|
+
当您不需要将告警事件路由到不同的协作空间,优先选择此方式,更简单。
|
|
8819
|
+
|
|
8820
|
+
<details>
|
|
8821
|
+
<summary>展开</summary>
|
|
8822
|
+
|
|
8823
|
+
1. 进入 Flashduty 控制台,选择 **协作空间**,进入某个空间的详情页面
|
|
8824
|
+
2. 选择 **集成数据** tab,点击 **添加一个集成**,进入添加集成页面
|
|
8825
|
+
3. 选择 **企微告警** 集成,点击 **保存**,生成卡片。
|
|
8826
|
+
4. 点击生成的卡片,可以查看到 **企微告警集成地址**,复制备用,完成。
|
|
8827
|
+
|
|
8828
|
+
</details>
|
|
8829
|
+
|
|
8830
|
+
#### 使用共享集成
|
|
8831
|
+
|
|
8832
|
+
当您需要根据告警事件的 Payload 信息,将告警路由到不同的协作空间,优先选择此方式。
|
|
8833
|
+
|
|
8834
|
+
<details>
|
|
8835
|
+
<summary>展开</summary>
|
|
8836
|
+
|
|
8837
|
+
1. 进入 Flashduty 控制台,选择 **集成中心=>告警事件**,进入集成选择页面。
|
|
8838
|
+
2. 选择 **企微告警** 集成:
|
|
8839
|
+
- **集成名称**:为当前集成定义一个名称。
|
|
8840
|
+
- **消息类型**:选择企微告警消息类型,目前仅支持 Text、Markdown。
|
|
8841
|
+
- **推送模式**:选择企微告警在何种情况下触发或恢复告警。
|
|
8842
|
+
3. 复制当前页面的 **企微告警集成地址** 备用。
|
|
8843
|
+
4. 配置默认路由,并选择对应的协作空间(集成创建后可以前往 \`路由\` 进行更多路由规则的配置)。
|
|
8844
|
+
5. 完成。
|
|
8845
|
+
|
|
8846
|
+
</details>
|
|
8847
|
+
</div>
|
|
8848
|
+
|
|
8849
|
+
### 定制企微告警集成
|
|
8850
|
+
|
|
8851
|
+
#### 企微告警集成地址
|
|
8852
|
+
|
|
8853
|
+
系统会帮您生成一个唯一的企微告警集成地址,该地址兼容企微机器人消息的协议,在有的平台仅支持企微机器人通道时,您可以使用该地址来接收对应的消息。
|
|
8854
|
+
|
|
8855
|
+
#### 推送模式
|
|
8856
|
+
|
|
8857
|
+
默认系统总是为每一条消息创建新的告警,但您可以切换模式为:
|
|
8858
|
+
|
|
8859
|
+
**根据规则触发或关闭告警**:该模式下,每当接收到新消息,系统会根据您的规则进行消息匹配,匹配到的消息按照规则去触发新告警或关闭已有告警。
|
|
8860
|
+
|
|
8861
|
+
- 您至少需要填写一条**触发**规则;
|
|
8862
|
+
- 您必须设置 Alert Key 的正则提取规则。系统使用该字段来查找历史告警,以便对其进行更新或关闭;**如果正则提取失败,系统将随机来生成 Alert Key**,以确保告警不会因为配置错误而丢失;
|
|
8863
|
+
- 您可以选择,当所有的规则都不匹配时,是否丢弃消息。
|
|
8864
|
+
|
|
8865
|
+
配置示例:
|
|
8866
|
+
|
|
8867
|
+
- 接收所有消息,当消息内容中包含 **RESOVED** 字样时,关闭告警,否则触发新告警;
|
|
8868
|
+
- Alert Key 从消息内容中提取,规则为 **/(.\\*)/**。
|
|
8869
|
+
|
|
8870
|
+
|
|
8871
|
+
### 注意事项
|
|
8872
|
+
- 企微告警集成地址仅支持接收 Text、Markdown 消息类型,其他消息无法接收。
|
|
8873
|
+
- Flashduty 会生成默认告警标题: “企微机器人告警”,如果您需要更改标题,可以通过[告警处理 Pipeline](https://docs.flashcat.cloud/zh/flashduty/alert-pipelines) 来自定义标题。
|
|
8874
|
+
|
|
8875
|
+
## 严重程度映射关系
|
|
8876
|
+
---
|
|
8877
|
+
|
|
8878
|
+
当前企微告警集成推送到 Flashduty 的严重程度均为Warning,但您可以通过[告警处理 Pipeline](https://docs.flashcat.cloud/zh/flashduty/alert-pipelines) 来自定义严重程度。`,ServiceDeskPlusSync:`---
|
|
8879
|
+
title: "ServiceDesk Plus 同步"
|
|
8880
|
+
description: "通过 ServiceDesk Plus 同步 Webhook,实现故障与 ServiceDesk Plus request 的关联。"
|
|
8881
|
+
date: "2025-05-19T10:00:00+08:00"
|
|
8882
|
+
url: "https://docs.flashcat.cloud/zh/flashduty/servicedesk-plus-sync"
|
|
8883
|
+
---
|
|
8884
|
+
|
|
8885
|
+
通过 ServiceDesk Plus 同步 Webhook,将 Flashduty 的故障与 ServiceDesk Plus request 进行关联同步,实现 Flashduty 与 ServiceDesk Plus 的联动。
|
|
8886
|
+
|
|
8887
|
+
本集成基于 ServiceDesk Plus 官方提供的 v3 API 协议,兼容其接口规范。若您使用私有化部署版本,请确认其 API 是否支持 v3 版本。此外,ServiceDesk Plus 的云版本与私有化版本在授权配置方式上存在差异,具体配置请参考相关文档说明。
|
|
8888
|
+
|
|
8889
|
+
- [云版本](#云版本)
|
|
8890
|
+
- [私有化](#私有化)
|
|
8891
|
+
|
|
8892
|
+
在配置此集成时,如果您选择的同步方向是 From_ServiceDesk_Plus,您可以直接跳过授权相关配置,直接参考[配置同步](#配置同步)即可。
|
|
8893
|
+
|
|
8894
|
+
## 云版本 <span id="云版本"></span>
|
|
8895
|
+
|
|
8896
|
+
### 在 ServiceDesk Plus
|
|
8897
|
+
#### 步骤1 创建授权应用
|
|
8898
|
+
请根据您的 ServiceDesk Plus 服务区域选择对应的 Developer Console 地址:[Data Centres](https://www.manageengine.com/products/service-desk/sdpod-v3-api/getting-started/data-centers.html)
|
|
8899
|
+
|
|
8900
|
+
1. 登录 Developer Console,选择 \`Self Client\` 类型的 Client 并创建。
|
|
8901
|
+
2. 点击 \`Generate Code\`,在 \`Scope\` 中填写:**SDPOnDemand.requests.ALL,SDPOnDemand.setup.READ,SDPOnDemand.custommodule.READ**。权限范围参考[官方文档](https://www.manageengine.com/products/service-desk/sdpod-v3-api/getting-started/oauth-2.0.html#scopes)。
|
|
8902
|
+
|
|
8903
|
+
3. \`Time Duration\` 选择最大的 **10 minutes**,\`Scope Description\` 填写内容可自定义,比如: Flashduty 同步使用,并创建。
|
|
8904
|
+
4. 将生成的 **Code** 和 **Client ID** 以及 **Client Secret** 复制备用。
|
|
8905
|
+
|
|
8906
|
+

|
|
8907
|
+

|
|
8908
|
+
|
|
8909
|
+
###### 注意:Code 的有效期只有 10 分钟且只能使用一次,所以在获取到 Code 后,请在有效期内尽快完成[集成授权](#集成授权)
|
|
8910
|
+
|
|
8911
|
+
### 在 Flashduty
|
|
8912
|
+
#### 步骤2 集成授权 <span id="集成授权"></span>
|
|
8913
|
+
请根据您的 ServiceDesk Plus 服务区域选择对应的 API Endpoint 和 Accounts Server URL:[Data Centres](https://www.manageengine.com/products/service-desk/sdpod-v3-api/getting-started/data-centers.html)
|
|
8914
|
+
|
|
8915
|
+
1. \`平台类型\` 选择**云版本**,填写\`API Endpoint\` 和 \`Accounts Server URL\`。
|
|
8916
|
+
2. 将**创建授权应用**步骤中生成的 \`Code\` 和 \`Client ID\` 以及 \`Client Secret\` 填写到对应的编辑框并点击下一步完成[集成配置](#集成配置)(如果报错请重新获取 Code,或联系技术支持排查问题)。
|
|
8917
|
+
|
|
8918
|
+
## 私有化版本 <span id="私有化"></span>
|
|
8919
|
+
### 在 ServiceDesk Plus
|
|
8920
|
+
#### 步骤1 生成 API 密钥
|
|
8921
|
+
1. 登录 ServiceDesk Plus 控制台,在个人中心点击 \`生成 API 密钥\`。
|
|
8922
|
+
2. \`令牌过期时间\` 选择 **永不过期**,将生成的 **Token** 复制备用,并完成[集成授权](#私有化版本集成授权)。
|
|
8923
|
+
|
|
8924
|
+
###### 注意:生成 API 密钥的用户需要具备相关权限,比如创建/更新请求、获取模版/优先级/自定义字段列表等权限,如果权限不足,会导致无法完成集成配置,建议使用管理员角色生成。
|
|
8925
|
+
|
|
8926
|
+
### 在 Flashduty
|
|
8927
|
+
#### 步骤2 集成授权 <span id="私有化版本集成授权"></span>
|
|
8928
|
+
1. \`平台类型\` 选择**私有化版本**,填写\`API Endpoint\`。
|
|
8929
|
+
2. 将生成的 **Token** 填写到对应的编辑框并点击下一步完成[集成配置](#集成配置)。
|
|
8930
|
+
|
|
8931
|
+
|
|
8932
|
+
## 通用配置
|
|
8933
|
+
|
|
8934
|
+
### 在 Flashduty
|
|
8935
|
+
#### 步骤1 集成配置 <span id="集成配置"></span>
|
|
8936
|
+
|
|
8937
|
+
1. **集成名称:** 为当前集成定义一个名称。
|
|
8938
|
+
2. **管理团队:** 当选择管理团队后,只有该团队成员以及租户管理员可以编辑此集成。
|
|
8939
|
+
3. **同步方向:**
|
|
8940
|
+
|
|
8941
|
+
- To_ServiceDesk_Plus:将 Flashduty 的故障同步至 ServiceDesk Plus。
|
|
8942
|
+
- From_ServiceDesk_Plus:将 ServiceDesk Plus 的 Request 同步至 Flashduty。
|
|
8943
|
+
- Two-way:Flashduty 和 ServiceDesk Plus 互相同步。
|
|
8944
|
+
|
|
8945
|
+
4. **触发模式**:
|
|
8946
|
+
- 自动触发:需要配置相应的条件,Flashduty 会自动将符合条件的故障同步到 ServiceDesk Plus 中。
|
|
8947
|
+
- 手动触发:需要在故障详情页的更多操作中手动触发 ServiceDesk Plus 同步(该集成配置的名称为触发器名称)。
|
|
8948
|
+
|
|
8949
|
+
5. **协作空间**:选择该集成生效的协作空间。
|
|
8950
|
+
6. **请求模版**:选择创建 request 时使用的模版。
|
|
8951
|
+
7. **严重程度映射**:Flashduty 的严重程度与 ServiceDesk Plus 优先级的映射关系,默认映射关系,请参考[优先级映射](#优先级映射)。
|
|
8952
|
+
8. **自定义字段映射**:可以将故障中的标签或自定义字段,映射到 ServiceDesk Plus 工单中的对应文本字段,实现信息自动填充。该功能支持将常见上下文信息(如服务名、实例地址、指标名称等)同步至 ServiceNow,便于后续排查与跟踪。
|
|
8953
|
+
- 仅支持目标为单行文本或多行文本类型的字段。
|
|
8954
|
+
- 支持从故障标签(如 service、instance)或自定义属性中提取值。
|
|
8955
|
+
- 若源字段为空,目标字段也将保持为空,不会覆盖原有内容。
|
|
8956
|
+
- 映射配置在集成设置中统一管理,无需每次手动填写。
|
|
8957
|
+
|
|
8958
|
+
9. **指派对象映射**:当 Flashduty 的故障同步至 ServiceDesk Plus 并需要自动指派到 Technician 或 Group 时,可以获取 Flashduty 故障标签的值作为指派对象(如果对应的指派对象不存在,会导致同步失败,请谨慎选择)。
|
|
8959
|
+
|
|
8960
|
+
10. 点击\`保存\`完成配置。
|
|
8961
|
+
|
|
8962
|
+
### 在 ServiceDesk Plus
|
|
8963
|
+
#### 步骤2 创建 Requester
|
|
8964
|
+
当 Flashduty 的故障同步到 ServiceDesk Plus 时,系统自动设置的 Requester
|
|
8965
|
+
|
|
8966
|
+
1. 登录 ServiceDesk Plus 控制台,找到 \`Setup\` 配置页面。
|
|
8967
|
+
2. 选择 \`Users & Permissions\` 之后,进入到 \`Users\` 创建页面,选择 \`New Requester\`。
|
|
8968
|
+
3. \`Name (Display Name)\` 和 \`First Name\` 填写 **flashduty**,\`Email\` 填写 **flashduty-sync@flashcat.cloud** 。
|
|
8969
|
+
4. 其他可按需设置,点击 \`Save\` 保存配置。
|
|
8970
|
+
|
|
8971
|
+

|
|
8972
|
+
|
|
8973
|
+
#### 步骤3 配置同步 <span id="配置同步"></span>
|
|
8974
|
+
要实现 ServiceDesk Plus 的 Request 向 Flashduty 的同步,请参考此配置项。**注意:** 不同版本的路径可能略有不同,但配置方法相同。
|
|
8975
|
+
##### 创建 Webhook
|
|
8976
|
+
1. 登录 ServiceDesk Plus 控制台,找到 \`Setup\` 配置页面。
|
|
8977
|
+
2. 选择 \`Automation\` 之后,进入到 \`Custom Actions\` 页面,并选择 \`Webhooks\`。
|
|
8978
|
+
3. 点击 \`New Webhook\`,在编辑页面中 \`Webhook Name\` 填写 **to_Flashduty**。
|
|
8979
|
+
4. \`URL\` 填写集成的<span class='integration_url'>推送地址</span>。
|
|
8980
|
+
5. \`Applies to\` 选择 **Requsts**,\`Method\` 选择 **POST**,\`Headers\` 中填写 **Content-Type application/json**。
|
|
8981
|
+
6. \`Message Body\` 的 Type 选择 **JSON**,并填写以下内容:
|
|
8982
|
+
|
|
8983
|
+
\`\`\`
|
|
8984
|
+
# 云版本
|
|
8985
|
+
{
|
|
8986
|
+
"subject":"\${subject}",
|
|
8987
|
+
"request_id":"\${id}",
|
|
8988
|
+
"description":"\${udf_fields.txt_destination}",
|
|
8989
|
+
"priority":"\${priority.name}",
|
|
8990
|
+
"status":"\${status.name}",
|
|
8991
|
+
"txt_test_field":"\${udf_fields.txt_test_field}"
|
|
8992
|
+
|
|
8993
|
+
}
|
|
8994
|
+
\`\`\`
|
|
8995
|
+
|
|
8996
|
+
\`\`\`
|
|
8997
|
+
# 私有化版本
|
|
8998
|
+
{
|
|
8999
|
+
"suject":"\${{request.subject}}",
|
|
9000
|
+
"request_id":"\${{request.id}}",
|
|
9001
|
+
"description":"\${{request.description}}",
|
|
9002
|
+
"status":"\${{request.status.name}}",
|
|
9003
|
+
"priority":"\${{request.priority.name}}",
|
|
9004
|
+
"udf_sline_301":"\${{request.udf_fields.udf_sline_301}}"
|
|
9005
|
+
}
|
|
9006
|
+
|
|
9007
|
+
\`\`\`
|
|
9008
|
+
7. 点击 \`Save\` 完成配置。
|
|
9009
|
+
|
|
9010
|
+

|
|
9011
|
+
|
|
9012
|
+
##### 创建触发器
|
|
9013
|
+
1. 登录 ServiceDesk Plus 控制台,找到 \`Setup\` 配置页面。
|
|
9014
|
+
2. 选择 \`Automation\` 之后,进入到 \`Triggers\` 页面,并选择 \`Request\`。
|
|
9015
|
+
3. 点击 \`New Trigger\`,在编辑页面中 \`Name\` 填写 **to_Flashduty**。
|
|
9016
|
+
4. \`Trigger applies to\` 选择 **Request**,\`Execute when a request is\` 勾选 **Create 和 Edited**。
|
|
9017
|
+
5. \`Execute during\` 选择 **Any time**,并勾选 **Enable Trigger**。
|
|
9018
|
+
6. \`Conditions\` 选择 \`Without condition\` 或按实际需求配置。
|
|
9019
|
+
7. 在 \`Actions\` 中选择 **Webhook** 并勾选 **to_Flashduty** 通道。
|
|
9020
|
+
8. 点击 \`Save\` 完成配置。
|
|
9021
|
+
|
|
9022
|
+

|
|
9023
|
+
|
|
9024
|
+
|
|
9025
|
+
## 同步信息映射关系
|
|
9026
|
+
|
|
9027
|
+
### 表单字段
|
|
9028
|
+
|
|
9029
|
+
| ServiceDesk Plus | Flashduty | 备注 |
|
|
9030
|
+
| ------------------- | ------------- | ---- |
|
|
9031
|
+
| Subjeck | Title | | 标题
|
|
9032
|
+
| Description | Description | 描述信息 |
|
|
9033
|
+
| Status | Progress | 状态 |
|
|
9034
|
+
| Priority | Severity | 严重程度 |
|
|
9035
|
+
| Others | Custom Fields | 自定义字段 |
|
|
9036
|
+
|
|
9037
|
+
### 状态映射
|
|
9038
|
+
|
|
9039
|
+
| ServiceDesk Plus | Flashduty | 备注 |
|
|
9040
|
+
| ----------- | ---------- | --------------- |
|
|
9041
|
+
| Open | Trigger | 触发 |
|
|
9042
|
+
| In Progress | Processing | 待处理 |
|
|
9043
|
+
| Assigned | Processing | 待处理 |
|
|
9044
|
+
| Pending Verification | Processing | 待处理 |
|
|
9045
|
+
| Staging | Processing | 待处理 |
|
|
9046
|
+
| On Hold | Snoozed | 默认暂缓 2 小时 |
|
|
9047
|
+
| Resolved | CLosed | 关闭 |
|
|
9048
|
+
| Closed | CLosed | 关闭 |
|
|
9049
|
+
| Canceled | CLosed | 关闭 |
|
|
9050
|
+
| Rejected | CLosed | 关闭 |
|
|
9051
|
+
|
|
9052
|
+
### 优先级映射 <span id="优先级映射"></span>
|
|
9053
|
+
|
|
9054
|
+
| ServiceDesk Plus | Flashduty | 备注 |
|
|
9055
|
+
| ---------- | --------- | ---- |
|
|
9056
|
+
| Low | Info | 提示 |
|
|
9057
|
+
| Medium | Warning | 警告 |
|
|
9058
|
+
| High | Critical | 灾难 |
|
|
9059
|
+
|
|
9060
|
+
|
|
9061
|
+
## 常见问题
|
|
9062
|
+
|
|
9063
|
+
<details>
|
|
9064
|
+
<summary> Scope 是否可以更改</summary>
|
|
9065
|
+
不可以,目前所使用的 Scope 已经是最小单元了,Flashduty 在与 ServiceDesc Plus 进行同步 request 时,需要做获取/创建/更新操作,以及在配置集成时,需要获取优先级/自定义字段列表,所以需要相应的权限支持。
|
|
9066
|
+
</details>
|
|
9067
|
+
`};n.FlashDocsZh=e})(window);
|
package/dist/zh.d.ts
CHANGED