cuba-platform / bproc-docs

Documentation for CUBA BProc add-on

BProc Addon Documentation

To build the documentation use the asciidoctor gradle task:

gradlew asciidoctor

The HTML documentation will be generated then in the project build directory.

bproc-docs's Issues

Provide ProcessFormScreens bean usage examples

Describe how to work with ScriptTask

Although BProc adds nothing to the ScriptTask functionality provided by Flowable, it's worth mentioning how to set and get process variables from within the ScriptTask.

Add a screenshot for editing process properties when a pool element is added

When a pool element is added to the canvas, it's not obvious how to edit process properties. When no pool element is added, process properties panel appears when you just click on the canvas anywhere.

When the pool element is added, process properties panel appears when you click on the pool header. Probably we can add a screenshot like this one to the documentation:

Update Quick Start section

Update Quick Start according to the last version of the add-on.

Describe how to use subscription key outside Studio

It is needed when building from the command line and if the subscription does not include Studio at all.
See https://doc.cuba-platform.com/manual-7.2/access_to_repo.html#access_to_premium_repo.

Describe how to use subprocess and call activities

BProc doesn't bring any new behavior to subprocesses and call activities functionality. However it's worth mentioning in BProc documentation that this functionality exists. We should briefly describe it and provide a reference to Flowable documentation: https://flowable.com/open-source/docs/bpmn/ch07b-BPMN-Constructs/#sub-processes-and-call-activities