Skip to content

Latest commit

 

History

History
58 lines (37 loc) · 1.79 KB

README.md

File metadata and controls

58 lines (37 loc) · 1.79 KB
Raw

BPMN Layout Generator Java Implementation

Requirements

To build and run, use:

JDK 17 or JDK 21

Warning

The build produces bytecode for JDK 17 or newer, so you cannot run the provided jar with older JDK versions.

Get the bpmn-layout-generator jar

Choose one of the following options:

Download

The jar is available in the release branches of the R package.

For example, for version 0.1.4, you can download the jar from https://github.com/process-analytics/bpmn-layout-generators/tree/bpmnLayoutGeneratoR-0.1.4/R/bpmnLayoutGeneratoR/inst/java.

Build

Note

Building the jar let you use the latest version of the code.

The project bundles a Maven Wrapper, so just run

./mvnw package

Usage

Note: for more options, run with the --help option

To generate the layout of an existing BPMN file and save the result as a BPMN file, run

java -jar target/bpmn-layout-generator-*-jar-with-dependencies.jar --output=<path_to_output_file> <path_to_input_bpmn_file>

If you want to have the resulting layout in an SVG file, pass --output-type=SVG
Notice that ASCII and SVG output types have been developed to get feedback when running tests i.e. to get a quick preview of the algorithm result. They are not fully implemented and won't probably never be (if you have some interest on that topic, feel free to provide a Pull Request)

To generate BPMN semantic and diagram layout from discovery CSV files, run

java -jar target/bpmn-layout-generator-*-jar-with-dependencies.jar \
  --input-type=CSV \
  --output=<path_to_output_file> \
  csv/PatientsProcess/nodeSimple.csv csv/PatientsProcess/edgeSimple.cs

Release

The release process is fully automated. See the release process for more details.