离线调度模板

合理配置离线调度模板,可以提高任务调度配置的效率,以满足特定业务场景的需求。本文为您介绍如何新建及管理离线调度模板。

权限说明

超级管理员系统管理员和拥有公共定义-管理权限点的自定义全局角色支持新增、管理离线调度模板。

新建离线调度模板

  1. Dataphin首页的顶部菜单栏中,选择规划 > 公共定义

  2. 公共定义页面,单击离线调度模板页签。

  3. 离线调度模板页面,单击新建调度模板

  4. 新建离线调度模板页面,配置以下参数。

    支持为基础调度和条件调度创建模板,不同模板类型需配置的参数不同。

    基础调度模板

    参数

    描述

    模板名称

    输入模板名称,支持任意字符,长度不超过64个字符。名称在租户下唯一。

    模板类型

    选择基础调度模板

    描述

    对当前基础调度模板的描述,长度不超过1000个字符。

    调度类型

    支持正常调度、空跑调度及暂停调度3种调度类型。

    • 正常调度:按照调度周期的时间配置调度,并正常执行(即会真实跑数据),通常任务默认选中该项。

    • 空跑调度:按照调度周期的时间配置调度,但都是空跑执行(即不会真实跑数据),即当调度到该任务时便直接返回成功,没有真正的执行任务。通常用于当某一个节点在一定时间内不需要执行,并且不阻塞他的下游节点执行时,可选择此类型调度

    • 暂停调度:选择暂停调度后,将按照调度周期配置的时间启动调度,但节点状态被置为暂停(即不会真实跑数据)。调度到该任务时,系统会直接返回失败,并且会阻塞依赖当前节点的下游节点执行。通常用于某个任务暂时不用执行,但后面还会继续使用的场景。

    生效日期

    选择当前模板生效的日期范围,例如2025-05-01 ~ 2025-06-01

    调度周期

    调度周期即在生产环境调度系统中,多久会真实执行一次该任务中的代码。当一个任务被成功提交后,该任务调度将提交当天次日开始该任务的时间属性配置生成自动调度的周期实例,并根据上游依赖的实例运行结果和时间点运行。

    调度周期可选择小时分钟

    • 日调度:即调度任务每天自动运行一次。新建周期任务时,系统默认的时间周期为每天0点运行一次。您可以根据需要,单击image图标,指定运行的时间点。

    • 周调度:即调度任务每周的特定几天,在特定时间点自动运行一次。您可以根据需要,单击image图标,指定运行的时间点。

      说明

      在非指定的调度时间内,为保证下游实例正常运行,系统会生成实例后直接设置为运行成功,而不会真正执行任何逻辑,也不会占用资源。

    • 月调度:即调度任务在每月的特定几天,在特定时间点自动运行一次。您可以根据需要,单击image图标,指定运行的时间点。

      说明

      在非指定的调度时间内,为保证下游实例正常运行,系统会每天生成实例后直接设置为运行成功,而不会真正执行任何逻辑,也不会占用资源。

    • 小时调度:支持时间段整点自定义时间段自定义时间点调度。

      • 时间段调度:即调度任务每天在指定时间段内,按照设置的时间间隔自动开始调度。单击image图标设置时间段的开始时间结束时间,单击image图标选择间隔n小时。例如,时间段选择为00:00~23:00,间隔选择1小时,则当前任务每天在00:00~23:00时间段内,每隔1小时自动调度一次。

      • 整点调度:单击下拉列表框选择整点时间,调度系统会在所选择的整点时间自动为任务生成实例并运行。

      • 自定义时间点调度:调度系统按照所选的自定义时间点自动为任务生成实例并运行。单击下拉列表框选择自定义时间点,可单击+添加自定义时间点添加多个时间点。

      • 自定义时间段调度:调度任务每天在某些时间段内按照设置的时间间隔自动开始调度。单击image图标设置时间段的开始时间结束时间,并在间隔后输入间隔n分钟(n5~360之间的整数),可单击+添加自定义时间段添加最多10时间段,多个时间段之间时间不可重叠。例如,时间段1中,时间段选择为00:00~03:00,间隔设置为30分钟,则当前任务每天在00:00~03:00时间段内,每间隔30分钟自动调度一次。

    • 分钟调度:支持每天每小时

      • 每天:即每天指定的时间段内,调度任务按间隔时间数的时间间隔运行一次。

      • 每小时:即每小时指定的开始时间到该小时结束的时间段内,调度任务按间隔时间数的时间间隔运行一次。

    调度运行计划

    单击预览,调度运行计划中按照所配置的调度周期,展示当前调度任务某个月每一天的所有调度实例及其调度类型,预览日期类型可选择按照业务日期运行日期(调度日期)

    鼠标悬浮在某天的调度类型模块上,可查看当前调度任务当日的详细调度实例列表,包含运行时间、调度类型、和条件名称。

    条件调度模板

    参数

    描述

    模板名称

    输入模板名称,支持任意字符,长度不超过64个字符。名称在租户下唯一。

    模板类型

    选择条件调度模板

    描述

    对当前条件调度模板的描述,长度不超过1000个字符。

    调度条件

    可设置多组调度条件,最多添加10调度条件。系统将按照从上到下的顺序进行条件判断,命中条件后即执行相应调度动作,并终止后续所有条件的判断。未命中任何条件时,则执行默认调度配置。

    重要

    条件调度仅在调度类型为正常调度时生效。

    1. 单击+添加调度条件

    2. 编辑条件调度对话框中,配置条件调度相关配置信息。

      • 条件名称:支持任意字符,长度在32个字符以内。

      • 生效状态:默认开启。关闭后,进行调度时该条件调度将被忽略。

      • 满足以下条件:条件的判断规则,当条件判断为真时,按执行调度的配置信息进行调度。配置说明,请参见条件调度规则说明

        说明

        不支持跨节点参数作为条件。

      • 执行调度:支持自定义与跟随调度属性:

        • 自定义:条件判断为真,根据所配置的调度类型运行调度。

        • 跟随调度属性:与调度属性中的调度策略一致,等同于关闭条件调度时的调度设置。

      • 调度类型:同基础调度模板中的调度类型。配置说明,请参见调度类型

      • 起调时间:为当前模板配置开始调度的时间,若某日调度任务的条件调度使用此模板,则根据此处配置的时间开始调度。

        说明
        • 仅调度类型为正常调度时,支持配置此项。

        • 若日调度任务配置的起调时间早于此处的起调时间,则以任务中配置的时间为准。

    3. 单击确定

    调度运行计划

    单击预览,调度运行计划中按照所配置的条件调度,展示当前调度任务某个月每一天的所有调度实例及其调度类型,预览日期类型可选择按照业务日期运行日期(调度日期)

    鼠标悬浮在某天的调度类型模块上,可查看当前调度任务当日的详细调度实例列表,包含运行时间、调度类型、和条件名称。

  5. 单击确定,完成模板配置。

管理离线调度模板

  1. 离线调度模板页面中,查看各离线调度模板信息,包含模板名称模板类型创建人创建时间最近修改时间

  2. (可选)可输入模板名称关键字进行搜索,或根据模板类型筛选目标模板。

  3. 您可在目标模板操作列,对其进行以下操作。

    操作项

    说明

    编辑

    支持对除模板名称和模板类型之外的信息进行编辑。离线模板编辑完成后,所有引用当前模板的生产任务无需提交发布,将自动使用最新模板。

    查看详情

    查看当前离线调度模板的详细信息,在查看离线调度模板页面单击预览,查看调度运行计划。

    查看引用

    查看引用当前离线调度模板的对象。离线调度模板引用对话框中,展示所有引用当前离线调度模板的对象列表,包含对象名称/ID所属项目/板块对象类型

    • 对象名称/ID:当对象为计算任务或集成任务时,展示对象名称和ID;当对象为逻辑表或派生指标时,仅展示对象名称。

    • 所属项目/板块:当对象为计算任务或集成任务时,展示所属项目名称;当对象为逻辑表或派生指标时,展示所属板块名称。

      说明

      若对象所属项目为Dev-Prod项目,则生产与开发将会分别进行记录。

    • 对象类型:包含计算任务、集成任务、逻辑表和派生指标。

    删除

    仅支持删除不存在任务引用的离线模板。