Skip to main content

Setup and settings

Enable the feature​

Turn the plugin feature on in the Flex configuration:

"supervisor_console": {
  "enabled": true
}

The console reads the wallboard's data, so it needs the same data sources (see Wallboard data sources and setup):

Needed forSetup
Queues, waiting, agents and statesLive TaskRouter statistics, read by Floor Walker.
Today's numbers, service level, attention items, the intraday chartThe Event Streams sink created at installation.
Per-queue service level thresholds and targetsService level settings in Reports, or your environment's defaults.
Unhappy customersAI insights on interactions (see Agent Workspace).
Outbound panelThe outbound dialer, with the plugin's dialer feature enabled.
TV boards section, broadcastsThe wallboard feature.
My team scopeThe team_name worker attribute.

"Today" is the day in your environment's timezone.

Settings​

The console's colour limits and attention rules are one settings document. There is no settings screen yet: an admin reads and changes it with a request to your Floor Walker service, using an admin's Flex token (Authorization: Bearer <Flex token>) or an API key with the supervisor-settings:write scope (X-Api-Key).

  • Read: GET https://<your-floor-walker-host>/supervisor/settings returns { "settings": { … } }. Supervisors may read it.
  • Change: PUT https://<your-floor-walker-host>/supervisor/settings with the whole document as the body. Admins only; returns the saved settings.

PUT replaces the whole document: any field left out goes back to its default, so send every value you changed before, not only the new one.

{
  "thresholds": {
    "tasks_waiting":  { "direction": "lower_is_better",  "warn": 5,  "bad": 10 },
    "longest_wait":   { "direction": "lower_is_better",  "warn": 60, "bad": 120 },
    "service_level":  { "direction": "higher_is_better", "warn": 80, "bad": 70 },
    "abandon_rate":   { "direction": "lower_is_better",  "warn": 5,  "bad": 10 },
    "asa":            { "direction": "lower_is_better",  "warn": 30, "bad": 60 },
    "occupancy":      { "direction": "lower_is_better",  "warn": 90, "bad": 95 }
  },
  "attention": {
    "wrapWarnSec": 120,
    "wrapBadSec": 300,
    "awayLimitSec": 900,
    "activityLimitsSec": { "Lunch": 2700, "Training": 7200, "Meeting": 3600 },
    "longTaskFactor": 3,
    "longTaskMinSec": 600,
    "ronaWarn": 5,
    "ronaBad": 10,
    "slMinSample": 5
  }
}

The values above are the defaults. What each one does is described in Colour limits and Rule settings. The service level threshold and target are not here: they are per queue, in the service level settings.

A body that does not match the document returns 400 validation_error with the problems listed; a non-admin gets 403 forbidden.