Data Hub Properties
The Data Hub properties control how Data Hub is installed and how connections are made. You can configure these properties through various tools, including the Data Hub Gradle Plugin.
MARKLOGIC SERVER HOST | ||
---|---|---|
Property | Description | Default Value |
mlHost | The MarkLogic Server host where Data Hub should be installed or is installed.
For on-premises and DHS. |
localhost |
mlIsProvisionedEnvironment | If true , indicates that the Data Hub instance is provisioned by a cloud provider; otherwise, indicates that the instance is on-premises.
For on-premises and DHS. If using DHS, must be set to |
false |
mlIsHostLoadBalancer | Must be set to true if the host specified by mlHost is a load balancer that directs traffic to MarkLogic hosts.
For on-premises and DHS. |
false |
mlAppServicesPort | The port number of an app server that Data Hub can use to determine the version of ML Server. The app server must always be available.
For on-premises and DHS. |
8000 |
mlAppServicesAuthentication | The authentication method for the app server specified by mlAppServicesPort. Valid values are digest (encrypted credentials) and basic (unencrypted credentials).
For on-premises and DHS. |
digest |
mlAppServicesSimpleSsl | If true , the connection with the app server specified by mlAppServicesPort is secured with SSL/TLS.
For on-premises and DHS. |
false |
mlManagePort | The port of the MarkLogic Manage server used to deploy a Data Hub application.
For on-premises and DHS. |
8002 |
mlManageScheme | The HTTP scheme for connecting to the MarkLogic Manage server. Valid values are http and https . Use https for an SSL/TLS connection.
For on-premises and DHS. |
http |
mlManageSimpleSsl | If true , the connection with the MarkLogic Manage app server is secured with SSL/TLS.
For on-premises and DHS. |
false |
STAGING | ||
Property | Description | Default Value |
mlStagingDbName | The STAGING database.
For on-premises only. |
data-hub-STAGING |
mlStagingForestsPerHost | The number of forests per host for the STAGING database.
For on-premises only. |
3 |
mlStagingAppserverName | The application server used to access the STAGING database.
For on-premises only. |
data-hub-STAGING |
mlStagingPort | The port used by the STAGING app server.
For on-premises and DHS. If using DHS, must be set to |
8010 |
mlStagingAuth | The authentication method for the STAGING app server. Valid values are digest (encrypted credentials) and basic (unencrypted credentials).
For on-premises and DHS. If using DHS, must be set to |
digest |
mlStagingSimpleSsl | If true , the connection with the STAGING server is secured with SSL/TLS.
For on-premises only. |
false |
FINAL | ||
Property | Description | Default Value |
mlFinalDbName | The FINAL database.
For on-premises only. |
data-hub-FINAL |
mlFinalForestsPerHost | The number of forests per host for the FINAL database.
For on-premises only. |
3 |
mlFinalAppserverName | The application server used to access the FINAL database.
For on-premises only. |
data-hub-FINAL |
mlFinalPort | The port used by the FINAL app server.
For on-premises and DHS. If using DHS, must be set to |
8011 |
mlFinalAuth | The authentication method for the FINAL app server. Valid values are digest (encrypted credentials) and basic (unencrypted credentials).
For on-premises and DHS. If using DHS, must be set to |
digest |
mlFinalSimpleSsl | If true , the connection with the FINAL server is secured with SSL/TLS.
For on-premises only. |
false |
JOBS | ||
Property | Description | Default Value |
mlJobDbName | The JOBS database.
For on-premises only. |
data-hub-JOBS |
mlJobForestsPerHost | The number of forests per host for the JOBS database.
For on-premises only. |
4 |
mlJobAppserverName | The application server used to access the JOBS database.
For on-premises only. |
data-hub-JOBS |
mlJobPort | The port used by the JOBS app server.
For on-premises and DHS. If using DHS, must be set to |
8013 |
mlJobAuth | The authentication method for the JOBS app server. Valid values are digest (encrypted credentials) and basic (unencrypted credentials).
For on-premises and DHS. If using DHS, must be set to |
digest |
mlJobSimpleSsl | If true , the connection with the JOBS server is secured with SSL/TLS.
For on-premises only. |
false |
OTHER DATABASES | ||
Property | Description | Default Value |
mlModulesDbName | The MODULES database to be used with the STAGING, FINAL, and JOBS app servers.
For on-premises only. |
data-hub-MODULES |
mlModulesForestsPerHost | The number of forests per host for the MODULES database.
For on-premises only. |
1 |
mlStagingTriggersDbName | The TRIGGERS database to be used with the STAGING app server.
For on-premises only. |
data-hub-staging-TRIGGERS |
mlStagingTriggersForestsPerHost | The number of forests per host for the STAGING-TRIGGERS database.
For on-premises only. |
1 |
mlStagingSchemasDbName | The SCHEMAS database to be used with the STAGING app server.
For on-premises only. |
data-hub-staging-SCHEMAS |
mlStagingSchemasForestsPerHost | The number of forests per host for the STAGING-SCHEMAS database.
For on-premises only. |
1 |
mlFinalTriggersDbName | The TRIGGERS database to be used with the FINAL app server.
For on-premises only. |
data-hub-final-TRIGGERS |
mlFinalTriggersForestsPerHost | The number of forests per host for the FINAL-TRIGGERS database.
For on-premises only. |
1 |
mlFinalSchemasDbName | The SCHEMAS database to be used with the FINAL app server.
For on-premises only. |
data-hub-final-SCHEMAS |
mlFinalSchemasForestsPerHost | The number of forests per host for the FINAL-SCHEMAS database.
For on-premises only. |
1 |
SECURITY | ||
Property | Description | Default Value |
mlFlowOperatorRole | The MarkLogic Server role with privileges to run flows.
For on-premises and DHS. If using DHS, must be set to |
flow-operator-role |
mlFlowDeveloperRole | The MarkLogic Server role with privileges to develop flows.
For on-premises and DHS. If using DHS, must be set to |
flow-developer-role |
|
The username and password associated with an account to use for every Data Hub operation.
For on-premises and DHS. |
Composite Properties
To simplify your configuration, you can set these composite properties instead of the individual properties.
Property | If the property is true , then |
Notes |
---|---|---|
hubDhs |
|
These settings are required by DHS.
Note: If
hubDhs=true , then hubSsl=true is automatically set. |
hubSsl |
|
You can set SSL/TLS in any environment. |
Deprecated Properties
Deprecated Property | Description | Notes |
---|---|---|
|
The username and password associated with an account assigned to the mlFlowOperatorRole 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 in Data Hub 5.2.0. Learn more: Users and Roles
|
|
The username and password associated with an account assigned to the mlFlowDeveloperRole role. | |
mlEntityModelPermissions | A comma-delimited string that defines permissions for entity models.
The string must be in the format Default: |
Important: Do not modify the values of any ml*Permissions properties. Doing so could disable some functionalities.
|
mlFlowPermissions | A comma-delimited string that defines permissions for flows.
The string must be in the format Default: |
|
mlJobPermissions | A comma-delimited string that defines permissions for job documents.
The string must be in the format Default: |
|
mlMappingPermissions | A comma-delimited string that defines permissions for mappings.
The string must be in the format Default: |
|
mlModulePermissions | A comma-delimited string that defines permissions for modules.
The string must be in the format Default: |
|
mlStepDefinitionPermissions | A comma-delimited string that defines permissions for flows.
The string must be in the format Default: |
|
mlCustomForestPath | The directory path to the custom forest definitions to be used when configuring a database. | |
mlDHFVersion | The Data Hub version to use in the MarkLogic Server host. | No longer needed in Data Hub 5.3.0 and later releases. |