Configuration¶
Change Flow Scheduler settings in the FSS Configuration dialog of the MetaMiner Administrator (MMA), and know which file wins when a setting is set in more than one place.
Before you begin¶
- The Flow Scheduler is enabled and the
MetaMinerFSSservice is running. See Enable the Flow Scheduler. - You run MMA on the Flow Scheduler host as a Windows administrator.
- In a high-availability cluster, you know which node is starred as the preferred node on Admin > HA / Nodes. See High Availability.
The FSS Configuration dialog¶
Open it with Tools > FSS Configuration... in MMA. It has four tabs and a status line at the bottom. Refresh reloads every tab; Close closes the dialog.
| Tab | What you do there | When it applies |
|---|---|---|
| Environments | Allow or block each Tableau environment, mark it SSO Ready, test Trusted Authentication | At once |
| Properties | View and change Flow Scheduler settings | After a Flow Scheduler restart (except the Display group) |
| Admins | Add or remove the Tableau users who are Flow Scheduler admins | Stored in the shared database; no restart |
| SAML / SSO | Configure SAML single sign-on for the web interface | When saved; no restart |
Steps¶
- In MMA, choose Tools > FSS Configuration... and open the Properties tab.
- Type part of the setting name or its description in Filter:.
- Select the row. The pane below shows the setting, its description and its default.
- Type the new value and click Apply. The status line confirms the save.
- Restart the Flow Scheduler: restart
MetaMinerFSSin Windows Services, or runnet stop MetaMinerFSSand thennet start MetaMinerFSSin an administrator command prompt.
The table columns are Group, Key, Type, Current value and Restart?. Secret settings are hidden and the edit box starts empty, so type the full new value.
Restart after every change except Display
Restart the Flow Scheduler after changing any setting, even when the Restart? column or the status line does not ask for it. Settings in the Display group (application title, column labels, e-mail product name) are the exception: they apply without a restart. The Configuration Reference is the authority for each setting.
Common changes¶
| To do this | Setting or control | Details |
|---|---|---|
| Send task e-mail | notifications.enabled, then switch e-mail on per environment and per task |
Notifications |
| Schedule a weekly backup of the node | backup.enabled and backup.cron |
Backup and Restore |
| Rename the application or columns | Display group | Web Interface Tour |
| Offer Personal Access Token sign-in | flowscheduler.auth.pat.enabled on MMS |
Sign-In Options |
| Change how REST API callers authenticate | Server API Auth in MMA | Authorization Modes |
| Turn on high availability | ha.lease.enabled and mms.url.local on each node |
Set Up High Availability |
Where settings are stored¶
The Properties tab writes your change to config-overrides.properties in the server folder (C:\Program Files\Infolytik\MetaMiner\server\). In that file every key carries the flowscheduler. prefix, for example flowscheduler.max.concurrent.per.env=5.
The same key can be set in other places. When the Flow Scheduler starts, it uses the first value it finds in this order:
| Order | Source | How it is set |
|---|---|---|
| 1 (wins) | JVM -D argument of the MetaMinerFSS service |
-Dflowscheduler.<key>=<value> |
| 2 | server\MetaMinerServer.properties |
flowscheduler.<key>=<value> |
| 3 | server\config-overrides.properties |
The MMA Properties tab |
| 4 | server\config\config.json, properties block |
"flowscheduler.<key>": "<value>" |
| 5 | Built-in default | Configuration Reference |
Keep Flow Scheduler settings out of MetaMinerServer.properties
A flowscheduler.* key in MetaMinerServer.properties or a -D argument is fixed at launch: the value you apply in the Properties tab has no effect, and in a cluster it does not follow the preferred node. Use the dialog. Leave in MetaMinerServer.properties only the switch flowscheduler.enabled and the settings MMS reads (below).
Settings that MMS reads¶
A few Flow Scheduler settings are read by the MetaMiner Server (MMS), not by the Flow Scheduler. Put them in server\MetaMinerServer.properties on every MMS node and restart MMS. The common ones are below; the full list with defaults is in the Configuration Reference.
| Setting | What it does |
|---|---|
flowscheduler.enabled |
Turns the Flow Scheduler on. Set from MMA > Preferences > Settings > General. |
flowscheduler.redirect.root |
true sends the server root / to /flowscheduler/. |
flowscheduler.auth.pat.enabled |
true offers Personal Access Token sign-in. |
flowscheduler.show.all.flows.enabled |
true shows the Show all option on the Flows list. |
Settings in a high-availability cluster¶
Once a node is starred as the preferred node, change shared settings on that node only. The other nodes take the new values and apply them at their next Flow Scheduler restart, so restart the Flow Scheduler on every node after a change.
If you apply a shared setting on another node, MMA refuses the save with a message that the setting is shared by the HA nodes and names the preferred node. Per-node settings (such as mms.url.local) can still be changed on any node. The setup order for the per-node settings is in Set Up High Availability.
Back up and restore the configuration¶
Flow Scheduler admins can export and restore the configuration as JSON in the web interface at Admin > Settings > Config (JSON), and back up a node at Admin > Settings > Backup. See Backup and Restore.
Verify¶
- The Current value column shows your value after Refresh.
- After the Flow Scheduler restart,
server\logs\flowscheduler.logshows no configuration errors.
Troubleshooting¶
The status line says FSS service offline
The MetaMinerFSS service is not running. Start it, click Refresh and apply the change again.
My change has no effect after the restart
The same key is set in MetaMinerServer.properties or as a -D argument, which win over the dialog. Remove it there and restart the Flow Scheduler.
The save fails with HTTP 409
This node is part of a high-availability cluster and the setting is shared. Make the change in MMA on the preferred node named in the message.
The dialog says MMS not reachable
The Flow Scheduler is running but the MetaMiner Server is stopped or still starting. Settings and admins stay editable; environments are listed once MMS is up. Click Refresh when MMS has started.