https://github.com/bpmn-io/camunda-transaction-boundaries

Visualize all Camunda transaction boundaries in a BPMN diagram.
https://github.com/bpmn-io/camunda-transaction-boundaries

bpmn-js camunda

Last synced: 3 months ago
JSON representation

Visualize all Camunda transaction boundaries in a BPMN diagram.

• Host: GitHub
• URL: https://github.com/bpmn-io/camunda-transaction-boundaries
• Owner: bpmn-io
• License: mit
• Created: 2016-07-11T14:28:20.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2022-09-08T10:09:57.000Z (over 2 years ago)
• Last Synced: 2024-10-31T07:34:58.611Z (3 months ago)
• Topics: bpmn-js, camunda
• Language: JavaScript
• Homepage:
• Size: 279 KB
• Stars: 15
• Watchers: 9
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-bpmn-io - camunda-transaction-boundaries - Visualize transaction boundaries, applied by the [Camunda workflow engine](https://camunda.com/) (Extensions)

README

        
> Looking for the [Camunda Modeler](https://github.com/camunda/camunda-modeler) plug-in? Find it [here](https://github.com/camunda/camunda-modeler-plugins/tree/master/camunda-transaction-boundaries-plugin).

> As of version `1.0.0` this library exposes [ES modules](http://exploringjs.com/es6/ch_modules.html#sec_basics-of-es6-modules). Use an ES module aware bundler such as [Webpack](https://webpack.js.org) or [Rollup](https://rollupjs.org) to bundle it for the browser.

# camunda-transaction-boundaries

[![CI](https://github.com/bpmn-io/camunda-transaction-boundaries/workflows/CI/badge.svg)](https://github.com/bpmn-io/camunda-transaction-boundaries/actions?query=workflow%3ACI)

A bpmn-js extension to visualize transaction boundaries, applied by [Camunda](https://docs.camunda.org).

![transaction boundaries screenshot](docs/screenshot.png "Screenshot of Transaction Boundaries")

## Features

Visualize all transaction boundaries in a BPMN diagram.

This includes all BPMN elements that are wait states and have a boundary for incoming connections:

* Intermediate Catching Message Event

* Intermediate Catching Timer Event

* Intermediate Catching Signal Event

* Receive Task

* User Task

* Event Based Gateway

* External Service Task

In addition to these elements all activities with asynchronous continuations act as transaction boundaries. This is also valid for multi-instance activities. Learn more about transactions and wait states in the [Camunda documentation](https://docs.camunda.org/manual/latest/user-guide/process-engine/transactions-in-processes/).

## Usage

Extend the [bpmn-js](https://github.com/bpmm-io/bpmn-js) modeler with the transaction boundaries module:

```javascript

import BpmnModeler from 'bpmn-js/lib/Modeler';

import transactionBoundariesModule from 'camunda-transaction-boundaries';

var canvas = $('#js-canvas');

var bpmnModeler = new BpmnModeler({

  container: canvas,

  additionalModules: [

    transactionBoundariesModule

  ]

});

bpmnModeler.importXML(xml, function(err) {

  if (err) {

    return console.error(err);

  }

  var transactionBoundaries = bpmnModeler.get('transactionBoundaries');

  transactionBoundaries.show();

});

```

Please see [this example](https://github.com/bpmn-io/bpmn-js-examples/tree/master/transaction-boundaries) for a more detailed instructions.

## Test

```

npm install

npm test

```

## License

MIT