Skip to content
This repository was archived by the owner on Nov 9, 2022. It is now read-only.

Commit c46dcbd

Browse files
committed
First stab at the Eclipse extension that works
1 parent 89f4c71 commit c46dcbd

File tree

129 files changed

+12129
-164
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

129 files changed

+12129
-164
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
node_modules
22
mljsadmin.log
3+
eclipse/org.eclipse.bpmn2.modeler.runtime.jboss.jbpm5
4+
.DS_Store
5+

.settings/org.eclipse.bpmn2.modeler.core.prefs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ show.advanced.properties=false
1818
show.descriptions=true
1919
show.id.attribute=false
2020
simplify.lists=true
21-
target.runtime=org.jboss.runtime.jbpm5
21+
target.runtime=org.eclipse.bpmn2.modeler.runtime.marklogic.workflow

documentation/DEV-MODELER.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,61 @@
11
This file contains information on the custom MarkLogic Workflow Runtime Environment for the Eclipse BPMN2 modeller.
22

3+
# Eclipse BPMN2 Modeler Extension
4+
5+
MarkLogic Workflow provides two Target Runtimes for the Eclipse BPMN2 modeler, and associated custom tasks. The two
6+
target runtimes are:-
7+
- MarkLogic Workflow - High level content and human centric workflow
8+
- MarkLogic Content Processing Framework (CPF) - Low level document state and lifecycle machine
9+
10+
These runtimes provide their own New File dialogues within the BPMN2 category in Eclipse. The resultant process model
11+
types (CPF or Workflow) provide a restricted and customised palette of BPMN2 Activities tailored specifically for
12+
the MarkLogic Workflow and CPF environments.
13+
14+
This ensures that model developers cannot use any features not supported by MarkLogic CPF and MarkLogic Workflow. In
15+
addition, default Interfaces, messages, and other process configuration is automatically provided within these process
16+
model types.
17+
18+
You should strongly consider using the 'MarkLogic Workflow Process Diagram' or 'MarkLogic CPF Process Diagram' types
19+
rather than the default Generic BPMN2 Process Diagram in order to ensure your processes can execute inside MarkLogic.
20+
21+
## Running the modelling extension
22+
23+
In future this extension may be bundled inside the standard BPMN2 modeler, and so installed BPMN2 modeler will give
24+
you access to everything you need.
25+
26+
Until this happens, or if you need the very latest MarkLogic Workflow model element support whilst working on a new
27+
project, you will need to execute the extension manually.
28+
29+
To execute the latest extension:-
30+
- Checkout or download the zip of the latest (develop branch) of MarkLogic Workflow at http://github.com/adamfowleruk/marklogicworkflow
31+
- Open Eclipse Luna (4.4) or above
32+
- Go to File -> Import project
33+
- Navigate to ./marklogicworkflow/eclipse/org.eclipse.bpmn2.modeler.runtime.marklogic (NOT just ./marklogicworkflow)
34+
- Import this workspace
35+
- Double click on the 'plugin.xml' file
36+
- In the top right of the edit dialogue for this file, click the green Play button. This launches Eclipse Luna with this extension
37+
- Now go to File - Import or File - New Project to create your new modelling project
38+
- Right click the root folder and select New - Other
39+
- Open the 'BPMN2' category and select either 'MarkLogic CPF Process Diagram' or 'MarkLogic Workflow Process Diagram'
40+
- Ensure the 'set runtim to...' tickbox is ticked (the default)
41+
- Click next and follow the prompts in the wizard as necessary. Process model names cannot include spaces or hyphens (-)
42+
43+
That's it! You now have a new model. In the right hand side of the model editor you'll see a restricted set of tasks that
44+
you can use in your model. Just drag/drop them on to the editor and connect as necessary.
45+
46+
When finished, save the file. Fix any red validation errors that appear after save. Then use the MarkLogic Workflow
47+
REST API to install your model (PUT /v1/resources/processmodel)
48+
49+
## Exporting a CPF pipeline for editing
50+
51+
In the future MarkLogic Workflow will allow any arbitrary CPF pipeline to be exported and modelled in Eclipse BPMN2
52+
modeler. This will allow for full round trip re-engineering of MarkLogic CPF processes.
53+
54+
*WARNING: It should be noted that CPF diagram support is very much an Alpha product and not scheduled to be fully
55+
implemented for a while.*
56+
57+
## Related information
58+
359
For the custom runtime/task videos, see this first:-
460

561
http://bobsbizbuzz.blogspot.it/2014/06/blog-post_10.html

documentation/SPRINTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ steps if a duplicate is found. Requires search (by property hash AND not (same u
4848
- Create CPF action to represent this
4949
- TEST Evaluation: Support for (/some/path/one,/some/path/two)[1] style evaluation for set task
5050
- DONE Tools: Process Data model XSD (for modeler import)
51-
- IN PROGRESS Tools: Eclipse BPMN 2 Modeler Palette and Process diagram support, including new diagram creation for MarkLogic
51+
- DONE Tools: Eclipse BPMN 2 Modeler Palette and Process diagram support, including new diagram creation for MarkLogic
5252
- DEFERRED UI: Ridiculously basic HTML widget in MLJS for rendering step and choosing action (for ease of testing)
5353
- TEST Start process using an Alert (content subscription)
5454
- TEST REST API: Basic process initiation, update and tracking methods
@@ -69,7 +69,7 @@ steps if a duplicate is found. Requires search (by property hash AND not (same u
6969
- DONE Test scripts for automating install, create, get, update, complete via REST API
7070
- DONE Bug: Change process model URI folder to include major and minor - else doing process doc update may run new pipeline instead of old one
7171
- DONE Bug: Multiple wf:status properties on in process process, complete and running
72-
- BPMN2 specification test process models modified and tested to MarkLogic executable standard
72+
- DEFERRED BPMN2 specification test process models modified and tested to MarkLogic executable standard
7373
- Basic
7474
- Incident Management Level 1
7575
- Incident Management Account Manager Only
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>MarkLogicWorkflow</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.pde.FeatureBuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
</buildSpec>
14+
<natures>
15+
<nature>org.eclipse.pde.FeatureNature</nature>
16+
</natures>
17+
</projectDescription>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
bin.includes = feature.xml

0 commit comments

Comments
 (0)