Browse Source

[doc] Improve the document introduction of complement (#11275)

insist777 2 years ago
parent
commit
8ad6e10da5

File diff suppressed because it is too large
+ 41 - 18
docs/docs/en/guide/project/workflow-definition.md


+ 38 - 14
docs/docs/zh/guide/project/workflow-definition.md

@@ -75,23 +75,47 @@
   * 收件人:选择通知策略||超时报警||发生容错时,会发送流程信息或告警邮件到收件人列表。
   * 抄送人:选择通知策略||超时报警||发生容错时,会抄送流程信息或告警邮件到抄送人列表。
   * 启动参数: 在启动新的流程实例时,设置或覆盖全局参数的值。
-  * 补数:包括串行补数、并行补数 2 种模式,日期可以通过选择或者手动进行输入。串行补数:指定时间范围内,从开始日期至结束日期依次执行补数,依次生成N条流程实例;并行补数:指定时间范围内,多天同时进行补数,同时生成 N 条流程实例。手动输入日期:手动输入以逗号分割日期格式为 `yyyy-MM-dd HH:mm:ss` 的日期。日期选择:通过前端选择日期。
+  * 补数:指运行指定日期范围内的工作流定义,根据补数策略生成对应的工作流实例,补数策略包括串行补数、并行补数 2 种模式,日期可以通过页面选择或者手动输入。
+   
+    * 串行补数:指定时间范围内,从开始日期至结束日期依次执行补数,依次生成多条流程实例;点击运行工作流,选择串行补数模式:例如从7月 9号到7月10号依次执行,依次在流程实例页面生成两条流程实例。
+  
+    ![workflow-serial](../../../../img/new_ui/dev/project/workflow-serial.png)
+    
+    * 并行补数: 指定时间范围内,同时进行多天的补数,同时生成多条流程实例。手动输入日期:手动输入以逗号分割日期格式为 `yyyy-MM-dd HH:mm:ss` 的日期。点击运行工作流,选择并行补数模式:例如同时执行7月9号到7月10号的工作流定义,同时在流程实例页面生成两条流程实例(执行策略为串行时流程实例按照策略执行)。
+    
+    ![workflow-parallel](../../../../img/new_ui/dev/project/workflow-parallel.png)
+  
+        * 并行度:是指在并行补数的模式下,最多并行执行的实例数。例如同时执行7月6号到7月10号的工作流定义,并行度为2,那么流程实例为:
+    ![workflow-concurrency-from](../../../../img/new_ui/dev/project/workflow-concurrency-from.png)
+    
+    ![workflow-concurrency](../../../../img/new_ui/dev/project/workflow-concurrency.png)
+   
     * 依赖模式:是否触发下游依赖节点依赖到当前工作流的工作流实例的补数(要求当前补数的工作流实例的定时状态为已上线,只会触发下游直接依赖到当前工作流的补数)。
-    * 补数: 执行指定日期的工作流定义,可以选择补数时间范围(当定时配置未上线时默认会根据所选时间范围进行每天一次的补数,如果定时配置已上线则会根据所选的时间范围结合定时配置进行补数),比如需要补 5 月 9 号到 5 月 10 号的数据,如下图所示: 
-
-    ![workflow-date](../../../../img/new_ui/dev/project/workflow-date.png)
-
-    > 串行模式:补数从 5 月 9 号到 5 月 10 号依次执行,依次在流程实例页面生成两条流程实例;
-
-    > 并行模式:同时执行 5 月 9 号到 5 月 10 号的任务,同时在流程实例页面生成两条流程实例。
-
-    * 补数: 通过手动输入补数时间(不依赖定时配置)完成工作流定义的补数。比如需要补 5 月 9 号到 5 月 10 号的数据,如下图所示:
-
-    ![workflow-date](../../../../img/new_ui/dev/project/workflow_date_manual.png)    
+    
+    ![workflow-dependency](../../../../img/new_ui/dev/project/workflow-dependency.png)
+    
+    * 日期选择:
+        1. 通过页面选择日期:
+        
+        ![workflow-pageSelection](../../../../img/new_ui/dev/project/workflow-pageSelection.png)
+        
+        2. 手动输入:
+        
+        ![workflow-input](../../../../img/new_ui/dev/project/workflow-input.png)
+     
+     * 补数与定时配置的关系:
+       
+        1. 未配置定时:当没有定时配置时默认会根据所选时间范围进行每天一次的补数,比如该工作流调度日期为7月 7号到7月10号,未配置定时,流程实例为:
+        
+        ![workflow-unconfiguredTimingResult](../../../../img/new_ui/dev/project/workflow-unconfiguredTimingResult.png)
 
-    > 串行模式:补数从 5 月 9 号到 5 月 10 号依次执行,依次在流程实例页面生成两条流程实例;
+        2. 已配置定时:如果有定时配置则会根据所选的时间范围结合定时配置进行补数,比如该工作流调度日期为7月 7号到7月10号,配置了定时(每日凌晨5点运行),流程实例为:
+        
+        ![workflow-configuredTiming](../../../../img/new_ui/dev/project/workflow-configuredTiming.png)
+        
+        ![workflow-configuredTimingResult](../../../../img/new_ui/dev/project/workflow-configuredTimingResult.png)
+    
 
-    > 并行模式:同时执行 5 月 9 号到 5 月 10 号的任务,同时在流程实例页面生成两条流程实例。
 
 ## 单独运行任务
 

BIN
docs/img/new_ui/dev/project/workflow-concurrency-from.png


BIN
docs/img/new_ui/dev/project/workflow-concurrency.png


BIN
docs/img/new_ui/dev/project/workflow-configuredTiming.png


BIN
docs/img/new_ui/dev/project/workflow-configuredTimingResult.png


BIN
docs/img/new_ui/dev/project/workflow-date.png


BIN
docs/img/new_ui/dev/project/workflow-dependency.png


BIN
docs/img/new_ui/dev/project/workflow-input.png


BIN
docs/img/new_ui/dev/project/workflow-pageSelection.png


BIN
docs/img/new_ui/dev/project/workflow-parallel.png


BIN
docs/img/new_ui/dev/project/workflow-serial.png


BIN
docs/img/new_ui/dev/project/workflow-unconfiguredTimingResult.png


BIN
docs/img/new_ui/dev/project/workflow_date_manual.png