From b21e211d2cbf7a2af2307f0a5c63dc9c2b837809 Mon Sep 17 00:00:00 2001 From: xiangzihao <460888207@qq.com> Date: Fri, 24 Jun 2022 16:33:10 +0800 Subject: [PATCH] [doc] Add docs about complement dependent mode (#10587) --- .../en/guide/project/workflow-definition.md | 31 ++++++++++--------- .../zh/guide/project/workflow-definition.md | 1 + 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/docs/en/guide/project/workflow-definition.md b/docs/docs/en/guide/project/workflow-definition.md index 7f16a6cbbd..a9d751add9 100644 --- a/docs/docs/en/guide/project/workflow-definition.md +++ b/docs/docs/en/guide/project/workflow-definition.md @@ -66,30 +66,31 @@ The following are the operation functions of the workflow definition list: Description of workflow operating parameters: - * Failure strategy: When a task node fails to execute, other parallel task nodes need to execute this strategy. "Continue" means: after a certain task fails, other task nodes execute normally; "End" means: terminate all tasks execution, and terminate the entire process - * Notification strategy: When the process is over, send the process execution result notification email according to the process status, options including no send, send if sucess, send of failure, send whatever result - * Process priority: The priority of process operation, divide into five levels: highest (HIGHEST), high (HIGH), medium (MEDIUM), low (LOW), and lowest (LOWEST). When the number of master threads is insufficient, high priority processes will execute first in the execution queue, and processes with the same priority will execute in the order of first in, first out; - * Worker group: The process can only be executed in the specified worker machine group. The default is `Default`, which can execute on any worker - * Notification group: select notification strategy||timeout alarm||when fault tolerance occurs, process result information or email will send to all members in the notification group - * Recipient: select notification policy||timeout alarm||when fault tolerance occurs, process result information or alarm email will be sent to the recipient list - * Cc: select notification policy||timeout alarm||when fault tolerance occurs, the process result information or warning email will be copied to the CC list - * Startup parameter: Set or overwrite global parameter values when starting a new process instance - * Complement: includes serial complement and parallel complement and supports manual date input and date selection. Serial complement defines, within the specified time range, executes the complements from the start date to the end date by sequential and N process instances are generated in sequence. Parallel complement defines executing the complement concurrently in the multiple days to generate N process instances within the specified time range. Manual date input defines: manually input the date following the date format `yyyy-MM-dd HH:mm:ss` and separate dates by a comma. Date selection defines: to select dates via UI. - * You can select complement time range (When the scheduled configuration is not online, the daily complement will be performed by default according to the selected time range.If the timing configuration is online, it will be complemented according to the selected time range in combination with the timing configuration) when executing a timing workflow definition. For example, need to fill in the data from 1st May to 10th May, as shown in the figure below: + * Failure strategy: When a task node fails to execute, other parallel task nodes need to execute this strategy. "Continue" means: after a certain task fails, other task nodes execute normally; "End" means: terminate all tasks execution, and terminate the entire process + * Notification strategy: When the process is over, send the process execution result notification email according to the process status, options including no send, send if sucess, send of failure, send whatever result + * Process priority: The priority of process operation, divide into five levels: highest (HIGHEST), high (HIGH), medium (MEDIUM), low (LOW), and lowest (LOWEST). When the number of master threads is insufficient, high priority processes will execute first in the execution queue, and processes with the same priority will execute in the order of first in, first out; + * Worker group: The process can only be executed in the specified worker machine group. The default is `Default`, which can execute on any worker + * Notification group: select notification strategy||timeout alarm||when fault tolerance occurs, process result information or email will send to all members in the notification group + * Recipient: select notification policy||timeout alarm||when fault tolerance occurs, process result information or alarm email will be sent to the recipient list + * Cc: select notification policy||timeout alarm||when fault tolerance occurs, the process result information or warning email will be copied to the CC list + * Startup parameter: Set or overwrite global parameter values when starting a new process instance + * Complement: includes serial complement and parallel complement and supports manual date input and date selection. Serial complement defines, within the specified time range, executes the complements from the start date to the end date by sequential and N process instances are generated in sequence. Parallel complement defines executing the complement concurrently in the multiple days to generate N process instances within the specified time range. Manual date input defines: manually input the date following the date format `yyyy-MM-dd HH:mm:ss` and separate dates by a comma. Date selection defines: to select dates via UI. + * Dependent Mode: Trigger the complement of workflow instances that the downstream dependent node depends on the current workflow(It is required that the scheduled status of the workflow instance of the current replenishment is online, and only the downstream supplement directly dependent on the current workflow will be triggered) + * You can select complement time range (When the scheduled configuration is not online, the daily complement will be performed by default according to the selected time range.If the timing configuration is online, it will be complemented according to the selected time range in combination with the timing configuration) when executing a timing workflow definition. For example, need to fill in the data from 1st May to 10th May, as shown in the figure below: ![workflow-date](../../../../img/new_ui/dev/project/workflow-date.png) - > Serial mode: the complement execute sequentially from 9th May to 10th May, and the process instance page generates 2 process instances; + > Serial mode: the complement execute sequentially from 9th May to 10th May, and the process instance page generates 2 process instances; - > Parallel mode: The tasks from 9th May to 10th May execute simultaneously, and the process instance page generates 2 process instances; + > Parallel mode: The tasks from 9th May to 10th May execute simultaneously, and the process instance page generates 2 process instances; - * You can manually enter the complement dates (independent from the timing configuration) to execute the complement data to workflow definitions. The figure below is an example to make complement data from 9th May to 10th May: + * You can manually enter the complement dates (independent from the timing configuration) to execute the complement data to workflow definitions. The figure below is an example to make complement data from 9th May to 10th May: ![workflow-date](../../../../img/new_ui/dev/project/workflow_date_manual.png) - > Serial mode: the complement execute sequentially from 9th May to 10th May, and the process instance page generates 2 process instances; + > Serial mode: the complement execute sequentially from 9th May to 10th May, and the process instance page generates 2 process instances; - > Parallel mode: The tasks from 9th May to 10th May execute simultaneously, and the process instance page generates 2 process instances; + > Parallel mode: The tasks from 9th May to 10th May execute simultaneously, and the process instance page generates 2 process instances; ## Workflow Timing diff --git a/docs/docs/zh/guide/project/workflow-definition.md b/docs/docs/zh/guide/project/workflow-definition.md index 5548d78291..d0a7931bf4 100644 --- a/docs/docs/zh/guide/project/workflow-definition.md +++ b/docs/docs/zh/guide/project/workflow-definition.md @@ -76,6 +76,7 @@ * 抄送人：选择通知策略||超时报警||发生容错时，会抄送流程信息或告警邮件到抄送人列表。 * 启动参数: 在启动新的流程实例时，设置或覆盖全局参数的值。 * 补数：包括串行补数、并行补数 2 种模式，日期可以通过选择或者手动进行输入。串行补数：指定时间范围内，从开始日期至结束日期依次执行补数，依次生成N条流程实例；并行补数：指定时间范围内，多天同时进行补数，同时生成 N 条流程实例。手动输入日期：手动输入以逗号分割日期格式为 `yyyy-MM-dd HH:mm:ss` 的日期。日期选择：通过前端选择日期。 + * 依赖模式：是否触发下游依赖节点依赖到当前工作流的工作流实例的补数（要求当前补数的工作流实例的定时状态为已上线，只会触发下游直接依赖到当前工作流的补数）。 * 补数： 执行指定日期的工作流定义，可以选择补数时间范围（当定时配置未上线时默认会根据所选时间范围进行每天一次的补数，如果定时配置已上线则会根据所选的时间范围结合定时配置进行补数)，比如需要补 5 月 9 号到 5 月 10 号的数据，如下图所示： ![workflow-date](../../../../img/new_ui/dev/project/workflow-date.png)