Interface BPClient

Hierarchy

  • BPClient

Properties

activateFSM: ((id) => Dict)

Type declaration

    • (id): Dict
    • active one FSM in BP

      Parameters

      • id: string

        record id

      Returns Dict

      return compile result

      Example


      import * as bp from 'bp'
      let client = bp.newClientV1()
      let res=client.activateFSM("id");
activeTask: ((iid) => Dict[])

Type declaration

    • (iid): Dict[]
    • get active tasks

      Parameters

      • iid: string

      Returns Dict[]

      active tasks

      Example


      import * as bp from 'bp'
      let client = bp.newClientV1()
      let res=client.activeTask("iid");
addHistory: ((iid, msg) => string)

Type declaration

    • (iid, msg): string
    • add history record of BP to db

      Parameters

      • iid: string

        bp interview id

      • msg: string

        message

      Returns string

      inserted record id

      Example

      import {addHistory} bp from 'bp';
      addHistory("iid","message");
complete: ((iid, input) => Dict)

Type declaration

    • (iid, input): Dict
    • complete current task(fill page/screen and commit) and continue the BP instance

      Parameters

      • iid: string

        bp interview id

      • input: Dict

        input parameters

      Returns Dict

      result

      Example

      import {complete} bp from 'bp';
      let client = bp.newClientV1()
      let res=client.complete("bpId","inputData");
continue: ((iid, input) => Dict)

Type declaration

    • (iid, input): Dict
    • continue to complete current task

      Parameters

      • iid: string

        bp interview id

      • input: Dict

        input parameters

      Returns Dict

      Example

      import {continue} bp from 'bp';
      let client = bp.newClientV1()
      let res=client.continue("bpId","inputData");

      Result

      result

createFSM: ((data) => Dict)

Type declaration

    • (data): Dict
    • create a new FSM in BP

      Parameters

      • data: Dict

        the bp content

      Returns Dict

      if create fsm, only return record id

      Example

      import * as bp from 'bp'
      let client = bp.newClientV1()
      let fsm = client.createFSM("data");
deactivateFSM: ((id) => void)

Type declaration

    • (id): void
    • deactivate one FSM in BP

      Parameters

      • id: string

        record id

      Returns void

      Example

      import * as bp from 'bp'
      let client = bp.newClientV1()
      let fsm = client.createFSM("data");
      fsm.deactivateFSM("fsmId");
delegate: ((iid, assignee, reason) => void)

Type declaration

    • (iid, assignee, reason): void
    • delegate task to another user or queue to process

      Parameters

      • iid: string

        bp interview id

      • assignee: string
      • reason: string

      Returns void

      Example

      import * as bp from 'bp'
      let client = bp.newClientV1()
      client.delegate("002N000000VwBrSDISbQ","user","resons")
delete: ((id) => number)

Type declaration

    • (id): number
    • delete one bp record

      Parameters

      • id: string

        record id

      Returns number

      deleted number

      Example

      import {delete} from 'bp'
      let res=delete"002N000000VwBrSDISbQ");
deleteInstance: ((instanceID, reason) => void)

Type declaration

    • (instanceID, reason): void
    • delete flow instance and related resource

      Parameters

      • instanceID: string
      • reason: string

        delete reason

      Returns void

      Example

      import {deleteInstance} from 'bp'
      let client = bp.newClientV1()
      client.deleteInstance"flowId","Unnecessary flow");
fsmAddSLA: ((id, data, objName?) => Dict)

Type declaration

    • (id, data, objName?): Dict
    • add one fsm sla

      Parameters

      • id: string

        record id

      • data: Dict

        content

      • Optional objName: string

        optional

      Returns Dict

      compile result

      Example

      import {fsmAddSLA} from 'bp'
      let res =fsmAddSLA("id","data"); // 返回null代表成功,失败的话会抛出错误信息
fsmAddStep: ((id, data, objName?) => Dict)

Type declaration

    • (id, data, objName?): Dict
    • add one fsm step

      Parameters

      • id: string

        record id

      • data: Dict

        content

      • Optional objName: string

        optional

      Returns Dict

      compile result

      Example

      import {fsmAddStep} from 'bp'
      fsm.fsmAddStep("stepId","stepData"); // 返回null代表成功,失败的话会抛出错误信息
fsmAddVar: ((id, data, objName?) => Dict)

Type declaration

    • (id, data, objName?): Dict
    • add one fsm var

      Parameters

      • id: string

        record id

      • data: Dict

        content

      • Optional objName: string

        optional

      Returns Dict

      compile result

      Example

      import {fsmAddVar} from 'bp'
      fsm.fsmAddVar("varId","varData"); // 返回null代表成功,失败的话会抛出错误信息
fsmDeleteSLA: ((id, objName?) => number)

Type declaration

    • (id, objName?): number
    • delete one fsm SLA

      Parameters

      • id: string

        record id

      • Optional objName: string

        optional

      Returns number

      deleted count

      Example

      import {fsmDeleteSLA} from 'bp'
      let res=fsm.fsmDeleteSLA("002N000000VwBrSDISbQ")
fsmDeleteStep: ((id, objName?) => number)

Type declaration

    • (id, objName?): number
    • delete one fsm step

      Parameters

      • id: string

        record id

      • Optional objName: string

        optional

      Returns number

      deleted count

      Example

      import {fsmDeleteStep} from 'bp
      fsm.fsmDeleteStep("002N000000VwBrSDISbQ")
getProcessSteps: ((id) => Dict[])

Type declaration

    • (id): Dict[]
    • get process steps in one bp record

      Parameters

      • id: string

      Returns Dict[]

      process steps

      Example

      import * as bp from 'bp'
      let bpInstance=bp.newClientV1();
      let progessList = bpInstance.getProcessSteps("002N000000VwBrSDISbQ")
getSLA: ((id) => Dict[])

Type declaration

    • (id): Dict[]
    • get sla in one bp record

      Parameters

      • id: string

      Returns Dict[]

      sla

      Example

      import * as bp from 'bp'
      let bpInstance=bp.newClientV1();
      let slaList = bpInstance.getSLA("002N000000VwBrSDISbQ")
getVars: ((instanceID, names) => Dict)

Type declaration

    • (instanceID, names): Dict
    • get values of variables

      Parameters

      • instanceID: string

        instance id

      • names: string[]

        get values by names. if names is empty then get values of all variables

      Returns Dict

      variable values

      Example

      import * as bp from 'bp'
      let client=bp.newClientV1();
      let vars = client.getVars("002N000000VwBrSDISbQ", ["foo", "bar"])
      console.log(vars)
modifyFSM: ((id, data) => Dict)

Type declaration

    • (id, data): Dict
    • modify one FSM in BP

      Parameters

      • id: string

        record id

      • data: Dict

        FSM content

      Returns Dict

      compile result

      Example

      import * as bp from 'bp'
      let instClient = bp.newClientV1();
      let res = bp.modifyFSM("002N000000VwBrSDISbQ","FSMData") // 返回null代表成功,失败的话会抛出错误信息
resume: ((instanceID) => void)

Type declaration

    • (instanceID): void
    • resume bp

      Parameters

      • instanceID: string

        instance id

      Returns void

      Example

      import * as bp from 'bp'
      let client = bp.newClientV1()
      let res = client.resume("002N000000VwBrSDISbQ")
setVars: ((instanceID, values) => void)

Type declaration

    • (instanceID, values): void
    • set values to according variables

      Parameters

      • instanceID: string

        instance id

      • values: Dict

        variables

      Returns void

      Example

      import * as bp from 'bp'
      let client = bp.newClientV1()
      client.setVars("002N000000VwBrSDISbQ", {"foo": "aaa","bar": "bbb"})
start: ((name, input, version?) => Dict)

Type declaration

    • (name, input, version?): Dict
    • start executing a BP

      Parameters

      • name: string

        the name of the bp

      • input: Dict
      • Optional version: string

        the version of bp, optional

      Returns Dict

      result. For example,

       {
      "interviewId": "002N000000FdtN6xwgjI",
      "screen": {
      "allowBack": false,
      "allowFinish": true,
      "allowNext": true,
      "allowPause": false,
      "helpText": "",
      "label": "input phone number",
      "name": "inputphonenumber",
      "pausedText": "",
      "screenFields": [
      {
      "dataType": "text",
      "defaultValue": "135xxxxxxxx",
      "fieldType": "InputField",
      "helpText": "",
      "isRequired": false,
      "label": "phone number",
      "name": "phoneNumber"
      }
      ]
      }

      Example

      import * as bp from 'bp'
      let client = bp.newClientV1()
      let res = client.start("test", { "foo": 1, "bar": 3}, "1.0.1")

      Input

      input the parameters of bp

suspend: ((instanceID) => void)

Type declaration

    • (instanceID): void
    • suspend bp

      Parameters

      • instanceID: string

        instance id

      Returns void

      Example

      import * as bp from 'bp'
      let client = bp.newClientV1()
      let res = client.suspend("002N000000VwBrSDISbQ")
terminate: ((instanceID, reason) => void)

Type declaration

    • (instanceID, reason): void
    • terminate BP and related resource

      Parameters

      • instanceID: string

        instance id

      • reason: string

        terminate reason

      Returns void

      Example

      import * as bp from 'bp'
      let client = bp.newClientV1()
      client.terminate("bpId","bp is end")