Class: BusinessProcess

Members

activity

Current activity

Source:

• businessprocess.js, line 61

locals

Local parameters

Source:

• businessprocess.js, line 72

metadata

Current meta data.

• name: process name
• label: name to display
• steps: activities with transitions

Source:

• businessprocess.js, line 45

next

Next activity = validate

Source:

• businessprocess.js, line 327

pid

Current process ID

Source:

• businessprocess.js, line 55

road

Screenflow of front-end activities

Source:

• businessprocess.js, line 66

Methods

action

Activity common action

Parameters:

Name	Type	Description
callback		optional callback on server response
action		: lock, unlock, validate, back, cancel, read, open, firstpage, lastpage, nextpage, backpage, gotopage
activity		Activity file
params		Options async: Asynchronous call (use default if absent) ? error: Custom error handler (use default error handler if absent) ? road: true to get the full navigation array, false to get the current activity

Source:

• businessprocess.js, line 245

back

Unlock the activity and read/lock the previous one

Source:

• businessprocess.js, line 330

cancel

Cancel the activity, returns the next activity or the forward parameters

Source:

• businessprocess.js, line 317

getActivityData

Get data values of the current activity

Source:

• businessprocess.js, line 218

getData

Get data values of a road step

Source:

• businessprocess.js, line 223

getLabel

Gets label name from meta data.

Source:

• businessprocess.js, line 121

getMetaData

Loads meta data.

Parameters:

Name	Type	Description
callback		Callback function called when loading is completed
params		Optional parameters async: Asynchronous call (use default if absent) ? error: Custom error handler (use default error handler if absent) ?

Source:

• businessprocess.js, line 85

getName

Gets name from meta data.

Source:

• businessprocess.js, line 113

isLoaded

Are metadata loaded ?

Source:

• businessprocess.js, line 105

localParameter

Local parameter in instance

Parameters:

Name	Type	Description
name		Parameter key name
value		Optional value (to get or set)

Source:

• businessprocess.js, line 130

lock

Read and lock the activity { step, aid }

Source:

• businessprocess.js, line 308

read

Read the activity with { step, aid }

Source:

• businessprocess.js, line 304

setActivityData

Set data values in the current activity

Source:

• businessprocess.js, line 210

start

Start a new process (or continue the screenflow)

Parameters:

Name	Type	Description
callback		optional callback on server response
params		Options async: Asynchronous call (use default if absent) ? error: Custom error handler (use default error handler if absent) ? road: true to get the full navigation array, false to get the current activity object: launcher object name rowId: launcher object id

Source:

• businessprocess.js, line 147

unlock

Read and unlock the activity { step, aid }

Source:

• businessprocess.js, line 312

validate

Validate the activity with data, returns errors, the next activity or the forward parameters

Source:

• businessprocess.js, line 322