bpmn-io / bpmn-js-token-simulation

A BPMN 2.0 specification compliant token simulator.

bpmn-js Token Simulation

A BPMN 2.0 specification compliant token simulator, built as a bpmn-js extension.

Try it on the classic booking example or checkout the full capability demo.

Installation

Install via npm.

npm install bpmn-js-token-simulation

Usage

Add as additional module to bpmn-js.

Modeler

import BpmnModeler from 'bpmn-js/lib/Modeler';
import TokenSimulationModule from 'bpmn-js-token-simulation';

const modeler = new BpmnModeler({
  container: '#canvas',
  additionalModules: [
    TokenSimulationModule
  ]
});

Viewer

import BpmnViewer from 'bpmn-js/lib/NavigatedViewer';
import TokenSimulationModule from 'bpmn-js-token-simulation/lib/viewer';

const viewer = new BpmnViewer({
  container: '#canvas',
  additionalModules: [
    TokenSimulationModule
  ]
});

Build and Run

Prepare the project by installing all dependencies:

npm install

Then, depending on your use-case you may run any of the following commands:

# build the library and run all tests
npm run all

# run the full development setup
npm run dev

# spin up the example
npm run start:example

Additional Resources

• Talk: Making of token simulation - The case for token simulation and how it builds on top of bpmn-js
• Talk: Token simulation internals - Detailed walk through the simulators core
• Talk: Your next BPMN engine - How we turned this project into a BPMN 2.0 spec compliant simulator
• Camunda Modeler Token Simulation plug-in - Token simulation for Camunda users

Licence

MIT