流程管理

基本操作

1. 工作流创建完成后，单击操作列DAG进入工作流编辑画布。

2. 从左侧菜单栏拖拽任务至画布，完成节点创建。

3. 将鼠标悬停于节点右侧或下侧，出现“+”图标后，拖拽至另一节点的左侧或上侧，建立依赖关系。

4. 选中节点或连线后单击鼠标右键，可移除对应元素。

5. 通过鼠标左键双击节点，或右键点击节点后选择编辑，可修改节点配置信息。

6. 若节点为任务节点，右键点击节点并选择编辑脚本，可修改该节点的脚本内容。

7. 单击保存新版本并输入版本名称后可保存当前工作流的变更。

8. 指定机器：如果应用接入多个执行器，可指定任务节点运行的执行器。

任务节点

逻辑节点

系统变量

自定义变量

工作流中所有任务节点均可自定义变量，分为IN和OUT两种类型。

• IN：作为任务节点的输入变量，当前节点脚本可直接使用该变量的值。

• OUT：如果下游节点需要依赖上游节点输出的结果，可通过OUT类型变量进行参数传递。

举例说明：

1. 在任务定义中配置如下脚本。

   #!/bin/bash
   echo "xxl-job: hello shell"
   
   # system variables
   echo "System schedule time (yyyyMMddHHmmss): ${system.schedule.time}"
   echo "System data time (yyyyMMddHHmmss): ${system.data.time}"
   echo "System data date(yyyyMMdd): ${system.biz.curdate}"
   echo "Task Definition Name: ${system.task.definition.name}"
   echo "Task Instance ID: ${system.task.instance.id}"
   echo "Workflow Definition Name: ${system.workflow.definition.name}"
   echo "Workflow Instance ID: ${system.workflow.instance.id}"
   
   # custom variables
   echo "#{setValue(var1=hello)}"
   echo "#{setValue(var2=world)}"
   
   # custom output
   sum=0
   for ((i=1; i<=100; i++))
   do
       echo "hello world $i"
       sum=$((sum + i))
   done
   echo "#{setResult($sum)}"
   
   exit 0

2. 在自定义参数中添加两个OUT类型参数。

   

3. 此时脚本最终任务结果为5050，并且在执行过程中为var1和var2分别赋值为hello和world，通过步骤2的自定义参数配置，可将var1和var2作为变量向下游传递，如果未设置自定义参数，var1和var2的赋值仅在此任务节点中生效。

Demo

#!/bin/bash
echo "xxl-job: hello shell"

# system variables
echo "System schedule time (yyyyMMddHHmmss): ${system.schedule.time}"
echo "System data time (yyyyMMddHHmmss): ${system.data.time}"
echo "System data date(yyyyMMdd): ${system.biz.curdate}"
echo "Task Definition Name: ${system.task.definition.name}"
echo "Task Instance ID: ${system.task.instance.id}"
echo "Workflow Definition Name: ${system.workflow.definition.name}"
echo "Workflow Instance ID: ${system.workflow.instance.id}"

# custom variables
echo "#{setValue(var1=hello)}"
echo "#{setValue(var2=world)}"

# custom output
sum=0
for ((i=1; i<=100; i++))
do
    echo "hello world $i"
    sum=$((sum + i))
done
echo "#{setResult($sum)}"

exit 0

工作流导出格式说明

导出格式为JSON格式，总体结构包括工作流类型、导出格式、功能版本，以及导出的工作流列表。

其中工作流列表中的每一项对应一个工作流对象，工作流对象包括工作流的定义信息、节点列表、边列表。

[
  "kind": "SchedulerXWorkflows", // 类型
  "type": "JSON", // 导出格式
  "version": "2.0", // 功能版本
  "content": [ // 工作流列表
    {
      "workflowInfo": {}, // 定义信息
      "nodes": [], // 节点列表
      "edges": [] // 边列表
    },
    {...}
  ],
]

工作流导出结果示例

以下图工作流为例，导出具体字段展示如下：

下图中的Schedulerx-Root 是系统内置的唯一根节点，节点ID为0（用户无需手动创建）

{
  "kind": "SchedulerXWorkflows",
  "type": "JSON",
  "version": "2.0",
  "content": [
    {
      "workflowInfo": {
        "appName": "qiacheng-import-test",
        "appType": 1,
        "name": "qiacheng-success",
        "description": "qiacheng-success",
        "currentExecuteStatus": 0,
        "timeConfig": {
          "calendar": "workday",
          "dataOffset": 0,
          "timezone": "Hongkong",
          "timeType": 1,
          "paramMap": {},
          "timeExpression": "0 0 12 * * ?"
        },
        "version": "v1.0",
        "maxConcurrency": 1,
        "status": 0,
        "creator": "xxxxx",
        "updater": "xxxxx"
      },
      "nodes": [
        {
          "name": "script-job1",
          "description": "script-job1",
          "jobType": "script_shell",
          "executeMode": "standalone",
          "attemptInterval": 30,
          "startTimeType": 1,
          "startTime": -1,
          "weight": 1,
          "routeStrategy": 1,
          "priority": 5,
          "contentType": 2,
          "content": "#!/bin/bash\n# system variables\necho \"System schedule time (yyyyMMddHHmmss): ${system.schedule.time}\"\necho \"System data time (yyyyMMddHHmmss): ${system.data.time}\"\necho \"System data date(yyyyMMdd): ${system.biz.curdate}\"\necho \"Task Definition Name: ${system.task.definition.name}\"\necho \"Task Instance ID: ${system.task.instance.id}\"\necho \"Workflow Definition Name: ${system.workflow.definition.name}\"\necho \"Workflow Instance ID: ${system.workflow.instance.id}\"\n\n# custom variables\necho \"#{setValue(var1=hello)}\"\necho \"#{setValue(var2=world)}\"\n\n# task process\nsum=0\nfor ((i=1; i<=100; i++))\ndo\n    echo \"hello world $i\"\n    sum=$((sum + i))\ndone\n\n# custom output result\necho \"#{setResult($sum)}\"\n\n# Returns 0 on success, otherwise returns an error code\nexit 0",
          "maxConcurrency": 1,
          "maxAttempt": 0,
          "xattrs": "{\"executorBlockStrategy\":1}",
          "parameters": "",
          "timeConfig": {
            "calendar": "",
            "dataOffset": 0,
            "paramMap": {},
            "timeType": -1,
            "timeExpression": ""
          },
          "monitorConfigInfo": {
            "endEarlyEnable": false,
            "failLimitTimes": 1,
            "failEnable": true,
            "failRate": 100,
            "timeoutKillEnable": false,
            "endEarly": 30,
            "sendChannel": "",
            "timeout": 300,
            "daysOfDeadline": 0,
            "alarmType": "CustomContacts",
            "missWorkerEnable": true,
            "timeoutEnable": true,
            "successNotice": false
          },
          "contactInfoList": [],
          "coordinate": {
            "x": -176,
            "y": 357
          },
          "dependentStrategy": 1,
          "status": 1
        },
        {
          "name": "script-job2",
          // 类似
        },
        {
          "name": "script-job3",
          // 类似
        },
        {
          "name": "script-job4",
          // 类似
        },
        {
          "name": "condition_branch",
          // 类似
        }
      ],
      "edges": [
        {
          "from": "Schedulerx-Root",
          "to": "script-job2"
        },
        {
          "from": "Schedulerx-Root",
          "to": "script-job1"
        },
        {
          "from": "script-job1",
          "to": "condition_branch"
        },
        {
          "from": "script-job2",
          "to": "condition_branch"
        },
        {
          "from": "condition_branch",
          "to": "script-job4"
        },
        {
          "from": "condition_branch",
          "to": "script-job3"
        }
      ],
      "kind": "SchedulerXWorkflows",
    }
  ]
}