fixed #513

also cleaned up some code. made all the ways to run flows use the same param names.

Author: paxtonhare

examples/healthcare/plugins/entities/Patients/harmonize/final/main.xqy

@@ -49,6 +49,7 @@ declare function plugin:main(
 
   let $envelope := dhf:make-envelope($content, $headers, $triples, map:get($options, "dataFormat"))
   return
-  (: explain: needed to call this way for static analysis :)
+  (: writers must be invoked this way.
+     see: https://github.com/marklogic-community/marklogic-data-hub/wiki/dhf-lib#run-writer :)
     dhf:run-writer(xdmp:function(xs:QName("writer:write")), $id, $envelope, $options)
 };

examples/healthcare/plugins/entities/Patients/input/hl7/main.xqy

@@ -46,6 +46,11 @@ declare function plugin:main(
   })
 
   let $envelope := dhf:make-envelope($content, $headers, $triples, map:get($options, "dataFormat"))
+  (:
+   : log the final envelope as a trace
+   : only fires if tracing is enabled
+   :)
+  let $_ := dhf:log-trace(dhf:writer-context($envelope))
   return
     $envelope
 };

examples/healthcare/plugins/entities/Patients/input/nppes/main.xqy

@@ -46,6 +46,11 @@ declare function plugin:main(
   })
 
   let $envelope := dhf:make-envelope($content, $headers, $triples, map:get($options, "dataFormat"))
+  (:
+   : log the final envelope as a trace
+   : only fires if tracing is enabled
+   :)
+  let $_ := dhf:log-trace(dhf:writer-context($envelope))
   return
     $envelope
 };

examples/hr-hub/plugins/entities/Employee/harmonize/harmonize-acme-tech/content/content.sjs

@@ -1,29 +1,29 @@
-/*
- * Create Content Plugin
- *
- * @param id         - the identifier returned by the collector
- * @param options    - an object containing options. Options are sent from Java
- *
- * @return - your content
- */
-function createContent(id, options) {
-  var doc = cts.doc(id);
-  var root = doc.root;
-
-  // for xml we need to use xpath
-  if (root && xdmp.nodeKind(root) === 'element') {
-    return root.xpath('/*:envelope/*:instance/node()');
-  }
-  // for json we need to return the instance
-  else if (root && root.envelope && root.envelope.instance) {
-    return root.envelope.instance;
-  }
-  // for everything else
-  else {
-    return doc;
-  }
-}
-
-module.exports = {
-  createContent: createContent
-};
+/*
+ * Create Content Plugin
+ *
+ * @param id         - the identifier returned by the collector
+ * @param options    - an object containing options. Options are sent from Java
+ *
+ * @return - your content
+ */
+function createContent(id, options) {
+  var doc = cts.doc(id);
+  var root = doc.root;
+
+  // for xml we need to use xpath
+  if (root && xdmp.nodeKind(root) === 'element') {
+    return root.xpath('/*:envelope/*:instance/node()');
+  }
+  // for json we need to return the instance
+  else if (root && root.envelope && root.envelope.instance) {
+    return root.envelope.instance;
+  }
+  // for everything else
+  else {
+    return doc;
+  }
+}
+
+module.exports = {
+  createContent: createContent
+};

examples/hr-hub/plugins/entities/Employee/harmonize/harmonize-acme-tech/main.sjs

@@ -32,7 +32,8 @@ function main(id, options) {
 
   var envelope = dhf.makeEnvelope(content, headers, triples, options.dataFormat);
 
-  // explain. needed to call this way for static analysis
+  // writers must be invoked this way.
+  // see: https://github.com/marklogic-community/marklogic-data-hub/wiki/dhf-lib#run-writer
   dhf.runWriter(xdmp.function(null, './writer/writer.sjs'), id, envelope, options);
 }
 

examples/hr-hub/plugins/entities/Employee/harmonize/harmonize-global-corp/collector/collector.sjs

@@ -1,24 +1,24 @@
-/*
- * Collect IDs plugin
- *
- * @param options - a map containing options. Options are sent from Java
- *
- * @return - an array of ids or uris
- */
-function collect(options) {
-
-  // grab a list of the unique employee IDs out of the JSON data
-  // This is a really bad way to do this. Use a range index instead
-  var y = [];
-  for (var x of fn.collection('load-global-corp')) {
-    var empid = x.root.envelope.instance.emp_id;
-    if (empid) {
-      y.push(empid);
-    }
-  }
-  return fn.distinctValues(xdmp.arrayValues(y));
-}
-
-module.exports = {
-  collect: collect
-};
+/*
+ * Collect IDs plugin
+ *
+ * @param options - a map containing options. Options are sent from Java
+ *
+ * @return - an array of ids or uris
+ */
+function collect(options) {
+
+  // grab a list of the unique employee IDs out of the JSON data
+  // This is a really bad way to do this. Use a range index instead
+  var y = [];
+  for (var x of fn.collection('load-global-corp')) {
+    var empid = x.root.envelope.instance.emp_id;
+    if (empid) {
+      y.push(empid);
+    }
+  }
+  return fn.distinctValues(xdmp.arrayValues(y));
+}
+
+module.exports = {
+  collect: collect
+};

examples/hr-hub/plugins/entities/Employee/harmonize/harmonize-global-corp/content/content.sjs

@@ -1,30 +1,30 @@
-/*
- * Create Content Plugin
- *
- * @param id         - the identifier returned by the collector
- * @param options    - an object containing options. Options are sent from Java
- *
- * @return - your content
- */
-function createContent(id, options) {
-  // start with an empty object
-  content = {};
-
-  // find the documents matching the given employee id
-  for (var doc of cts.search(cts.jsonPropertyValueQuery('emp_id', id))) {
-
-    // merge the keys and values from the found document into content
-    for (var key in doc.root.envelope.instance) {
-      if (doc.root.envelope.instance.hasOwnProperty(key)) {
-        content[key] = doc.root.envelope.instance[key];
-      }
-    }
-  }
-
-  // return the merged content
-  return content;
-}
-
-module.exports = {
-  createContent: createContent
-};
+/*
+ * Create Content Plugin
+ *
+ * @param id         - the identifier returned by the collector
+ * @param options    - an object containing options. Options are sent from Java
+ *
+ * @return - your content
+ */
+function createContent(id, options) {
+  // start with an empty object
+  content = {};
+
+  // find the documents matching the given employee id
+  for (var doc of cts.search(cts.jsonPropertyValueQuery('emp_id', id))) {
+
+    // merge the keys and values from the found document into content
+    for (var key in doc.root.envelope.instance) {
+      if (doc.root.envelope.instance.hasOwnProperty(key)) {
+        content[key] = doc.root.envelope.instance[key];
+      }
+    }
+  }
+
+  // return the merged content
+  return content;
+}
+
+module.exports = {
+  createContent: createContent
+};

examples/hr-hub/plugins/entities/Employee/harmonize/harmonize-global-corp/main.sjs

@@ -32,7 +32,8 @@ function main(id, options) {
 
   var envelope = dhf.makeEnvelope(content, headers, triples, options.dataFormat);
 
-  // explain. needed to call this way for static analysis
+  // writers must be invoked this way.
+  // see: https://github.com/marklogic-community/marklogic-data-hub/wiki/dhf-lib#run-writer
   dhf.runWriter(xdmp.function(null, './writer/writer.sjs'), id, envelope, options);
 }
 

examples/hr-hub/plugins/entities/Employee/input/load-acme-tech/main.sjs

@@ -31,7 +31,13 @@ function main(id, rawContent, options) {
     return triplesPlugin.createTriples(id, content, headers, options);
   });
 
-  return dhf.makeEnvelope(content, headers, triples, options.dataFormat);
+  var envelope = dhf.makeEnvelope(content, headers, triples, options.dataFormat);
+  
+  // log the final envelope as a trace
+  // only fires if tracing is enabled
+  dhf.logTrace(dhf.writerContext(envelope));
+
+  return envelope;
 }
 
 module.exports = {

examples/hr-hub/plugins/entities/Employee/input/load-global-corp/main.sjs

@@ -31,7 +31,13 @@ function main(id, rawContent, options) {
     return triplesPlugin.createTriples(id, content, headers, options);
   });
 
-  return dhf.makeEnvelope(content, headers, triples, options.dataFormat);
+  var envelope = dhf.makeEnvelope(content, headers, triples, options.dataFormat);
+
+  // log the final envelope as a trace
+  // only fires if tracing is enabled
+  dhf.logTrace(dhf.writerContext(envelope));
+
+  return envelope;
 }
 
 module.exports = {