Merge pull request #119 from marklogic-community/feature-115

eouthwaite · web-flow · commit ad212433b412 · 2017-11-13T13:12:38.000Z
Feature 115
diff --git a/deploy/ml-config.xml b/deploy/ml-config.xml
@@ -253,6 +253,26 @@
 -->
       </range-element-indexes>
       <range-element-attribute-indexes>
+        <range-element-attribute-index>
+          <scalar-type>string</scalar-type>
+          <parent-namespace-uri>http://marklogic.com/workflow</parent-namespace-uri>
+          <parent-localname>process</parent-localname>
+          <namespace-uri/>
+          <localname>id</localname>
+          <collation>http://marklogic.com/collation/</collation>
+          <range-value-positions>false</range-value-positions>
+          <invalid-values>ignore</invalid-values>
+        </range-element-attribute-index>
+        <range-element-attribute-index>
+          <scalar-type>string</scalar-type>
+          <parent-namespace-uri>http://marklogic.com/workflow</parent-namespace-uri>
+          <parent-localname>attachment</parent-localname>
+          <namespace-uri/>
+          <localname>uri</localname>
+          <collation>http://marklogic.com/collation/</collation>
+          <range-value-positions>false</range-value-positions>
+          <invalid-values>ignore</invalid-values>
+        </range-element-attribute-index>
 <!--
         Sample for:
           <person name="bob" xmlns="http://marklogic.com/ns/sample"/>
diff --git a/documentation/INSTALL.md b/documentation/INSTALL.md
@@ -1,4 +1,4 @@
-## Roxy Installation
+### Roxy Installation
 
 To install via roxy, within the roxy directory, edit the properties file for the target environment - for example, ``deploy/local.properties`` and run the following commands:
 
diff --git a/rest-api/ext/process.xqy b/rest-api/ext/process.xqy
@@ -1,5 +1,3 @@
-
-
 (: process.xqy - Start a new, or modify an existing, MarkLogic Workflow process
  :
  :)
@@ -9,16 +7,14 @@ module namespace ext = "http://marklogic.com/rest-api/resource/process";
 
 (: import module namespace config = "http://marklogic.com/roxy/config" at "/app/config/config.xqy"; :)
 import module namespace json = "http://marklogic.com/xdmp/json" at "/MarkLogic/json/json.xqy";
-
 import module namespace cpf = "http://marklogic.com/cpf" at "/MarkLogic/cpf/cpf.xqy";
 import module namespace wfu="http://marklogic.com/workflow-util" at "/workflowengine/models/workflow-util.xqy";
 import module namespace wfa="http://marklogic.com/workflow-actions" at "/workflowengine/models/workflow-actions.xqy";
 
+declare namespace rapi = "http://marklogic.com/rest-api";
 declare namespace roxy = "http://marklogic.com/roxy";
 declare namespace wf="http://marklogic.com/workflow";
 
-declare namespace rapi = "http://marklogic.com/rest-api";
-
 (:
  : To add parameters to the functions, specify them in the params annotations.
  : Example
@@ -174,7 +170,8 @@ function ext:post(
 
        (: call wfu complete on it :)
        let $_ := xdmp:log("Calling wfa:complete-userTask")
-       let $feedback := wfa:complete-userTask($pid,$input/wf:data/node(),$input/wf:attachments/node())
+       let $feedback := wfa:complete-userTask($pid, $input/wf:data/node(), $input/wf:attachments/node())
+       (: let $feedback := wfa:complete-userTask($pid,$input/ext:updateRequest/wf:data/node(),$input/ext:updateRequest/wf:attachments/node()) :)
        (: Could return errors with data or attachments :)
        return
          if (fn:not(fn:empty($feedback))) then
@@ -243,7 +240,8 @@ function ext:post(
             else
               $update
         else
-          () (: Just default to updating the data, but doing nothing around locking :)
+          (: Just default to updating the data, but doing nothing around locking :)
+          wfa:update-userTask($pid,$input/ext:updateRequest/wf:data/node(),$input/ext:updateRequest/wf:attachments/node())
 
 
  let $out := ($res,<ext:updateResponse><ext:outcome>SUCCESS</ext:outcome></ext:updateResponse>)[1]
@@ -264,3 +262,26 @@ function ext:post(
     }
   )
 };
+
+declare
+%roxy:params("")
+function ext:delete(
+  $context as map:map,
+  $params  as map:map,
+  $input   as document-node()*
+) as document-node()* {
+
+  let $preftype := if ("application/xml" = map:get($context,"accept-types")) then "application/xml" else "application/json"
+
+  let $pid := map:get($params,"processid")
+  let $_ := xdmp:log("REST EXT ProcessId: " || $pid)
+  let $_ := wfu:delete($pid)
+
+  return
+    (
+      map:put($context, "output-types", $preftype),
+      xdmp:set-response-code(200, "OK"),
+      document {()}
+    )
+};
+
diff --git a/rest-api/ext/processasset.xqy b/rest-api/ext/processasset.xqy
@@ -3,14 +3,11 @@ xquery version "1.0-ml";
 module namespace ext = "http://marklogic.com/rest-api/resource/processasset";
 
 import module namespace json = "http://marklogic.com/xdmp/json" at "/MarkLogic/json/json.xqy";
-
 import module namespace wfi="http://marklogic.com/workflow-import" at "/workflowengine/models/workflow-import.xqy";
 import module namespace wfu="http://marklogic.com/workflow-util" at "/workflowengine/models/workflow-util.xqy";
 
 declare namespace wf="http://marklogic.com/workflow";
-
 declare namespace roxy = "http://marklogic.com/roxy";
-
 declare namespace rapi = "http://marklogic.com/rest-api";
 
 
@@ -52,6 +49,7 @@ function ext:get(
  :)
 declare
 %roxy:params("")
+%rapi:transaction-mode("update")
 function ext:put(
     $context as map:map,
     $params  as map:map,
diff --git a/rest-api/ext/processinbox.xqy b/rest-api/ext/processinbox.xqy
@@ -8,6 +8,7 @@ import module namespace json = "http://marklogic.com/xdmp/json" at "/MarkLogic/j
 import module namespace cpf = "http://marklogic.com/cpf" at "/MarkLogic/cpf/cpf.xqy";
 import module namespace wfu="http://marklogic.com/workflow-util" at "/workflowengine/models/workflow-util.xqy";
 
+declare namespace rapi= "http://marklogic.com/rest-api";
 declare namespace roxy = "http://marklogic.com/roxy";
 declare namespace wf="http://marklogic.com/workflow";
 
@@ -17,7 +18,7 @@ declare namespace wf="http://marklogic.com/workflow";
  : Returns the full process document
  :)
 declare
-%roxy:params("inbox=xs:string")
+%roxy:params("user=xs:string")
 function ext:get(
   $context as map:map,
   $params  as map:map
@@ -30,7 +31,7 @@ function ext:get(
 
   let $out :=
       <ext:readResponse><ext:outcome>SUCCESS</ext:outcome>
-        {wfu:inbox( () )}
+        {wfu:inbox( map:get($params,"user") )}
       </ext:readResponse>
 
   return
diff --git a/rest-api/ext/processmodel.xqy b/rest-api/ext/processmodel.xqy
@@ -3,15 +3,13 @@ xquery version "1.0-ml";
 module namespace ext = "http://marklogic.com/rest-api/resource/processmodel";
 
 import module namespace json = "http://marklogic.com/xdmp/json" at "/MarkLogic/json/json.xqy";
-
 import module namespace wfi="http://marklogic.com/workflow-import" at "/workflowengine/models/workflow-import.xqy";
 import module namespace wfu="http://marklogic.com/workflow-util" at "/workflowengine/models/workflow-util.xqy";
 
 declare namespace wf="http://marklogic.com/workflow";
-
+declare namespace rapi= "http://marklogic.com/rest-api";
 declare namespace roxy = "http://marklogic.com/roxy";
 
-
 (:
  : Get the process model by exact name
  :  ?publishedId=name
@@ -53,6 +51,7 @@ function ext:get(
  :)
 declare
 %roxy:params("")
+%rapi:transaction-mode("update")
 function ext:put(
     $context as map:map,
     $params  as map:map,
@@ -105,6 +104,7 @@ function ext:put(
  :)
 declare
 %roxy:params("")
+%rapi:transaction-mode("update")
 function ext:post(
     $context as map:map,
     $params  as map:map,
diff --git a/rest-api/ext/processqueue.xqy b/rest-api/ext/processqueue.xqy
@@ -8,6 +8,7 @@ import module namespace json = "http://marklogic.com/xdmp/json" at "/MarkLogic/j
 import module namespace cpf = "http://marklogic.com/cpf" at "/MarkLogic/cpf/cpf.xqy";
 import module namespace wfu="http://marklogic.com/workflow-util" at "/workflowengine/models/workflow-util.xqy";
 
+declare namespace rapi= "http://marklogic.com/rest-api";
 declare namespace roxy = "http://marklogic.com/roxy";
 declare namespace wf="http://marklogic.com/workflow";
 
@@ -17,7 +18,7 @@ declare namespace wf="http://marklogic.com/workflow";
  : Returns the full process document
  :)
 declare
-%roxy:params("inbox=xs:string")
+%roxy:params("queue=xs:string")
 function ext:get(
   $context as map:map,
   $params  as map:map
diff --git a/rest-api/ext/processroleinbox.xqy b/rest-api/ext/processroleinbox.xqy
@@ -8,6 +8,7 @@ import module namespace json = "http://marklogic.com/xdmp/json" at "/MarkLogic/j
 import module namespace cpf = "http://marklogic.com/cpf" at "/MarkLogic/cpf/cpf.xqy";
 import module namespace wfu="http://marklogic.com/workflow-util" at "/workflowengine/models/workflow-util.xqy";
 
+declare namespace rapi= "http://marklogic.com/rest-api";
 declare namespace roxy = "http://marklogic.com/roxy";
 declare namespace wf="http://marklogic.com/workflow";
 
@@ -16,7 +17,7 @@ declare namespace wf="http://marklogic.com/workflow";
  : Fetch a process inbox for the current role
  :)
 declare
-%roxy:params("inbox=xs:string")
+%roxy:params("role=xs:string")
 function ext:get(
   $context as map:map,
   $params  as map:map
diff --git a/rest-api/ext/processsubscription.xqy b/rest-api/ext/processsubscription.xqy
@@ -5,10 +5,10 @@ module namespace ext = "http://marklogic.com/rest-api/resource/processsubscripti
 
 (: import module namespace config = "http://marklogic.com/roxy/config" at "/app/config/config.xqy"; :)
 import module namespace json = "http://marklogic.com/xdmp/json" at "/MarkLogic/json/json.xqy";
-
 import module namespace cpf = "http://marklogic.com/cpf" at "/MarkLogic/cpf/cpf.xqy";
 import module namespace wfu="http://marklogic.com/workflow-util" at "/workflowengine/models/workflow-util.xqy";
 
+declare namespace rapi= "http://marklogic.com/rest-api";
 declare namespace roxy = "http://marklogic.com/roxy";
 declare namespace wf="http://marklogic.com/workflow";
 
@@ -31,6 +31,7 @@ declare namespace wf="http://marklogic.com/workflow";
   :)
 declare
 %roxy:params("")
+%rapi:transaction-mode("update")
 function ext:put(
    $context as map:map,
    $params  as map:map,
diff --git a/rest-api/ext/workplace.xqy b/rest-api/ext/workplace.xqy
@@ -3,7 +3,6 @@ xquery version "1.0-ml";
 module namespace ext = "http://marklogic.com/rest-api/resource/workplace";
 
 declare namespace roxy = "http://marklogic.com/roxy";
-
 declare namespace rapi = "http://marklogic.com/rest-api";
 
 (:
diff --git a/src/test/suites/e2e-rest-process-xml/015-processmodel-xml.xqy b/src/test/suites/e2e-rest-process-xml/015-processmodel-xml.xqy
@@ -17,6 +17,12 @@ return ( (:
   test:assert-equal('SUCCESS', xs:string($process[2]/createResponse/outcome)),
   test:assert-equal('015-restapi-tests__1__0', xs:string($process[2]/createResponse/modelId))
 );
+(:
+  <ext:createResponse xmlns:ext="http://marklogic.com/rest-api/resource/processmodel">
+    <ext:outcome>SUCCESS</ext:outcome>
+    <ext:modelId>015-restapi-tests__1__0</ext:modelId>
+  </ext:createResponse>
+:)
 
 (: 02-processmodel-read :)
 import module namespace const="http://marklogic.com/roxy/workflow-constants" at "/test/workflow-constants.xqy";
@@ -48,6 +54,12 @@ return ( (:
   test:assert-equal('SUCCESS', xs:string($result[2]/createResponse/outcome)),
   test:assert-equal('015-restapi-tests__1__2', xs:string($result[2]/createResponse/modelId))
 );
+(:
+  <ext:createResponse xmlns:ext="http://marklogic.com/rest-api/resource/processmodel">
+    <ext:outcome>SUCCESS</ext:outcome>
+    <ext:modelId>015-restapi-tests__1__2</ext:modelId>
+  </ext:createResponse>
+:)
 
 (: 04-processmodel-publish :)
 import module namespace const="http://marklogic.com/roxy/workflow-constants" at "/test/workflow-constants.xqy";
@@ -66,6 +78,12 @@ return ( (:
   test:assert-equal('SUCCESS', xs:string($result[2]/updateResponse/outcome)),
   test:assert-exists(xs:string($result[2]/updateResponse/domainId))
 );
+(:
+  <ext:updateResponse xmlns:ext="http://marklogic.com/rest-api/resource/processmodel">
+    <ext:outcome>SUCCESS</ext:outcome>
+    <ext:domainId>16663957717060497977</ext:domainId>
+  </ext:updateResponse>
+:)
 
 (: there is and has never been 05 :)
 
@@ -100,13 +118,21 @@ return (
   test:assert-equal('SUCCESS', xs:string($result[2]/ext:readResponse/ext:outcome)),
   test:assert-exists($result[2]/ext:readResponse/ext:document)
 );
+(:
+  <ext:readResponse xmlns:ext="http://marklogic.com/rest-api/resource/process">
+    <ext:outcome>SUCCESS</ext:outcome>
+    <ext:document/>
+  </ext:readResponse>
+:)
 
 (: 08-processinbox-read :)
 import module namespace const="http://marklogic.com/roxy/workflow-constants" at "/test/workflow-constants.xqy";
 import module namespace wrt="http://marklogic.com/workflow/rest-tests" at "/test/workflow-rest-tests.xqy";
 import module namespace test="http://marklogic.com/roxy/test-helper" at "/test/test-helper.xqy";
+declare namespace cpf = "http://marklogic.com/cpf";
 declare namespace ext = "http://marklogic.com/rest-api/resource/processinbox";
 declare namespace http = "xdmp:http";
+declare namespace prop = "http://marklogic.com/xdmp/property";
 declare namespace wf="http://marklogic.com/workflow";
 
 let $_pause := xdmp:sleep(5000)
@@ -115,7 +141,23 @@ let $result := wrt:test-08-processinbox-read($const:xml-options)
 return (
   test:assert-equal('200', xs:string($result[1]/http:code)),
   test:assert-equal('SUCCESS', xs:string($result[2]/ext:readResponse/ext:outcome)),
-  test:assert-exists($result[2]/ext:readResponse/wf:inbox/wf:task[@processid=$pid])
+  test:assert-exists($result[2]/ext:readResponse/wf:inbox/wf:task[@processid=$pid]),
+  let $task := $result[2]/ext:readResponse/wf:inbox/wf:task[@processid=$pid]
+  return (
+    test:assert-exists($task/wf:process-data/wf:process/wf:data),
+    test:assert-exists($task/wf:process-data/wf:process/wf:attachments),
+    test:assert-exists($task/wf:process-data/wf:process/wf:audit-trail),
+    test:assert-exists($task/wf:process-data/wf:process/wf:metrics),
+    test:assert-exists($task/wf:process-data/wf:process/wf:process-definition-name),
+    let $properties := $task/wf:process-properties/prop:properties
+    return (
+      test:assert-equal('done', xs:string($properties/cpf:processing-status)),
+      test:assert-equal('user', xs:string($properties/wf:currentStep/wf:type)),
+      test:assert-equal('admin', xs:string($properties/wf:currentStep/wf:assignee)),
+      test:assert-equal('userTask', xs:string($properties/wf:currentStep/wf:step-type)),
+      test:assert-equal('ENTERED', xs:string($properties/wf:currentStep/wf:step-status))
+    )
+  )
 );
 
 (: 09-process-update :)
diff --git a/src/workflowengine/actions/sendTask.xqy b/src/workflowengine/actions/sendTask.xqy
@@ -55,7 +55,7 @@ try {
   (: If still none, throw failure message (misconfiguration) :)
   return
     (
-      xdmp:email($messageXml)
+      if(fn:empty($messageXml)) then () else xdmp:email($messageXml)
       ,
       wfu:complete( $cpf:document-uri, $cpf:transition, (), $st )
     )
diff --git a/src/workflowengine/models/alert-action-process.xqy b/src/workflowengine/models/alert-action-process.xqy
@@ -9,7 +9,6 @@ xquery version "1.0-ml";
 
 import module namespace alert = "http://marklogic.com/xdmp/alert" at "/MarkLogic/alert.xqy";
 declare namespace wf = "http://marklogic.com/workflow";
-import module namespace sem = "http://marklogic.com/semantics" at "/MarkLogic/semantics.xqy";
 
 import module namespace wfu="http://marklogic.com/workflow-util" at "/workflowengine/models/workflow-util.xqy";
 
@@ -29,12 +28,12 @@ let $pid :=   wfu:create($procname,$alert:doc/element(),
 return ()
 
 
-(:)
+(:
   xdmp:document-insert($procname || "/" || sem:uuid-string() || ".xml",
    <process xmlns="http://marklogic.com/workflow/process">
     <data>
     {
-      (: TODO check config for mappings options - rather than map entire document in:)
+      ( : TODO check config for mappings options - rather than map entire document in : )
       $alert:doc/element()
     }
     </data>
diff --git a/src/workflowengine/models/lib-search-subscribe.xqy b/src/workflowengine/models/lib-search-subscribe.xqy
diff --git a/src/workflowengine/models/workflow-actions.xqy b/src/workflowengine/models/workflow-actions.xqy
diff --git a/src/workflowengine/models/workflow-import.xqy b/src/workflowengine/models/workflow-import.xqy
diff --git a/src/workflowengine/models/workflow-util.xqy b/src/workflowengine/models/workflow-util.xqy

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## Roxy Installation`
	`1`	`+### Roxy Installation`
`2`	`2`
`3`	`3`	To install via roxy, within the roxy directory, edit the properties file for the target environment - for example, ``deploy/local.properties`` and run the following commands:
`4`	`4`