https://github.com/stephenott/vertx-bpmn-model-doc-generator
Generate rendered FreeMarker templates based on Camunda BPM Model API usage of BPMN files. Great for generating business process documentation based on a .bpmn file
https://github.com/stephenott/vertx-bpmn-model-doc-generator
bpmn camunda vertx vertx-lang-js
Last synced: over 1 year ago
JSON representation
Generate rendered FreeMarker templates based on Camunda BPM Model API usage of BPMN files. Great for generating business process documentation based on a .bpmn file
- Host: GitHub
- URL: https://github.com/stephenott/vertx-bpmn-model-doc-generator
- Owner: StephenOTT
- Created: 2018-03-20T18:08:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-20T22:23:09.000Z (over 8 years ago)
- Last Synced: 2025-02-28T09:11:43.451Z (over 1 year ago)
- Topics: bpmn, camunda, vertx, vertx-lang-js
- Language: JavaScript
- Homepage:
- Size: 119 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Camunda BPMN Model API to Freemarker Template
This is a use case example of using the CamundaBPM (Camunda.org) Model API with Vertx.
Allows you to provide a BPMN file which will be read and parsed by Camunda's Java Model API and then rendered through a provided FreeMarker template.
## Still not sure what this does...
This lets you provide a FreeMarker template and a BPMN file; the output is a rendered template. The purpose is to allow someone to navigate the Camunda BPMN model API directly in the FreeMarker template in order to easily generate documentation for BPMN files.
# Setup
Install NPM Dependencies: `./gradlew clean npmInstall`
Run Gradle Build: `./gradlew clean run`
# References
1. https://docs.camunda.org/javadoc/camunda-bpm-platform/7.8/?org/camunda/bpm/model/bpmn/instance/package-summary.html
1. User Tasks Model Element: https://docs.camunda.org/javadoc/camunda-bpm-platform/7.8/org/camunda/bpm/model/bpmn/instance/UserTask.html
# BPMN
## BPMN File XML Snippet
```xml
...
SequenceFlow_0adri7o
SequenceFlow_15kfmnc
...
```
# FreeMarker Template
template is loaded from `app/templates/myTemplate.ftl`
Example:
```freemarker
<#list tasks_>
Elements:
<#items as task>
Task Type:
${task.getElementType().getTypeName()}
Task Name:
${task.getName()}
Custom Attributes:
<#list task.getExtensionElements().getElementsQuery().filterByType(extensionElements_).singleResult().getCamundaProperties()>
<#items as extensionElement>
Attribute:
Key: ${extensionElement.getCamundaName()}
Value: ${extensionElement.getCamundaValue()}
#items>
#list>
--------------------
#items>
#list>
```
# Config File
The template_inputs property is inserted into freemarker. Any property with a underscore `_` at the end of the property name will go through `eval()`.
Config is loaded from `app/template_config.json`
```js
...
{
"template_inputs": {
"extensionElements_": "instanceClass('camunda.CamundaProperties')",
"tasks_": "modelInstance.getModelElementsByType(instanceClass('Task'))"
},
"template_path": "myTemplate.ftl"
}
...
```
The `extensionElements_` property is a special property that provides the CamundaProperties Class for use in the FreeMarker template such as:
```freemarker
<#list task.getExtensionElements().getElementsQuery().filterByType(extensionElements_).singleResult().getCamundaProperties()>
```
# Console Output
```console
Elements:
Task Type:
userTask
Task Name:
Step 1
Custom Attributes:
Attribute:
Key: order
Value: some order value
Attribute:
Key: title
Value: some title value
Attribute:
Key: failure
Value: some fail
Attribute:
Key: resolution
Value: some resolution
--------------------
Task Type:
userTask
Task Name:
Step 2
Custom Attributes:
Attribute:
Key: order
Value: order123
Attribute:
Key: title
Value: title321
Attribute:
Key: failure
Value: fail000
Attribute:
Key: resolution
Value: resABC
--------------------
Task Type:
userTask
Task Name:
Step 3
Custom Attributes:
Attribute:
Key: order
Value: My Order
Attribute:
Key: title
Value: My Title
Attribute:
Key: failure
Value: My Failure
Attribute:
Key: resolution
Value: My Resolution
--------------------
```
# TODO / Enhancements:
1. Provide external / injectable `input` object as a json file.
1. Config/Input defines the Template
1. Provide a File Writer
1. Add more generation get Elements call so that all elements are gotten and the FreeMarker template will sub-navigate the tree of elements. (Removes the current need to setup "Per Element Type" properties in the `inputs` object)
1. Provide a HTTP endpoint to get the rendered template as different content types such as JSON and HTML
1. Provide a HTTP Endpoint to inject Config and FTL templates so the parser can live as a "microservice"
1. Generate Image of BPMN file
1. Generate Zoomed in Image of BPMN Element in context of overall file