工作流引擎-核心表结构与接口设计

电子书地址：https://workflow-engine-book.shuwoom.com

核心表结构

流程表

workflow表

流程实例表

workflow_inst表

节点实例表

node_inst表

核心接口

WFMC定义的所有接口如下：

● 过程定义数据，以及过程定义数据的转换规范

● 支持不同工作流系统间协同工作的接口

● 支持与各种不同IT应用程序交互的接口

● 支持与用户交互的接口

● 提供系统监视，以及标准功能来简化复合工作流应用环境管理的接口

创建流程

请求

各个字段的说明请参考第三章的《流程定义》。

{
    "name":"Unknown",
"description":"",
"startTaskInstId":"",
"endTaskInstId":"",
"engine":"fast",
"status":"",
"creator":"admin",
"executor":"",
"timeout":0,
"inputDataSchema":{
...
},
"outputDataSchema":{
...
},
"error":"",
"extension":{
...
},
"metadata":{
...
},
"tasks":[
...
]
}

响应

{
    "response": {
        "id": "proc-avxhke9u"
    }
}

获取流程详情

请求

• • process_id (流程ID，字符串)

/v1/process/proc-avxhke9u

响应

{
    "id":"proc-avxhke9u",
"name":"Unknown",
"description":"",
"startTaskInstId":"",
"endTaskInstId":"",
"engine":"fast",
"status":"",
"creator":"admin",
"executor":"",
"timeout":0,
"inputDataSchema":{
...
},
"outputDataSchema":{
...
},
"error":"",
"extension":{
...
},
"metadata":{
...
},
"tasks":[
...
]
}

获取任务详情

请求

• • process_id (流程ID，字符串)

• • task_id（任务ID，字符串）

/api/process/proc-10001/task-3udfizra

响应

{
    "instId":"task-3udfizra",
"name":"脚本任务执行",
"description":"执行脚本任务",
"template":"script",
"positions":[],
"connections":[],
"parameters":{
"code":{
"label":"代码",
"type":"string",
"value":"",
"default":"",
"required":true
}
},
"errorHandler":{},
"loopHandler":{},
"timeout":0,
"isIgnore":false
}

启动流程实例

请求

• • process_id (流程ID，字符串)

• • payload (初始化数据，可以为空，也可以传递启动的JSON数据)

/api/process/proc-avxhke9u

{
    "param1": "hello world",
        "param2": "tester"
}

响应

启动成功后，异步返回流程实例ID

{
    "response": {
        "id": "1541815603606036480"
    }
}

获取流程实例详情

请求

• • inst_id (流程实例ID，字符串。注意：每个inst_id是唯一的不重复)

/api/processInst/1541815603606036480

响应

这里主要是获取流程实例中各个任务实例在运行时的数据，即runtimes数据。

{
    "id":"1541815603606036480",
"proc_id":"proc-avxhke9u",
"name":"Unknown",
"description":"",
"startTaskInstId":"",
"endTaskInstId":"",
"engine":"fast",
"status":"",
"creator":"admin",
"executor":"",
"timeout":0,
"inputDataSchema":{
...
},
"outputDataSchema":{
...
},
"error":"",
"extension":{
...
},
"metadata":{
...
},
"tasks":[
{
"instId":"task-3udfizra",
"name":"脚本任务执行",
"description":"执行脚本任务",
"template":"script",
"positions":[],
"connections":[],
"parameters":{
"code":{
"label":"代码",
"type":"string",
"value":"",
"default":"",
"required":true
}
},
"errorHandler":{},
"loopHandler":{},
"timeout":0,
"isIgnore":false,
"runtimes":[
{
"index":0,
"startAt":1700063265000,
"endAt":1700063307000,
"status":"done",
"error":"",
"input":{
"code":"xxx"
},
"output":"ok"
}
]
}
]
}

获取任务实例详情

请求

• • inst_id（流程实例ID，字符串。注意：每个流程实例ID都是唯一不重复的）

• • task_id (任务ID，字符串。注意：流程实例中每个任务ID都是唯一不重复的)

/api/processInst/inst-avxhke9u/task-3udfizra

响应

这里只返回对应流程实例中所关注的任务的运行时数据，即runtimes数据。

{
    "instId":"task-3udfizra",
"name":"脚本任务执行",
"description":"执行脚本任务",
"template":"script",
"positions":[],
"connections":[],
"parameters":{
"code":{
"label":"代码",
"type":"string",
"value":"",
"default":"",
"required":true
}
},
"errorHandler":{},
"loopHandler":{},
"timeout":0,
"isIgnore":false,
"runtimes":[
{
"index":0,
"startAt":1700063265000,
"endAt":1700063307000,
"status":"done",
"error":"",
"input":{
"code":"xxx"
},
"output":"ok"
}
]
}

查询代办任务

请求

• • user (用户，字符串)

• • limit(分页大小，整形)

• • offset(分页偏移，整形)

/api/taskInsts?user=zhangsan&limit=20&offset=0

响应

返回的list数组中的任务实例ID：inst-xf2gh3xs9是唯一不重复的。

{
    "response":{
"list":[
{
"id":"inst-xf2gh3xs9",
"name":"请假条审批",
"content":"由于.....",
"createAt":"2023-12-01 10:00:00"
}
],
"total":1
}
}

提交任务

请求

• • task_inst_id (任务实例ID，字符串)

• • payload提交的post参数，根据任务实例的入参来传递key、value数据。可以通过前面的获取任务实例详情接口得到入参列表。

/api/taskInst/inst-xf2gh3xs9

{
    "key1": "value1",
    "key2": "value2"
}

原文始发于微信公众号（瓶中小人）：工作流引擎-核心表结构与接口设计