bpmn-js-token-simulation

Looking for the Camunda Modeler Plugin? Get it here!

bpmn-js Token Simulation

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

Installation

Install via npm.

npm install bpmn-js-token-simulation

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

# spin up the example
npm start

# run the full development setup
npm run dev

Licence

MIT

Changelog

0.25.0

• FEAT: rewrite simulator using event scopes and subscriptions (#101)
• FEAT: support event rethrow and "absorption" (#100)
• FEAT: trigger all startable elements inside bpmn:SubProcess (#107, acdae242)
• FEAT: support transactions and cancel events (#76, #102, 5026298b)
• FEAT: support compensation (#76, #102, bcdad034)
• FEAT: eagerly interrupt when entering event sub-process (452ce5ec)
• FEAT: add Simulator APIs for (BPMN) event triggering and subscriptions (5da21ed8)
• FEAT: add Simulator#waitForScopes API (e23e57f0)
• FIX: don't allow pause on event sub-process (af04910b)
• FIX: correct pause handling on receive tasks (#99)
• FIX: ensure technically equal events can still be signaled individually (#103, #107 15d14062)
• CHORE: implement termination as a behavior (e92e8ff8)
• CHORE: remove destroyed scopes (b3662dc8)
• CHORE: namespace CSS (#30)
• CHORE: add properties panel to example (104)
• DEPS: update to bpmn-js@8.9.0

Breaking Changes

• Generated markup and used CSS classes changed; things are consistently prefixed with bts now to avoid foreign classes crashing (#30)
• Drop destroyContext in favor of dedicated scope state (failed/ended) (#101)
• Reworked way the outside interacts with the simulator: Rather than signaling the simulator with knowledge of internal working mechanisms you trigger an event on a particular scope, notifying all registered subscribers. (#101)
• Destroyed scopes are now longer kept around by simulator (b3662dc8)