Run a Flow Using the Data Hub Client JAR

To avoid dependence on Gradle and project files, especially in production environments, Data Hub provides a client JAR that depends on a Java Virtual Machine (JVM) only.

Before you begin

You need:

Procedure

  1. Download the Data Hub client JAR (marklogic-data-hub-VERSION_NUMBER-client.jar) to a local directory.
  2. Run the JAR with the runFlow command.

    For DHS:

    java -jar marklogic-data-hub-VERSION_NUMBER-client.jar runFlow -host yourDhsHost -username yourUserName -password yourPasswordOrNothing -flowName YourFlowName -steps 2,3 -ssl -auth basic -PmlIsHostLoadBalancer=true -PanyDataHubProperty=newPropertyValue

    For on-premises or other cloud environments:

    java -jar marklogic-data-hub-VERSION_NUMBER-client.jar runFlow -host yourHost -username yourUserName -password yourPasswordOrNothing -flowName YourFlowName -steps 2,3 -PanyDataHubProperty=newPropertyValue
    -host
    (Required) The MarkLogic Server host.
    -username
    (Required) The username for a security account assigned to a role with the privilege to run flows, e.g., flow-operator-role. See Users and Roles.
    -password
    (Required) The password for the specified security account. For better security, do not specify a value after the parameter, so that you will be prompted for your password.
    -flowName
    (Required) The name of the flow to run.
    -steps
    Used for partial runs. A comma-separated list of step numbers to run.
    -ssl
    (Required for DHS) If present, the connection with DHS is secured with SSL/TLS. Must not have a value.
    -auth
    (Required for DHS) Must be set to basic for DHS. The connection with DHS uses basic authentication.
    -PmlIsHostLoadBalancer=true
    (Required for DHS) Must be set to true for DHS. The host is a load balancer that directs traffic to MarkLogic hosts.
    -P<anyDataHubProperty>=<newPropertyValue>
    Sets the value of the specified Data Hub property. See Data Hub Properties. Example: -PmlStagingPort=8410
    Tip: To view the complete list of possible parameters, run the JAR without parameters. 
    java -jar marklogic-data-hub-VERSION_NUMBER-client.jar