Interface BPClient

active one FSM in BP

Example

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

Copy

Returns

return compile result

get active tasks

Example

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

Copy

Returns

active tasks

add history record of BP to db

Example

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

Returns

inserted record id

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");
Copy

Returns

result

continue to complete current task

Example

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

Result

result

create a new FSM in BP

Example

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

Returns

if create fsm, only return record id

deactivate one FSM in BP

Example

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

delegate task to another user or queue to process

Example

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

delete one bp record

Example

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

Returns

deleted number

delete flow instance and related resource

Example

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

add one fsm sla

Example

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

Returns

compile result

add one fsm step

Example

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

Returns

compile result

add one fsm var

Example

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

Returns

compile result

delete one fsm SLA

Example

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

Returns

deleted count

delete one fsm step

Example

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

Returns

deleted count

get process steps in one bp record

Example

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

Returns

process steps

get sla in one bp record

Example

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

Returns

sla

get values of variables

Example

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

Returns

variable values

modify one FSM in BP

Example

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

Returns

compile result

resume bp

Example

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

set values to according variables

Example

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

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")
Copy

Input

input the parameters of bp

Returns

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

suspend bp

Example

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

terminate BP and related resource

Example

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