Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BPClient

Hierarchy

  • BPClient

Index

Methods

Methods

activateFSM

  • activateFSM(id: string): Dict

  • active one FSM in BP

    example
    
import * as bp from 'bp'
let client = bp.newClientV1()
let res=client.activateFSM("id");

    Parameters

    • id: string

      record id

    Returns Dict

    return compile result

activeTask

  • activeTask(iid: string): Dict[]

  • get active tasks

    example
    
import * as bp from 'bp'
let client = bp.newClientV1()
let res=client.activeTask("iid");

    Parameters

    • iid: string

    Returns Dict[]

    active tasks

addHistory

  • addHistory(iid: string, msg: string): string

  • add history record of BP to db

    example
    import {addHistory} bp from 'bp';
addHistory("iid","message");

    Parameters

    • iid: string

      bp interview id

    • msg: string

      message

    Returns string

    inserted record id

complete

  • complete(iid: string, input: Dict): Dict

  • complete current task(fill page/screen and commit) and continue the BP instance

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

    Parameters

    • iid: string

      bp interview id

    • input: Dict

      input parameters

    Returns Dict

    result

continue

  • continue(iid: string, input: Dict): Dict

  • continue to complete current task

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

    result

    Parameters

    • iid: string

      bp interview id

    • input: Dict

      input parameters

    Returns Dict

createFSM

  • create a new FSM in BP

    example
    import * as bp from 'bp'
let client = bp.newClientV1()
let fsm = client.createFSM("data");

    Parameters

    • data: Dict

      the bp content

    Returns Dict

    if create fsm, only return record id

deactivateFSM

  • deactivateFSM(id: string): void

  • deactivate one FSM in BP

    example
    import * as bp from 'bp'
let client = bp.newClientV1()
let fsm = client.createFSM("data");
fsm.deactivateFSM("fsmId");

    Parameters

    • id: string

      record id

    Returns void

delegate

  • delegate(iid: string, assignee: string, reason: string): void

  • delegate task to another user or queue to process

    example
    import * as bp from 'bp'
let client = bp.newClientV1()
client.delegate("002N000000VwBrSDISbQ","user","resons")

    Parameters

    • iid: string

      bp interview id

    • assignee: string
    • reason: string

    Returns void

delete

  • delete(id: string): number

  • delete one bp record

    example
    import {delete} from 'bp'
let res=delete（"002N000000VwBrSDISbQ"）;

    Parameters

    • id: string

      record id

    Returns number

    deleted number

deleteInstance

  • deleteInstance(instanceID: string, reason: string): void

  • delete flow instance and related resource

    example
    import {deleteInstance} from 'bp'
let client = bp.newClientV1()
client.deleteInstance（"flowId","Unnecessary flow"）;

    Parameters

    • instanceID: string
    • reason: string

      delete reason

    Returns void

fsmAddSLA

  • fsmAddSLA(id: string, data: Dict, objName?: string): Dict

  • add one fsm sla

    example
    import {fsmAddSLA} from 'bp'
let res =fsmAddSLA("id","data"）; // 返回null代表成功，失败的话会抛出错误信息

    Parameters

    • id: string

      record id

    • data: Dict

      content

    • Optional objName: string

      optional

    Returns Dict

    compile result

fsmAddStep

  • fsmAddStep(id: string, data: Dict, objName?: string): Dict

  • add one fsm step

    example
    import {fsmAddStep} from 'bp'
fsm.fsmAddStep("stepId","stepData"); // 返回null代表成功，失败的话会抛出错误信息

    Parameters

    • id: string

      record id

    • data: Dict

      content

    • Optional objName: string

      optional

    Returns Dict

    compile result

fsmAddVar

  • fsmAddVar(id: string, data: Dict, objName?: string): Dict

  • add one fsm var

    example
    import {fsmAddVar} from 'bp'
fsm.fsmAddVar("varId","varData"); // 返回null代表成功，失败的话会抛出错误信息

    Parameters

    • id: string

      record id

    • data: Dict

      content

    • Optional objName: string

      optional

    Returns Dict

    compile result

fsmDeleteSLA

  • fsmDeleteSLA(id: string, objName?: string): number

  • delete one fsm SLA

    example
    import {fsmDeleteSLA} from 'bp'
let res=fsm.fsmDeleteSLA("002N000000VwBrSDISbQ")

    Parameters

    • id: string

      record id

    • Optional objName: string

      optional

    Returns number

    deleted count

fsmDeleteStep

  • fsmDeleteStep(id: string, objName?: string): number

  • delete one fsm step

    example
    import {fsmDeleteStep} from 'bp
fsm.fsmDeleteStep("002N000000VwBrSDISbQ")

    Parameters

    • id: string

      record id

    • Optional objName: string

      optional

    Returns number

    deleted count

getProcessSteps

  • getProcessSteps(id: string): Dict[]

  • get process steps in one bp record

    example
    import * as bp from 'bp'
let bpInstance=bp.newClientV1();
let progessList = bpInstance.getProcessSteps("002N000000VwBrSDISbQ")

    Parameters

    • id: string

    Returns Dict[]

    process steps

getSLA

  • getSLA(id: string): Dict[]

  • get sla in one bp record

    example
    import * as bp from 'bp'
let bpInstance=bp.newClientV1();
let slaList = bpInstance.getSLA("002N000000VwBrSDISbQ")

    Parameters

    • id: string

    Returns Dict[]

    sla

getVars

  • getVars(instanceID: string, names: string[]): Dict

  • get values of variables

    example
    import * as bp from 'bp'
let client=bp.newClientV1();
let vars = client.getVars("002N000000VwBrSDISbQ", ["foo", "bar"])
console.log(vars)

    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

modifyFSM

  • modifyFSM(id: string, data: Dict): Dict

  • modify one FSM in BP

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

    Parameters

    • id: string

      record id

    • data: Dict

      FSM content

    Returns Dict

    compile result

resume

  • resume(instanceID: string): void

  • resume bp

    example
    import * as bp from 'bp'
let client = bp.newClientV1()
let res = client.resume("002N000000VwBrSDISbQ")

    Parameters

    • instanceID: string

      instance id

    Returns void

setVars

  • setVars(instanceID: string, values: Dict): void

  • set values to according variables

    example
    import * as bp from 'bp'
let client = bp.newClientV1()
client.setVars("002N000000VwBrSDISbQ", {"foo": "aaa","bar": "bbb"})

    Parameters

    • instanceID: string

      instance id

    • values: Dict

      variables

    Returns void

start

  • start(name: string, input: Dict, version?: string): Dict

  • start executing a BP

    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

    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"
}
]
}

suspend

  • suspend(instanceID: string): void

  • suspend bp

    example
    import * as bp from 'bp'
let client = bp.newClientV1()
let res = client.suspend("002N000000VwBrSDISbQ")

    Parameters

    • instanceID: string

      instance id

    Returns void

terminate

  • terminate(instanceID: string, reason: string): void

  • terminate BP and related resource

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

    Parameters

    • instanceID: string

      instance id

    • reason: string

      terminate reason

    Returns void