Configuration Files¶
Where the MetaMiner Server (MMS) reads its configuration, which source wins, and which changes apply without a restart.
Files at a glance¶
All paths are relative to the server folder, for example C:\Program Files\Infolytik\MetaMiner\server\.
| File | Content | Edited with |
|---|---|---|
config\config.json |
Power BI environments (pbiInfos), MMDB connection, server settings (properties section), email settings, license path |
MMA |
MetaMinerServer.properties |
Java system properties for special cases, for example retention periods | Text editor, on advice from Infolytik Support |
MetaMinerServer.ini |
Service launcher settings and fixed Java options | Do not edit without Infolytik Support |
config\webapps.json |
Web app settings, including the Power BI dashboards user group | MMA (Settings > WebApps) |
silver-jobs\ |
Definitions of the dashboard rollup jobs | Shipped with the release; the user group is written by MMA |
config\api-clients.json |
API clients and the SHA-256 hash of each token (never the token itself), while the Flow Scheduler is switched off | MMA (Settings > Advanced > Server API Auth > Manage API Clients...) |
config\apitoken.json |
No longer used. The shared token of earlier releases is imported once as the API client api, then the file is renamed apitoken.json.imported-<date>-<time>; you can delete it |
- |
config\mm-truststore.p12, config\mm-hostname-exemptions.properties |
Certificates and host names you chose to trust | MMA certificate prompts |
config\mmdb-service-state.json |
State of the embedded database service migration | MMS |
security\ |
MetaMiner users, roles and environment assignments | MMA Security menu |
licenses\ |
License files | MMA License section |
config.json¶
MMA reads and writes config.json. When the server is running, MMA sends each change to MMS, which applies it and writes the file. When the server is stopped, MMA writes the file directly. Writes are atomic and locked (config\config.lock), so MMA and MMS never overwrite each other.
| Feature | Detail |
|---|---|
| Daily backup | MMS copies the file to config\config.json.back_<date> when it loads it |
| Secrets | Client secrets and passwords are stored encrypted |
| Encrypted variant | With configuration encryption on, the file is config\config.ecf plus a key file config\config.ek. See Secrets and Configuration Encryption. |
| Unreadable file | MMS keeps its previous configuration and refuses to save until the file is fixed, so a damaged file is never overwritten with partial data |
Prefer MMA over hand edits
If you must edit config.json by hand, stop the server first, back up the file, and validate the JSON before starting again. Never copy config.json from another server; it contains that server's database and environment settings.
MetaMinerServer.properties¶
Contains Java system properties, one key=value per line. Lines starting with # are ignored. The file is read when the service starts; restart the server after editing.
The installer ships a commented template, MetaMinerServer.properties.customize, and never overwrites your MetaMinerServer.properties during upgrades. Properties relevant to Power BI are listed in Server Properties, Data Retention and Collection Schedule.
MetaMinerServer.ini¶
Launcher settings for the metaminer service: working directory, Java runtime, class path, log file and fixed Java options (vmarg.N lines). Server memory and the Java temp folder are not set here; MMA writes them into the service command line. See Memory and JVM.
Do not edit
The file states that its arguments must not be modified without consulting Infolytik Support.
TODO: state whether upgrades replace MetaMinerServer.ini
A MetaMinerServer.ini.customize file is also shipped. Confirm how customer changes to the ini survive an update installer.
Precedence¶
For Java system properties, the first source that sets a key wins:
MetaMinerServer.properties-Doptions inMetaMinerServer.inior the service command line- The built-in default
Settings in the properties section of config.json are separate. Some of them take their initial default from a system property of the same name; once MMA has saved a value in config.json, that value is used.
Apply changes: live or restart¶
| Change | Takes effect |
|---|---|
| Power BI environment added, edited, enabled, disabled or removed | Next server restart |
| Server port | MMS restarts its services on the new port automatically; MetaMiner Clients must reconnect |
| Server SSL, server memory, Java temp folder | Next server restart |
| Power BI dashboards user group (Settings > WebApps) | Dashboards within seconds; user-population figures at the next license-waste job run or restart |
| MetaQuery web console settings | Live |
| Other Settings pages | Restart when MMA offers it, to be sure |
MetaMinerServer.properties, MetaMinerServer.ini |
Next server restart |