Interface BPMTaskClient

Hierarchy

  • BPMTaskClient

Properties

addAttachments: ((taskInsId, recs) => string[])

Type declaration

    • (taskInsId, recs): string[]
    • 为BPM任务添加文件附件信息

      Parameters

      • taskInsId: string

        任务实例ID

      • recs: Dict[]

        文件附件信息记录

      Returns string[]

      返回新增文件附件信息记录的id列表

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.addAttachments("002N000000VwBrSDISbQ", [
      {
      "name": "aaa",
      "fileName": "a/b/c",
      "category": "xxx",
      "url": "xxx.com/xxx/xxx",
      "taskID": "xxx",
      },
      {
      "name": "bbb",
      "fileName": "a/b/c/d",
      "category": "yyy",
      "url": "yyy.com/yyy/yyy",
      "taskID": "yyy",
      }
      ])
      console.log(res)
addComment: ((taskInsId, comment) => Dict)

Type declaration

    • (taskInsId, comment): Dict
    • 为BPM任务添加评论

      Parameters

      • taskInsId: string

        任务实例ID

      • comment: string

        评论信息

      Returns Dict

      返回添加的评论相关记录

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.addComment("comments")
cancel: ((taskInsId, reason?) => Dict)

Type declaration

    • (taskInsId, reason?): Dict
    • 取消并行任务

      Parameters

      • taskInsId: string

        任务实例ID

      • Optional reason: string

        可以置空

      Returns Dict

      任务状态信息

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let tasks = taskClient.cancel(
      "002N000000VBk5qqWi1I",
      "task is end"
      )
      console.log(tasks)
claim: ((taskInsId) => Dict)

Type declaration

    • (taskInsId): Dict
    • 申请处理指定的任务

      Parameters

      • taskInsId: string

        任务实例ID

      Returns Dict

      任务状态信息

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.claim(
      "002N000000VBk5qqWi1I"
      )
complete: ((taskInsId, outcome, inputs) => Dict)

Type declaration

    • (taskInsId, outcome, inputs): Dict
    • 结束任务

      Parameters

      • taskInsId: string

        任务实例ID

      • outcome: string

        可以指定任务结果状态,如果为空字符串,任务状态将默认置为"complete"

      • inputs: Dict

        可以设置BPM任务的变量,如果为空Map{}则不修改变量值

      Returns Dict

      任务状态信息

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.complete(
      "002N000000VBk5qqWi1I",
      "",
      {}
      )
      console.log(res)
completeWithAssignee: ((taskInsId, assignee, outcome, inputs) => Dict)

Type declaration

    • (taskInsId, assignee, outcome, inputs): Dict
    • 结束任务,并指定下一个任务的参与者(必须在下一个任务的参与者列表中,或具有管理权限)。

      Parameters

      • taskInsId: string

        任务实例ID

      • assignee: string
      • outcome: string

        可以指定任务结果状态,如果为空字符串,任务状态将默认置为"complete"

      • inputs: Dict

        可以设置BPM任务的变量,如果为空Map{}则不修改变量值

      Returns Dict

      任务状态信息

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.completeWithAssignee(
      "002N000000VBk5qqWi1I",
      "user",
      "",
      {}
      )
      console.log(res)
createSubTask: ((procInsId, parentId, assignee) => Dict)

Type declaration

    • (procInsId, parentId, assignee): Dict
    • 创建一个BPM子任务实例,注意parentId对应任务不能是用户任务

      Parameters

      • procInsId: string

        bp实例的ID

      • parentId: string

        父任务的ID

      • assignee: string

        用户标识,可以是用户的登录账号,也可以是用户的ID

      Returns Dict

      任务状态信息

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.createSubTask(
      "002N000000VBk5qqWi1I",
      "002N000000VBk5qqWaSd",
      "user",
      )
      console.log(res)
delegate: ((taskInsId, assignee, reason?) => Dict)

Type declaration

    • (taskInsId, assignee, reason?): Dict
    • 将任务进行委托

      Parameters

      • taskInsId: string

        任务实例ID

      • assignee: string

        被委托的用户标识,可以是用户的登录账号,也可以是用户的ID

      • Optional reason: string

        可以置空

      Returns Dict

      任务状态信息

      Example

      import {delegate}from 'bp'
      delegate("002N000000VwBrSDISbQ","user","resons")
delete: ((taskInsId) => void)

Type declaration

    • (taskInsId): void
    • 删除任务

      Parameters

      • taskInsId: string

        任务实例ID

      Returns void

      Example

      import * as bp from 'bp'
      let task = bp.newTaskClient()
      task.delete("taskInsId")
deleteAttachments: ((taskInsId, idList) => void)

Type declaration

    • (taskInsId, idList): void
    • 删除BPM任务的文件附件信息

      Parameters

      • taskInsId: string

        任务实例ID

      • idList: string[]

        要删除的附件信息记录id列表

      Returns void

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      taskClient.deleteAttachments("002N000000VwBrSDISbQ",["id1","id2"])
deleteComment: ((taskInsId, commentId) => void)

Type declaration

    • (taskInsId, commentId): void
    • 删除BPM任务的评论

      Parameters

      • taskInsId: string

        任务实例ID

      • commentId: string

        评论实例ID

      Returns void

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.deleteComment("taskInsId","commentId")
getComment: ((taskInsId, commentId, options?) => Dict)

Type declaration

    • (taskInsId, commentId, options?): Dict
    • 获取某个具体的BPM任务评论

      Parameters

      • taskInsId: string

        任务实例ID

      • commentId: string

        评论实例ID

      • Optional options: OptionItem

        可选参数,可部分置空或全部置空

      Returns Dict

      返回某个具体的评论记录

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.getComment("taskInsId","commentId")
getComments: ((taskInsId, options?) => Dict[])

Type declaration

    • (taskInsId, options?): Dict[]
    • 获取BPM任务的评论

      Parameters

      • taskInsId: string
      • Optional options: OptionItem

        可选,可部分置空或全部置空

      Returns Dict[]

      返回相关的评论记录

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.getComments("taskInsId")
getVars: ((taskInsId, names) => Dict)

Type declaration

    • (taskInsId, names): Dict
    • 获取BPM任务的变量值

      Parameters

      • taskInsId: string

        任务实例ID

      • names: string[]

        要查询的变量值列表,如果填入空数组,则查询所有变量

      Returns Dict

      变量Key-Value键值对

      Example


      import * as bp from 'bp'
      let taskClient=bp.newTaskClient()
      let vars = taskClient.getVars("002N000000VwBrSDISbQ", ["foo", "bar"])
      console.log(vars)
query: ((taskInsId, options?) => Dict)

Type declaration

    • (taskInsId, options?): Dict
    • 指定具体BPM任务ID,查任务信息

      Parameters

      • taskInsId: string

        任务实例ID

      • Optional options: OptionItem

        可选,可部分置空或全部置空

      Returns Dict

      任务信息

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.query("002N000000VwBrSDISbQ", {
      fields: ["name", "bpStatus", "createdDate", "owner"],
      })
      console.log(res)
queryActiveList: ((activeTaskCondition?) => Dict[])

Type declaration

    • (activeTaskCondition?): Dict[]
    • 查询活跃状态的BPM任务列表,这里激活状态包括New/Dispatched/InProcess这三种任务状态

      Parameters

      • Optional activeTaskCondition: ActiveTaskCondition

        查询活跃状态任务的条件,可部分留空或全部留空

      Returns Dict[]

      返回匹配的任务列表

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let tasks = taskClient.queryActiveList({
      owner: "002I000000VBjYt2OCYK",
      rootID: "002N000000VBjj8I66gC",
      options: {
      fields: ["assignee", "assigneeID", "assigneeType", "assigneeName", "name", "state", "rootID", "owner"],
      }
      })
      console.log(tasks)
queryAttachments: ((taskInsId, options?) => Dict[])

Type declaration

    • (taskInsId, options?): Dict[]
    • 查询BPM任务的文件附件信息记录

      Parameters

      • taskInsId: string

        任务实例ID

      • Optional options: OptionItem

        可选,可部分置空或全部置空

      Returns Dict[]

      查询到的文件附件信息记录

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let recs = taskClient.queryAttachments("002N000000VwBrSDISbQ", {
      fields: ["taskID", "name", "fileName", "url"],
      limit: 5,
      })
      console.log(recs)
queryByCondition: ((condition?) => Dict[])

Type declaration

    • (condition?): Dict[]
    • 按照指定条件查BPM任务

      Parameters

      • Optional condition: "bp".ConditionOption

        指定的查询条件,若不指定具体condition或option留空即可

      Returns Dict[]

      返回查询出的BPM任务的记录

      Example


      import * as bp from 'bp'
      import * as db from 'db'
      let taskClient = bp.newTaskClient()
      let res = taskClient.queryByCondition({
      condition: {
      conjunction: db.Conjunction.AND,
      conditions: [
      {
      field: "createdDate",
      operator: db.Operator.gt,
      value: "2019-08-01 00:00:00"
      }
      ]
      },
      options: {
      fields: ["assignee", "assigneeID", "assigneeType", "assigneeName", "name"],
      orderby: [
      {
      field: "assignee",
      order: db.Order.desc
      }
      ],
      }
      })
      console.log(res)
queryClosedList: ((queryCondition?) => Dict[])

Type declaration

    • (queryCondition?): Dict[]
    • 查询closed状态的bpm任务,示例与querySuspendList类似

      Parameters

      • Optional queryCondition: QueryCondition

        查询条件,可以全部为空或部分为空

      Returns Dict[]

      查询返回的任务列表

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.queryClosedList({
      creator: "002I000000VBjYt2OCYK",
      owner: "002I000000VBjYt2OCYK"
      })
      console.log(res)
queryCompletedList: ((queryCondition?) => Dict[])

Type declaration

    • (queryCondition?): Dict[]
    • 查询completed状态的bpm任务,示例与querySuspendList类似

      Parameters

      • Optional queryCondition: QueryCondition

        查询条件,可以全部为空或部分为空

      Returns Dict[]

      查询返回的任务列表

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.queryCompletedList({
      creator: "002I000000VBjYt2OCYK",
      owner: "002I000000VBjYt2OCYK"
      })
      console.log(res)
queryList: ((queryTaskListCondition?) => Dict[])

Type declaration

    • (queryTaskListCondition?): Dict[]
    • 按照指定条件查询BPM任务列表

      Parameters

      Returns Dict[]

      查询返回的任务列表

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.queryList({
      rootID: "002N000000VBk5qqWi1I",
      states: [bp.State.Terminated, bp.State.New],
      procInsID: "xxxxxxxxxxxxxxxxxx",
      })
      console.log(res)
queryMyList: ((myTaskCondition?) => Dict[])

Type declaration

    • (myTaskCondition?): Dict[]
    • 查询属主是调用者本人的BPM任务列表

      Parameters

      • Optional myTaskCondition: MyTaskCondition

        查询自己BPM任务的条件,可部分留空或全部留空

      Returns Dict[]

      返回匹配的任务列表

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let tasks = taskClient.queryMyList({
      instID: "002N000000VwBrSDISbQ",
      rootID: "002N000000VBjj8I66gC",
      options: {
      fields: ["assignee", "assigneeID", "assigneeType", "assigneeName", "name", "state", "rootID", "owner"],
      }
      })
      console.log(tasks)
querySuspendList: ((queryCondition?) => Dict[])

Type declaration

    • (queryCondition?): Dict[]
    • 查询suspended状态的bpm任务

      Parameters

      • Optional queryCondition: QueryCondition

        查询条件,可以全部为空或部分为空

      Returns Dict[]

      查询返回的任务列表

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.querySuspendList({
      creator: "002I000000VBjYt2OCYK",
      owner: "002I000000VBjYt2OCYK"
      })
      console.log(res)
rollbackSpecifiedTask: ((taskInsId, outcome, inputs) => FlowInstance)

Type declaration

    • (taskInsId, outcome, inputs): FlowInstance
    • 结束任务

      Parameters

      • taskInsId: string

        任务实例ID

      • outcome: string

        可以指定任务结果状态,如果为空字符串,任务状态将默认置为"complete"

      • inputs: Dict

        可以设置BPM任务的变量,如果为空Map{}则不修改变量值

      Returns FlowInstance

      任务状态信息

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.rollbackSpecifiedTask(
      "002N000000VBk5qqWi1I",
      "",
      {}
      )
      console.log(res)
setVars: ((taskInsId, inputs) => void)

Type declaration

    • (taskInsId, inputs): void
    • 设置BPM任务中定义变量的值

      Parameters

      • taskInsId: string

        任务实例ID

      • inputs: Dict

        参数key-value键值对,注意设置的变量名是BPM定义过的变量

      Returns void

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      taskClient.setVars("002N000000VwBrSDISbQ", {
      "foo": "aaa",
      "bar": "bbb"
      })
terminate: ((taskInsId, reason?) => Dict)

Type declaration

    • (taskInsId, reason?): Dict
    • 终止任务

      Parameters

      • taskInsId: string

        任务实例ID

      • Optional reason: string

        可以置空

      Returns Dict

      任务状态信息

      Example

      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      taskClient.terminate("bpId","bp is end")
transfer: ((taskInsId, assignee, reason?) => Dict)

Type declaration

    • (taskInsId, assignee, reason?): Dict
    • 让系统将任务转移给他人

      Parameters

      • taskInsId: string

        任务实例ID

      • assignee: string

        被委托的用户标识

      • Optional reason: string

        可以置空

      Returns Dict

      任务状态信息

      Example

      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      taskClient.transfer("bpId","userId","")
updateComment: ((taskInsId, commentId, comment) => void)

Type declaration

    • (taskInsId, commentId, comment): void
    • 更新BPM任务的评论

      Parameters

      • taskInsId: string

        任务实例ID

      • commentId: string

        评论实例ID

      • comment: string

        评论信息

      Returns void

      Example


      import * as bp from 'bp'
      let taskClient = bp.newTaskClient()
      let res = taskClient.updateComment("taskInsId","commentId","comment")