Gradle Properties

Data Hub-specific Gradle properties

The following are the Gradle properties used by Data Hub to install and run properly.

Property Description Default Value
GENERAL
mlDHFVersion The Data Hub version to use in the MarkLogic Server host.
mlHost The MarkLogic Server host where Data Hub should be installed or is installed. localhost
mlIsProvisionedEnvironment If true, indicates that the Data Hub instance is provisioned by a cloud provider; otherwise, indicates that the instance is on-premise. Must be true if using MarkLogic Data Hub Service. false
STAGING
mlStagingDbName The STAGING database. data-hub-STAGING
mlStagingForestsPerHost The number of forests per host for the STAGING database. 3
mlStagingAppserverName The application server used to access the STAGING database. data-hub-STAGING
mlStagingPort The port used by the STAGING app server. 8010
mlStagingAuth The authentication method for the STAGING app server. Valid values are digest (encrypted credentials) and basic (unencrypted credentials). digest
mlStagingSimpleSsl If true, the connection with the STAGING server is secured with SSL. false
FINAL
mlFinalDbName The FINAL database. data-hub-FINAL
mlFinalForestsPerHost The number of forests per host for the FINAL database. 3
mlFinalAppserverName The application server used to access the FINAL database. data-hub-FINAL
mlFinalPort The port used by the FINAL app server. 8011
mlFinalAuth The authentication method for the FINAL app server. Valid values are digest (encrypted credentials) and basic (unencrypted credentials). digest
mlFinalSimpleSsl If true, the connection with the FINAL server is secured with SSL. false
JOBS
mlJobDbName The JOBS database. data-hub-JOBS
mlJobForestsPerHost The number of forests per host for the JOBS database. 4
mlJobAppserverName The application server used to access the JOBS database. data-hub-JOBS
mlJobPort The port used by the JOBS app server. 8013
mlJobAuth The authentication method for the JOBS app server. Valid values are digest (encrypted credentials) and basic (unencrypted credentials). digest
mlJobSimpleSsl If true, the connection with the JOBS server is secured with SSL. false
OTHER DATABASES
mlModulesDbName The MODULES database to be used with the STAGING, FINAL, and JOBS app servers. data-hub-MODULES
mlModulesForestsPerHost The number of forests per host for the MODULES database. 1
mlStagingTriggersDbName The TRIGGERS database to be used with the STAGING app server. data-hub-staging-TRIGGERS
mlStagingTriggersForestsPerHost The number of forests per host for the STAGING-TRIGGERS database. 1
mlStagingSchemasDbName The SCHEMAS database to be used with the STAGING app server. data-hub-staging-SCHEMAS
mlStagingSchemasForestsPerHost The number of forests per host for the STAGING-SCHEMAS database. 1
mlFinalTriggersDbName The TRIGGERS database to be used with the FINAL app server. data-hub-final-TRIGGERS
mlFinalTriggersForestsPerHost The number of forests per host for the FINAL-TRIGGERS database. 1
mlFinalSchemasDbName The SCHEMAS database to be used with the FINAL app server. data-hub-final-SCHEMAS
mlFinalSchemasForestsPerHost The number of forests per host for the FINAL-SCHEMAS database. 1
SECURITY
mlFlowOperatorRole The MarkLogic Server role with permissions to run flows. flow-operator-role
  • mlFlowOperatorUserName
  • mlFlowOperatorPassword
 The username and password associated with an account assigned to the mlFlowOperatorRole role.
mlFlowDeveloperRole The MarkLogic Server role with permissions to develop flows. flow-developer-role
  • mlFlowDeveloperUserName
  • mlFlowDeveloperPassword
 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 role,capability,role,capability,..., where capability can be read, insert, update, or execute.

 data-hub-entity-model-reader,read,data-hub-entity-model-writer,update
mlFlowPermissions A comma-delimited string that defines permissions for flows.

The string must be in the format role,capability,role,capability,..., where capability can be read, insert, update, or execute.

 data-hub-flow-reader,read,data-hub-flow-writer,update
mlJobPermissions A comma-delimited string that defines permissions for job documents.

The string must be in the format role,capability,role,capability,..., where capability can be read, insert, update, or execute.

 data-hub-job-reader,read,data-hub-job-internal,update
mlMappingPermissions A comma-delimited string that defines permissions for mappings.

The string must be in the format role,capability,role,capability,..., where capability can be read, insert, update, or execute.

 data-hub-mapping-reader,read,data-hub-mapping-writer,update
mlModulePermissions A comma-delimited string that defines permissions for modules.

The string must be in the format role,capability,role,capability,..., where capability can be read, insert, update, or execute.

 data-hub-module-reader,read,data-hub-module-reader,execute,data-hub-module-writer,update,rest-extension-user,execute
mlStepDefinitionPermissions A comma-delimited string that defines permissions for flows.

The string must be in the format role,capability,role,capability,..., where capability can be read, insert, update, or execute.

 data-hub-step-definition-reader,read,data-hub-step-definition-writer,update
mlCustomForestPath The directory path to the custom forest definitions to be used when configuring a database.
Note: Other properties conform to the ml-gradle properties. See the ml-gradle Property Reference