Skip to content

Enable the Flow Scheduler

Switch the Flow Scheduler on in the MetaMiner Administrator (MMA), restart MetaMiner, choose environments and admins, and open the web interface.

The Flow Scheduler is installed with the MetaMiner Server (MMS) but is off by default. Until you enable it, the MetaMinerFSS service does not run and MMS does not serve the web interface.

Before you begin

  • MetaMiner is installed on the server and the MetaMinerFSS Windows service exists.
  • At least one Tableau Server environment is connected and enabled in MMA.
  • The MetaMiner Database (MMDB) is PostgreSQL. The Flow Scheduler stores its data in the same database.
  • You run MMA on the MMS host as a Windows administrator. The FSS Configuration dialog talks to the Flow Scheduler on the local host.
  • You know the Tableau user names of the people who will administer the Flow Scheduler.
  • For e-mail, SMTP is set up in MMA > Preferences > Settings > Email.

Steps

  1. In MMA, choose Preferences > Settings and open the General category.
  2. In the Flow Scheduler group, select Enable Flow Scheduler (FSS) and save. MMA writes flowscheduler.enabled=true to server\MetaMinerServer.properties. As the tooltip says, turning it on starts the Flow Scheduler with the next MetaMiner start.
  3. Restart MetaMiner from MMA: click Stop Server, wait until it has stopped, then click Start Server. MMS reads the switch at start and serves the web interface, and MMA starts MetaMinerFSS after MMS. Starting only the metaminer service from Windows Services does not start the Flow Scheduler.
  4. In MMA, choose Tools > FSS Configuration....
  5. On the Environments tab, select Enabled for each Tableau environment the Flow Scheduler may run flows in. The change applies at once. Every environment starts disabled. See Allowed Environments.
  6. On the Admins tab, type a Tableau user name in Username: and click Add. Repeat for each Flow Scheduler admin. Only users on this list see the Admin area and admin-only actions in the web interface.

  7. Open the web interface in a browser:

    https://<mms-host>:<port>/flowscheduler/

    The default port is 49714. Use http:// only if SSL is not enabled on MMS.

Open the Flow Scheduler at the server root

To send users who open https://<mms-host>:<port>/ straight to the Flow Scheduler, add flowscheduler.redirect.root=true to server\MetaMinerServer.properties and restart MMS. See Configuration Reference.

Verify

  • In Windows Services, MetaMinerFSS is running.
  • In MMA, Tools > FSS Configuration... loads its tabs without an "FSS service offline" message.
  • The browser shows the Flow Scheduler sign-in page with your environments in Tableau Environment.
  • server\logs\flowscheduler.log shows no errors at start-up.

Turn the Flow Scheduler off

Clear Enable Flow Scheduler (FSS) in MMA > Preferences > Settings > General and save. MMA stops a running MetaMinerFSS service at once. Restart MMS to remove the web interface. Schedules, tasks and history stay in the MMDB for when you enable it again.

While the Flow Scheduler is off, REST API calls to /fss/v1 and /fss/backup fail until you switch it on again.

Troubleshooting

The browser shows an error or a blank page at /flowscheduler/

MMS was not restarted after you enabled the Flow Scheduler, or the switch did not save. Check that server\MetaMinerServer.properties contains flowscheduler.enabled=true, then restart MetaMiner from MMA. Include the trailing slash in /flowscheduler/.

The Tableau Environment list is empty

No environment is enabled on the Environments tab of Tools > FSS Configuration..., or no Tableau Server environment is enabled in MMA. Enable one and reload the page.

The FSS Configuration dialog says FSS service offline

The MetaMinerFSS service is not running. Start it (or restart MetaMiner from MMA), then click Refresh in the dialog. If it does not stay running, check server\logs\flowscheduler.start.log.

Next steps