diff options
| author |   seshukm <seshu.kumar.m@huawei.com> | 2017-11-06 10:50:27 +0530 |
|---|---|---|
| committer | seshukm <seshu.kumar.m@huawei.com> | 2017-11-06 10:50:27 +0530 |
| commit | 01b1ed2fd877bbc3809a3ba0701b55af75715b66 (patch) | |
| tree | faebe65757f30a2ec6854dce128e6d74b528c114 /docs | |
| parent | 107e0c48c8a391981a4dba8fba23051ef9f1f68f (diff) | |
.rst file for BPMN project structure
IssueId: SO-300
Change-Id: Ic0a0c737323cf0206bf24fd1548936587156adbf
Signed-off-by: seshukm <seshu.kumar.m@huawei.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/BPMN_Project_Structure.rst | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/BPMN_Project_Structure.rst b/docs/BPMN_Project_Structure.rst new file mode 100644 index 0000000000..3c5ccc3e7d --- /dev/null +++ b/docs/BPMN_Project_Structure.rst @@ -0,0 +1,47 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017 Huawei Technologies Co., Ltd.
+
+BPMN Project Structure
+=======================
+
+BPMN main process flow
+----------------------
+
+A BPMN main process flow is a top-level flow. All main process flows are under the src/main/resources/process folder.
+
+CreateVfModuleVolumeInfraV1 is a main process flow.
+
+.. image:: images/bpmn_project_structure_1.png
+
+Open BPMN files with the camunda modeler (standalone application). To launch the modeler from eclipse, right-click→open-with→Other→Browse. Select Check the boxes on the dialog so that eclipse will open all .bpmn files with the camunda-modeler executable.
+
+BPMN subprocess flow
+---------------------
+
+A BPMN subprocess flow is meant to be invoked by other flows (either main process flows or other subprocess flows). All subprocess flows are under the src/main/resources/subprocess folder.
+
+The CreateVfModuleVolumeInfraV1 process flow is delivered with two custom subflows: DoCreateVfModuleVolumeV2 and DoCreateVfModuleVolumeRollback.
+
+.. image:: images/bpmn_project_structure_2.png
+
+Groovy scripts
+---------------
+
+There is one groovy script for each BPMN file. Groovy scripts are invoked by script tasks within the BPMN flows.
+
+.. image:: images/bpmn_project_structure_3.png
+
+Unit Tests
+-----------
+
+Normally, we create a unit test class for every flow. This one is missing a unit test for its rollback flow.
+
+.. image:: images/bpmn_project_structure_4.png
+
+Unit Test Resource Files
+------------------------
+
+Any files needed by the unit tests are kept under the src/test/resources/__files folder.
+
+.. image:: images/bpmn_project_structure_5.png
\ No newline at end of file |