MMS Configuration Files
Purpose of Custom Settings¶
MMTE is designed for minimal configuration and tuning and should allow 90% of all installations to work straight "out of the box". All required settings should be made in MetaMiner Administrator.
But certain environments must run MMTE with specialized configurations, required due to environmental limitations or because of ongoing diagnosis of an issue being reviewed.
Only use the section below if you know what you are doing and/or were asked to do so by Infolytik Support staff.
Supportability Caution
Infolytik does not support configurations with customized system settings unless explicitly asked to do so by Infolytik Support staff. Modifying MMTE behaviour using the system settings can cause unwanted or unexpected results and should be made with caution. If you do decide to use the settings described below, always remember to make a backup and be ready to revert your changes.
MMS Configuration Levels¶
MMTE Server uses three levels of system configuration files:
Level | File | Required | MMS read/write access | Description |
---|---|---|---|---|
Low | MetaMinerServer.ini | No | MMS only reads it | It includes vmarg parameters for MMS. If this file is missing, MMTE Server uses its default template hardcoded into its loader. Available variables are described here. |
Middle | MetaMinerServer.properties | No | MMS only reads it | This config file allows you to alter system objects properties. If this file is missing, MMTE Server uses default values for all properties. See below for more details. |
High | config.json | Yes | MMS reads and writes it | This config file stores all settings defined in MMTE Administrator: for connected environments, databases, etc. It is not recommended to edit this file manually. |
MetaMinerServer.properties File¶
MMTE Server searches for this file in the same directory where its binaries are located: <METAMINER INSTALLATION DIRECTORY>\server
.
A typical MetaMinerServer.properties
file looks like the one shown here, with no settings enabled by default:
# Orphan handling options
# DROP: Any orphans are dropped during import.
# NONE: Orphans are imported, although they are in an error state (not having a parent) and will not commit unless they are given a parent.
# THROW: If any orphans are detected an exception is thrown during import
#import.orphan.handling.mode=NONE
#lcm.promotion.include.security=true
#lcm.promotion.include.applicationsecurity=true
#lcm.promotion.export.dependencies=true
#named.archive.folders=true
#audit.username.exclusions='Administrator','metamineradmin','mmadmin','MetaMinerAdmin'
# You shouldn't need to modify these - but if you do, please consult Infolytik support first
#audit.days.to.pull=30
#webi.keep.history=false
#audit.batch.size=10000
#threads.per.webi=2
#hikari.cfg.maximumpoolsize=40
#sql.engine.enabled=false
MetaMinerServer.properties Usage
Normally, the MetaMinerServer.properties
file should not have any settings enabled by default (all lines should be commented out by having an "#" symbol in front of each line).
To enable/add custom properties, follow these steps:
- Navigate to
<METAMINER INSTALLATION DIRECTORY>\server
-
Open the file
MetaMinerServer.properties
with a text editor.Note
On Windows OS, use Wordpad if no custom text editor is installed. Notepad may not render the file correctly.
-
Modify the file as needed.
#
at the beginning of the line indicates that the property will be ignored. This is by default. -
Save the file.
- Restart MMTE Server.
Note
There may be unpublished settings provided by Infolytik that are not in the documentation but provided to customers on an as-needed basis.
The following properties are available for use with Tableau environments:
Setting | Type | Example | Description |
---|---|---|---|
tab.pull.exclusions.enabled | Boolean | true | Enables exclusion mode (black list) which prevents certain data types from being processed. It is useful when diagnosing pull issues. |
tab.pull.exclusions | List | <datatype>,<datatype>,... | Enumerates the data types to be excluded from processing for all enabled Tableau environments. Data type names can be found here: data types. The setting tab.pull.exclusions.enabled must be set to true. |
tab.pull.inclusions.enabled | Boolean | true | Enables inclusion mode (white list) which explicitly lists data types allowed for processing. It is useful when diagnosing pull issues. |
tab.pull.inclusions | List | <datatype>,<datatype>,... | Enumerates the data types to be included for processing for all enabled Tableau environments. Data type names can be found here: data types. The setting tab.pull.inclusions.enabled must be set to true. |