https://github.com/camunda/camunda-modeler-process-io-specification-plugin

A plug-in that allows you to document input and output specifications for your BPMN processes.
https://github.com/camunda/camunda-modeler-process-io-specification-plugin

camunda-modeler camunda-modeler-plugin

Last synced: about 2 months ago
JSON representation

A plug-in that allows you to document input and output specifications for your BPMN processes.

• Host: GitHub
• URL: https://github.com/camunda/camunda-modeler-process-io-specification-plugin
• Owner: camunda
• Created: 2019-05-17T15:12:19.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-01-29T06:57:17.000Z (11 months ago)
• Last Synced: 2024-05-02T00:05:16.744Z (8 months ago)
• Topics: camunda-modeler, camunda-modeler-plugin
• Language: JavaScript
• Homepage:
• Size: 1.46 MB
• Stars: 12
• Watchers: 9
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Camunda Modeler Process I/O Specification Plug-in

[![CI](https://github.com/camunda/camunda-modeler-process-io-specification-plugin/workflows/CI/badge.svg)](https://github.com/camunda/camunda-modeler-process-io-specification-plugin/actions?query=workflow%3ACI) [![Compatible with Camunda Modeler version 5](https://img.shields.io/badge/Modeler_Version-5.0.0+-blue.svg)](./README.md#compatibility-notice) [![Plugin Type](https://img.shields.io/badge/Plugin_Type-BPMN_(Camunda_Platform_7)-orange.svg)](#)

This [Camunda Modeler Plugin](https://github.com/camunda/camunda-modeler) adds the ability to document required inputs and produced outputs of a BPMN 2.0 process. To do that it adds a `I/O Specification` tab to the BPMN editor properties panel.

![Screenshot](./docs/screenshot.png)

## Details

The input and output mappings are not to be confused with [Camunda Input/Output variable mappings](https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/#input-output-variable-mapping).

The meta-data is stored directly within the BPMN 2.0 diagram:

```xml

  

    

      

      

      

    

  

 ...

```

It has __no execution semantics__ but may be read during process execution, i.e. via execution or BPMN parse listeners registered with the engine.

## Building

Install dependencies:

```sh

npm install

```

Package plugin to `client/client-bundle.js`:

```sh

npm run bundle

# or

npm run bundle:watch

```

## Compatibility Notice

This plugin is currently only compatible with following Camunda Modeler versions.

| Camunda Modeler | Plugin         |

|-----------------|----------------|

| 4.3 - 4.12      | 0.1.0          |

| 5.x             | 0.3.0 or newer |

## Additional Resources

* [Plugins documentation](https://docs.camunda.io/docs/components/modeler/desktop-modeler/plugins/)

## Licence

MIT