Server Properties¶
Configuration keys of the MetaMiner Server that BusinessObjects customers can tune: name, default, effect, and whether a restart is needed.
Change only what you need
Most settings have a field in the MetaMiner Administrator (MMA). Use the MMA where one exists. Change the other keys only when this page or Infolytik Support tells you to, and write down every change so you can revert it.
Where settings live¶
| File | Location | Read when | Who writes it |
|---|---|---|---|
config.json, properties section |
server\config\config.json |
At start, and again whenever the file changes | The MMA (Preferences > Settings and the environment dialogs) |
MetaMinerServer.properties |
server\MetaMinerServer.properties |
Once, at service start | You, with a text editor |
- The installer ships
MetaMinerServer.properties.customizeas a commented template and never overwrites your ownMetaMinerServer.properties. Copy the template toMetaMinerServer.propertiesbefore you add keys. - A key in
MetaMinerServer.propertiesoverrides the same key passed on the service command line. - If the configuration is encrypted,
config.jsonis replaced byconfig.ecfand can only be changed through the MMA. See Encrypting the Configuration. - Restart: the MMA offers to restart the service after you save settings. Accept it unless the table says the key is
applied live. Keys in
MetaMinerServer.propertiesalways need a service restart.
See also Configuration Files and Custom Settings.
Image of the MMA Settings dialog with the page list (General, Audit, Backup, Pull, Email, Metrics, Notifications, System, MetaQuery, Web Apps, Advanced)
../../images/help/mma-settings-pages.png
Server, memory and network (config.json)¶
| Key | Default | Effect | MMA field | Restart |
|---|---|---|---|---|
port |
49714 |
Port the MMS listens on for clients and browsers | General > Server Port | Applied automatically (the MMS rebinds) |
mms.ssl |
false |
Turns on TLS for the MMS port | General > Configure SSL | Yes |
mms.ssl.cert, mms.ssl.pk, mms.ssl.pk.passw |
none | PEM certificate, PEM private key and its password (stored encrypted) | General > Configure SSL | Yes |
postgres_port |
49614 |
Port of the embedded MMDB | MetaMiner Database dialog | Yes |
jvm.xmx |
at least 2 (GB) |
Maximum heap of the MMS | System > Memory allocation for MetaMiner's JVM | Yes |
limit.jvm.memory.to.half |
true |
Caps the heap choice at half the physical memory | System > Limit max memory to half of physical memory | Yes |
jvm.temp.dir |
server\javatemp |
Java temporary folder for unpacked BIARs and ZIPs | System > Java Temp Folder | Yes |
max.allowed.cores |
8 |
CPUs MetaMiner uses for parallel work | System > Maximum Allowed CPUs | Yes |
mms.api.auth |
TOKEN on new installs; upgrades keep their value |
Authentication for the external automation API | Advanced | Yes |
Pull and processing (config.json)¶
| Key | Default | Effect | MMA field |
|---|---|---|---|
webi.deep.pull.period |
5 (minutes) |
How often Web Intelligence documents are deep-processed | Pull > Webi Metadata pull period |
universe.deep.pull.period |
5 (minutes) |
How often universes are deep-processed | Pull > Universe Metadata pull period (min) |
threads.per.datatype |
4 |
Parallel threads per object type during a pull | Pull > Threads per datatype |
threads.per.web |
4 |
Parallel threads for Web Intelligence deep processing | Pull > Threads per Webi |
cms.pull.metrics |
true |
Collects BusinessObjects server metrics (also needed for the Web Intelligence Processing Server check) | Pull > Pull Server Metrics |
sql.engine.enabled |
true |
Parses Web Intelligence and Crystal SQL for database impact analysis | Pull |
keep.biars |
false |
Keeps BIAR files from export and promotion on disk | Pull > Keep BIAR Files |
webi.keep.history |
false |
Keeps Web Intelligence versions for Visual Diff | Backup > Keep Web Intelligence versions? |
unx.keep.history |
true |
Keeps universe versions | Backup > Keep Universe versions? |
archivePath |
server\alerts\archives |
Folder for backup archives | Backup |
import.orphan.handling.mode |
THROW |
Orphan handling during promotion imports: DROP, NONE or THROW |
General |
Audit (config.json)¶
| Key | Default | Effect | MMA field |
|---|---|---|---|
audit.days.ago |
550 |
Days of audit history read on the first audit pull | Audit |
cms.pull.audit.delay |
20 (minutes) |
Minimum interval between audit pulls | Audit |
cms.pull.extendedaudit |
true |
Pulls audit events from the audit database | Audit |
audit.username.exclusions |
empty | Quoted, comma-separated user names left out of audit statistics, for example 'Administrator','MetaMinerAdmin' |
Audit |
audit.cfg.max.pool.size |
5 |
Maximum connections to each audit database | Audit > Audit DB Connection pull size |
Notifications (config.json)¶
| Key | Default | Effect | MMA field |
|---|---|---|---|
deletions.warning.threshold |
3000 |
Deletions in one pull that trigger an excessive deletions notification | Notifications > Excessive deletions notification threshold |
disk.space.remaining.pct |
20 |
Free space percentage on the installation drive that triggers a notification | Notifications > MMS Disk space remaining threshold |
alert.cluster.nodes.offline |
false |
Notifies when BusinessObjects cluster nodes go offline | Notifications |
TODO: align the excessive deletions default
The product default is 3000; the MMA tooltip says 200. Confirm which value is intended and fix the tooltip or the default.
Web Console (config.json)¶
| Key | Default | Effect | MMA field |
|---|---|---|---|
web.bo.enabled |
false |
Turns on the BusinessObjects Web Console apps under /web/bo/ |
Web Apps |
web.bo.login |
required |
Sign-in for the BusinessObjects console: required, optional or off (forced off when MetaMiner user security is off) |
Web Apps |
web.monitor.enabled |
false |
Turns on the Monitor web app | Web Apps |
web.metaquery.enabled |
false |
Turns on Meta Query on the web | MetaQuery |
See Web Apps and Enable the Web Console.
MetaMinerServer.properties keys¶
All keys below need a service restart.
| Key | Default | Effect |
|---|---|---|
cms.pull.exclusions.enabled |
false |
Turns on the exclusion list below |
cms.pull.exclusions |
empty | Comma-separated object types not pulled for any environment, for example WEBI1400. Use for diagnosis, then remove |
cms.pull.inclusions.enabled |
false |
Turns on the inclusion list below |
cms.pull.inclusions |
empty | Comma-separated object types that are the only ones pulled |
webi.timeout |
5 (minutes) |
Time allowed to process one Web Intelligence document through the SDK |
webi.rest.threads |
4 |
Parallel sessions used for Web Intelligence processing through the RESTful web service |
ooc.orb.policy.request_timeout |
14400000 (ms, 4 hours) |
Upper bound for any single BusinessObjects SDK call. Never set 0 (no limit) |
security.extractor.scheduled |
true |
Runs the scheduled security (rights) extraction |
security.extraction.cron |
0 0/30 * ? * * (every 30 minutes) |
Schedule of the security extraction |
lcm.promotion.include.security |
false |
Includes object security in LCM promotions |
lcm.promotion.include.applicationsecurity |
false |
Includes application security in LCM promotions |
lcm.promotion.export.dependencies |
false |
Exports dependencies in LCM promotions |
cms.bo.con.failure.alerts.skip.list |
empty | Comma-separated environment IDs (the numeric id of the environment in config.json). For these environments MetaMiner sends one connection-failure email per outage instead of repeating it until the connection recovers |
hikari.cfg.maximumpoolsize |
75 |
Maximum MMDB connections in each MMS connection pool |
bo.ssl.support.enabled |
false |
Enables SSL for the SDK connection to the CMS. See Server to BusinessObjects SSL |
proxy.auth.user, proxy.auth.password |
none | Credentials for an authenticating outbound HTTP proxy |
use.encrypted.config |
false |
Set by the MMA when you encrypt the configuration; do not edit by hand |
mm.truststore.path |
config\mm-truststore.p12 |
Trust store for certificates you trust in the MMA |
server\MetaMinerServer.properties (example)
# Diagnose a Web Intelligence problem: skip Web Intelligence BI 4 deep processing
cms.pull.exclusions.enabled=true
cms.pull.exclusions=WEBI1400