Release 2.0

Author: eouthwaite

.gitignore

@@ -2,4 +2,6 @@ node_modules
 mljsadmin.log
 eclipse/org.eclipse.bpmn2.modeler.runtime.jboss.jbpm5
 .DS_Store
-
+shtests/*-out.txt
+shtests/output.log
+.idea/*

CHANGELOG.mdown

@@ -105,13 +105,11 @@ equivalent to our .editorconfig file.
 #### Test your code (pre-release mainly)
 
 We are working hard to improve MarkLogic Workflow's testing. If you add new actions
-in process models then please write unit tests in the shtests directory.
-When finished, verify that the self-test works.
+in process models then please write unit tests using the [Roxy framework](https://github.com/marklogic-community/roxy/wiki/Unit-Testing).
 
-```sh
-$ cd shtests
-$ ./all.sh
-```
+The default location for the test interface is http://localhost:8042/test/ - note that tests e2e-rest-process-json and e2e-rest-process-xml will attempt to create a user (**test-workflow-user**) during setup and remove it during the teardown phase.
+
+When finished, verify that the self-test works.
 
 Make sure that all tests pass. Please, do not submit patches that fail.
 

CONTRIBUTING.md

@@ -1,14 +1,44 @@
-A way to import and execute basic process models using MarkLogic's CPF feature.
+A way to import and execute BPMN2 process models using MarkLogic's CPF feature.
 
-## Why? Just... Why!?!
+## What is MarkLogic Workflow?
 
-This project aims to provide a new useful way to define CPF Pipelines. This means providing a way to model CPF pipelines
-and then take those models to generate a pipeline. Rather than create a custom modelling tool just for CPF, it is easier
-to use one of the many process model formats and existing tools, and provide a palette of MarkLogic specific actions for
-these tools.
+This project aims to provide a way to use the dominant BPMN2 process modelling standard in order to provide a way to
+build workflows that can be executed within MarkLogic's Content Processing Framework (CPF) feature.
 
-This functionality can also be used by MarkLogic customers to implement extended workflow functionality. BPMN2 model
-import and standard activity types are supported, allowing implementation of Content-Centric Workflow.
+Many customers of MarkLogic desire simple content and human centric workflows rather than complex ESB/JMS system-to-system integration. A full-fledged separate BPM suite therefore forces them to install a great deal more infrastructure
+and has a higher learning curve than is necessary to support these workflows.
+
+MarkLogic Workflow uses the MarkLogic Enterprise NoSQL Database and it's document state processing functionality - CPF -
+in order to provide a single integrated platform for MarkLogic-document and human user centric workflow modelling and
+processing.
+
+This provides customers with an easy entry point in to content-centric BPM for long-lived processes that use MarkLogic
+stored content. It does this at minumum cost, with no extra working
+parts (other than a modelling tool), and uses open standards and open source software to minimise vendor lock in.
+
+Example processes that can be implemented:-
+
+- Content review/approval workflows
+- Content change request workflows
+- Content creation request workflows
+- Case management workflows using content about a person/event/customer/place as context for a human user's decision making
+- Long term content review and disposition (policy driven deletion) workflows
+
+## Why use MarkLogic Workflow?
+
+Good question. A few quick reasons:-
+
+- No additional cost for existing MarkLogic customers
+- Extends CPF to allow parallel execution of sub-processes and inclusion of multiple documents, or none, in a single process
+- Uses MarkLogic Alerting to precisely identify which documents affect which processes, at a more granular level that CPF Domains
+- Introduces the concept of human steps, and work queues, which CPF does not support
+- Implemented using CPF - which means long running processes have ZERO PROCESSING COST when not active - this is UNIQUE in the BPM space
+- Uses the dominant BPMN2 standard and provides a MarkLogic view in the Eclipse BPMN2 modeler, a leading open source BPM modelling application, used by jBPM also, avoiding vendor lock-in
+
+MarkLogic workflow does not aim to be a full fledge BPM Suite providing round trip business process re-engineering. It is
+also not aimed at system to system integration, although will be able to invoke and be invoked by web services in a future
+release. MarkLogic workflow can, therefore, act as part of an overall SOA architecture that also includes system to system
+BPM environments like IBM WebSphere Process Server or TIBCO ActiveMatrix BPM.
 
 ## Information on MarkLogic Workflow
 - Overview

README.md

@@ -0,0 +1,93 @@
+## Release v2.0 2018-06-11
+
+Main additions:
+* Fork/return
+* Locking
+* Deployment via Roxy
+
+
+    Fixed #67
+    Fixed #68
+    Fixes #57 #56 #55 #47 #46 #45 #49 #50 #51 #53 #52
+    Releasing MarkLogic Workflow Eclipse Plugin fix. Fixes #64.
+    Merge pull request #72 from adamfowleruk/feature-64
+    Fixes #64 Really, honestly, it does
+    Fixes #63 - tests remain to be ran
+    Fixes #63 process asset management REST API
+    Merge pull request #73 from adamfowleruk/feature-63
+    Merge pull request #74 from adamfowleruk/feature-61
+    Merge pull request #75 from adamfowleruk/feature-64
+    initial files
+    "Upsert" data and attachments information.
+    Merge pull request #76 from steliann/steliann-patch-1
+    Fixes #4 - Fork and Rendezvous
+    Refactored states so Workflow only ever has a single initial state
+    Merge pull request #78 from adamfowleruk/feature-4
+    Fixes #80 - tested fork within fork example working with 12 pipelines
+    Merge pull request #81 from adamfowleruk/feature-80
+    alternative roxy approach
+    additional bug fixes needed
+    Merge pull request #106 from kghmanuel/feature-103-alt
+    Merge branch 'master' into develop - to include user locking of queue work items #100
+    prevent locking
+    fix for invalid coercion ; document roxy installation ; make roxy executable
+    A refactoring related change in the BPMN library caused the imports to fail.
+    Merge pull request #110 from kghmanuel/102_fix_bpmn_plugin
+    Updated contacts and urls
+    Merge pull request #108 from kghmanuel/79-processsubscription-svc-extime
+    feature #111 - start to convert tests from shell to roxy
+    first batch of XML tests added
+    tests complete in JSON - some incorrect though
+    fixes for tests ; debug logging
+    converted email and fork tests to roxy
+    All tests have been created  - Locking locked task tests need investigation
+    process-create works with JSON
+    renamed tests to better reflect action
+    #111 Convert shell tests to Roxy framework complete
+    Merge pull request #116 from marklogic-community/feature-111
+    #113 move /src/app/models to /src/workflowengine/models
+    document the change to tests
+    Merge pull request #117 from marklogic-community/feature-113
+    #115 - performance improvements and bugfixes from feedback
+    #115 - performance improvements and bugfixes from feedback
+    Merge pull request #119 from marklogic-community/feature-115
+    update roxy to current version
+    split fork tests
+    split fork tests into own suites ; load bpmn into own raw directory
+    #118 Additional rest api tests
+    118 - tidy code; update tests; fix fork, returns still not working
+    #118 - more forking changes ; extra tests
+    #118 - more testing
+    #118 - setup should be done on both tests
+    #121 - bugfix: lib-search-subscribe contains incorrect path
+    Merge pull request #122 from marklogic-community/feature-121
+    #123 - bugfix: tests failing in ML9
+    Merge pull request #124 from marklogic-community/feature-123
+    updates for ML9 - mostly new roxy version
+    Toggle output type depending on accept type
+    #118 - simplify test bpmn; remove fork with wf:branches (this looks like an earlier typo)
+    Getting forking working
+    REST Parameter should have rs: prefix
+    Basis for inclusive gateway test
+    Better initial settings for shell scripts
+    better shell script defaults
+    Sorting out mime types and a typo correction
+    Ensure that tests are using the XML option in the XML test suite
+    JSON tests now producing JSON - revise accordingly
+    Unit tests for inclusive gateways plus support
+    Merged 118 + 126
+    Correctly named process now returned. Forking now working, so end state is COMPLETE
+    New Inclusive Gateway test
+    Inclusive gateway test where we have two active branches
+    Merge pull request #131 from marklogic-community/feature-126-merging
+    Merge fixes from branch 'develop' into develop-9.0
+    Take care when json arrays required
+    Merge branch 'develop' into develop-9.0
+    Process delete plus testing
+    ProcessSubscription delete and test
+    Merge branch 'develop' into develop-9.0 - fixes for #54 and process deletion
+    Modeler Tested with Latest version of Eclipse (oxygen 4.7.2)
+    Merge branch 'develop' into develop-9.0 (#102)
+    Included search for wf:user on Inbox and added test for dynamicUser and inbox
+    Alter import to pick up user rather than assignee; additional tests and fixes for tests
+    Merge pull request #135 from marklogic-community/feature-133

Releases.mdown

@@ -2,12 +2,12 @@
 
 # CREATED BY YEOMAN generator-mljsworkplace!
 
-RESTHOST=192.168.123.4
-RESTPORT=6061
-DATABASE=workflow-content
-MLADMINUSER=admin
-MLADMINPASS=admin
-MLAUTH=digest
+export RESTHOST=127.0.0.1
+export RESTPORT=8040
+export DATABASE=workflow-content
+export MLADMINUSER=admin
+export MLADMINPASS=admin
+export MLAUTH=digest
 MLDEFAULTUSER=nobody
 WEBPORT=5001
 ALERTPORT=5002

config/webserver-settings.sh

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<bpmn2:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn2="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="Definitions_1" targetNamespace="http://marklogic.com/workflow">
-  <bpmn2:process id="two_sample_transitions" name="Default Process" processType="Public">
+<!-- origin at X=0.0 Y=0.0 -->
+<bpmn2:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn2="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:ns="http://www.w3.org/2001/XMLSchema" id="Definitions_1" exporter="org.eclipse.bpmn2.modeler.core" exporterVersion="1.1.4.201509111742" targetNamespace="http://marklogic.com/workflow">
+  <bpmn2:process id="two_sample_transitions" name="Default Process" isExecutable="false" processType="Public">
     <bpmn2:startEvent id="StartEvent_1" name="Start">
       <bpmn2:outgoing>SequenceFlow_2</bpmn2:outgoing>
     </bpmn2:startEvent>
@@ -27,44 +28,66 @@
   <bpmndi:BPMNDiagram id="BPMNDiagram_1" name="Default Process Diagram">
     <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="two_sample_transitions">
       <bpmndi:BPMNShape id="BPMNShape_1" bpmnElement="StartEvent_1">
-        <dc:Bounds height="36.0" width="36.0" x="100.0" y="100.0"/>
+        <dc:Bounds height="36.0" width="36.0" x="92.0" y="100.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_1" labelStyle="BPMNLabelStyle_1">
+          <dc:Bounds height="10.0" width="20.0" x="100.0" y="136.0"/>
+        </bpmndi:BPMNLabel>
       </bpmndi:BPMNShape>
       <bpmndi:BPMNShape id="BPMNShape_2" bpmnElement="EndEvent_1">
         <dc:Bounds height="36.0" width="36.0" x="810.0" y="100.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_2" labelStyle="BPMNLabelStyle_1">
+          <dc:Bounds height="10.0" width="24.0" x="816.0" y="136.0"/>
+        </bpmndi:BPMNLabel>
       </bpmndi:BPMNShape>
       <bpmndi:BPMNShape id="BPMNShape_Task_2" bpmnElement="Task_2">
-        <dc:Bounds height="50.0" width="110.0" x="424.0" y="93.0"/>
+        <dc:Bounds height="50.0" width="110.0" x="420.0" y="93.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_3" labelStyle="BPMNLabelStyle_1">
+          <dc:Bounds height="10.0" width="45.0" x="452.0" y="113.0"/>
+        </bpmndi:BPMNLabel>
       </bpmndi:BPMNShape>
       <bpmndi:BPMNShape id="BPMNShape_Task_1" bpmnElement="Task_1">
         <dc:Bounds height="50.0" width="110.0" x="209.0" y="93.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_4" labelStyle="BPMNLabelStyle_1">
+          <dc:Bounds height="10.0" width="22.0" x="253.0" y="113.0"/>
+        </bpmndi:BPMNLabel>
       </bpmndi:BPMNShape>
       <bpmndi:BPMNShape id="BPMNShape_Task_3" bpmnElement="Task_3">
         <dc:Bounds height="50.0" width="110.0" x="639.0" y="93.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_5" labelStyle="BPMNLabelStyle_1">
+          <dc:Bounds height="10.0" width="28.0" x="680.0" y="113.0"/>
+        </bpmndi:BPMNLabel>
       </bpmndi:BPMNShape>
       <bpmndi:BPMNEdge id="BPMNEdge_SequenceFlow_2" bpmnElement="SequenceFlow_2" sourceElement="BPMNShape_1" targetElement="BPMNShape_Task_1">
-        <di:waypoint xsi:type="dc:Point" x="136.0" y="118.0"/>
+        <di:waypoint xsi:type="dc:Point" x="128.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="168.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="168.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="209.0" y="118.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_6" labelStyle="BPMNLabelStyle_1"/>
       </bpmndi:BPMNEdge>
       <bpmndi:BPMNEdge id="BPMNEdge_SequenceFlow_3" bpmnElement="SequenceFlow_3" sourceElement="BPMNShape_Task_1" targetElement="BPMNShape_Task_2">
         <di:waypoint xsi:type="dc:Point" x="319.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="366.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="366.0" y="118.0"/>
-        <di:waypoint xsi:type="dc:Point" x="424.0" y="118.0"/>
+        <di:waypoint xsi:type="dc:Point" x="420.0" y="118.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_7" labelStyle="BPMNLabelStyle_1"/>
       </bpmndi:BPMNEdge>
       <bpmndi:BPMNEdge id="BPMNEdge_SequenceFlow_4" bpmnElement="SequenceFlow_4" sourceElement="BPMNShape_Task_2" targetElement="BPMNShape_Task_3">
-        <di:waypoint xsi:type="dc:Point" x="534.0" y="118.0"/>
+        <di:waypoint xsi:type="dc:Point" x="530.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="581.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="581.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="639.0" y="118.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_8" labelStyle="BPMNLabelStyle_1"/>
       </bpmndi:BPMNEdge>
       <bpmndi:BPMNEdge id="BPMNEdge_SequenceFlow_5" bpmnElement="SequenceFlow_5" sourceElement="BPMNShape_Task_3" targetElement="BPMNShape_2">
         <di:waypoint xsi:type="dc:Point" x="749.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="776.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="776.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="810.0" y="118.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_9" labelStyle="BPMNLabelStyle_1"/>
       </bpmndi:BPMNEdge>
     </bpmndi:BPMNPlane>
+    <bpmndi:BPMNLabelStyle id="BPMNLabelStyle_1">
+      <dc:Font name="arial" size="9.0"/>
+    </bpmndi:BPMNLabelStyle>
   </bpmndi:BPMNDiagram>
 </bpmn2:definitions>

data/examples/bpmn2/001_two_sample_transitions.bpmn

@@ -1,7 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<bpmn2:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn2="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="Definitions_1" targetNamespace="http://sample.bpmn2.org/bpmn2/sample/process">
+<!-- origin at X=0.0 Y=0.0 -->
+<bpmn2:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn2="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:xs="http://www.w3.org/2001/XMLSchema" id="Definitions_1" exporter="org.eclipse.bpmn2.modeler.core" exporterVersion="1.1.4.201509111742" targetNamespace="http://sample.bpmn2.org/bpmn2/sample/process">
   <bpmn2:dataStore id="DataStore_1" name="Data Store 2"/>
-  <bpmn2:process id="002_data_basic" name="Default Process" processType="Public">
+  <bpmn2:process id="data_basic" name="Default Process" isExecutable="false" processType="Public">
     <bpmn2:startEvent id="StartEvent_1">
       <bpmn2:outgoing>SequenceFlow_1</bpmn2:outgoing>
     </bpmn2:startEvent>
@@ -11,16 +12,20 @@
     </bpmn2:endEvent>
   </bpmn2:process>
   <bpmndi:BPMNDiagram id="BPMNDiagram_1" name="Default Process Diagram">
-    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="002_data_basic">
+    <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="data_basic">
       <bpmndi:BPMNShape id="BPMNShape_1" bpmnElement="StartEvent_1">
         <dc:Bounds height="36.0" width="36.0" x="100.0" y="100.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_1"/>
       </bpmndi:BPMNShape>
       <bpmndi:BPMNShape id="BPMNShape_2" bpmnElement="EndEvent_1">
         <dc:Bounds height="36.0" width="36.0" x="500.0" y="100.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_2"/>
       </bpmndi:BPMNShape>
       <bpmndi:BPMNEdge id="BPMNEdge_SequenceFlow_1" bpmnElement="SequenceFlow_1" sourceElement="BPMNShape_1" targetElement="BPMNShape_2">
         <di:waypoint xsi:type="dc:Point" x="136.0" y="118.0"/>
+        <di:waypoint xsi:type="dc:Point" x="313.0" y="118.0"/>
         <di:waypoint xsi:type="dc:Point" x="500.0" y="118.0"/>
+        <bpmndi:BPMNLabel id="BPMNLabel_3"/>
       </bpmndi:BPMNEdge>
     </bpmndi:BPMNPlane>
   </bpmndi:BPMNDiagram>

data/examples/bpmn2/002_data_basic.bpmn

@@ -1,10 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- origin at X=0.0 Y=0.0 -->
-<bpmn2:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn2="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:ns1="http://www.example.org/BPMNTestProcessData" xmlns:ns2="http://marklogic.com/workflow" xmlns:ns.xsd="http://marklogic.com/workflow" xmlns:xs="http://www.w3.org/2001/XMLSchema" id="Definitions_1" exporter="org.eclipse.bpmn2.modeler.core" exporterVersion="1.1.3.201503241414" targetNamespace="http://marklogic.com/workflow">
+<bpmn2:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn2="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" xmlns:ns1="http://www.example.org/BPMNTestProcessData" xmlns:ns2="http://marklogic.com/workflow" xmlns:ns.xsd="http://marklogic.com/workflow" xmlns:xs="http://www.w3.org/2001/XMLSchema" id="Definitions_1" exporter="org.eclipse.bpmn2.modeler.core" exporterVersion="1.1.3.Final" targetNamespace="http://marklogic.com/workflow">
   <bpmn2:import importType="http://www.w3.org/2001/XMLSchema" location="platform:/resource/MarkLogic%20Workflow/documentation/marklogicworkflow.xsd" namespace="http://marklogic.com/workflow"/>
-  <bpmn2:itemDefinition id="ItemDefinition_1_1" isCollection="false" structureRef="ns1_schema"/>
+  <bpmn2:itemDefinition id="ItemDefinition_4" isCollection="false" structureRef="ns1_schema"/>
   <bpmn2:itemDefinition id="ItemDefinition_2" isCollection="false" structureRef="ns2__process"/>
-  <bpmn2:itemDefinition id="_ItemDefinition_2" isCollection="false" structureRef="process"/>
   <bpmn2:itemDefinition id="ItemDefinition_3" isCollection="false" structureRef="ns2__attachmentType_uri"/>
   <bpmn2:itemDefinition id="ItemDefinition_1" isCollection="false" structureRef="process"/>
   <bpmn2:signal id="Signal_1" name="InitiatingAttachment" structureRef="ItemDefinition_3"/>
@@ -262,4 +261,4 @@
       <dc:Font name="arial" size="9.0"/>
     </bpmndi:BPMNLabelStyle>
   </bpmndi:BPMNDiagram>
-</bpmn2:definitions>
+</bpmn2:definitions>