|
1 | 1 | This file contains information on the custom MarkLogic Workflow Runtime Environment for the Eclipse BPMN2 modeller. |
2 | 2 |
|
| 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 | + |
3 | 59 | For the custom runtime/task videos, see this first:- |
4 | 60 |
|
5 | 61 | http://bobsbizbuzz.blogspot.it/2014/06/blog-post_10.html |
0 commit comments