Fixes #1

Author: adamfowleruk

.project

@@ -10,6 +10,11 @@
 			<arguments>
 			</arguments>
 		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.wst.validation.validationbuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
 	</buildSpec>
 	<natures>
 		<nature>org.eclipse.bpmn2.modeler.core.bpmn2Nature</nature>

CONTRIBUTING.md

@@ -135,5 +135,5 @@ to your code.
 
 ### Further information
 
-[issue tracker]: https://github.com/adamfowleruk/marklogicworkflow/issues
-[.editorconfig]: http://editorconfig.org/
+- [issue tracker](https://github.com/adamfowleruk/marklogicworkflow/issues)
+- [.editorconfig](http://editorconfig.org/)

data/examples/bpmn2/011_gateways_test.bpmn

@@ -42,7 +42,7 @@ steps if a duplicate is found. Requires search (by property hash AND not (same u
 - DONE Evaluation: Support for fn:doc(/process/attachments/attachment[@name="default"]/uri/text())/some/path/to/property style evaluation
 - DONE Evaluation: replace $processData or $wf:process with fn:doc($processUri) everywhere in xpath expression
 - DONE can use fn:current-dateTime - Evaluation: Support for 'now' date time assignment to variable
-- Activity: Set process variable activity with multiple from and to (simple XPath evaluation)
+- DEFERRED Activity: Set process variable activity with multiple from and to (simple XPath evaluation)
  - See if there is an equivalent BPMN2 method - may just be a variable assignment on each step instead
  - Create import step for this BPMN2 method
  - Create CPF action to represent this
@@ -65,7 +65,7 @@ steps if a duplicate is found. Requires search (by property hash AND not (same u
  - DONE processinbox.xqy
  - DONE processqueue.xqy
  - TEST support for roles (processroleinbox.xqy) on user tasks (For BD)
-- TEST BPMN2: send task -> 1 of 2: send Email (Implemented as an example message driven task)
+- DONE BPMN2: send task -> 1 of 2: send Email (Implemented as an example message driven task)
 - DONE Test scripts for automating install, create, get, update, complete via REST API
 - 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
 - DONE Bug: Multiple wf:status properties on in process process, complete and running
@@ -75,6 +75,7 @@ steps if a duplicate is found. Requires search (by property hash AND not (same u
   - Incident Management Account Manager Only
   - Incident Management Process Engine only
 - DONE basic documentation for supported step types and their configuration (STEPS.md)
+- DONE Scripting - change $wf:process/ replacement to $wf:process external variable declaration (much less buggy to implement)
 
 ## Sprint 2 - Process Orchestration
 
@@ -85,7 +86,6 @@ steps if a duplicate is found. Requires search (by property hash AND not (same u
 - BPMN2: call activity (process or global task)
 - BPMN2: parallel gateway -> fork to or synchronise from all flow paths
 - BPMN2: complex gateway -> E.g. 3 of 5 incoming routes required in order to activate gateway
-- CPF: Invoke CPF pipeline
 - BPMN2: service task -> invoke service and process response
 - Update Eclipse Modeler palette
 - Enterprise features

data/examples/bpmn2/021-initiating-attachment.bpmn

@@ -100,7 +100,16 @@ To create an operation:-
 - You can name these anything you like, be sure to provide a name and an implementation name
 - Set the Out Message to point to an XML Schema definition that consists of your message
 
-TODO Document how the VALUE not SCHEMA for this message is created (read BPMN2 spec and examples).
+
+*WARNING: If you type 'RejectedEmail' as the name of the Out Message, then MarkLogic workflow will check the MODULES
+database for a document called /workflowengine/assets/PROCESSNAME/MAJORVERSION/MINORVERSION/RejectedEmail.xml. If this
+document does not exist, it will check in the major version folder, and failing that in the process name folder. This is
+because (unbelievably) BPMN2 does not support data modelling, and such the structure of the message is out of scope of
+the modelling tool. It is possible to add a 'structure' definition in BPMN2 that points to a fixed XML message, BUT this
+is not supported by any modelling tool! Only XML Schema (for the structure of the email, not the template) is supported.*
+
+The format of the outgoing email message (Out Message) can be found in the
+[xdmp:email online docs](http://docs.marklogic.com/xdmp:email).
 
 Now go back and edit the Send Task:-
 - Left click on the send task
@@ -113,6 +122,10 @@ Now go back and edit the Send Task:-
 
 Save the process diagram (validates your configuration of the task - no red stars mean it's configured properly).
 
+For configuring a local mail agent to test this task, see [The CentOS website](http://wiki.centos.org/HowTos/postfix#head-c02f30bf0669d9b47a6c14c114243338b5ea1f27). Don't forget to set an
+alias pointing 'admin' at your local linux machine's logged in user - you can then use Thunderbird to receive email
+from the sample processes.
+
 ## Additional notes
 
 There are some configuration elements that are true across multiple steps. These are documented below.

documentation/SPRINTS.md

@@ -661,11 +661,14 @@ declare function m:bpmn2-to-cpf($pname as xs:string, $doc as element(b2:definiti
 
           (: Send email example - sendTask.xqy :)
           for $state in $start/b2:sendTask
-          let $message := $doc/b2:message[@id = $state/@messageRef]
+          let $messageText := xs:string($doc/b2:message[@id = $state/@messageRef]/@name)
+          (:
           let $item := $doc/b2:itemDefinition[@id = $message/@itemRef]
           let $structureRef := xs:string($item/@structureRef)
-          let $messageXml := () (: TODO get actual message value, followed by replacement(s) :)
+
           let $operation := $doc/b2:interface/b2:operation[@id = $state/@operationRef]
+          :)
+
           let $route := xs:string($state/b2:outgoing[1]) (: TODO support split here? :)
           let $rc :=
             if (fn:contains($route,":")) then
@@ -679,10 +682,7 @@ declare function m:bpmn2-to-cpf($pname as xs:string, $doc as element(b2:definiti
                 $failureState,(),
                 p:action("/workflowengine/actions/sendTask.xqy","BPMN2 Send Task: "||xs:string($state/@name),
                   <options xmlns="/workflowengine/actions/sendTask.xqy">
-                    { (: Message :)
-                      $messageXml
-                      (: TODO distinguish between email message and web service invocation (fire and forget) :)
-                    }
+                    <wf:message>{$messageText}</wf:message>
                   </options>
                 ),()
               )

documentation/STEPS.md

@@ -58,6 +58,24 @@ declare function m:getProcessUri($processId as xs:string) as xs:string? {
   (fn:collection("http://marklogic.com/workflow/processes")/wf:process[./@id = $processId]/fn:base-uri(.))
 };
 
+declare function m:getProcessAsset($processUri as xs:string,$assetname as xs:string) as node()? {
+  xdmp:eval(
+    'xquery version "1.0-ml";declare namespace wf="http://marklogic.com/workflow";' ||
+    'declare variable $wf:process as element(wf:process) external;' ||
+    'declare variable $wf:assetname as xs:string external;' ||
+    '(fn:doc("/workflowengine/assets/" || xs:string($wf:process/@name) || "/" || xs:string($wf:process/@major) || "/" || xs:string($wf:process/@minor) || "/" || $wf:assetname ),' ||
+    '  fn:doc("/workflowengine/assets/" || xs:string($wf:process/@name) || "/" || xs:string($wf:process/@major) || "/" || $wf:assetname ),' ||
+    '  fn:doc("/workflowengine/assets/" || xs:string($wf:process/@name) || "/" || $wf:assetname )' ||
+    ')[1]'
+    ,
+      (xs:QName("wf:process"),fn:doc($processUri)/wf:process,xs:QName("wf:assetname"),$assetname),
+      <options xmlns="xdmp:eval">
+        <database>{xdmp:modules-database()}</database>
+        <isolation>different-transaction</isolation>
+      </options>
+    )  (: MUST be executed in the modules DB - where the assets live :)
+};
+
 
 
 
@@ -247,7 +265,10 @@ declare function m:metric($processUri as xs:string,$state as xs:string,$start as
   )
 };
 
-declare function m:evaluate($processUri as xs:string,$namespaces as element(wf:namespace)*,$xpath as xs:string) as xs:boolean {
+(:
+ : The below has been replaced by an eval (m:evaluate), which bypasses the string replacement approach
+
+declare function m:evaluateOLD($processUri as xs:string,$namespaces as element(wf:namespace)*,$xpath as xs:string) as xs:boolean {
 
   let $_ := xdmp:log("In wfu:evaluate")
 
@@ -276,3 +297,42 @@ declare function m:evaluate($processUri as xs:string,$namespaces as element(wf:n
   return
     $result
 };
+:)
+
+declare function m:evaluate($processUri as xs:string,$namespaces as element(wf:namespace)*,$xpath as xs:string) as xs:boolean {
+  let $ns :=
+    for $namespace in $namespaces
+    return
+      if (fn:not(fn:empty($namespace/@short/text())) and fn:not(fn:empty($namespace/@long/text()))) then
+        "declare namespace " || $namespace/@short/text() || ' = "' || $namespace/@long/text() || '"; '
+      else ""
+  let $xquery :=
+    'xquery version "1.0-ml";declare namespace wf="http://marklogic.com/workflow";' || $ns ||
+    'declare variable $wf:process as element(wf:process) external;' ||
+    $xpath
+  let $_ := xdmp:log($xquery)
+  return
+    xdmp:eval($xquery,
+      (xs:QName("wf:process"),fn:doc($processUri)/wf:process),
+      <options xmlns="xdmp:eval">
+        <isolation>different-transaction</isolation>
+      </options>
+    )
+};
+
+declare function m:evaluateXml($processUri as xs:string,$namespaces as element(wf:namespace)*,$xmlText as xs:string,$params as node()*) as node()* {
+  let $xquery := 'xquery version "1.0-ml";declare namespace wf="http://marklogic.com/workflow";' ||
+      'declare variable $wf:process as element(wf:process) external;' || $xmlText
+  let $_ := xdmp:log("wfu:evaluateXml: xquery: " || $xquery)
+  let $result :=
+   xdmp:eval($xquery,
+      (xs:QName("wf:process"),fn:doc($processUri)/wf:process), (: TODO accept external params without having blank params of () in the eval call :)
+      <options xmlns="xdmp:eval">
+        <isolation>different-transaction</isolation>
+      </options>
+    )
+  let $_ := xdmp:log("wfu:evaluateXml: result:-")
+  let $_ := xdmp:log($result)
+  let $_ := xdmp:log("wfu:evaluateXml: Complete. Returning...")
+  return $result
+};

modules/app/models/workflow-import.xqy

@@ -22,9 +22,7 @@ declare variable $cpf:options as element() external;
         <wf:namespaces>
           <wf:namespace short="xh" long="http://some/xml/ns" />
         </wf:namespaces>
-        <wf:message xmlns:wf="http://marklogic.com/workflow">
-          XML SMTP MESSSAGE FORMAT AS PER xdmp:email with {/wf:process/some/parameter} replacements.
-        </wf:message>
+        <wf:message>EmailTest</wf:message>
       </options>
     </action>
   </execute>
@@ -38,18 +36,26 @@ try {
   let $ns := ($cpf:options/wf:namespaces/wf:namespace,<wf:namespace short="wf" long="http://marklogic.com/workflow" />)
   (: Default namespace is same as process doc :) (: TODO mix in those from BPMN2 doc :)
 
-  let $message := $cpf:options/wf:message/node() (: XML send email format from xdmp:email :)
-
-  (: TODO perform active parameter replacements withing text of email :)
-
+  let $message := xs:string($cpf:options/wf:message) (: XML send email format from xdmp:email :)
   let $_ := xdmp:log("sendTask: Email message:-")
   let $_ := xdmp:log($message)
 
 
+  let $messageText := wfu:getProcessAsset($cpf:document-uri,$message || ".txt")/text() (: This is a text file!!! Not XML :)
+  let $_ := xdmp:log($messageText)
+
+  (: Perform replacements across returned content :)
+  let $messageXml := wfu:evaluateXml($cpf:document-uri,$ns,$messageText, ()) (: TODO pass in real parameters, like to and from email etc.? Or just do inside template? :)
+
+
+  let $_ := xdmp:log("sendTask: Email message result XML:-")
+  let $_ := xdmp:log($messageXml)
+
+
   (: If still none, throw failure message (misconfiguration) :)
   return
     (
-      xdmp:email($message)
+      xdmp:email($messageXml)
       ,
       wfu:complete( $cpf:document-uri, $cpf:transition, (), $st )
     )

modules/app/models/workflow-util.xqy

@@ -4,6 +4,7 @@ import module namespace cpf = "http://marklogic.com/cpf" at "/MarkLogic/cpf/cpf.
 import module namespace wfu="http://marklogic.com/workflow-util" at "/app/models/workflow-util.xqy";
 
 declare namespace wf="http://marklogic.com/workflow";
+declare namespace p="http://marklogic.com/cpf/pipelines";
 
 declare variable $cpf:document-uri as xs:string external;
 declare variable $cpf:transition as node() external;
@@ -28,9 +29,18 @@ declare variable $cpf:options as element() external;
 
 try {
   let $st := fn:current-dateTime()
+  let $_ := xdmp:log($cpf:transition)
+  let $parts := fn:tokenize($cpf:transition/p:state/text(),"/")
+  let $_ := xdmp:log($parts)
+  let $processinfo := fn:tokenize($parts[fn:last() - 1],"__")
+  let $_ := xdmp:log($processinfo)
   return
   (
     (: set initial Workflow properties :)
+    xdmp:node-insert-child(fn:doc($cpf:document-uri)/wf:process,attribute title {$parts[fn:last() - 1]}),
+    xdmp:node-insert-child(fn:doc($cpf:document-uri)/wf:process,attribute name {$processinfo[1]}),
+    xdmp:node-insert-child(fn:doc($cpf:document-uri)/wf:process,attribute major {$processinfo[2]}),
+    xdmp:node-insert-child(fn:doc($cpf:document-uri)/wf:process,attribute minor {$processinfo[3]}),
     xdmp:document-add-properties($cpf:document-uri,
       (
         <wf:start>{fn:current-dateTime()}</wf:start>