/bpmn-viz

BPMN visualization provides a functionality to generate the diagramm interchange information for a given BPMN model.

Primary LanguageJavaMozilla Public License 2.0MPL-2.0

BPMN Visualization

javadoc Maven Central GitHub release License: MPL 2.0 DOI

BPMN visualization provides a functionality to generate the diagramm interchange information for a given BPMN model.

Getting Started

To use the bpmn visualization, simply include the maven dependency on the project.

<dependency>
    <groupId>science.aist</groupId>
    <artifactId>bpmn-viz</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope> <!-- Note: this is default -->
</dependency>

Then you are able to load generate the diagramm interchange information the following way:

// Create the repository to load the definition elements
XMLRepository<TDefinitions> repository = new BPMNTDefinitionsRepository();
// Load the root element
JAXBElement<TDefinitions> tDefinitionsJAXBElement = repository.load(...);
// Create the processing data
BpmnProcessorData bpmnProcessorData = new BpmnProcessorData(tDefinitionsJAXBElement, horizontalLayout);
// create the auto layouter
BpmnAutoLayout bpmnAutoLayout = new BpmnAutoLayout(bpmnProcessorData);
// run the auto layouting
bpmnAutoLayout.execute();
// save the element back again (note: the org. element is manipulated)
repository.save(tDefinitionsJAXBElement, ...);

Building the BPMN visualization yourself

If you want to build the project yourself, just checkout this git repo, make sure you have jdk 11 or above installed as well as maven 3.6.0 or above and build the project by running the maven command: mvn package. This results in a jar-file inside the target folder, which can be used as a dependency in other projects.

FAQ

If you have any questions, please checkout our FAQ section.

Contributing

First make sure to read our general contribution guidelines.

Licence

Copyright (c) 2020 the original author or authors. DO NOT ALTER OR REMOVE COPYRIGHT NOTICES.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

The following code is under different licence and copyright:

Licence Filepaths
Apache 2.0
see LICENCE_APACHE_2_0		 src/main/java/science/aist/bpmn/viz/BpmnAutoLayout.java
jgraph mxgraph
see LICENSE_JGRAPH_MXGRAPH		 dependency: com.mxgraph:mxgraph-all:3.7.4

Research

If you are going to use this project as part of a research paper, we would ask you to reference this project by citing it. DOI