natashawso2 / bpelviz

BPELviz visualizes WS-BPEL 2.0 processes interactively with HTML5.

BPELviz

BPELviz visualizes WS-BPEL 2.0 processes interactively with HTML5.

Building

We use Sass to generate the CSS. We keep the compiled .css file in the repository to enable a quick start with the visualizer.

Sass installation is described at http://sass-lang.com/install. In a nutshell, you have to install ruby and then execute gem install sass on the command line. BPELviz.scss can be converted into BPELviz.css by executing sass BPELviz.scss BPELviz.css in src/main/resources.

License

MIT License

Installation

[manual] make sure that JAVA_HOME points to local jdk folder
$ git clone https://github.com/BPELtools/BPELviz
$ cd BPELviz
$ gradlew installApp
[manual] add build/install/BPELviz/bin to PATH

Usage

usage: BPELviz [options] BPEL_FILE [HTML_FILE]
 -o,--open-in-browser   opens html file in default browser

# Examples
$ BPELviz -o example.bpel # opens the html5 of example.bpel in default browser
$ BPELviz example.bpel example.html # creates example.html from example.bpel
$ BPELviz -o example.bpel example.html # creates example.html from example.bpel and opens it in default browser

Development

Some commands which are very helpful during development:

$ gradlew sass # src/main/resources/BPELviz.scss --> src/main/resources/BPELviz.css
$ gradlew idea # create/update intellij project files
$ gradlew eclipse # create/update eclipse project files
$ gradlew run -Pargs="ARGS" # Run BPELviz; ARGS see Usage
$ gradlew generateExamples # Generates visualizations for all betsy-tests

Some documentation:

• The folder betsy-tests contains the whole test suite of betsy comprising over 160 BPEL processes. Via the class bpelviz.BetsyTestVisualizer, the visualizations of all processes within the betsy-tests folder can be created within the betsy-tests-visualization folder.
• The core class is the BPELviz class - the entry to this library. The core logic, however, is within the js, xsl and scss/css files within the src/main/resources directory. The primary files are named BPELviz while secondary (included) files are named something else.

Contribution Guide

• Fork
• Send Pull Request