Skip to content

Commit 0177b70

Browse files
authored
docs(plugin-workflow-cc): add new plugin docs (#394)
1 parent 95b4071 commit 0177b70

File tree

13 files changed

+242
-1
lines changed

13 files changed

+242
-1
lines changed

docs/config/handbook.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2691,6 +2691,12 @@ export default [
26912691
'title.ja-JP': '承認',
26922692
link: '/handbook/workflow/nodes/approval',
26932693
},
2694+
{
2695+
title: 'CC',
2696+
'title.zh-CN': '抄送',
2697+
'title.ja-JP': '抄送',
2698+
link: '/handbook/workflow/nodes/cc',
2699+
},
26942700
],
26952701
},
26962702
{
@@ -2876,6 +2882,14 @@ export default [
28762882
},
28772883
],
28782884
},
2885+
{
2886+
title: 'CC',
2887+
'title.fr-FR': 'CC',
2888+
'title.zh-CN': '抄送',
2889+
'title.ja-JP': 'CC',
2890+
subTitle: '@nocobase/plugin-workflow-cc',
2891+
link: '/handbook/workflow-cc',
2892+
},
28792893
{
28802894
title: 'Custom Action Trigger',
28812895
'title.fr-FR': "Déclencheur d'action personnalisé",
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# CC (Carbon Copy)
2+
3+
<PluginInfo name="workflow-cc" link="/handbook/workflow-cc" commercial="true"></PluginInfo>
4+
5+
The CC node is used to send certain contextual information from the workflow process to designated users for their awareness and reference. For example, during approval or other processes, relevant information can be copied to other participants so that they can stay informed of the progress.
6+
7+
You can configure multiple CC nodes in a workflow so that when the flow reaches these nodes, the corresponding information will be sent to specified recipients.
8+
9+
The copied content will appear under the "CC to Me" menu in the Task Center. Users can view all content copied to them here. Unread items are highlighted, and users can manually mark them as read after viewing.
10+
11+
## User Guide
12+
13+
### Create a Node
14+
15+
In the workflow configuration interface, click the plus (“+”) button in the flow to add a “CC” node:
16+
17+
![Add CC](https://static-docs.nocobase.com/20250710222842.png)
18+
19+
### Node Configuration
20+
21+
![Node Configuration](https://static-docs.nocobase.com/20250710224041.png)
22+
23+
In the node configuration panel, you can set the following parameters:
24+
25+
#### Recipients
26+
27+
Recipients are the users who will receive the copied content. This can be one or more users. The source can be statically selected from the user list, dynamically specified using variables, or based on a query result from the user table.
28+
29+
![Recipient Configuration](https://static-docs.nocobase.com/20250710224421.png)
30+
31+
#### User Interface
32+
33+
Recipients need to view the copied content under the "CC to Me" menu in the Task Center. You can configure blocks using results from triggers or other nodes in the workflow context.
34+
35+
![User Interface](https://static-docs.nocobase.com/20250710225400.png)
36+
37+
#### Task Title
38+
39+
The task title is what appears in the Task Center. You can dynamically generate the title using variables from the workflow context.
40+
41+
![Task Title](https://static-docs.nocobase.com/20250710225603.png)
42+
43+
### Task Center
44+
45+
Users can view and manage all content CCed to them in the Task Center, and filter by read/unread status.
46+
47+
![20250710232932](https://static-docs.nocobase.com/20250710232932.png)
48+
49+
![20250710233032](https://static-docs.nocobase.com/20250710233032.png)
50+
51+
After viewing, tasks can be marked as read. The unread count will update accordingly.
52+
53+
![20250710233102](https://static-docs.nocobase.com/20250710233102.png)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Carbon Copy (CC)
2+
3+
<embed src="../../workflow-cc/index.md#L3-L999"></embed>

docs/en-US/handbook/workflow/nodes/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ From a functional perspective, the nodes implemented so far are in four categori
3333
- Manual Processing
3434
- [Manual Processing](./manual.md) (provided by plugin @nocobase/plugin-workflow-manual)
3535
- [Approval](./approval.md) (provided by plugin @nocobase/plugin-workflow-approval)
36+
- [CC](./cc.md) (provided by plugin @nocobase/plugin-workflow-cc)
3637
- Other Extensions
3738
- [HTTP Request](./request.md) (provided by plugin @nocobase/plugin-workflow-request)
3839
- [Response Message](./response-message.md) (provided by plugin @nocobase/plugin-workflow-response-message)
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Copie carbone (CC)
2+
3+
<PluginInfo name="workflow-cc" link="/handbook/workflow-cc" commercial="true"></PluginInfo>
4+
5+
Le nœud de copie carbone permet d'envoyer certaines informations contextuelles du processus de workflow à des utilisateurs spécifiés, à des fins de consultation ou d'information. Par exemple, au cours d’un processus d’approbation ou autre, vous pouvez envoyer des informations à d’autres parties prenantes afin qu’elles soient tenues au courant de l’avancement.
6+
7+
Vous pouvez configurer plusieurs nœuds CC dans le workflow, afin que lorsque le flux atteint ces nœuds, les informations correspondantes soient envoyées aux destinataires définis.
8+
9+
Le contenu copié s'affichera dans le menu "Copie à moi" du centre des tâches. Les utilisateurs peuvent y consulter tous les éléments copiés à leur attention. Les éléments non lus sont indiqués, et l'utilisateur peut les marquer manuellement comme lus après consultation.
10+
11+
## Guide d'utilisation
12+
13+
### Création d’un nœud
14+
15+
Dans l'interface de configuration du workflow, cliquez sur le bouton plus (“+”) dans le flux pour ajouter un nœud “CC” :
16+
17+
![Ajouter CC](https://static-docs.nocobase.com/20250710222842.png)
18+
19+
### Configuration du nœud
20+
21+
![Configuration du nœud](https://static-docs.nocobase.com/20250710224041.png)
22+
23+
Dans le panneau de configuration du nœud, vous pouvez définir les paramètres suivants :
24+
25+
#### Destinataires
26+
27+
Les destinataires sont les utilisateurs qui recevront le contenu copié. Cela peut être un ou plusieurs utilisateurs. La source peut être une sélection statique à partir de la liste des utilisateurs, une valeur dynamique définie par des variables, ou le résultat d’une requête sur la table des utilisateurs.
28+
29+
![Configuration des destinataires](https://static-docs.nocobase.com/20250710224421.png)
30+
31+
#### Interface utilisateur
32+
33+
Les destinataires doivent consulter le contenu copié via le menu "Copie à moi" du centre des tâches. Vous pouvez configurer des blocs de contenu à partir des résultats des déclencheurs ou d'autres nœuds du contexte du workflow.
34+
35+
![Interface utilisateur](https://static-docs.nocobase.com/20250710225400.png)
36+
37+
#### Titre de la tâche
38+
39+
Le titre de la tâche s'affiche dans le centre des tâches. Vous pouvez générer ce titre dynamiquement à l'aide de variables du contexte du workflow.
40+
41+
![Titre de la tâche](https://static-docs.nocobase.com/20250710225603.png)
42+
43+
### Centre des tâches
44+
45+
Les utilisateurs peuvent consulter et gérer tous les contenus qui leur ont été copiés dans le centre des tâches, et les filtrer en fonction de leur statut de lecture.
46+
47+
![20250710232932](https://static-docs.nocobase.com/20250710232932.png)
48+
49+
![20250710233032](https://static-docs.nocobase.com/20250710233032.png)
50+
51+
Une fois consulté, l'utilisateur peut marquer l'élément comme lu, ce qui mettra à jour le compteur des éléments non lus.
52+
53+
![20250710233102](https://static-docs.nocobase.com/20250710233102.png)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Copie carbone (CC)
2+
3+
<embed src="../../workflow-cc/index.md#L3-L999"></embed>

docs/fr-FR/handbook/workflow/nodes/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ D'un point de vue fonctionnel, les nœuds implémentés jusqu'à présent se ré
2929
- **Traitement Manuel**
3030
- [Traitement manuel](./manual.md) (fourni par le plugin @nocobase/plugin-workflow-manual)
3131
- [Approbation](./approval.md) (fourni par le plugin @nocobase/plugin-workflow-approval)
32+
- [CC](./cc.md) (fourni par le plugin @nocobase/plugin-workflow-cc)
3233
- **Autres Extensions**
3334
- [Requête HTTP](./request.md) (fourni par le plugin @nocobase/plugin-workflow-request)
3435
- [Message de réponse](./response-message.md) (fourni par le plugin @nocobase/plugin-workflow-response-message)
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# 参照通知(CC)
2+
3+
<PluginInfo name="workflow-cc" link="/handbook/workflow-cc" commercial="true"></PluginInfo>
4+
5+
参照通知ノードは、ワークフローの実行中に発生する一部のコンテキスト情報を指定されたユーザーに送信し、内容を把握・参照してもらうために使用します。たとえば、承認プロセスや他の処理中に関連情報を別の関係者に共有することで、進捗をタイムリーに把握してもらうことができます。
6+
7+
ワークフロー内に複数の参照通知ノードを設定することで、処理がそのノードに到達したときに、指定された受信者に関連情報を送信できます。
8+
9+
通知された内容は、タスクセンターの「参照通知」メニューに表示されます。ユーザーはここで自分に送られた全ての通知を確認できます。未読状態に応じた通知が表示され、確認後に手動で既読としてマークすることができます。
10+
11+
## 操作ガイド
12+
13+
### ノードの作成
14+
15+
ワークフローの設定画面で、フロー上のプラス(「+」)ボタンをクリックし、「参照通知」ノードを追加します:
16+
17+
![参照通知_追加](https://static-docs.nocobase.com/20250710222842.png)
18+
19+
### ノード設定
20+
21+
![ノード設定](https://static-docs.nocobase.com/20250710224041.png)
22+
23+
ノード設定画面では、以下のパラメータを設定できます:
24+
25+
#### 受信者
26+
27+
受信者は通知を受け取るユーザーの集合であり、1 人または複数人が対象となります。静的にユーザー一覧から選択することも、変数を用いて動的に指定することも、ユーザーテーブルのクエリ結果を利用することも可能です。
28+
29+
![受信者設定](https://static-docs.nocobase.com/20250710224421.png)
30+
31+
#### ユーザーインターフェース
32+
33+
受信者は、タスクセンターの「参照通知」メニューで通知内容を確認します。フローコンテキスト内のトリガーや他ノードの出力を内容ブロックとして構成できます。
34+
35+
![ユーザーインターフェース](https://static-docs.nocobase.com/20250710225400.png)
36+
37+
#### タスクタイトル
38+
39+
タスクタイトルはタスクセンターで表示されるタイトルです。ワークフローのコンテキスト変数を使用して動的に生成できます。
40+
41+
![タスクタイトル](https://static-docs.nocobase.com/20250710225603.png)
42+
43+
### タスクセンター
44+
45+
ユーザーはタスクセンターで、自分に参照通知されたすべての内容を確認・管理でき、閲覧状況に応じてフィルタリングして閲覧することができます。
46+
47+
![20250710232932](https://static-docs.nocobase.com/20250710232932.png)
48+
49+
![20250710233032](https://static-docs.nocobase.com/20250710233032.png)
50+
51+
確認後に既読としてマークでき、未読の件数は自動で減少します。
52+
53+
![20250710233102](https://static-docs.nocobase.com/20250710233102.png)
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# 抄送参照通知(CC)
2+
3+
<embed src="../../workflow-cc/index.md#L3-L999"></embed>

docs/ja-JP/handbook/workflow/nodes/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
- 人手処理
3737
- [人手処理](./manual.md)(プラグイン @nocobase/plugin-workflow-manual 提供)
3838
- [承認](./approval.md)(プラグイン @nocobase/plugin-workflow-approval 提供)
39-
39+
- [抄送](./cc.md)(プラグイン @nocobase/plugin-workflow-cc 提供)
4040
- その他拡張
4141
- [HTTP リクエスト](./request.md)(プラグイン @nocobase/plugin-workflow-request 提供)
4242
- [レスポンスメッセージ](./response-message.md)(プラグイン @nocobase/plugin-workflow-response-message 提供)

0 commit comments

Comments
 (0)