api summary

bpmn-server

API Summary Full Listing

Server Components

• engine BPMN Execution Engine
• definitions
• dataStore
• cache
• cron

Other Components and Topics

• Data Query
• configuration
• appDelegate
• events listener
• Data Variables and input/output
• Timers

engine:

The execution Engine , processes an BPMN definition - Engine

Method	parameters	return	description
start	name, input	ExecutionContext	- Start a new Process execution
invoke	itemQuery ,input	ExecutionContext	Invoke an already started Item (waiting)
signal	signalId,input	ExecutionContext	Issue a signal or message
get	instanceQuery	Instance	Get an already running or idle Instance

examples:

    let response: executioncontext;
    let data = {};

    //  engine
    response = await bpmn.engine.start('SubProcess');
    response = await bpmn.engine.invoke(itemQuery, data);
    response = await bpmn.engine.signal(signalId, data);
    response = await bpmn.engine.startEvent(instanceQuery, 'elementId', data);
    response = await bpmn.engine.get(instanceQuery);

definitions

Manages BPMN defintions - Definitions

Method	parameters	return	description
list	-	string[]
load	name	definition

datastore

Saves and retrievs Instances Data - DataStore

Method	parameters	return	description
findInstances	instanceQuery	Instance[]
findItems	itemQuery	Item[]

cache

Caches running instances for performance - CacheManager

	list		id[]
	get			instance
	remove
	clear
	restart

cron

Manages background tasks, primarly timers - Cron

	start
	check
	stop

- configuration

- AppDelegate

- Event Listener

- Data

## Enumerations

* [BPMN_TYPE](api/enums/bpmn_type.md)
* [EXECUTION_EVENT](api/enums/execution_event.md)
* [EXECUTION_STATUS](api/enums/execution_status.md)
* [ITEM_STATUS](api/enums/item_status.md)
* [Behaviour_names](api/README.md#const-behaviour_names)