Browse Source

Optimized complement documentation (#12550)

3.2.0-release
Kerwin 2 years ago committed by GitHub
parent
commit
63244c8065
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 7
      docs/docs/en/guide/project/workflow-definition.md
  2. 7
      docs/docs/zh/guide/project/workflow-definition.md

7
docs/docs/en/guide/project/workflow-definition.md

@ -75,7 +75,8 @@ Workflow running parameter description:
* **Worker grouping**: This process can only be executed in the specified worker machine group. The default is Default, which can be executed on any worker.
* **Notification Group**: Select Notification Policy||Timeout Alarm||When fault tolerance occurs, process information or emails will be sent to all members in the notification group.
* **Startup parameters**: Set or override the value of global parameters when starting a new process instance.
* **Complement(Backfill)**: Run workflow for a specified historical period. There are two strategies: serial complement and parallel complement. You could select the time period or fill in it manually in UI.
* **Complement(Backfill)**: Run workflow for a specified historical period. There are two strategies: serial complement and parallel complement.
> You could select the time period or fill in it manually in UI. The date range is left closed and right closed time interval (startDate <= N <= endDate)
* Serial complement: Run the workflow from start date to end date according to the time period you set in serial.
![workflow-serial](../../../../img/new_ui/dev/project/workflow-serial.png)
@ -105,11 +106,11 @@ Workflow running parameter description:
* Complement with or without scheduling:
1. Without scheduling: Run workflow every day from start date to end date according to the time period you set. e.g. Do complement from July 7th to 10th without scheduling:
1. `Unconfigured timing` or `Configured timing and timing status offline`: Complement the number according to the selected time range combined with the timing default configuration (0:00 every day). e.g. the workflow scheduling date is from July 7th to July 10th:
![workflow-unconfiguredTimingResult](../../../../img/new_ui/dev/project/workflow-unconfiguredTimingResult.png)
2. With scheduling: Run workflow from start date to end date on schedule according to the time period and schedule you set. e.g. Do complement from July 7th to 10th with the schedule of 5 AM every day:
2. `Configured timing and timing status online`: Complement the number according to the selected time range combined with the timing configuration. e.g. the workflow scheduling date is from July 7th to July 10th, and the timing is configured (running at 5 am every day):
![workflow-configuredTiming](../../../../img/new_ui/dev/project/workflow-configuredTiming.png)

7
docs/docs/zh/guide/project/workflow-definition.md

@ -83,7 +83,8 @@
* Worker 分组:该流程只能在指定的 worker 机器组里执行。默认是 Default,可以在任一 worker 上执行。
* 通知组:选择通知策略||超时报警||发生容错时,会发送流程信息或邮件到通知组里的所有成员。
* 启动参数: 在启动新的流程实例时,设置或覆盖全局参数的值。
* 补数:指运行指定日期范围内的工作流定义,根据补数策略生成对应的工作流实例,补数策略包括串行补数、并行补数 2 种模式,日期可以通过页面选择或者手动输入。
* 补数:指运行指定日期范围内的工作流定义,根据补数策略生成对应的工作流实例,补数策略包括串行补数、并行补数 2 种模式。
> 日期可以通过页面选择或者手动输入,日期范围是左关右关区间(startDate <= N <= endDate)
* 串行补数:指定时间范围内,从开始日期至结束日期依次执行补数,依次生成多条流程实例;点击运行工作流,选择串行补数模式:例如从7月 9号到7月10号依次执行,依次在流程实例页面生成两条流程实例。
![workflow-serial](../../../../img/new_ui/dev/project/workflow-serial.png)
@ -113,11 +114,11 @@
* 补数与定时配置的关系:
1. 未配置定时:当没有定时配置时默认会根据所选时间范围进行每天一次的补数,比如该工作流调度日期为7月7号到7月10号,未配置定时,流程实例为:
1. `未配置定时`或`已配置定时并定时状态下线`:根据所选的时间范围结合定时默认配置(每天0点)进行补数,比如该工作流调度日期为7月7号到7月10号,流程实例为:
![workflow-unconfiguredTimingResult](../../../../img/new_ui/dev/project/workflow-unconfiguredTimingResult.png)
2. 已配置定时:如果有定时配置则会根据所选的时间范围结合定时配置进行补数,比如该工作流调度日期为7月7号到7月10号,配置了定时(每日凌晨5点运行),流程实例为:
2. `已配置定时并定时状态上线`根据所选的时间范围结合定时配置进行补数,比如该工作流调度日期为7月7号到7月10号,配置了定时(每日凌晨5点运行),流程实例为:
![workflow-configuredTiming](../../../../img/new_ui/dev/project/workflow-configuredTiming.png)

Loading…
Cancel
Save