Data Hub Properties

TheData Hub properties control howData Hub is installed and how connections are made. You can configure these properties through various tools, including theData Hub Gradle Plugin.

MARKLOGIC SERVER HOST
PropertyDescriptionDefault Value
mlHostThe MarkLogic Server host whereData Hub should be installed or is installed.

For on-premises andDHS.

localhost
mlIsProvisionedEnvironmentIftrue, indicates that theData Hub instance is provisioned by a cloud provider; otherwise, indicates that the instance is on-premises.

For on-premises andDHS.

If usingDHS, must be set totrue.

false
mlIsHostLoadBalancerMust be set totrue if the host specified bymlHost is a load balancer that directs traffic to MarkLogic hosts.

For on-premises andDHS.

false
mlAppServicesPortThe port number of an app server thatData Hub can use to determine the version ofML Server. The app server must always be available.

For on-premises andDHS.

8000
mlAppServicesAuthenticationThe authentication method for the app server specified bymlAppServicesPort.Valid values aredigest (encrypted credentials) andbasic (unencrypted credentials).

For on-premises andDHS.

digest
mlAppServicesSimpleSslIftrue, the connection with the app server specified bymlAppServicesPort is secured with SSL/TLS.

For on-premises andDHS.

false
mlManagePortThe port of the MarkLogic Manage server used to deploy aData Hub application.

For on-premises andDHS.

8002
mlManageSchemeThe HTTP scheme for connecting to the MarkLogic Manage server. Valid values arehttp andhttps. Usehttps for an SSL/TLS connection.

For on-premises andDHS.

http
mlManageSimpleSslIftrue, the connection with the MarkLogic Manage app server is secured with SSL/TLS.

For on-premises andDHS.

false
STAGING
PropertyDescriptionDefault Value
mlStagingDbNameThe STAGING database.

For on-premises only.

data-hub-STAGING
mlStagingForestsPerHostThe number of forests per host for the STAGING database.

For on-premises only.

3
mlStagingAppserverNameThe application server used to access the STAGING database.

For on-premises only.

data-hub-STAGING
mlStagingPortThe port used by the STAGING app server.

For on-premises andDHS.

If usingDHS, must be set to8010.

8010
mlStagingAuthThe authentication method for the STAGING app server.Valid values aredigest (encrypted credentials) andbasic (unencrypted credentials).

For on-premises andDHS.

If usingDHS, must be set tobasic.

digest
mlStagingSimpleSslIftrue, the connection with the STAGING server is secured with SSL/TLS.

For on-premises only.

false
FINAL
PropertyDescriptionDefault Value
mlFinalDbNameThe FINAL database.

For on-premises only.

data-hub-FINAL
mlFinalForestsPerHostThe number of forests per host for the FINAL database.

For on-premises only.

3
mlFinalAppserverNameThe application server used to access the FINAL database.

For on-premises only.

data-hub-FINAL
mlFinalPortThe port used by the FINAL app server.

For on-premises andDHS.

If usingDHS, must be set to8011.

8011
mlFinalAuthThe authentication method for the FINAL app server.Valid values aredigest (encrypted credentials) andbasic (unencrypted credentials).

For on-premises andDHS.

If usingDHS, must be set tobasic.

digest
mlFinalSimpleSslIftrue, the connection with the FINAL server is secured with SSL/TLS.

For on-premises only.

false
JOBS
PropertyDescriptionDefault Value
mlJobDbNameThe JOBS database.

For on-premises only.

data-hub-JOBS
mlJobForestsPerHostThe number of forests per host for the JOBS database.

For on-premises only.

4
mlJobAppserverNameThe application server used to access the JOBS database.

For on-premises only.

data-hub-JOBS
mlJobPortThe port used by the JOBS app server.

For on-premises andDHS.

If usingDHS, must be set to8013.

8013
mlJobAuthThe authentication method for the JOBS app server.Valid values aredigest (encrypted credentials) andbasic (unencrypted credentials).

For on-premises andDHS.

If usingDHS, must be set tobasic.

digest
mlJobSimpleSslIftrue, the connection with the JOBS server is secured with SSL/TLS.

For on-premises only.

false
OTHER DATABASES
PropertyDescriptionDefault Value
mlModulesDbNameThe MODULES database to be used with the STAGING, FINAL, and JOBS app servers.

For on-premises only.

data-hub-MODULES
mlModulesForestsPerHostThe number of forests per host for the MODULES database.

For on-premises only.

1
mlStagingTriggersDbNameThe TRIGGERS database to be used with the STAGING app server.

For on-premises only.

data-hub-staging-TRIGGERS
mlStagingTriggersForestsPerHostThe number of forests per host for the STAGING-TRIGGERS database.

For on-premises only.

1
mlStagingSchemasDbNameThe SCHEMAS database to be used with the STAGING app server.

For on-premises only.

data-hub-staging-SCHEMAS
mlStagingSchemasForestsPerHostThe number of forests per host for the STAGING-SCHEMAS database.

For on-premises only.

1
mlFinalTriggersDbNameThe TRIGGERS database to be used with the FINAL app server.

For on-premises only.

data-hub-final-TRIGGERS
mlFinalTriggersForestsPerHostThe number of forests per host for the FINAL-TRIGGERS database.

For on-premises only.

1
mlFinalSchemasDbNameThe SCHEMAS database to be used with the FINAL app server.

For on-premises only.

data-hub-final-SCHEMAS
mlFinalSchemasForestsPerHostThe number of forests per host for the FINAL-SCHEMAS database.

For on-premises only.

1
SECURITY
PropertyDescriptionDefault Value
mlFlowOperatorRoleThe MarkLogic Server role with privileges to run flows.

For on-premises andDHS.

If usingDHS, must be set toflowOperator.

flow-operator-role
mlFlowDeveloperRoleThe MarkLogic Server role with privileges to develop flows.

For on-premises andDHS.

If usingDHS, must be set toflowDeveloper.

flow-developer-role
  • mlUsername
  • mlPassword
The username and password associated with an account to use for everyData Hub operation.

For on-premises andDHS.

Note: Other properties conform to the ml-gradle properties. Seethe ml-gradle Property Reference

Composite Properties

To simplify your configuration, you can set these composite properties instead of the individual properties.

PropertyIf the property istrue, thenNotes
hubDhs
   mlIsHostLoadBalancer=true  mlFinalAuth=basic  mlStagingAuthMethod=basic  mlJobAuthMethod=basic  mlIsProvisionedEnvironment=true  mlAppServicesPort=8010  mlAppServicesAuthentication=basic
These settings are required byDHS.
Note: IfhubDhs=true, thenhubSsl=true is automatically set.
hubSsl
   mlStagingSimpleSsl=true  mlJobSimpleSsl=true  mlFinalSimpleSsl=true  mlManageScheme=https  mlManageSimpleSsl=true  mlAppServicesSimpleSsl=true  mlSimpleSsl=true
You can set SSL/TLS in any environment.

Deprecated Properties

Deprecated PropertyDescriptionNotes
  • mlFlowOperatorUserName
  • mlFlowOperatorPassword
The username and password associated with an account assigned to themlFlowOperatorRole role.
Important: Do not use the auto-generated operator and developer user accounts. You must create your own user accounts and assign to them the appropriate security roles that were introduced inData Hub 5.2.0. Learn more:Users and Roles
  • mlFlowDeveloperUserName
  • mlFlowDeveloperPassword
The username and password associated with an account assigned to themlFlowDeveloperRole role.
mlEntityModelPermissionsA comma-delimited string that defines permissions for entity models.

The string must be in the formatrole,capability,role,capability,..., wherecapability can beread,insert,update, orexecute.

Default:data-hub-entity-model-reader,read,data-hub-entity-model-writer,update

Important: Do not modify the values of anyml*Permissions properties. Doing so could disable some functionalities.
mlFlowPermissionsA comma-delimited string that defines permissions for flows.

The string must be in the formatrole,capability,role,capability,..., wherecapability can beread,insert,update, orexecute.

Default:data-hub-flow-reader,read,data-hub-flow-writer,update

mlJobPermissionsA comma-delimited string that defines permissions for job documents.

The string must be in the formatrole,capability,role,capability,..., wherecapability can beread,insert,update, orexecute.

Default:data-hub-job-reader,read,data-hub-job-internal,update

mlMappingPermissionsA comma-delimited string that defines permissions for mappings.

The string must be in the formatrole,capability,role,capability,..., wherecapability can beread,insert,update, orexecute.

Default:data-hub-mapping-reader,read,data-hub-mapping-writer,update

mlModulePermissionsA comma-delimited string that defines permissions for modules.

The string must be in the formatrole,capability,role,capability,..., wherecapability can beread,insert,update, orexecute.

Default:data-hub-module-reader,read,data-hub-module-reader,execute,data-hub-module-writer,update,rest-extension-user,execute

mlStepDefinitionPermissionsA comma-delimited string that defines permissions for flows.

The string must be in the formatrole,capability,role,capability,..., wherecapability can beread,insert,update, orexecute.

Default:data-hub-step-definition-reader,read,data-hub-step-definition-writer,update

mlCustomForestPathThe directory path to the custom forest definitions to be used when configuring a database.
mlDHFVersionTheData Hub version to use in the MarkLogic Server host.No longer needed inData Hub 5.3.0 and later releases.