Merge branch 'master' into 67-InputFlowReportFailure

Author: gmarintes

README.md

@@ -39,3 +39,50 @@ To generate eclipse project files run:
 `./gradlew eclipse`
 
 Then import the project into eclipse
+
+####Available Transforms
+Data Hub has provided several transforms that can be used when installed along with the created entities and flows in the MarkLogic server.
+####run-flow
+This transform can be used to run the flow when inserting document. It accepts the following `entity-name` and `flow-name`. 
+
+#####Use Cases:
+
+1. Using [MarkLogic REST API PUT /v1/documents](http://docs.marklogic.com/REST/PUT/v1/documents)
+
+`curl --anyauth --user <user>:<password> -X PUT -T <documentDirectory> -H "Content-type:<contentType>" 'http://<mlHost>:<port>/<version>/documents?uri=<uri>&transform=run-flow&trans:entity-name=<entityName>&trans:flow-name=<flowName>'`
+
+Example:
+
+`cat ./documents/employee1.xml`
+
+`<employee xmlns="http://company.com/ns/employee">`
+`<id>1</id>`
+`</employee>`
+
+To insert/update this document with uri '/employee1.xml' into the database 'data-hub-STAGING' (with host 'localhost' and port '8010'), given a user 'admin' with password 'admin' and rest-writer role AND to be able to run the flow 'IngestFlow' of the 'Customer' entity, run the following:
+
+`curl --anyauth --user admin:admin -X PUT -T ./documents/employee1.xml -H "Content-type:application/xml" 'http://localhost:8010/LATEST/documents?uri=/employee1.xml&transform=run-flow&trans:entity-name=Customer&trans:flow-name=IngestFlow'`
+
+This will create a document with uri '/employee1.xml'. The content will depend on the data format of the entity. 
+
+If it is JSON ('application/json'), the content will be:
+
+`{`
+`"identifier": "/employee1.xml", `
+`"content": "<employee xmlns=\"http://company.com/ns/employee\">\n  <id>1</id>\n</employee>"`
+`}`
+
+Else if it is XML ('application/xml'), it will be:
+
+`<?xml  version="1.0" encoding="UTF-8"?>`
+`<envelope xmlns="http://marklogic.com/data-hub/envelope">`
+`<headers>`
+`</headers>`
+`<triples>`
+`</triples>`
+`<content>`
+`<employee xmlns="http://company.com/ns/employee">`
+`<id>1</id>`
+`</employee>`
+`</content>`
+`</envelope>`

marklogic-data-hub/gradle.properties

@@ -6,6 +6,6 @@ mlFinalRestPort=8011
 mlUsername=admin
 mlPassword=admin
 mlHost=localhost
-mlAppName=data-hub-in-a-box
+mlAppName=data-hub
 auth=digest
 version=1.0.0-alpha.2

marklogic-data-hub/src/main/java/com/marklogic/hub/DataHub.java

@@ -64,12 +64,12 @@
 public class DataHub {
 
     static final private Logger LOGGER = LoggerFactory.getLogger(DataHub.class);
-    static final public String STAGING_NAME = "data-hub-in-a-box-STAGING";
-    static final public String FINAL_NAME = "data-hub-in-a-box-FINAL";
-    static final public String MODULES_DB_NAME = "data-hub-in-a-box-modules";
+    static final public String STAGING_NAME = "data-hub-STAGING";
+    static final public String FINAL_NAME = "data-hub-FINAL";
+    static final public String MODULES_DB_NAME = "data-hub-modules";
     private ManageConfig config;
     private ManageClient client;
-    public static String HUB_NAME = "data-hub-in-a-box";
+    public static String HUB_NAME = "data-hub";
     public static int FORESTS_PER_HOST = 4;
     private String host;
     private int stagingRestPort;

marklogic-data-hub/src/main/java/com/marklogic/hub/FlowManager.java

@@ -63,7 +63,7 @@
 import com.marklogic.spring.batch.hub.FlowWriter;
 
 public class FlowManager extends ResourceManager {
-    private static final String HUB_NS = "http://marklogic.com/hub-in-a-box";
+    private static final String HUB_NS = "http://marklogic.com/data-hub";
     private static final String NAME = "flow";
     private static final int DEFAULT_THREAD_COUNT = 8;
 

marklogic-data-hub/src/main/java/com/marklogic/hub/Mlcp.java

@@ -140,7 +140,7 @@ public List<String> getMlcpArguments() throws IOException {
             arguments.add("-transform_module");
             arguments.add("/com.marklogic.hub/mlcp-flow-transform.xqy");
             arguments.add("-transform_namespace");
-            arguments.add("http://marklogic.com/hub-in-a-box/mlcp-flow-transform");
+            arguments.add("http://marklogic.com/data-hub/mlcp-flow-transform");
             arguments.add("-transform_param");
             arguments.add("\"" + sourceOptions.getTransformParams() + "\"");
             return arguments;

marklogic-data-hub/src/main/java/com/marklogic/hub/flow/AbstractFlow.java

@@ -246,7 +246,7 @@ protected XMLStreamWriter makeXMLSerializer(OutputStream out) {
 
         try {
             XMLStreamWriter serializer = factory.createXMLStreamWriter(out, "UTF-8");
-            serializer.setDefaultNamespace("http://marklogic.com/hub-in-a-box");
+            serializer.setDefaultNamespace("http://marklogic.com/data-hub");
             return serializer;
         } catch (Exception e) {
             throw new MarkLogicIOException(e);

marklogic-data-hub/src/main/resources/ml-config/databases/final-database.json

@@ -1,5 +1,5 @@
 {
-  "database-name": "data-hub-in-a-box-FINAL",
+  "database-name": "data-hub-FINAL",
   "triple-index": true,
   "collection-lexicon":true
 }

marklogic-data-hub/src/main/resources/ml-config/databases/staging-database.json

@@ -1,5 +1,5 @@
 {
-  "database-name": "data-hub-in-a-box-STAGING",
+  "database-name": "data-hub-STAGING",
   "triple-index": true,
   "collection-lexicon":true
 }

marklogic-data-hub/src/main/resources/ml-config/rest-api.json

@@ -1,8 +1,8 @@
 {
   "rest-api" : {
-    "name" : "data-hub-in-a-box-STAGING",
+    "name" : "data-hub-STAGING",
     "group" : "%%GROUP%%",
-    "database" : "data-hub-in-a-box-STAGING",
+    "database" : "data-hub-STAGING",
     "modules-database" : "%%MODULES_DATABASE%%",
     "port" : %%PORT%%,
     "xdbc-enabled" : true,

marklogic-data-hub/src/main/resources/ml-modules/root/com.marklogic.hub/collectors/query.xqy

@@ -16,7 +16,7 @@
 
 xquery version "1.0-ml";
 
-module namespace plugin = "http://marklogic.com/hub-in-a-box/plugins/query";
+module namespace plugin = "http://marklogic.com/data-hub/plugins/query";
 
 import module namespace ast = "http://marklogic.com/appservices/search-ast" at
   "/MarkLogic/appservices/search/ast.xqy";