bpmnVisualizationR

bpmnVisualizationR is an R package for visualizing process execution data on BPMN diagrams, using overlays, style customization and interactions.

It is made possible by htmlwidgets, which provides an easy-to-use framework for bringing together R and the bpmn-visualization TypeScript library. <!-- END OF duplicated with index.md -->

♻️ Usage

Installation

Install devtools

Devtools is an R package used to ease the installation and the development of other R packages.
It can be installed from the R console: r install.packages('devtools')

Install bpmnVisualizationR

From CRAN

The latest stable version of the bpmnVisualizationR package can be obtained from CRAN with the command: install.packages("bpmnVisualizationR")

From GitHub

To install a dedicated version (available versions can be found in the GitHub releases page), run: r devtools::install_github("process-analytics/bpmn-visualization-R@v0.5.0")

Or install the development version: r devtools::install_github("process-analytics/bpmn-visualization-R")

Then, make the library available to the current R project: r library(bpmnVisualizationR) <!-- END OF duplicated with index.md -->

Load the BPMN file

bpmnVisualizationR accepts a BPMN file (or an XML document):

```r

File from the package

bpmnfile <- system.file("examples/EmailVoting.bpmn", package = "bpmnVisualizationR") ```

Or r bpmn_file <- file.choose()

Or r bpmn_file <- "path_to_bpmn_file"

Or r bpmn_file <- "<?xml version="1.0" encoding="UTF-8"?> ...xml_content"

💡 The package provides some BPMN examples. \ They are taken from the BPMN 2.0 examples non-normative machine-readable files. - EmailVoting.bpmn - NobelPrizeProcess.bpmn - OrderManagement.bpmn - OrderProcessforPizzaV4.bpmn - Travel_Booking.bpmn

Display the BPMN diagram

r bpmnVisualizationR::display(bpmn_file)

Display the BPMN diagram with overlays

r overlays <- list(bpmnVisualizationR::create_overlay("bpmn_element_id_1", "42"), bpmnVisualizationR::create_overlay("bpmn_element_id_2", "9")) bpmnVisualizationR::display(bpmn_file, overlays)

Style an overlay

```r style <- bpmnVisualizationR::createoverlaystyle( fontcolor = 'WhiteSmoke', fontsize = 19, fillcolor = 'Teal', strokecolor = 'SpringGreen' )

overlay <- bpmnVisualizationR::createoverlay("bpmnelementid1", "42", style, "middle-right") ```

ℹ️ To see more information about the value of position in bpmn-visualization-js library, please visit https://process-analytics.github.io/bpmn-visualization-js/api/types/OverlayPosition.html.

Disable the default styles of the overlays

r bpmnVisualizationR::display(bpmn_file, overlays, enableDefaultOverlayStyle=FALSE)

Style BPMN shapes

```r bpmnElementStyles <- list( bpmnVisualizationR::createshapestyle( elementIds = list("callactivity11"), strokecolor = 'RoyalBlue', fontcolor = 'DarkOrange', fontfamily = 'Arial', fontsize = 12, fontbold = TRUE, fontitalic = TRUE, fontstrikethrough = TRUE, fontunderline = TRUE, opacity = 75, fillcolor = 'Yellow', fillopacity = 50 ), bpmnVisualizationR::createedgestyle( elementIds = list("startevent11"), strokecolor = 'DeepPink', strokewidth = 3, strokeopacity = 70, fontcolor = 'ForestGreen', fontfamily = 'Courier New', fontsize = 14, fontbold = TRUE, fontitalic = TRUE, fontstrikethrough = FALSE, fontunderline = FALSE, font_opacity = 80, opacity = 80 ) )

bpmnVisualizationR::display( bpmn_file, bpmnElementStyles = bpmnElementStyles, width='auto', height='auto' ) ```

ℹ️ It is possible to apply styles to both BPMN edges and shapes simultaneously by adding them to the shared bpmnElementStyles list.

Style BPMN edges

```r bpmnElementStyles <- list( bpmnVisualizationR::createshapestyle( elementIds = list("messageflow11"), strokecolor = 'RoyalBlue', fontcolor = 'DarkOrange', fontfamily = 'Arial', fontsize = 12, fontbold = TRUE, fontitalic = TRUE, fontstrikethrough = TRUE, fontunderline = TRUE, opacity = 75, fillcolor = 'Yellow', fillopacity = 50 ), bpmnVisualizationR::createedgestyle( elementIds = list("sequenceflow14"), strokecolor = 'DeepPink', strokewidth = 3, strokeopacity = 70, fontcolor = 'ForestGreen', fontfamily = 'Courier New', fontsize = 14, fontbold = TRUE, fontitalic = TRUE, fontstrikethrough = FALSE, fontunderline = FALSE, font_opacity = 80, opacity = 80 ) )

bpmnVisualizationR::display( bpmn_file, bpmnElementStyles = bpmnElementStyles, width='auto', height='auto' ) ```

ℹ️ It is possible to apply styles to both BPMN edges and shapes simultaneously by adding them to the shared bpmnElementStyles list.

Integrate in Shiny Applications

The following displays a BPMN diagram provided as an example by the package with an overlay on top of a BPMN element.

```r

Install and load the shiny package

install.packages("shiny") library(shiny)

displayBpmn <- function() { bpmnfile <- system.file("examples/TravelBooking.bpmn", package = "bpmnVisualizationR") style <- bpmnVisualizationR::createoverlaystyle( fontcolor = 'Black', fontsize = 25, fillcolor = 'MediumSpringGreen', strokecolor = 'MediumSpringGreen' ) overlays <- list(bpmnVisualizationR::createoverlay("6-203", "9", style, "bottom-right")) bpmnVisualizationR::display(bpmn_file, overlays) }

ui <- shinyUI(fluidPage( titlePanel("Display bpmn diagrams with execution data"), bpmnVisualizationR::bpmnVisualizationROutput('bpmnContainer') ) )

server = function(input, output) { # renderBpmnVisualization is the R bridge function to the html widgets output$bpmnContainer <- bpmnVisualizationR::renderBpmnVisualizationR({ displayBpmn() }) }

shinyApp(ui, server) ```

🔧 Contributing

To contribute to bpmnVisualizationR, fork and clone this repository locally and commit your code on a separate branch. \ Please write tests for your code before opening a pull-request.

You can find more detail in our Contributing guide. Participation in this open source project is subject to a Code of Conduct.

✨ A BIG thanks to all our contributors 🙂

📃 License

bpmnVisualizationR is released under the Apache 2.0 license. \ Copyright © from 2021, Bonitasoft S.A.